› Batch Class Management › Batch class › Import and export extraction and classification rules

Import and export extraction and classification rules

Follow these procedures to export and import extraction and classification rules. These steps are intended for Transact administrators.

Transact enables you to export or import the following rules to aid in reuse and quicker batch class design:

  • Key-value extraction rules from index fields

  • Key-value page level field extraction rules

  • Key-value page process classification rules

These rules are compressed into a .zip file that can be imported into an index field or batch class that you select.

Prerequisites

To import and export extraction and classification rules, the following configurations must be in place:

  • You will need a batch class with a document type configured. For detailed steps, see Add new document type.

  • Your document type should have at least one index field. For detailed steps, see Add new index field.

Export extraction and classification rules

To begin the export, start with these steps:

  1. From the Batch Class Management page, select and open your batch class.
  2. To export KV Extraction rules:
    1. From the Document Types page, select and open your document type.
    2. Go to Index Fields > (Field Name) > KV Extraction Rule.
  3. To export KV Page Process related rules:
    1. For page process key-value page level field extraction rules, go to Modules > Page Process > KV_PAGE_PROCESS > Page Level Fields.
    2. For page process classification rules, go to Modules > Page Process > KV_PAGE_PROCESS > Classification Rules.

    The page for your selected item appears.

  4. Select the items you want to export. To select all of them, select the check box in the column heading.

    At least one item must be selected to export.

  5. Click Export.

    The .zip file is generated and saved on your computer.

Import extraction and classification rules

Use the .zip file to import your items. Do the following:

  1. From the Batch Class Management page, select and open your batch class.
  2. Go to the appropriate rule panel:

    • For index field key-value extraction rules, go to (Document Type) > Index Fields > (Field Name) > KV Extraction Rule.

    • For page process key-value page level field extraction rules, go to Modules > Page Process > KV_PAGE_PROCESS > Page Level Fields.

    • For page process classification rules, go to Modules > Page Process > KV_PAGE_PROCESS > Classification Rules.

  3. Drag the .zip file into the Import panel at the bottom of the window. You can also click Select Files and navigate to the .zip file you want to import.

    As an example, this is what the Import panel looks like for KV Extraction Rules.

    Import KV Extraction Rules
  4. When the import is completed, the number of rules added are indicated along with any duplicate rules that were ignored. Click OK to continue.
  5. When you are satisfied, click Apply.
  6. Click Deploy.

Troubleshooting

Issue Workaround

Unable to export or import extraction rules in Transact versions prior to 2023.1.00.

Perform an in-place upgrade of Transact to 2023.1.00 before attempting to export or import extraction rules.

Batches are not visible on the Batch Instance Management, Review, and Validation screens.

This may happen when roles are not assigned or if the Roles check box is cleared when importing the batch class. Perform the following steps to resolve this issue:

  1. Navigate to the Batch Instance Management screen.

  2. Edit the corresponding batch class.

  3. Assign roles to the batch class.