New Workflow

Workflow name

Name the use case.

Module

Select Incident Management, Service Request, Work Order.

Trigger Event

Tenant

Select the Tenant for which the Orchestration is applicable.

Workflow Category

Search for the desired category.

Active

Indicates the status of Orchestration:

If selected, the Orchestration is active.

If cleared, the Orchestration is inactive.

Description

Describe the function of the workflow.

Parser Type

Lists the configured parser types:

• Line: If Incident/Service Request/ Work Order description is in line format then select Parser Type as Line. Line parser type can only be applied for Description content type.
  
  
   
  
• Free-form: If Symptom/Description is in paragraph format then select Parser Type as Free Form. It is used to extract the words between two words. Free-form can be applied to either Description or Symptom content type.
  
  

Line Delimiter

The line delimiter is a character that indicates the end of the line or splits the description value into multiple lines.  

Based on Line Delimiter, content is divided into lines. Select the line delimiter from the list. By default, the New Line option is selected. If you select Others, type in the character that is considered as a line delimiter in the text box.

The Key Delimiter is a character that separates the User-defined key and the other text in the output.

Based on Key Delimiter options, the key, and the value are identified from a line. Select the key delimiter from the list. By default, the Colon option is selected. If you select Others, type in the character that is considered a key delimiter in the text box.

For example, If the Line No. is represented as one (1) then the first line from the Description is considered as the key value.

Line No.

Select the content type from the drop-down list. Available options are as following:

• Symptom or Subject
• Description

Key Name

Specify a number. In an Incident/Service Request/Work Order, the occurrence of the specified preceding and succeeding text or the preceding text alone in the selected Content Type is represented as a number.

For example, If the Occurrence is represented as one (1) for the Content Type: Symptom, then the first occurrence of the specified text is considered as the key value.

Key Value: In the Incident/Service Request/Work Order, the available text between the preceding text and the succeeding text is considered as the key value. For example, the Incident/Service Request/Work Order containing the following content:

Status: The job (Job: "DBSUtil01 Backup 00007) completed successfully. Status: The job (Job: "DBSUtil02 Backup 00008) completed successfully.

Condition Name

Name the condition.

Operator

Logical expressions which may be evaluated by a workflow engine to decide the sequence of activity execution within a process.

Value

Enter a condition value.

Action

Add or delete conditions applicable to the use case.

Script Name

Type in the Orchestration Script name.

Script Language

Scripts can be in any of the following languages

• DOS command
• Perl script
• PowerShell script
• Python script
• Shell script(windows)
• Shell script(non-windows)
• VB script

Configuration Item

Target Host Type

The script is executed for the selected predefined CI, Service Request CI, Dynamic CI, or from a previous output.

Target Host

Select the Operating System on the target machine.

Schedule Type

Select a Schedule Type (One Time/Recurring) from the drop-down list to schedule the script execution on the target machine.

• One Time: The script is executed on the target machine on the specified interval (mins) for the specified number of times In case script execution status is FAILED. If the Schedule Type is selected as One Time, the Retry Count field is displayed.
  • Retry Count: Specify the number of times the script is to be executed on the target machine in case script execution status is FAILED.

Example: If the Retry Interval is 5 mins and the Retry Count is 10, the script is executed on the target machine every 5 minutes for the 10 times in case script execution status is FAILED.

• Recurring: The script is executed in the target machine on the specified interval (mins) for the specified number of days in case script execution status is FAILED. If the Schedule Type is selected as Recurring, the Recurring Days field is displayed.
  • Recurring Days: Specify the number of days the script is to be executed on the target machine in case script execution status is FAILED.

Example: If the Retry Interval is 5 minutes and the Recurring Days field is 2, the script is executed on the target machine every 5 minutes for the 2 days in case script execution status is FAILED.

Retry Interval (In Mins)

Type in the retry interval for the script in minutes.

In case script executions status is FAILED, the script is executed on the target machine at the specified interval for the specified number of Retry Count.

Retry Count

Type in the retry count for the script. In case script executions status is FAILED, the script is executed on the target machine for the specified number of times at the specified interval.

Data Source

Select the data source for the parameter.

• If you select Fixed Input, the Fixed Input Value field appears.
• If you select other data sources in the list, Data Value Field appears.
• If you select Action Output, the output from the previous script is used as the input for the next script. You can only map the previous execution orders in the Data Value Field drop-down.
• Select Password as the Data Source to specify the password for the specified parameter. For Example, after the execution of the script, if you want to send an e-mail to a particular user without specifying SMTP credentials, you can enter the password here to use in the script.
• If you select Content Parser - Line, Data Field will display all the configured keys from the BEGIN object.
• If you select Content Parser - Free Form, Data Field will display all the configured keys from the BEGIN object.

Fixed Input Value

Type in the Data Field name.

Data Value Field

Select the Value Field in the list.

Submit Button