5.5 Steps

Steps are the basic components of a Template. Every Template must have a Start Step and an End Step. The Start Step exists by default. You can also add the following types of Steps to a Template:

5.5.1 Start Step

Every workflow template must have one and only one Start step. The transition from a Start step is always Unconditional.

5.5.2 Manual Steps

This type of step indicates that manual work must be performed. Every manual step in a Template must be assigned to a Role. The users in that role are notified through a worklist item when an instantiated workflow process reaches the Manual Step. When a user accepts the worklist item, it is removed from the queue of the other users in that Role. For more information about worklists and stepping through a workflow process, see Section 6.1.1, Work Item Summary. section.

The description of the step should indicate what work needs to be performed. The user is expected to perform that work and then acknowledge completion.

A Manual Step includes the following attributes:

  • Name of step

  • Role

  • Variables

    • Delete

    • Add

  • Description

Variables

The user can also be asked to set one or more variables to appropriate values. Four variable types can be assigned to manual steps: (1) Integer, (2) Boolean, (3) String and (4) Float. This variable can be set to an explicit default value during the Step definition, or the user can set the value at run-time as part of the workflow process. The value can be optional or required.

The value of the variable can be used as part of a Conditional transition to determine the path the workflow follows. It can also be used later as part of a Conditional Transition from a Decision step to determine the workflow path.

NOTE:If the value is going to be used later as part of a Decision step, it should be marked “Required.”

For example, an integer variable can be set by the user to hold the event rate. Output transitions from the Manual Step can be defined so that if the event rate is greater than 500, one path is followed; else another path is followed.

To create a variable:

  1. Click iTRAC tab.

  2. In the Navigator, click iTRAC Administration > Template Manager.

  3. Click Add button in upper left corner to open a new template or highlight an existing template, click View/Edit.

  4. Right click Variables in the Process Tree and select the type of variable to add or right-click the variable type and select Add [type] Variable.

  5. Give the variable a name and specify the Default Value, if desired.

    Boolean Variable:

    Integer Variable:

    String Variable:

    Float Variable

  6. Click OK.

From a Manual Step, you can set Conditional, Unconditional, Timeout, or Alert transitions.

5.5.3 Decision Steps

This type of step selects between exit transitions depending on the values of variables defined in prior steps. See Section 5.5.2, Manual Steps for the available variable types. The Decision Step itself is very simple; you can edit only the step name and description. The workflow path is determined by the transitions.

From a Decision Step, you can set Conditional and Else transitions. Every Decision Step must have an Else transition and at least one Conditional transition. The Else transition leads to a workflow path that is followed if none of the criteria for the Conditional transitions is met.

5.5.4 Mail Steps

This step sends a pre-written email. A Mail Step includes the following attributes:

  • Name of step

  • To addressee

  • From addressee

  • Subject of email

  • Body of email

From a Mail Step, you can set a Conditional, Unconditional, Timeout, Alert, or Error transition. An Error transition should always be included so error conditions can be handled properly.

NOTE:If the first step of a workflow fails without an error transition, the iTRAC process cannot proceed.

5.5.5 Command Steps

A Command Step is a step in which an operating-system level command or script (shell, batch, perl and so on) is executed. The name of the command can be provided explicitly or set as a string variable, and parameters can be passed in the same manner. Output from the command can also be placed back into a string variable.

A Command Step includes the following attributes:

  • Name of step

  • Description

  • Command (Can be explicit or variable-driven)

  • Arguments (Can be explicit or variable-driven)

  • Output Variable

NOTE:The command (or a batch file or script that refers to the command) must be stored in the %ESEC_HOME%\config\exec or $ESEC_HOME/config/exec directory on the iTRAC workflow server, usually the same machine where the Data Access Server (DAS) is installed. Symbolic links are not supported

Variables

The command output can also be used to set a variable to the appropriate values. Command steps must use String variable types.

The value of the variable can be used as part of a Conditional transition to determine the path the workflow follows. It can also be used later as part of a Decision step to determine the workflow path.

For example, a command step can return a value of 0 for failure and 1 for success. This output can be assigned to a variable, and then a Conditional transition or a Decision step can use this value to determine which workflow path to take.

The command and its arguments can each be specified explicitly by the person designing the workflow or be set as a string variable. If either one is set as a string variable, there must be a previous step in the Template where the variable is set to a string value.

From a Command Step, you can set Conditional, Unconditional, Timeout, or Alert, or Error transitions. An Error transition should always be included so error conditions can be handled properly.

NOTE:If the first step of a workflow fails without an error transition, the iTRAC process cannot proceed.

5.5.6 Activity Steps

An Activity Step is a type of automated step that can be used in a workflow Template. Activity Steps are created in the Activity Manager and can consist of internal Sentinel operations or external scripted operations. After Activity Steps are created, the user can select from the library of these Activities and include them into in a workflow. For more information on creating each type of pre-defined Activity, see Section 5.7.4, Creating iTRAC Activities.

An Activity Step includes the following attributes:

  • Name

  • Description

  • Activity Assignment

From an Activity Step, you can set Conditional, Unconditional, Timeout, or Alert, or Error transitions. An Error transition should always be included so error conditions can be handled properly.

NOTE:If the first step of a workflow fails without an error transition, the iTRAC process cannot proceed.

5.5.7 End Step

Every workflow template must have an End Step to complete every branch of the workflow path.

5.5.8 Adding Steps to a Workflow

Steps can be added to a workflow using the Step Palette or using a right-click in the Process Builder. When adding steps to a workflow, a yellow entry field indicates an invalid entry.

To add a Step from the Step Palette:

  1. Drag and drop a step from the Step Palette.

  2. Right-click the step and select Edit Step.

  3. Edit the details of the step and click Save.

To add a Step using a Right-Click:

  1. Right-click an existing step in the Process Builder and select Insert New.

  2. Edit the details of the step and click Save.

  3. Select Manual, Decision, Mail, Command or End Step.

  4. Edit the details of the step and click Save.

To add an Activity Step:

  1. Click and drag an Activity from the Activity Pane to the Process Builder.

To add an End Step:

  1. Right-click a Step with no transition and select Add End Transition.

5.5.9 Managing Steps

Steps can be copied, edited, or deleted.

Copying Steps

To copy a Step:

  1. Click the iTRAC tab.

  2. In the Navigator, click iTRAC Administration > Template Manager.

  3. Highlight an existing template, click View/Edit. iTRAC Process Builder window displays.

  4. Select an existing step, right-click, and select Copy Step.

  5. The Step window opens in edit mode with all the attributes of the selected step. Specify a name to the new step.

  6. Edit step attributes as required. Click OK.

Modifying Steps

To edit a Step:

  1. Click the iTRAC tab.

  2. In the Navigator, click iTRAC Administration > Template Manager.

  3. Highlight an existing template, click View/Edit. iTRAC Process Builder window displays.

  4. Select an existing step, right-click, and select Edit Step.

  5. Edit the step attributes. Click OK.

To edit a Manual Step:

  1. Right-click a Manual Step and select Edit Step.

  2. Provide a Name for the step.

  3. Attach a Role to this step by selecting a Role from the drop-down list. (For more information on Roles, see Section 11.0, Administration.

  4. Click Associate to associate a Variable; select the variable from the list or create new variables to be associated. Set a default value as desired.

  5. Check the Read-Only box if this variable is to be forced to the default value.

  6. Click Description tab to provide description for this step.

  7. Click Preview to preview the step you created.

  8. Click OK.

To edit a Decision Step:

  1. Right-click a Decision Step and select Edit Step.

  2. Provide Name.

  3. Click Description tab to provide description for this step.

  4. Click OK

To edit a Mail Step:

  1. Right-click a Mail Step and select Edit Step.

  2. Provide Name for the step.

  3. Provide To and From mail addresses and Subject in the General Tab.

  4. Click Body tab and type the message.

  5. Click OK.

To edit a Command Step:

  1. Right-click a Command Step and select Edit Step.

  2. Provide a Name for this step.

  3. Specify the path and name of the command or script to execute (relative to the $ESEC_HOME/config/exec or %ESEC_HOME%\config\exec directory)

  4. If you want to run a command or script referenced in a variable that gets populated during the workflow process, check the Use Variables box.

  5. Specify any command-line arguments to pass to the command or script. If you want to use the contents of a variable that gets populated during the workflow process, check the Use Variables box.

  6. Specify a variable to hold output from the command or script. Any standard output is placed into these variables.

  7. Click Description tab to provide description for this step.

  8. Click OK.

Deleting Steps

To delete a Step:

  1. Click iTRAC tab.

  2. In the Navigator, click iTRAC Administration > Template Manager.

  3. Highlight an existing template, click View/Edit. iTRAC Process Builder window displays.

  4. Select an existing step, right-click, and select Delete Step.

  5. In the Alert Message window, select Yes to delete.