Get Job Status activity

An activity that gets the status of a job from UiPath.


Get Job Status activity

Configure the Get Job Status activity

To configure the Get Job Status activity, do the procedure in this topic.

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the UiPath RPA tab.

    Open UiPath
  3. On the UiPath RPA tab, drag the Get Job Status activity onto your process.

    Drag Get Job Status

General Configuration

Specifies the basic settings for the Get Job Status activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Get Job Status Configuration

Specifies the information to get the status of a job from UiPath.

Figure: Get Job Status Configuration screen

Get Job Status Configuration screen

Fields

Field NameDefinition

UiPath

Function:
Specifies the access token that connects to your UiPath service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for UiPath
Function of this Screen:
Configure an access token to connect to UiPath.

Folder

Function:
Specifies the name of the folder from which to retrieve the status of the job.

When you select the access token from the UiPath field, this field shows the folders associated with the access token from UiPath.

Accepted Values:
A UiPath folder name from the list.
Default Value:
None
Limitations:

This field is available in these releases:

Job ID

Function:
Specifies the job ID associated with the job in UiPath.
Accepted Values:
A job ID from UiPath.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store Response Job Status in this Variable

Function:
Specifies the process data variable that stores the status of a job from UiPath.
Accepted Values:
A process data variable that accepts a text string with no spaces.

The status can be one of these:

  • Pending
  • Running
  • Successful
  • Faulted
  • Stopping
  • Terminating
  • Stopped
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?