Capture Condition

The Capture Condition task checks the status or field contents of a Capture document that has been processed by the Capture Field Processor action task.

This task is put into effect in the following use cases and example processes:

Input

A data file in PGC or PDF format that is accompanied by valid Metadata. This Metadata must contain Capture information and is generally available after a Capture Fields Processor or Find Capture Documents task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead.

Processing

The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope).

Output

The original data file and Metadata is output by this task. If the rules used in the condition return True, the data and Metadata is sent down in the condition's branch. Otherwise, this same information is sent in the trunk.

Task properties

General Tab

  • Document Origin:
    • Document to process: Determines where the document information is read
      • From Metadata: Select to use the current document available in the Metadata generated by the Capture Field Processor.
      • From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its Metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
  • Condition based on Document Status: Select this to base the condition on the state of the document
    • Document is open: Condition will be true if the document is open (not all Capture fields are filled).
    • Document is closed: Condition will be true if the document is closed (all relevant Capture Fields are filled).
    • Document is complete: Condition will be true if the document is still open, but all appropriate Capture Fields are filled.
    • Document is partial: Condition will be true if the document is still open but only part of the appropriate Capture Fields are filled.
    • Document is empty: Condition will be true if the document is open but no Capture Field is filled.
    • Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
  • Condition based on Pattern Availability : Select to base the condition on the availability or non availability of patterns in a specific pattern sequence.
    • For Pattern Sequence: The name or identification of the pattern sequence to check. Leave blank if no pattern sequence is used.
    • Number of Patterns available are: The operator for the comparison. Numeric comparison with the number of available patterns in the specified pattern sequence.
    • This number of Patterns: The number to use as a comparison to the available number of patterns in the pattern sequence.
  • Capture Field-based condition: Select to base the condition on the state of one or more fields of your document.
    • Field Name: The name of the field on which to base your condition. This is equivalent to the name of the Capture Field Object in PlanetPress Design.

      In this field in particular, the right-click menu displays a unique option, 'Open Document Preview'. This option displays a list of existing documents. When clicking on a document, the PDF Viewer appears and displays all of the Capture fields. Double-click on a Capture field to automatically add its name to the Field Name box.

    • Condition: Defines what should trigger the condition:
      • Ink is Present: Triggered by the presence or absence of ink in the field.
        • None: No ink should be present in any field with this name.
        • Any: Ink should be present in at least one field of this name in your document.
        • All: Ink should be present in all fields of this name in your document.
        • Index: The specified index of the Capture Field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1-based.
      • Pidget setting: Triggered by specific pidget settings.
        • Every pidget setting (such as stroke color and stroke thickness) is listed here. If the specific pidget was triggered before ink was applied to the Capture Field, the conditions becomes true.
      • Start timestamp: Triggered when the first ink is applied in the field.
        • Before: If the first stroke found in the Capture Field was made earlier than the specified date and time, the condition becomes true.
        • After: If the first stroke found in the Capture Field was made later than the specified date and time, the condition becomes true.
        • In the last: If the first stroke found in the Capture Field was made within the specified number of Hour(s), Day(s) or Week(s) counting backwards from the moment the PGC is received, the condition becomes true.
      • End timestamp: Triggered when the last stroke finishes in the field. (see Start Timestamp for detailed options)
      • Pen Id: Triggered by the ID (serial number) of the pen. A box provides a way to specify which Pen ID will trigger this condition to be true.
      • Field List Value: Triggered only on Field List Capture Fields. A box provides a way to specify which value will trigger this condition to be true.
      • Content Status: Triggered when the field is in a specific status. A Drop-down provides a way to select which status will trigger this condition to be true.
        • Complete: The field contains ink and no error was detected.
        • Empty: No ink was found in the field.
        • Error: A logical error was detected in the field. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
      • ICR Value: Triggered when the value given by the ICR engine compares with the specified value. Operators are available for the comparison (such as Equal, Not Equal, Lower or Higher Than, Contains and etc). It is also possible to select which Index of the field to use (See Ink is Present" above).
      • ICR Confidence: Triggered when the confidence percentage the ICR engine gave to the ICR value compares with the value determined in the "Confidence" box, using the chosen comparison operator.
      • ICR Resemblance: Triggered then the resemblance percentage the ICR engine gave to the ICR value in relation to its recognition database compares with the value determined in the "Resemblance" box, using the chosen comparison operator. For more information on ICR, see PlanetPress Capture ICR.
  • button: Add a new field and action line.
  • button: Remove the currently selected line.
  • The condition is true when: Specifies how to react when more than one Capture Field based condition is present
    • All items are met: The task will return true if ALL the combined conditions are true.
    • At least one item is met: The task will return true if ANY of the combined conditions is true.
  • Condition Scope: Determines whether the conditions need to be true for all the pages of the document, or any one of them.
    • In the document (occurrence): The task will return true if the condition set it true for any page of the document.
    • On each pages: The task will return true only if the condition set is true for all of the pages of the document.
  • Invert condition: Inverts the result of the task.
On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in the Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see General appearance preferences), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.