Load Workflow
Verb: loadWorkflow
Loads a Workflow created on a local file or on the IBM RPA Control Center, returning it in a variable, so that it can be manipulated later.
Workflow is a process flow control engine. A Workflow represents a process within a BPMN file.
Syntax
loadWorkflow [--adapter(StorageAdapter)] [--isfromfile(Boolean)] --file(String) --name(String) [--version(Numeric)] --process(String) [--automapsubs(Boolean)] [--automapvariables(Boolean)] (Workflow)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --adapter | Adapter | Optional | Storage Adapter | Connection to the Database, of the server or location, which contains the context of the Workflow to be loaded.
1. The connection is obtained through the Create Storage Adapter command. 2. If this parameter is empty, storage will occur in the memory of the machine on which the script is being executed, without having any persistence in the database. |
| --isfromfile | Is Local File | Optional | Boolean | When enabled, it allows the path of the BPMN file to be used in the Workflow process, instead of the one configured on the IBM RPA Control Center. |
| --file | File | Only whenIs Local File is True | Text | Full path of the BPMN file.
BPMN is a notation that allows you to model a business process, demonstrating the sequence of execution of that process visually. |
| --name | Name | Only whenIs Local File is False | Text | Name assigned to the Workflow created on the IBM RPA Control Center or on the local Database. |
| --version | Version | Optional | Number | Version assigned to the Workflow used.
1. If this parameter is not met, the production version is used. 2. If the Workflow is loaded from the IBM RPA Control Center, new versions will be registered on the website. If the Workflow is loaded from a local file, new versions will be registered automatically based on the changes in the file. |
| --process | Process | Only whenIs Local File is True | Text | Process ID or name of the loaded BPMN file.
1. Only one process per Workflow is allowed. 2. If thestorage Adapter parameter is local or in memory, the ID or process name of the loaded BPMN file is informed. |
| --automapsubs | Automatically Map Subroutines | Optional | Boolean | When enabled, it automatically maps the subroutine(s) defined by the Workflow task. |
| --automapvariables | Automatically Map Variables | Optional | Boolean | When enabled, it automatically maps the variable(s) configured on the IBM RPA Control Center, or in the local BPMN file. |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| value | Workflow | Workflow | Returns a variable with Workflow loaded from a local BPMN file or from the IBM RPA Control Center. |
Example
The Load Workflow command loads a Workflow from a BPMN file, selected in the File parameter, and displays the process ID representing the loaded Workflow.
defVar --name workflow --type Workflow
// Download the following file to run the command.
loadWorkflow --isfromfile --file "bpmnTestVar.bpmn" --process "Process 1" workflow=value
logMessage --message "Process ID representing the loaded Workflow:${workflow}" --type "Info"
Download File
To run the sample script, it is necessary to download the file and inform its path in the File parameter of the Load Workflow command.