bpm/deployer

Documentation

• source: bpm/deployer.ts

Overview

Classes

Deployer

deployProcess()

Deploys a new process definition from a specified location (e.g., a file path).

static deployProcess(location: string): string;

Parameter	Type	Description
location	string	The path or location of the BPMN XML file to be deployed.

Returns

• Type: string
• Description: The deployment ID assigned to the new process definition.

undeployProcess()

Undeploys a process definition previously deployed from the specified location.

static undeployProcess(location: string): void;

Parameter	Type	Description
location	string	The path or location associated with the deployed BPMN file.

Returns

• Type: void
• Description:

deleteProcess()

Deletes a deployed process definition by its ID.

> Note: This permanently removes the process definition and all its associated history and runtime data.

static deleteProcess(id: string, reason: string): void;

Parameter	Type	Description
id	string	The ID of the process definition to delete.
reason	string	The reason for deleting the process definition (e.g., "Obsolete").

Returns

• Type: void
• Description: