› Robot building › Robot steps › TotalAgility

TotalAgility

This step connects to a Tungsten TotalAgility server and can start a new job, get a job status, create a new document, get a job variable, or raise a job event.

Set "Allow multiple logons" in TotalAgility to work with RPA.

In Design Studio, to execute a robot that uses a TotalAgility step, place your robot in the shared project.

Actions

The following actions are available.

Create Job

This action starts a job in TotalAgility. 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 TotalAgility to a variable, so that the result of the execution can be monitored.

First, select the TotalAgility category that your process is in. As a result, a drop-down list of TotalAgility processes in that category is displayed. Then, select the process you want to start. The list of parameters belonging to that process is displayed. All parameters have a default value in TotalAgility. To override the default value in your robot, here you can select the required parameter and fill in your new value.

Get Job Status

With this action, the TotalAgility step provides status information for 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 TotalAgility. The document ID is returned to the robot. This document ID can be passed to the Create TotalAgility Job step as a variable of type Document. Refer to TotalAgility 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

Get Job Variable

With this action, TotalAgility step provides a value of a specific TotalAgility variable. To specify a TotalAgility variable to get a value for, fill in the following fields:

  • Job ID: Type in the TotalAgility job ID

  • Variable ID: Type in the TotalAgility variable ID

The returned information shown in Results consists of the Value field and the Variable is Found field, indicating if the variable is found in the job.

Raise Job Event

Use this action to send events to TotalAgility and modify TotalAgility variables.

Raise job event

After the TotalAgility job is created, use the Raise Job Event action and fill in the following fields:

  • Job ID: Type in the TotalAgility job ID .

    You can type in the same value as used in the Create Job action.

  • Event Name: Type in the TotalAgility event name.

    Event name is case insensitive.

  • Event Source: Type in the TotalAgility event source.

To modify a variable, first check the Update Variables option.

Then, check a variable from the list and modify its value.

Note that Raise Job Event action makes it possible to modify all the TotalAgility variables, not only initialization ones.

Document validation example

Follow these steps to validate a PDF document.

  1. Add a TotalAgility step to the Robot.

  2. Add a Read File step and load a PDF document into the variable DocData.

  3. In the TotalAgility step, add a Create Document action to save the document in the TotalAgility database. Fill in the following options. Note that other options depend on your TotalAgility server.

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

    • MIME Type: Specify the format of the document: application/pdf.

    • Document ID: Specify the ID that TotalAgility assigned to the document.

  4. In the TotalAgility step, use the Create Job action to start a TotalAgility process that can validate your document.

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

    • MYDOCUMENT: The parameter of this TotalAgility process that passes the document ID.

    • Job ID: Specify the ID that TotalAgility assigned to your process.

  5. Add a Get Job Status step to ensure that the job is successful. Fill in the following options.

    • Job ID: Specify the ID of the Create Job action in the TotalAgility step.

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

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

When the Get Job Status step returns the "Ready For Evaluation" status, you can set the activity in TotalAgility to be completed manually or automatically. After the activity is completed, the "Completed" status is returned after you execute the Get Job Status step.