Overview of Internal Program Steps
The following tables provide an overview of the internal sequence in which the program works, and the individual processing steps involved. The overview is meant to aid you in configuring processing scenarios by showing how and in which order configuration elements build on each other and interact.
Notice
The overview is limited to a single worker of each type and to standard processes, which excludes some special cases. Also note that some of the work steps are only executed if they have been activated in configuration.
Input worker
Work step | Configuration property |
|---|---|
Periodic execution, performed sequentially across all scenarios assigned to the worker: | |
Query for newly available input batches and sequential batch processing | InputSystem |
Reading of raw data of batch | |
Check for duplicates | Input.CheckDuplicate*** |
Execution of pre-processing macros, performed sequentially across all documents in the batch (special variant executed before the batch has undergone any restructuring) | Input.DocSplit.PreProcessMacro[] |
Restructuring of the documents in the batch | Input.DocSplit |
Execution of pre-processing macros, performed sequentially across all documents in the batch (standard variant executed after the batch has undergone any restructuring) | Input.PreProcessMacro[] |
Execution of input format readers, performed sequentially across all defined formats, all documents of the batch and all matching file attachments of a document | InputFormat[] |
Post-processing, performed sequentially across all documents in the batch: | |
Execution of post-processing macros | Input.PostProcessMacro[] |
Generation of key values | Input.TrackingKeyMacro Input.TrackingIdMacro Input.CustomKeyMacro |
Process worker
Work step | Configuration property |
|---|---|
Periodic execution, performed for all scenarios assigned to the worker: | |
Query of administration database for new documents available in this work step, sorted by priority and age, with sequential processing of the documents being read | General.Priority |
Execution of pre-processing macros | Process.PreProcessMacro[] |
Assignment of the standard field catalog with initial values and reading of the index data, processed sequentially via all defined index data readers | FieldCatalog[].Field[].InitValue ProcessReadIndex[] |
Execution of field initialization macros, performed sequentially across all defined fields | FieldCatalog[].Field[].InitMacro |
Check determining whether to switch to another scenario and, if necessary, whether to cancel further document processing at this point | Process.ScenarioSwitchMacro |
Check determining whether to switch to a specialized field catalog and, if necessary, whether to repeat the steps (above) for this new catalog | FieldCatalog[].ConditionMacro |
Assignment of the specialized field catalog with initial values and reading of the index data, processed sequentially via all defined index data readers | FieldCatalog[].Field[].InitValue ProcessReadIndex[] |
Execution of field initialization macros, performed sequentially across all defined fields | FieldCatalog[].Field[].InitMacro |
Execution of general processing macros in the order in which they are defined | ProcessMacro[] |
Generation of key values | Process.TrackingKeyMacro Process.TrackingIdMacro Process.CustomKeyMacro |
Output worker
Work step | Configuration property |
|---|---|
Periodic execution, performed for all scenarios assigned to the worker: | |
Query of the administration database for new documents available in this work step, sorted by priority and age, with sequential processing of the documents being read | General.Priority |
Execution of the output steps, performed sequentially in the order specified by configuration or in the order of their definition | OutputFormat[].Order OutputSystem[].Order |
Creation of output formats | OutputFormat[] |
Processing of output systems | OutputSystem[] |
Execution of pre-processing macros | OutputSystem[].PreProcessMacro |
Data transfer to target system | |
Execution of post-processing macros | OutputSystem[].PostProcessMacro |
Updating of key values | Input.CustomKeyMacro or Process.CustomKeyMacro |
Backup worker
Work step | Configuration property |
|---|---|
Periodic execution, performed for all scenarios that the input worker has assigned to the client: | |
Query of the administration database for new batches available in this step, sorted by age, with sequential processing of the read batches: | |
Determination of backup files, depending on the input system from the source directory or from the temporary storage, with the files copied to the target folder | Backup.DestFolder |
Deletion of files from temporary storage | Backup.DeleteFromStorage |
Deletion of files from the input system, if supported by the input system | Backup.DeleteFromSource |