Scripts are used to execute a script as part of a process. Process variables can be passed to the script and the results of a script can be sent back to a process instance as process variables. Any JavaScript that is created by the modeling application has the same permissions assigned to it as the logged in user. This is helpful because it allows the logged in user to test their own scripts with their own files.

Script design uses the functionality of the Monaco Editor and uses the GraalVM JavaScript Engine for execution.

Scripts are added to a process definition using a script task.

Properties

The basic properties of a script are:

Create a script

To create a script:

1. Sign into the Modeling Application and open a project.

2. Click the NEW dropdown.

3. Select how to create the script:

   • Create > Script creates a new, empty script.

   • Upload > Script allows for uploading an existing script .bin file into the Modeling Application.

   Alternatively use the + or Upload buttons next to Scripts in the left-hand menu.

4. Enter a name and optional description.

Script modeling

The Modeling Application contains two tabs for creating and managing scripts.

The Script Editor is the GUI for modeling scripts by typing in the declared language. The editor has autocomplete functionality for APIs and script variables. The Metadata contains the properties related to the script.

Simulation

Once a script has been written, it can be simulated by entering potential inputs and viewing their output.

In the UI click the Simulate button after entering the input values to simulate. The results will be populated in the outputs section.

Variables

There are two types of variables associated with a script. Script variables are stored as JSON and are used to pass values between a process and a script. Declared variables are used within the script body itself.

Script variables

Script variables can be used to pass and receive values from process variables.

The properties for a script variable are:

The data types that a script variable can be set as are:

Declared variables

Declared variables are used within the script itself and can be set to the value of a script variable by using the prefix variables. to reference the script variable. An input variable will set a declared variable to the value of a script variable when the script is executed.

For example, in a process the script variables cost and orders will have their values set from process variables. The declared variables costOfItem and numberOfOrders can then be set to these values using the following:

Code copied to clipboard.
let costOfItem = variables.cost;
let numberOfOrders = variables.orders;

The value of the script variable totalCost will then be set after the script has executed by using the following:

Code copied to clipboard.
variables.totalCost = costOfItem * numberOfOrders;

The value of the script variable totalCost can finally be sent back to the process by mapping it to a process variable.

Process scripts

Scripts can be used to start a process instance by building a payload.

For example, use the process definition ID and set the process variables using:

Code copied to clipboard.
let startProcessInstanceCmd = processPayloadBuilder.start()
	.withProcessDefinitionKey("Process_GyW7Ekkw")
	.withVariable("orderNumber": variables.orderNumber)
	.withVariable("quantity": variables.quantity)
	.build();
commandProducer.send(startProcessInstanceCmd);

Content APIs

The following content APIs are supported:

• ActionService
• GroupService
• NodeService
• PeopleService
• QueryService
• SearchService
• SiteService
• TagService

Note: The API scripts can be tested in the simulator on the scripts window.

You can create the object by accessing the API which then allows you to make use of all its methods.

For example:

Code copied to clipboard.
const nodeBodyCreate = { name: variables.name, nodeType: "cm:folder" };
const nodeService = new NodeService();
nodeService.createNode(variables.parentNodeId, nodeBodyCreate);

Runtime APIs

The following APIs are supported:

• ProcessInstanceAdminControllerImplApi
• ProcessInstanceControllerImplApi
• ProcessInstanceTasksControllerImplApi
• ProcessInstanceVariableAdminControllerImplApi
• ProcessInstanceVariableControllerImpl
• TaskAdminControllerImplApi
• TaskControllerImplApi
• TaskVariableAdminControllerImplApi
• TaskVariableControllerImplApi

Using the following names you can perform all the actions related to the APIs mentioned above:

• RuntimeProcessInstanceAdminService: APA Runtime Process Instance Admin REST API (it includes ProcessInstanceAdminControllerImplApi, and ProcessInstanceVariableAdminControllerImplApi)
• RuntimeProcessInstanceService: APA Runtime Process Instance REST API (it includes ProcessInstanceControllerImplApi, ProcessInstanceTasksControllerImplApi, and ProcessInstanceVariableControllerImpl)
• RuntimeTaskAdminService: APA Runtime Task Admin API (it includes TaskControllerImplApi, and TaskVariableAdminControllerImplApi)
• RuntimeTaskService: APA Runtime Task API (it includes TaskControllerImplApi, and TaskVariableControllerImplApi)

For example:

Code copied to clipboard.
const startProcessPayload = { businessKey: variables.businessKey, payloadType: 'StartProcessPayload', processDefinitionKey: variables.processKey, variables: { fileArray: variables.fileArray } };
const runtimeProcessInstanceService = new RuntimeProcessInstanceService();
runtimeProcessInstanceService.startProcess(startProcessPayload);

Query APIs

The following APIs are currently supported:

• ProcessInstanceAdminControllerApi
• ProcessInstanceControllerApi
• ProcessInstanceDeleteControllerApi
• ProcessInstanceDiagramAdminControllerApi
• ProcessInstanceDiagramControllerApi
• ProcessInstanceServiceTasksAdminControllerApi
• ProcessInstanceTasksControllerApi
• ProcessInstanceVariableAdminControllerApi
• ProcessInstanceVariableControllerApi
• TaskAdminControllerApi
• TaskControllerApi
• TaskVariableAdminControllerApi
• TaskVariableControllerApi

You can use the following names to perform all the actions related to the APIs indicated above:

• QueryProcessInstanceAdminService: APA Query Process Instance Admin REST API (it includes ProcessInstanceAdminControllerApi, ProcessInstanceDiagramAdminControllerApi, ProcessInstanceServiceTasksAdminControllerApi, and ProcessInstanceVariableAdminControllerApi)
• QueryProcessInstanceService: APA Query Process Instance REST API (it includes ProcessInstanceControllerApi, ProcessInstanceDeleteControllerApi, ProcessInstanceDiagramControllerApi, ProcessInstanceTasksControllerApi, and ProcessInstanceVariableControllerApi)
• QueryTaskAdminService: APA Query Task Admin API (it includes TaskAdminControllerApi, and TaskVariableAdminControllerApi)
• QueryTaskService: APA Query Task API (it includes TaskControllerApi, and TaskVariableControllerApi)

For example:

Code copied to clipboard.
const queryProcessInstanceAdminService = new QueryProcessInstanceAdminService();
queryProcessInstanceAdminService.findById('idProcess');

Form API

The following API is currently supported:

• FormApi

You can use the following name to perform all the actions related to the API indicated above:

• FormService: APA Form API (it includes FormApi)

For example:

Code copied to clipboard.
const formId = variables.formId;
const formService = new FormService();
const form = formService.getFormDefinition(formId);

Actions

The actions that can be run against a script are: