FlowDocumentSynchronizer

Provides functionality to synchronize flow documents with configurable options.

Properties

Name	Description
TargetType	Defines the type of the target in the synchronization process.
TargetTableName	The name of the table in the target document.
Key	A unique identifier for the workflow step.
TargetConnectionName	The name of the connection for the target document.
Fields	Represents a list of fields used for mapping between source and target documents.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
CachedDMObjects	The cached document management objects related to the flow object.
HideSystemFields	Determines whether system fields are hidden during synchronization.
TypeCode	The type code associated with the flow object.
ValueType	Indicates the type of the value being synchronized.
ValueSourceType	Indicates the source type of the value in the synchronization process.
ResumeOnError	Indicates whether the synchronization process should continue when an error occurs. (Deprecated)
ErrorDescriptionObjectName	Specifies the object name for error descriptions during synchronization. (Deprecated)
ErrorOptions	Defines error-related options for the API step.
Name	Name for the workflow step.
Value	The actual value being synchronized between source and target.
SourceDocumentObjectName	The object name of the source document for synchronization.
SourceType	Defines the type of the source in the synchronization process.
TargetQueryName	The name of the query used for the target document.
SourceDetailName	The detail name associated with the source document.
TargetDocumentObjectName	The object name of the target document for synchronization.
TargetDetail	The detail associated with the target document.
Caption	The caption dictionary representing localized captions for the flow object.

Constructors

Name	Description
FlowDocumentSynchronizer(name, workflowData, workflowCodeInstance)	Constructor for the FlowDocumentSynchronizer class. Initializes a new instance of the FlowDocumentSynchronizer class.
FlowDocumentSynchronizer(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowDocumentSynchronizer class.
FlowDocumentSynchronizer(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowDocumentSynchronizer class with a name, workflow data, and workflow code instance.

Methods

Name	Description
Synchronize()	Performs the synchronization process between source and target documents.
Initialize()	Initializes the flow document synchronizer with the required configurations.

Events

Name	Description
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.
Execute(sender, args)	Occurs during the execution of the FlowDocumentSynchronizer step, triggering whenever an execution-related event occurs.

Generic Types

Name	Description
TProperties	Generic type of properties.