Skip to main content

FlowStart Properties

An object defining properties for the FlowStart class.

Key

A unique identifier for the workflow step.

Type: string


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


HideApporoverInHistory

Determines whether the approver should be hidden in the workflow history.

Type: bool


AutoOpenApprovalOption

Indicates if the approval options should automatically open for this step.

Type: bool


GeolocationOptions

Geolocation options for the step.

Type: IFlowGeolocationOptions


StartImmediately

Determines if the workflow should start immediately without delays.

Type: bool


TypeCode

The type code associated with the flow object.

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

WebNotificationOptions

Settings for web notifications related to this step.

Type: IFlowWebNotificationOptions


Name

Name for the workflow step.

Type: string


Documents

A list of documents associated with the step.

Type: List<IDocument>


Events

A read-only list of events related to the step.

Type: IReadOnlyList<IEvent>


ShowInFlowHistory

Specifies if the step should appear in the workflow history.

Type: bool


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>