Script rule

ABBYY FlexiCapture allows you to configure the data check rule with the help of a script.

To create such a rule, proceed as follows:

  1. Open the field properties dialog box (right-click the field to open its shortcut menu and select Properties...) or the Document Definition properties dialog box (from the Document Definition editor menu, select Document Definition → Document Definition Properties...).
  2. Go to the Rules tab.
  3. Click the New Rule... button.
  4. From the list of rule types select Script and click OK.
  5. Type the name of the rule.
  6. Disable the Show rule name in message to verifier option if necessary. If this option is disabled, the error message will be displayed as "error message" instead of "name of rule: error message".
  7. Specify the severity of the rule.
  8. If required, specify the conditions under which the rule must be applied (by default, a rule is applied unconditionally). See Conditions for applying rules for more information.
  9. Specify tags for the rule.
  10. Disable the Enabled rule option if necessary. The rule will be created, but will not be applied until this option is enabled by a user.
  11. Click Next >.
  12. Available objects will be displayed in the Available Fields list in the dialog box that opens. You can add and delete fields using the Add... and Delete buttons. Fields that have the Read Only option enabled can only be read, all other fields can be changed by a script.
    Note: Add all fields which you want to use in the script to this list. If a field is not in this list, it cannot be used by the script.
  13. Click the Edit... button to open a special window for script editing.
  14. Select the scripting language and enter the script text.
  15. The script can be checked by selecting Tools → Check Script in the main menu.
  16. Save the script by selecting File → Save.
  17. Click Finish. The created rule will be displayed in the list of the Rules tab.

For details on the script parameters, see Script rule.

10.11.2020 12:08:04


Please leave your feedback about this article