Skip to main content

StepArguments Properties

An object defining properties for the StepArguments class.

Id

Gets the unique identifier of the workflow step.

Type: long

The Id property provides the primary unique identifier for the workflow step. This numeric identifier is used to uniquely distinguish the step within the workflow system and is essential for tracking and referencing specific workflow steps during execution.


Key

Gets the unique key identifier for the workflow step.

Type: string

The Key property provides a string-based unique identifier for the workflow step. This key is used as an alternative identifier to the numeric Id, often providing a more meaningful or human-readable way to reference the step within the workflow system.


TypeCode

Gets the type code that categorizes the workflow step.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

The TypeCode property specifies the category or type of the workflow step using the WorkflowItemTypeCode enumeration. This classification helps determine the behavior and processing requirements of the step, allowing the workflow system to apply appropriate handling based on the step's type.


Name

Gets the display name of the workflow step.

Type: string

The Name property provides the human-readable display name for the workflow step. This name is used for presentation purposes in the user interface and for logging, making it easier for users and developers to identify the step during workflow execution and debugging.