Process

Overview

Module

• package: @aerokit/sdk/bpm
• source: bpm/process.ts
• last updated:

This module provides functionalities for managing and interacting with BPMN process instances, including starting processes, updating metadata, and handling process variables.

Key Features

• Start new process instances with optional business keys and parameters
• Update process instance metadata such as name, business key, and business status
• Manage process variables with support for local and global scopes, as well as transient variables

Use Cases

• Initiating new process instances from application code
• Dynamically updating process instance information during execution
• Managing process variables for data storage and retrieval within process executions

Example Usage

import { Process } from "@aerokit/sdk/bpm";
// Start a new process instance
const processInstanceId = Process.start("myProcessDefinitionKey", "myBusinessKey", { myVariable: "value" });
console.log(`Started process instance with ID: ${processInstanceId}`);
// Update process instance name
Process.setProcessInstanceName(processInstanceId, "My Process Instance");
// Set a process variable
Process.setVariable(processInstanceId, "myVariable", "newValue");

Classes

BpmnError

Process

start()

Starts a new process instance for a given process definition key.

static start(key: string, businessKey: string, parameters: any): string;

Parameter	Type	Description
key	string	The process definition key (ID) of the process to start.
businessKey	string	An optional business key to associate with the process instance. Defaults to an empty string.
parameters	any	An optional map of process variables to pass to the process instance upon starting. Defaults to an empty object.

Returns

• Type: string
• Description: The unique ID of the newly started process instance.

setProcessInstanceName()

Sets a human-readable name for an existing process instance.

static setProcessInstanceName(processInstanceId: string, name: string): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance to update.
name	string	The new name for the process instance.

Returns

• Type: void
• Description:

updateBusinessKey()

Updates the business key of an existing process instance.

static updateBusinessKey(processInstanceId: string, businessKey: string): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance to update.
businessKey	string	The new business key.

Returns

• Type: void
• Description:

updateBusinessStatus()

Updates the business status of an existing process instance.

static updateBusinessStatus(processInstanceId: string, businessStatus: string): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance to update.
businessStatus	string	The new business status.

Returns

• Type: void
• Description:

getVariable()

Retrieves the value of a specific variable from a process instance.

static getVariable(processInstanceId: string, variableName: string): any;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance.
variableName	string	The name of the variable to retrieve.

Returns

• Type: any
• Description: The value of the variable, or null if the variable does not exist. The type is any as it depends on the stored value.

getVariables()

Retrieves all variables associated with a process instance.

static getVariables(processInstanceId: string): any;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance.

Returns

• Type: any
• Description: An object containing all variables for the process instance, where keys are variable names and values are the variable values.

setVariable()

Sets or updates the value of a variable in a process instance.

static setVariable(processInstanceId: string, variableName: string, value: any): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance.
variableName	string	The name of the variable to set.
value	any	The new value for the variable. The type is any to accommodate different data types.

Returns

• Type: void
• Description:

removeVariable()

Removes a variable from a process instance.

static removeVariable(processInstanceId: string, variableName: string): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance.
variableName	string	The name of the variable to remove.

Returns

• Type: void
• Description:

correlateMessageEvent()

Correlates a message event with a running process instance.

static correlateMessageEvent(processInstanceId: string, messageName: string, variables: Map): void;

Parameter	Type	Description
processInstanceId	string	The ID of the process instance to correlate the message to.
messageName	string	The name of the message event defined in the BPMN process.
variables	Map	A map of variables (Map<string, any>) to pass along with the message event.

Returns

• Type: void
• Description:

getExecutionContext()

Retrieves the current execution context object, typically used within an execution listener or service task.

static getExecutionContext(): ExecutionContext;

Returns

• Type: ExecutionContext
• Description: A new instance of the ExecutionContext containing details about the current process execution path.

getTaskContext()

Retrieves the current task context object, typically used within a task listener or service task.

static getTaskContext(): TaskContext;

Returns

• Type: TaskContext
• Description: A new instance of the TaskContext containing details about the current task.