Versions Compared

Old Version 2

changes.mady.by.user Chilukuri Srinivasa Reddy (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Mayuresh Balaji Kamble

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Exporter macro migration
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

truetruetruetrue

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:

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

    Figure:  SCRIPT CONFIGURATION page

    Field Description

    Scroll export button
    scopecurrent
    template-id4fda9400-a7df-4ede-a95f-e4ae5fcf4796
    captionDownload this Page
    add-onScroll PDF Exporter

    Scripts are the set of commands which are written to accomplish a specific task. Scripts can be written in multiple languages like PowerShell, Perl Python etc. Published scripts will be available to create the Orchestration Workflow.

    To get a quick understanding of loading the Script to the Service Automation, browse the following video.

    Widget Connector
    urlhttps://www.youtube.com/watch?v=OlpqlPCRz28

    To configure a new Orchestration Script:

    1. Select Script Configurations. The Script Configurations list page is displayed.
    2. On the Script Configurations list page, click on + icon to configure a new script. For more information on the fields of Script Configurations list page, see, Field Description.
    3. Select the Script Language.
    4. Click Load Parameters, after specifying the script. Specify other required fields in Script Configurations details page. For more information on the fields of Script Configurations details page, see, Field Description.
    5. Click Submit. A new Orchestration Script  is configured.

    To update an existing Orchestration Script:

    1. Select Script Configurations. The Script Configurations list page is displayed.
    2. On the Script Configurations list page, select the specific script to edit or view the script. For more information on the fields of Script Configurations list page, see, Field Description.
    3. Click Load Parameters, after specifying the required parameters of the script. For more information on the fields of Script Configurations details page, see, Field Description.
    4. Click Submit. The orchestration's script's configurations are updated.


    Image Added

    Figure:  Script Configurations List Page

    Field Description

    Anchor
    ListPage
    ListPage

    The following table describes the fields on the SCRIPT CONFIGURATION Script Configurations list page:

    Fields

    Description

    General

    Script Name

    Type in

    Displays the

    Orchestration Script

    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.ExecutionMax 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.

    Status

    Displays the status of the script.

    Category

    Displays the category of the script.

    Right click on icon and the following options are displayed:

    • Sort (A to z)
    • Sort (Z to a)
    • Group by Column

    Check the Group by Column check box to group the categories. Uncheck the Group by Column check box to un-group the categories.

    Script Language

    Displays the script language.

    Created By

    Displays the name of the user who has created the script.

    Last Updated By

    Displays the name of the user who has last updated the script.

    Last Updated Date

    Displays the date on which the script was last updated.

    Created Date

    Displays the date on which the script was last created.

    Description

    Displays the description of the script.

    Image Added

    Click this icon to add a new script.

    Image Added

    Click this icon and select one the of following options:

    • Export to Excel – To export the all the listed script configurations to Microsoft Excel sheet.
    • Export to JSON - To export the individual listed script configuration to the respective individual json file.

    Image Added

    Click this option and Filter Pop-up page is displayed. You can apply, save, and update the filters to the script configuration.

    Image Added

    Figure: Filter Pop-up

    Image Added

    Click this option and Edit Column pop-up page is displayed. You can add a column, delete a column, or change the order of columns. Click Apply to save the changes and you can view the applied changes on Screen Configurations page.

    Image Added

    Figure: Edit Columns Pop-up

    Image Added

    Click on this icon, a search text box is displayed against each column to search the data against each column.

    Image Added

    Figure: Script Configurations details page

    Field Description

    Anchor
    DetailsPage
    DetailsPage

    The following table describes the fields on the Script Configurations list page:

    Fields

    Description

    Script Language

    Select the language in which you want to write the script

    is written or writing

    . SummitAI Orchestration supports the following scripting languages:

    • DOS Command
    • Perl Script
    Powershell
    • 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

    Script Editor

    Specify the commands in the script window.

    Input Parameters should be declared as [*VariableName*]

    The starting and ending of Output Parameters should be declared as [START##VariableName##] and [END##VariableName##].

    Script Details

    Specify the following parameters under script details.

    • Script Name – Specify the script name.
    • Category – Specify the category of automation script.
    • Status – By default, status will be in Design mode. Specify the status of the script as required. Available options are as follows:
      • Design
      • Maintenance
      • Published

    Note

    Except Status field, all other fields will be read-only. Only published scripts will be displayed in the Workflow Designer.

    • Description – Specify the description of the script.

    Execution

    Specify the following parameters under execution.

    • Max Run Time (In Mins) - Specify the maximum run time for the script in terms of minutes. By default, it is saved as 0, if maximum run time is not specified.
    • Remote Execution By - Administrators 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.

    Input

    Once you click on Load Parameters, the parameters specified in the script are displayed under Input tab.

    Output

    Once you click on Load Parameters, the output variables specified in the script are displayed in Output Variable drop-down under Output tab. You can map the Output Name to the required Output Value.

    By default, the following options are available in Output Value drop-down list:

    • Execution Output
    • Execution Error

    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
    • .



    Scroll ignore
    scroll-pdftrue
    scroll-officetrue
    scroll-chmtrue
    scroll-docbooktrue
    scroll-eclipsehelptrue
    scroll-epubtrue
    scroll-htmltrue
    1

    | |