Updating the built-in Document Definition

ABBYY FlexiCapture for Invoices ships with a built-in Document Definition designed specifically for processing invoices. Each time a new version of ABBYY FlexiCapture for Invoices is released, the built-in Document Definition is also updated.

Users who created an invoice processing project in earlier versions of ABBYY FlexiCapture for Invoices may update their Document Definition for invoices, preserving all their custom settings (the appearance of the data form, custom fields, rules etc.) and benefiting from the improvements introduced in the newer version of ABBYY FlexiCapture for Invoices.

The following will be updated or added The following will remain unchanged
Fields

The settings used for the main fields of the ABBYY FlexiCapture for Invoices Document Definition will be updated (see the list of fields).

Any new fields introduced in the new version of the ABBYY FlexiCapture for Invoices Document Definition will be added to the user's Document Definition.

If the user has created a new field in his own Document Definition and there is a rule with the same name in the new version of the ABBYY FlexiCapture for Invoices Document Definition, the update will be interrupted and an error message will be displayed. To continue with the update, the user needs to rename the conflicting field in the Document Definition.

The fields created by the user.
Rules

The settings used for the main rules of the ABBYY FlexiCapture for Invoices Document Definition will be updated (see the list of rules).

Any new rules introduced in the new version of the ABBYY FlexiCapture for Invoices Document Definition will be added to the user's Document Definition.

The rules created by the user. In the event of conflict of rule names: the conflicting rules created by the user will be automatically renamed (the suffix "_1" will be added to each conflicting name).

The user's scripts for all fields.

data sets The standard and the user's data sets.
FlexiLayouts The main FlexiLayout. The additional FlexiLayout.
Invoice processing settings Any new keywords, tax rates, and country- and language-specific field formats will be added to the user's Document Definition.

The invoice processing features enabled by the user.

The countries and languages enabled by the user.

Any keywords, tax rates, and field formats specified by the user.

Event handlers Any event handlers disabled in the user's Document Definition will be updated. Any event handlers enabled in the user's Document Definition.
External assemblies The standard assemblies included in the ABBYY FlexiCapture for Invoices Document Definition. Any assemblies added by the user.

The export settings, the data form, and the localization of the Document Definition will remain unchanged.

How to update

  1. On the main menu, click Project → Document Definitions.... The Document Definitions dialog box will be displayed, where you can manage your Document Definitions.
    Note: We recommend backing up your Document Definition before updating it. To create a back-up copy of a Document Definition, select it in the list and click Duplicate.
  2. To update a Document Definition, select it in the list and click Update.
  3. Click Publish to publish the changes.

If you want to discard the changes made by the update, click Discard Changes.

Possible errors and warnings

Your Document Definition will be updated even if error messages and warnings are displayed during the updating process. You can open, edit, and publish your updated Document Definition, or you can discard the changes made by the update.

If an error occurs when you update your Document Definition, the cause of the error will be indicated in the corresponding error message. The changes that cause the error will not be included in the updated Document Definition.

If you see error messages and warnings while updating your Document Definition, this means that some manual editing will be required. We do not recommend using a Document Definition that was updated with errors and warnings.

12/1/2020 7:03:59 AM


Please leave your feedback about this article