› Set up an export connector for a document type

Set up an export connector for a document type

Set up an export connector for the document types in a process. You can configure multiple export connectors to a document type.

When multiple export connectors are configured for a document type, and if the first export connector can set a value for ReleaseData.RepositoryDocumentID, the second subsequent connector can use this value to release the document.

You can configure an export connector to run multiple times on the same document type in TotalAgility.

  1. On the Start menu, select All Programs > Kofax TotalAgility > Kofax Export Connector.

    The Export Connector Configuration window appears.

  2. Click Setup.

    The Export Connectors - Setup window appears.

  3. By default, the Select Category list displays ALL which means the Select Process list displays all the processes (system and user-defined). You can filter processes based on other categories (Default Category, Management Console, System Category, and TotalAgility Forms).
  4. On the Select Process list, select a process.

    The list of document types from the selected process appears in the Available Document Types box.

    • If you select a process for which a classification group is not defined, an error message appears.

    • If you use an Export activity in your process, at runtime, documents are exported according to the settings specified in the export connectors assigned to the process.

  5. From the Available Document Types box, select the document type and click Add.

    The selected document type appears in the Assigned Document Types box.

  6. From the Assigned Document Types box, select the document type for which to assign the connector and click Connectors.

    The Export Connectors - <Document type name> window appears.

  7. From the Available Export Connectors box, select the connectors to assign to the document type and click Add.

    The Kofax Export Connector for <Connector Name> Setup window appears with a predefined user interface.

  8. Enter a Name for the export connector.
  9. Map the Document Index Fields, Folder Index Fields, Batch Fields, or Kofax Values to appropriate values of the documents at the backend, depending on the export connector as described in the following table.

    Index Fields

    Map to the document fields.

    Folder Index Fields

    Map to the document folder fields.

    Batch Fields

    Map to the process variables.

    The following variable types are supported: Bool, Currency, Date, Decimal, Float, Long, Nullable date, Nullable string, Short, String. and System.

    Kofax Values

    Map to the system fields of the document.

    InstanceID

    ReviewValid

    OnlineLearningOptions

    Name

    ReviewForcedValid

    OnlineLearningComments

    Type

    Verified

    FileName

    ParentID

    Rejected

    CurrentDate

    NoOfPages

    RejectionReason

    CurrentTime

    Valid

    RepositoryDocumentID

    CurrentUTCDate

    ErrorDescription

    IsReadOnly

    CurrentUTCTime

    The values of CurrentDate and CurrentTime are as available at the time of exporting documents and in the format configured in the regional setting of current system. For example:

    CurrentDate = "5/21/2021"

    CurrentTime = "3:29:30 PM"

    The values of CurrentUTCDate and CurrentUTCTime are equal to (UTC + 00:00) time zone and represented in the universal format. For example:

    CurrentUTCDate = "2021-05-21"

    CurrentUTCTime = "08:29:30"

    If the time zone of the server where the export service is installed is changed, you must restart the export service to have the macros’ time value reflect this change.

  10. Configure the other settings as needed.
  11. Click Apply and click OK.

    The export connector appears under Assigned Export Connectors.

  12. Repeat the procedure from Steps 6 to 11 to add more export connectors as needed for a single document type.

    The assigned export connectors with details such as connector name, setup version, and release version appear in the Assigned Export Connectors box.

  13. Use and to change the sequence of connectors in the Assigned Export Connectors box.
    The export connectors are executed in the sequence specified.
  14. To edit the setup properties for an Export Connector, select the Export Connector in the Assigned Export Connectors list and click Update.

    The Kofax Export Connector for <Connector Name> Setup window appears with a predefined user interface.

  15. If you already have an earlier version configured in the process or batch class, you can upgrade it to the later version. To upgrade, select the version from the Available Export Connectors list and select the one you want to upgrade in the Assigned Export Connectors list, and click Upgrade. The assigned Export Connector gets upgraded. All the setting from the earlier version are displayed correctly in the upgraded version.
  16. Click Save.

    The Export Connectors - Setup window appears.

  17. Click Save.

    A message appears stating that the connectors mappings are saved successfully.