Skip to main content

FlowSourceOptions Properties

An object defining properties for the FlowSourceOptions class.

DocumentObjectKey​

Gets or sets the unique key identifier of the document object.

Type: string

The DocumentObjectKey property specifies the unique identifier for the document object that serves as the data source. This key is used to locate and access the specific document object within the system. This property implements the corresponding property from the IFlowSourceOptions interface.

IsChanged​

Gets or sets whether the source configuration has been modified.

Type: bool

The IsChanged property indicates whether any changes have been made to the data source configuration. This flag is used to track modifications to the source settings and can be used to determine if the configuration needs to be saved or updated. This property implements the corresponding property from the IFlowSourceOptions interface.

Type​

Gets or sets the type identifier of the data source.

Type: int

The Type property specifies the category or type of the data source being used in the workflow. This numeric identifier helps determine how the source data should be accessed and processed during workflow execution. This property implements the corresponding property from the IFlowSourceOptions interface.

DocumentObjectName​

Gets or sets the display name of the document object.

Type: string

The DocumentObjectName property specifies the human-readable name of the document object that serves as the data source. This name is used for display purposes and helps users identify the source document in the workflow interface. This property implements the corresponding property from the IFlowSourceOptions interface.

DetailName​

Gets or sets the name of the detail section within the document object.

Type: string

The DetailName property specifies which detail section of the document object should be used as the data source. This property is used when the source data is contained within a specific detail section of the document object. This property implements the corresponding property from the IFlowSourceOptions interface.