Invoke Robot activity

An activity that invokes a Blue Prism robot to execute a specified method.


Invoke Robot activity

Configure the Invoke Robot activity

To configure the Invoke Robot activity, do the procedure in this topic.

Video: AgilePoint NX Connector for Blue Prism RPA

Embedding for the video is not available at this time. To view the video, refer to http://agilepointnxblog.com/agilepoint-nx-connector-for-blue-prism-rpa/

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 the Process Builder, in the Activity Library, open the Blue Prism tab.

    Open Blue Prism tab
  3. On the Blue Prism tab, drag the Invoke Robot activity onto your process.

    Drag Invoke Robot activity

General Configuration

Specifies the basic settings for the Invoke Robot activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

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

Invoke Robot Configuration > Request tab

Specifies the information to invoke a robot.

Figure: Invoke Robot Configuration > Request tab

Invoke Robot Configuration Request tab

Fields

Field Name Definition

Blue Prism

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

Create Add Token icon

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

Method Name

Function:
Specifies the method name to execute in Blue Prism.

When you select the access token from the Blue Prism field, this field shows the method names associated with the access token.

Accepted Values:
A method name from the list.
Default Value:
None
Accepts Process Data Variables:
No

Request Mapping

Function:
Connects the Blue Prism request data to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the request to the data model for your process.

Default Value:
None
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?

Invoke Robot Configuration > Response tab

Specifies how to store the response from the Blue Prism robot to your process schema.

Figure: Invoke Robot Configuration > Response tab

Invoke Robot Configuration Response tab

Fields

Field Name Definition

Blue Prism

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

Create Add Token icon

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

Method Name

Function:
Specifies the method name to execute in Blue Prism.

When you select the access token from the Blue Prism field, this field shows the method names associated with the access token.

Accepted Values:
A method name from the list.
Default Value:
None
Accepts Process Data Variables:
No

Store the Response in Custom Variable / Map Response to AgilePoint Schema

Function:
Specifies where to store the response from Blue Prism robot.
Accepted Values:
  • Store the Response in Custom VariableSelect this option if you expect Blue Prism to return only one data item.

    In the text field, specify a variable to store the Blue Prism data returns.

  • Map Response to AgilePoint SchemaSelect this option if you expect Blue Prism to return more than one data item.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

Default Value:
Map Response to AgilePoint Schema
Accepts Process Data Variables:
  • If you select Store the Response in Custom Variable, you must enter a variable.
  • If you select Map Response to AgilePoint Schema, this does not apply.
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?