Configure an Export activity
Use the following procedure to configure an Export activity.
-
Add an activity to the map.
By default, the Configuration tab is open in the properties panel of the activity.
- Change the default Name of the activity to something meaningful.
- On the Type list, select .
-
Configure the following properties.
Input document/folder A document or folder variable to export documents or folders.
Take page image from rendition If selected, allows you to take an image from the selected rendition and not use the page's source image for export.
On the Page rendition list, select the rendition.
A source image is used if a page does not have an image rendition.
Export order The order in which the export should happen. Available options are:
-
By document order: If the input data of the export activity is a folder type, the export service opens the folder and then opens the documents in sequence. For each document, it loads the export connector in sequence to process the document.
Example for export by document order
[Folder] - Doc 1: Connector 1, Connector 3
- Doc 2: Connector 1
- Doc 3: Connector 2, Connector 4
Connector Sequence Connector 1, 3, 1, 2, 4 Document Sequence Document 1, 1, 2, 3, 3 -
By assigned Export Connector: If the input data of the export activity is a folder type, the export service opens the folder and then loads the export connectors in sequence. For each connector, it processes all the documents in sequence.
Example for export by connector order
[Folder] - Doc 1: Connector 1, Connector 3
- Doc 2: Connector 1
- Doc 3: Connector 2, Connector 4
Connector Sequence Connector 1, 3, 2, 4 Document Sequence Document 1, 2, 1, 3, 3
If the input data of the export activity is a document type, the export service processes it as a special folder with only one document; the Export order field is disabled.Export source document If selected, sends the source document (if one exists) to the export connectors. Each non-image file is exported as a separate document.
Export page image Sends the documents with pages to the export connectors.
Export annotations Exports annotations and image masks based on selection. Available options are:
-
None (default): No annotations and image masks are exported.
-
Annotations only: Only annotations are exported.
-
Annotations and masks: Both annotations and image masks are exported.
On export, TotalAgility does the following:
-
For PDFs, converts annotation to native PDF format.
-
For images, burns the annotation into the image.
The permanent redactions (if any) are only applied to the exported PDF file regardless of the "Export annotations" option. The original document source file or generated PDF is not updated.Mark completed Marks the exported documents as complete at runtime so that you can differentiate between documents currently being processed and documents that have completed processing.
Keep this property clear if the Export activity is not at the end of document processing.
Error handling Handles errors in the export connector if the current document fails. Available options are:
-
Never stop (default): Continues to export the document to subsequent export connectors. Exports subsequent documents to all export connectors.
-
Stop entire job: Stops exporting the job and routes it to the next activity.
-
Stop export for error document only: Stops exporting the document to subsequent export connectors. Exports subsequent documents to all export connectors.
Export success indicator A Boolean variable to indicate if the export succeeds or fails.
Documents not exported A Complex variable to receive information such as document ID, connector name, error message, document type ID, and document type name for the documents not processed at runtime.
Documents exported A Complex variable to receive information such as document ID for the documents that are to be exported.
-
-
Save the process map.
- At runtime, the documents supplied to the Export activity are exported.
-
If an export connector is configured for the process with document type and an error occurs, the export activity is still completed. A message is recorded in the complex variable for the document that could not be exported.
The export activity is still completed if an export connector is not configured for the process with the document type.
- The export activity is still completed if an export connector is not configured for the process with document type. The details of that document, except the name of the export connector, are recorded in the complex variable.
- You can enable multiple instances of Export Service and keep connectors
loaded during export by setting the "SupportMultipleInstances" and "RemainLoaded" properties to True in the INF file (available at
your installed location) for the Kofax Export Connector. By default, this file is located at
C:\Program Files (x86)\Kofax\TotalAgility\ExportConnectors\bin\KEC-TotalAgility.
For more information on these properties, see the Kofax Export Connector Help.