This article provides guidance on how to use the Start Process Smart Service in your process models and SAIL interfaces. The Start Process Smart Service allows you to initiate a process from another process, a web API, or a SAIL interface. The new process is started asynchronously, and the process flow of the current process continues immediately after all activity-chaining completes.
The behavior of the node depends on the permissions of the user running the smart service. The following table details the result of running the smart service given different permission levels.
|Permission Level||Result of Executing Smart Service|
|Deny or Not in Role Map||The smart service errors, generating an error message for the process administrators and pausing the process|
|Initiator||The process is started, but only the process instance ID (
|Viewer and Above||The process is started, and all process model properties, process instance properties, and process variable values are populated in the process info output value|
Category: Process Management
Assignment Options: Unattended/Attended - Note: When this smart service is attended, the form that the user sees is the form configured on the node, not the start form for the specified process model.
|Process Model||Process Model||The process model to start asynchronously||Yes||No|
|Process Parameters||Dictionary||A dictionary containing the parameters for the process and their values||No||No|
The Process Parameters property is a dictionary where the keys are process parameter names and the values are parmeters' values. If any required parameters are missing or if the dictionary contains any entries that do not match parameters of the selected process model, the process will not start.
For example, if you have a process model that controls an employee review cycle, it might have a required parameter named
employeeId and optional parameters named
To successfully start this process, the Process Parameters input would look like one of the following:
In the following examples, the process would not start. For the first two cases, the reason is that the required process model parameter,
employeeId, was not provided. For the third case the reason is that an entry in the Process Parameters input,
supervisorId, did not match any of the parameters of the process model.
|Process Info||ProcessInfo||Contains information about the process that was started, its model, and the values of its process variables|
a!startProcess(processModel, processParameters, onSuccess, onError)
a!httpResponse(). The following function variable is available when configuring this input:
This smart service follows activity-chaining, completing only when the activity chain is complete or broken. The smart service then returns the process variables as of the completion of activity chaining through the
processInfo.pv output. This means that the Start Process smart service can be used to complete multiple smart services and retrieve the results of the smart services from within a SAIL interface or web API. This can be a very powerful tool. Nonetheless, consider the following notes when using activity-chaining in conjunction with the Start Process smart service to ensure you use the smart service properly:
On This Page