Interface ActivateInstructions

interface ActivateInstructions {
    ancestorElementInstanceKey?: string;
    elementId: string;
    variableInstructions?: {
        scopeId?: string;
        variables: {
            [key: string]: string | number | boolean | null;
        };
    }[];
}

Properties

ancestorElementInstanceKey? elementId variableInstructions?

Properties

Optional ancestorElementInstanceKey

ancestorElementInstanceKey?: string

The key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope. Default: -1

elementId

elementId: string

The ID of the element that should be activated.

Optional variableInstructions

variableInstructions?: {
    scopeId?: string;
    variables: {
        [key: string]: string | number | boolean | null;
    };
}[]

Type declaration

  • Optional scopeId?: string

    The ID of the element in which scope the variables should be created. Leave empty to create the variables in the global scope of the process instance *

  • variables: {
        [key: string]: string | number | boolean | null;
    }

    JSON document that will instantiate the variables for the root variable scope of the process instance. It must be a JSON object, as variables will be mapped in a key-value fashion.

    • [key: string]: string | number | boolean | null

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc