Skip to main content

WorkflowInstance Constructors

An object defining constructors for the WorkflowInstance class.

WorkflowInstance(projectName, flowName, processId, agentMode, api, documentOptions)​

Initializes a new instance of the WorkflowInstance class with specified project details, workflow settings, API connection, and document options.

Parameters:​

projectName (required): string
The name of the project associated with the workflow instance.

flowName (required): string
The name of the workflow or flow associated with this instance.

processId (required): long
The unique identifier for the process instance within the workflow.

agentMode (required): bool
Indicates whether the workflow instance operates in agent mode, affecting connection and access configurations.

api (required): WorkflowManagerAPI
The API object that provides access to the workflow manager, used for workflow management and interactions.

documentOptions (required): List<StartParametersDocumentOption>
The list of document options used to initialize the workflow instance with specific document parameters.

WorkflowInstance(projectName, flowName, processId, agentMode, api)​

Initializes a new instance of the WorkflowInstance class with specified project and flow names, process ID, agent mode, and API instance.

Parameters:​

projectName (required): string
The name of the project.

flowName (required): string
The name of the flow.

processId (required): long
The process identifier.

agentMode (required): bool
Indicates whether the workflow is in agent mode.

api (required): WorkflowManagerAPI
The API object that provides access to the workflow manager, used for workflow management and interactions.

WorkflowInstance(options)​

Initializes a new instance of the WorkflowInstance class with specified initial options for configuration.

Parameters:​

options (required): InitialOptions
The initial options used to configure the workflow instance, including details such as project name, flow name, and process settings.