Configure Script Objects

Owned by Enterprise IT
Jun 02, 2024
2 min read

SummitAI Orchestration

Orchestration Scripts need to be configured so that Analysts can execute the scripts on the Configuration Items (CIs). The configured scripts are used in Orchestration. As an Administrator, you need to configure the scripts, specify target platform, and add commands that need to be executed through the script. You need to run the ‘Incident Smart Action’ job in the Custom Scheduler. This option is useful for issuing operational commands as well (besides diagnostic ones), such as restarting processes, changing supervisor parameters, and so on.

To configure Orchestration Scripts:

  1. Select Orchestration > Script Configuration. The SCRIPT CONFIGURATION page is displayed.
  2. On the SCRIPT CONFIGURATION page, specify all the fields to configure a new script.
  3. Click LOAD PARAMETERS, after specifying the script. 
  4. Click SUBMIT. A new Orchestration Script  is configured.


    Figure:  SCRIPT CONFIGURATION page

Field Description

The following table describes the fields on the SCRIPT CONFIGURATION page:

Fields

Description

General

Script Name

Type in the Orchestration Script name.

Category Select the Category for which you want to write a script.
Status

Select the status of the script as follows:

  • Design
  • Maintenance
  • Published
DescriptionSpecify the description for the script.
Execution
Max Runtime (In Mins)Specify the maximum run time for the script in terms of minutes.
Remote Execution ByAdministrators can configure the Orchestration Scripts to capture the account under which the Script should get executed through Remote Executor Tool by selecting System Account or CI Account.
Language

Select the language in which the script is written or writing. SummitAI Orchestration supports the following scripting languages:

  • DOS Command
  • Perl Script
  • Powershell Script
  • Python
  • Shell Script (Windows)
  • Shell Script (Non-Windows)
  • VB Script
Theme

You can select the theme while writing the script to get the better view of the script. The following themes are available:

  • Light
  • Dark
  • High Contrast Dark
Criteria

Success or Failure

Specify the condition to define the success or failure of the Orchestration Script .

  • Slide the Active button to make the success criteria on.
  • Select the variable from the list.
  • Choose the condition from the list.
  • Specify the value for the condition.

Output Parsing Criteria

Specify the condition to remove the additional output text and obtain only the valid output.

Specify the keywords in the Keyword text box and select the Criteria from the list box. The specified criteria will be removed from the output value and only the required output text is displayed.