Skip to main content

IFlowTargetOptions Properties

An object defining properties for the IFlowTargetOptions 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 target. This key is used to locate and access the specific document object within the system where data will be written.

TableName​

Gets or sets the name of the database table to be used.

Type: string

The TableName property specifies the name of the database table where data should be written. This property is used when the target is a database table and direct table operations are required.

QueryName​

Gets or sets the name of the query to be used for data operations.

Type: string

The QueryName property specifies the name of the predefined query that should be used when performing data operations on the target. This property is used when specific query logic is required for data manipulation.

IsChanged​

Gets or sets whether the target configuration has been modified.

Type: bool

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

ConnectionName​

Gets or sets the name of the database connection to be used.

Type: string

The ConnectionName property specifies the name of the database connection that should be used when writing data to the target. This property is used when the target is a database table or when database operations are required.

Type​

Gets or sets the type identifier of the data target.

Type: int

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

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 target. This name is used for display purposes and helps users identify the target document in the workflow interface.

Detail​

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

Type: string

The Detail property specifies which detail section of the document object should be used as the data target. This property is used when the target data should be written to a specific detail section of the document object.