Appearance

API: deployer ​

Source: bpm/deployer.ts

API Deployer

  • Provides methods for managing the lifecycle of Business Process Model and Notation (BPMN) definitions, including deployment, undeployment, and deletion.

Classes ​

Deployer ​

API Deployer
* Provides methods for managing the lifecycle of Business Process Model and Notation (BPMN) definitions,
including deployment, undeployment, and deletion.

Methods ​

deployProcess ​

  • deployProcess (location:string):string

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

    @param location The path or location of the BPMN XML file to be deployed.
    @returns The deployment ID assigned to the new process definition.

undeployProcess ​

  • undeployProcess (location:string):void

    Undeploys a process definition previously deployed from the specified location.

    @param location The path or location associated with the deployed BPMN file.

deleteProcess ​

  • deleteProcess (id:string, reason:string):void

    Deletes a deployed process definition by its ID.

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

    @param id The ID of the process definition to delete.
    @param reason The reason for deleting the process definition (e.g., "Obsolete").