Get Capture Document

The Get Capture Document action task is used after the Capture Field Processor to retrieve all documents that have been updated.

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

One PDF, corresponding to the information present either in the metadata or specified in the task, is extracted from the Capture database.

When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database. This may mean space issues if too many PDF files remain in your database.

Performance-wise, when this plugin retrieves a document from a 10,000 page PDF in the database, it will take more time then if it retrieved it from a 100 page PDF.

Output

The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the Capture Fields Processor action task.

In addition, any ICR information available (when using PlanetPress Capture ICR) will be placed at the Page Level, as follows:

ICR_[FieldName]_Val : The value of the text that was recognized by the ICR engine, for the field named [FieldName]. If the field is not and ICR field or if that field contains no ink, the value will be empty.
ICR_[FieldName]_Cfd : The confidence value (in percentage) of the engine for the value provided.

Task Properties

General Tab

Document Origin group:
- 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.
Document Type group
- Get all documents: Get all the documents that have been updated, according to the metadata.
- Get closed documents only: Get only the documents that have been closed in this process, according to the metadata.
Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete.
Annotate PDF: Add annotations to the PDF that describe each Capture field and the ink that is included in those fields. Note that not all PDF readers support annotations.

Examples & Use Cases

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

On Error Tab

By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.

Send to Process: Check this option to send the job file to an error management process.
Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available:
- Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process.
- Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
- Stop Process: The process is stopped and no more processing is done. No further output is produced.
Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file.
Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file.
Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID.
Reset to defaults: Resets all options in this tab to their default values.

If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.

Common Errors

Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.

Comments Tab

The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single 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.