The Document Transformation action processes your graphical or PDF documents using a selected project. A project is a module that processes and transforms your documents using OCR and other specified operations.

The processing result is returned to the Desktop Automation robot and opened in the Document Transformation Browser in the Recorder view. The service forms an element tree with all extracted information. Note that in a multi-page document, you can browse through the pages using the Previous and Next buttons on the DT browser toolbar. See DT browser for details.

Elements in the tree contain confidence levels for the OCR results and other extraction results defined by the project. The confidence attribute can contain values from zero to one where the most confident is one.

Derived attributes such as der_x help you find the element and can be used in finders.

Once the transformed document is in the editor, you can determine whether you want to perform the validation of the transformation results. If you are satisfied with the transformation results without any validation, you can extract and use the data in the document.

Validation is performed by the Document Transformation Thin Client. Click in the Document Transformation Browser to send the document to the specified Thin Client. A unique URL is generated and returned to the robot. The robot extracts the URL and uses it to send the document to a validation user, such as via email. The validation user clicks the URL, enters credentials, and after that the document with the extracted data opens. The validation user inspects the transformed document and, if needed, modifies extracted information in the document.

When validating documents, the user can enable the Online Learning feature to increase the rate of field recognition on similar documents. This feature is based on remembering the layout of a sample document, such as an invoice. By using automatic field completion, manually typing or selecting the correct value in the document, the user contributes to the knowledge base, which improves extraction results when the user works on a similar document next time.

When validation is finished, the validation user marks the document as valid. When the document is marked valid, it is used as an argument for a robot specified in the Callback URL in the Document Transformation action.

Action

Select an action to perform using the Kofax RPA Document Transformation Service.

Service URL

Specify a URL and a port if necessary for the computer running the Document Transformation Service. If the service is installed locally, enter localhost in this field. The URL must include the http:// or https:// prefix. If you use https, the web hosting service should have a certificate accepted by well-known certificate authorities.

Project Type

• Default Project: This option provides a set of predefined projects. See Predefined projects.

• Custom Project: When you select this option, specify the path to the project to process your documents in Custom Project Path.

Document Source

Select how the robot locates a document to process.

• Local File: Enter the path to one or more documents to process in File name. Use either a full path to an image file, .zip archive, folder with files, or another file of the supported format accessible form the computer running a robot.

• Robot File System: Enter the path to the configured file system and the file name, such as myshare/doctotransform.pdf. The file system name must correspond to that specified in the Robot File System section in Management Console.

• Binary Variable: Specify a binary variable that contains a document.

When a path to multiple documents is specified, you can navigate between the documents using the DT browser toolbar buttons.

Meta data

Select this option to pass additional data to the Document Transformation Service.

This data is added to the input document as XValues, so it can be used by the Document Transformation Service project. The projects usually use the data to tune or control the analysis. Common use cases for this option are language settings or customer identification. The XValues are available in the device tree after the processed documents are received back from the Document Transformation Service.

Consult the developer of your Document Transformation Service projects to identify which values are supported by a specific project.

Note You can add more than one Key/Value pair to the Meta data property.

If any Key appears more than once in the list, the Value of the last occurrence is used.

Validation URL

Select this option to specify a URL for the thin client service. This property is required to send processed documents for validation. The URL is specified in the ValidationService property of the Document Transformation Service. The URL may look similar to the following:

http://localhost:8082

Callback URL

Select this option to specify a REST Robot URL for the thin client service to call after a document is validated. When validation is complete, this URL is used to start a robot by the Management Console. The URL must include the Management Console address along with a path to the robot to run. The URL may look similar to the following:

http://localhost:8080/ManagementConsole/rest/run/Default project/binaryInputAndWait.robot

You can find a valid callback URL in the Management Console by clicking the REST button for the given robot. Such a robot should have an input variable called document with an attribute doc of type binary. When the robot is called, the doc attribute of the document contains the transformed and validated document. If the Management Console needs credentials for login, they can be provided in the URL as follows:

http://user:password@localhost:8080/ManagementConsole/rest/run/Default project/binaryInputAndWait.robot

See REST for more information.