Auto-Lookup > Blue Prism > Name/Value

This topic shows how to create a lookup with Blue Prism as the data source based on a name/value pair for the Auto-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

How to Start

  1. On the Auto-Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Auto-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: Lookup Details screen

Blue Prism Lookup Details screen

Good to Know

Fields

Field Name Definition

Access Token

Function:
Specifies the access token that connects to your data source.
Accepted Values:
A list of access tokens configured for your environment.
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.

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

Function:
Specifies the name you want to give to your lookup procedure.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Lookup Type

Function:
Specifies the type of lookup procedure to do.
Accepted Values:
  • Name/Value - The lookup gets data for specified name/value pairs.
  • Multiple Columns - The lookup gets data for more than one column.
Default Value:
Name/Value
Example:
Refer to:

Configure Lookup > Request tab

Configures a lookup with the existing data format from Blue Prism.

Figure: Configure Lookup > Request tab

Request tab

Fields

Field Name Definition

Blue Prism Method

Function:
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.

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

Endpoint URL

Function:
Shows the endpoint URL of the Blue Prism service to which to connect.
Accepted 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

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

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

Default Value:
None

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 Name Definition

Blue Prism Method

Function:
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.

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

Endpoint URL

Function:
Shows the endpoint URL of the Blue Prism service to which to connect.
Accepted 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

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

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

Default Value:
None

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 Name Definition

Blue Prism Method

Function:
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.

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

Endpoint URL

Function:
Shows the endpoint URL of the Blue Prism service to which to connect.
Accepted 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.

No Items Retrieved

Function:
Specifies the error message to show if the lookup does not return any data.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Lookup Failed

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