Creating a workflow script main routine

Create the workflow integration script's main routine.

About this task

In the script's main routine, you can link workflow tasks and variables to the script's subroutines and variables. Then, you can create workflow instances and, if needed, process them.

This procedure uses the IBM RPA Studio's Designer tab.

Inserting commands

In the workflow script, it will be requested to you insert commands. Complete the following steps to it:

  1. Search for the command name in the IBM RPA Studio Toolbox.
    • You can also search for the command verb.
  2. Drag and drop the command from the Toolbox to the script development area.
    • You can double-click to add the command at the bottom of the script structure.

Commands verbs are highlighted in front of command links. You can search the command in the IBM RPA Studio toolbox using verbs.

Creating variables

In the workflow script, the variables will be created directly on the command editor and the values will not be assigned in the variable creation. To create variables in this way, complete the following steps:

  1. Click the Variable selector icon.
  2. Then, click the New variable icon.
  3. On the Define variable (defVar) command, in the Name parameter, type the variable name as requested.
  4. In the Type parameter, select the variable type as requested.
  5. Click the Save button.

Procedure

  1. Insert the Load Workflow command.
    1. Enable the Is Local File option.
    2. In the File parameter, click the folder icon and select the workflow "exampleWorkflow.bpmn". See Connecting workflow tasks for details on how to build the BPMN file for this procedure.
    3. In the Process parameter, insert the diagram process id.
    4. In the Workflow output, type "workflow".
    5. Click the Save button.
  2. Insert the Map Workflow Activities (mapWorkflowActivities) command.
    1. In the Workflow parameter, select the ${workflow} variable.
    2. In the Mappings parameter, click three times in the plus signal (+) icon.
    3. In the first Parameter mapping field, type "hello_world_file":
    4. In the Value field, type "hello_world_file".
    5. In the second Parameter mapping field, type "hello_world_message".
    6. In the Value field, type "hello_world_message".
    7. In the third Parameter mapping field, type "start_message".
    8. In the Value field, type "start_message".
    9. Click the Save button.
  3. Insert the Bind Process Variables (bindProcessVariables) command.
    1. In the Workflow parameter, select the ${workflow} variable.
    2. In the Mappings parameter, click four times in the plus signal (+) icon.
    3. In the first Parameter mapping field, type "startMessage".
    4. In the Mappings field, create a variable of type Text named "startMessage".
    5. In the second Parameter mapping field, type "helloWorldType".
    6. In the Value field, create a variable of type Text named "helloWorldType".
    7. In the third Parameter mapping field, type "helloWorldMessage".
    8. In the Value field, create a variable of type Text named "helloWorldMessage".
    9. In the fourth Parameter mapping field, type "helloWorldFileMessage".
    10. In the Value field, create a variable of type Text named "helloWorldFileMessage".
    11. Click the Save button.
  4. Insert the For (for) command.
    1. In the Variables parameter, create a variable of type Number named "createInstance".
    2. In the From parameter, type "1".
    3. In the To parameter, type "2".
    4. In the Step parameter, type "1".
    5. Click the Save button.
  5. In the For command structure, insert the Create Workflow Instance (createWorkflowInstance) command.
    1. In the Workflow parameter, select the ${workflow} variable.
    2. In the Workflow instance output, type "instance".
    3. Click the Save button.
  6. The command Next (next) was automatically added to the end of the For command structure.
  7. Insert the List Workflow Instances (listWorkflowInstances) command.
    1. In the Workflow parameter, select the ${workflow} variable.
    2. In the Status parameter, select the New option.
    3. In the Workflow Instance output, type "instancesToExecute".
    4. Click the Save button.
  8. Insert the For Each (foreach) command.
    1. In the Collection parameter, select the ${instancesToExecute} variable.
    2. In the Variable parameter, select the ${instance} variable.
    3. Click the Save button.
  9. Insert the Execute Workflow Instance (executeWorkflowInstance) command.
    1. In the Workflow Instance parameter, select the ${instance} variable.
    2. Click the Save button.
  10. The command End For Each (next) was automatically added to the end of the For command structure.