KTA

This step connects to a Kofax TotalAgility (KTA) server and can start a new job, get a job status, or create a new document.

Important Set "Allow multiple logons" in KTA to work with RPA.

Properties

Action
Select from the following actions depending on your task: Create Job, Get Job Status, Create Document.
KTA Server
Specify the name of the Kofax TotalAgility installation to use. To add and configure a new Kofax TotalAgility installation, navigate to the Admin > Settings > KTA Configurations tab in the Management Console. For more information, see KTA Configurations.

Actions

Create Job

This action starts a job in KTA. Note that only released versions of Processes can be started from RPA. The step does not wait for the process to complete the execution, but assigns the resulting job ID from KTA to a variable, so that the result of the execution can be monitored.

First select the KTA category that your process is in. As a result, a drop-down list of KTA processes in that category is displayed. Select the process you want to start. The list of parameters belonging to that process displayed. All parameters have a default value in KTA. If you want to deviate from the default value in this robot, you can do that here: select the parameter and fill in your new value.

Get Job Status
With this action, KTA provides status information of a specific job. The job is identified by its job ID, such as a status returned from the Create Job step. The status information consists of two fields: a number and a description (Value and Formatted as Text in the following table).

Value

Formatted as Text

0

Active

1

Completed

2

Terminated

3

Suspended

4

Pending Completion

5

Locked

6

Ready For Evaluation

7

On Hold

8

Awaiting Completion

9

Awaiting Case Completion

10

Awaiting Completion Terminated

11

Awaiting Case Completion Terminated

Create Document
This action creates a document in KTA. The Document ID is returned to the robot. This Document ID can be passed into the Create KTA Job step as a variable of type Document. See KTA documentation for the list of document types that can be created.

The following parameters cannot be set from RPA:

  • Checklist
  • Data Backbone
  • Dynamic Complex
  • XML expression

Document validation example

In the following steps we validate a PDF document.

  1. Load a document into the variable DocData, by using a Read File step.

  2. Save the document in the KTA database, by using the Create Document Action in the KTA step. Fill in the following options. Note that other options depend on your KTA server.

    • Document Data: Specify the DocData variable with a document to process.

    • MIME Type: Specify the format of the document, such as application/pdf for the .pdf document.

    • Document ID: The ID that KTA assigned to the document, so that we can refer to it.

  3. Start a process in KTA that can validate the document by using the Create Job action in the KTA step. Fill in the following options.

    • Process: Specify the process name that you created in KTA that can process your document.

    • NMDDOCUMENT: The single parameter of this KTA process (we pass the ID of the document).

    • Job ID: Specify the ID that KTA assigned to your process, so that we can refer to it.

  4. In this step we make sure the job succeeds by adding the Get Job Status step. Fill in the following options.

    • Job ID: The ID of the Create Job action of the KTA step.

    • Value: Specify a variable to contain the job status value.

    • Formatted as Text: Specify a variable to contain the status description.

The Get Job Status step returns the "Ready For Evaluation" status and you can set to either manually or automatically complete the activity in KTA. Once the activity is complete, the "Completed" status is returned after you run the Get Job Status step.