Skip to content

process.execute

Executes a specified process within a given model, with optional parameters and execution modes.

js
process.execute(processNameOrId)
process.execute(processNameOrId, fireAndForget)
process.execute(modelNameOrId, processNameOrId)
process.execute(modelNameOrId, processNameOrId, fireAndForget)
process.execute(processNameOrId, parameters)
process.execute(processNameOrId, parameters, fireAndForget)
process.execute(modelNameOrId, processNameOrId, parameters)
process.execute(modelNameOrId, processNameOrId, parameters, fireAndForget)

Parameters

  • modelNameOrId (string): The name or ID of the model to execute the process in. (optional)
  • processNameOrId (string): The name or ID of the process to be executed.
  • parameters (object): An object containing parameters to be passed to the process. The keys represent parameter names, and the values represent the corresponding parameter values. (optional)
  • fireAndForget (boolean): A boolean flag indicating whether to execute the process without waiting for its completion. Default value is false. (optional)

Returns

  • boolean: Returns true if the process was successfully executed, otherwise false.

Examples

js
// Execute a process.
var success = process.execute("yourProcess");
console.log(success); // true or false
js
// Execute a process within a specific model.
var success = process.execute("yourModel", "yourProcess");
js
// Execute a process with parameters.
var parameters = { "param1": "value1", "param2": "value2" };
var success = process.execute("yourProcess", parameters);