Single Select Lookup > Blue Prism

This topic shows how to create a lookup with Blue Prism as the data source for the Single Select Lookup form control.

Background and Setup

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

  • 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?

How to Start

  1. On the Single Select Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Single Select Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select Blue Prism.

    Select Blue Prism
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Blue Prism Lookup Details screen

Blue Prism Lookup Details screen

Fields

Field NameDefinition

Access Token

Description:
Specifies the access token that connects to your data source.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts 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.

Add New Add New icon

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

Lookup Name

Description:
Specifies the name you want to give to your lookup procedure.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Lookup Type

Description:
Specifies the Name/Value type for the lookup procedure.

The Single Select Lookup form control does not support Multiple Columns lookups. If you select the Multiple Columns, the configuration screen shows Name/Value lookup type.

Allowed Values:
Read only.
Default Value:
Name/Value

Configure Lookup > Request tab

Configures a lookup with the existing data format from your data source.

Figure: Configure Lookup > Request tab

Configure Lookup Request tab

Fields

Field NameDefinition

Blue Prism Method

Description:
Specifies the name of the Blue Prism method to execute.

When you select the access token in the Lookup Details for Blue Prism screen, this field shows the method names associated with the access token.

Allowed Values:
A method name from the list.
Default Value:
None

Endpoint URL

Description:
Shows the endpoint URL of the Blue Prism service to which to connect.
Allowed Values:
Read only.
Default Value:

This field shows the value from Process Service URL or Business Object Service URL field entered in the Blue Prism access token configuration screen.

Request Mapping

Description:
Connects the Blue Prism request data to your process schema.
Allowed Values:
To open the Schema Mapper, click the Ellipses (...) button.

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

Default Value:
None
Example:
Refer to:

Configure Lookup > Response tab

Connects the response data from the Blue Prism method call to your app.

Figure: Configure Lookup > Response tab

Response tab

Fields

Field NameDefinition

Blue Prism Method

Description:
Specifies the name of the Blue Prism method to execute.

When you select the access token in the Lookup Details for Blue Prism screen, this field shows the method names associated with the access token.

Allowed Values:
A method name from the list.
Default Value:
None

Endpoint URL

Description:
Shows the endpoint URL of the Blue Prism service to which to connect.
Allowed Values:
Read only.
Default Value:

This field shows the value from Process Service URL or Business Object Service URL field entered in the Blue Prism access token configuration screen.

Map Response to AgilePoint Schema

Description:
Specifies the connection from the Blue Prism API response parameter to your process schema.
Allowed Values:
To open the Schema Mapper, click the Ellipses (...) button.

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

Default Value:
None
Example:
Refer to:

Configure Lookup > Error Messages tab

Configures the message to show if the lookup does not return any data.

Figure: Configure Lookup > Error Messages tab

Error Messages tab

Fields

Field NameDefinition

No Items Retrieved

Description:
Specifies the error message to show if the lookup does not return any data.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Lookup Failed

Description:
Specifies the message to show if the data fails to load.
Allowed Values:
More than one line of text.
Default Value:
Failed to load data.