Mock Process

Simulates an orchestration process.

Command availability: IBM RPA SaaS and IBM RPA on premises

Script syntax

IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.

mockProcess --queuename(String) --body(String) [--enqueuedtime(DateTime)] [--priority(Numeric)]

Input parameters

The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.

Designer mode label Script mode name Required Accepted variable types Description
Queue Name queuename Required Text Name of the queue that should be simulated.
Message Structure body Required Text Content of the message in the simulated queue.
Queued Message Date enqueuedtime Optional Date Time, Date Date of the simulated process.
Priority priority Optional Number Priority given to the message added to the simulated queue.


This command simulates an orchestration process and creates a variable to be used in this process.

defVar --name queueName --type String --value "Simulated queue name"
defVar --name queueStructure --type String --value "Simulated queue structure"
defVar --name variableContent --type String --value "IBM Robotic Process Automation Simulate Orchestrator"
defVar --name variableReceives --type String
defVar --name successGet --type Boolean
mockProcess --queuename "${queueName}" --body "${queueStructure}Simulated queue message structure."
mockProcessVariable --name variableName --type "Text" --value "${variableContent}"
currentQueueMessage queueName=queuename queueStructure=body successGet=success
mapProcessVariables --mappings "variableName=${variableReceives}"
logMessage --message "Queue name obtained: ${queueName}\r\nQueue structure obtained: ${queueStructure}\r\nSuccess get current message: ${successGet}\r\nMapped variable content: ${variableContent}\r\n" --type "Info"
// Result:
// Queue name obtained: Simulated queue name
// Queue structure obtained: Simulated queue structure
// Success get current message: True
// Mapped variable content: IBM Robotic Process Automation Simulate Orchestrator


  • Only one Mock Process can be used in each script.
  • This command is only used to simulate orchestrated processes, and must not be used in production.