Skip to main content

OnBeforeExecutionArguments Properties

An object defining properties for the OnBeforeExecutionArguments class.

IsSessionStarterObject​

Gets whether this execution is for a session starter object.

Type: bool

The IsSessionStarterObject property indicates whether the current execution is related to a session starter object. This flag helps determine the context of the workflow execution and can be used to apply specific logic or handling for session initialization scenarios.

Cancel​

A boolean property that can be set to true to cancel the execution of the workflow step, preventing it from continuing.

Type: bool

Step​

Gets the arguments containing information about the current workflow step.

Type: StepArguments

The Step property provides access to the StepArguments object that contains detailed information about the workflow step currently being executed. This includes the step's configuration, parameters, and any other step-specific information needed during execution.

Context​

Gets the business context in which the workflow step is being executed.

Type: #linkDocument(csharp-Bimser.Synergy.Entities.Shared.Business.Objects.Context)

The Context property provides access to the business context object that contains the environment and configuration information needed for the workflow step execution. This includes user context, system settings, and other business-specific information required for proper workflow operation.

ProcessId​

Gets the unique identifier of the workflow process instance.

Type: long

The ProcessId property uniquely identifies the workflow process instance in which the step is being executed. This identifier is used to track and manage the workflow execution state and can be used to correlate related workflow activities.