Auto-Lookup > REST > Multiple Columns

Advanced Configuration

Function:

Specifies if you want to do a detailed configuration of the REST service.

Accepted Values:

• Deselected - Does not do a detailed configuration of the REST service.
• Selected - Does a detailed configuration of the REST service.

Default Value:

Deselected

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:

Refer to:

• (Example) Create a REST Service Access Token

Add New

Opens this Screen:

Access Token for REST Service

Function of this Screen:

Configure an access token to connect to a REST service.

Example:

Refer to:

• (Example) Create a REST Service Access Token

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:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?
• (Example) Configure an Auto-Lookup Form Control with Microsoft Excel

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:

• (Example) How Do I Configure a Pop-Up Select Control to Bind the Lookup Values to a Data Grid?
• (Example) Configure an Auto-Lookup Form Control with Microsoft Excel

Request URL

Function:

Specifies the REST service URL for your method.

Accepted Values:

A valid REST service URL.

Default Value:

None

Action

Function:

Specifies the type of action for the REST service to do.

Accepted Values:

• POST
• GET
• DELETE
• PUT
• PATCH

Default Value:

GET

Content Type

Function:

Specifies the type of content the REST service uses.

JSON or XML patch files are also supported to patch the document with the specified changes.

Accepted Values:

• XML
• JSON

Default Value:

JSON

Accept

Function:

Specifies the data format to accept in a REST service.

Accepted Values:

• XML
• JSON

Default Value:

JSON

Protocol

Function:

Specifies the communication protocol for your REST service.

Accepted Values:

• HTTP 1.0
• HTTP 1.1

Default Value:

None

Request Timeout (sec)

Function:

Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity.

Accepted Values:

An integer, representing a number of seconds.

Default Value:

60

Read-Write Timeout (sec)

Function:

Specifies the maximum amount of time, in seconds, for read and write methods.

Accepted Values:

An integer, representing a number of seconds.

Default Value:

60

Header Information

Function:

Specifies the custom headers for the REST service.

Request headers are usually used to give security information, such as authentication credentials.

Accepted Values:

• Name
• Value

Default Value:

None

Accepts Process Data Variables:

Yes

Authentication

Opens this Screen:

• Configure Lookup > Basic Authentication tab - Creates REST service authentication credentials to connect to a REST service URL with basic authentication.
• Configure Lookup > OAuth 2.0 tab - Creates REST service authentication credentials to connect to a REST service URL with the OAuth 2.0 protocol.
• Configure Lookup > Windows Authentication tab - Creates REST service authentication credentials to connect to a REST service URL with Windows Authentication (NTLM).

User Name

Function:

Specifies the user name for REST service authentication.

Accepted Values:

A valid user name.

Default Value:

None

Example:

Refer to:

• (Example) Create a REST Service Access Token

Password

Function:

The password for the authentication account.

Accepted Values:

An alphanumeric string that represents a password.

Default Value:

None

Accepts Process Data Variables:

No

Authorization

Function:

Specifies an authorization value to connect to the REST service.

Accepted Values:

A valid authorization value.

When you click Generate button, this field completes.

Default Value:

None

Generate

Function:

Gives the authorization value to connect to the REST service.

Insert

Function:

Adds the authorization name and value in the Header and Value field.

Reset

Function:

Deletes the REST service authentication credentials.

Token Type

Function:

Specifies the name of an external system, such as SharePoint, Google Drive, or Box from the list.

Accepted Values:

The name of an external system.

Default Value:

None

Token

Function:

Specifies the access token for the specified external system.

Accepted Values:

An access token from the list.

Default Value:

None.

When you select an external system from the Token Type field, the name of the access token for the specified system shows in this field.

Domain

Function:

The domain for the REST service authentication.

Accepted Values:

A valid domain.

Default Value:

None

User Name

Function:

Specifies the user name for the REST service authentication.

Accepted Values:

A valid user name.

Default Value:

None

Password

Function:

The password for the authentication account.

Accepted Values:

An alphanumeric string that represents a password.

Default Value:

None

Example:

Refer to:

• (Example) Create a REST Service Access Token

Request Payload

Function:

Specifies your payload values in the box. The values of the payload must be in JSON/XML format.

Accepted Values:

• JSON
• XML

Default Value:

The value specified in the XML/JSON Payload field of the access token.

Map Schema

Opens this Screen:

Schema Mapper

Function of this Screen:

Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..

Example:

Refer to:

• (Example) Schema Mapper

Store the Response in Form Field

Function:

Specifies the variable that stores the response to a method call. The method calls a REST service.

This field is applicable only for Multiple Columns lookup type.

Accepted Values:

A process data variable.

Default Value:

None

Accepts Process Data Variables:

Yes

Enter Sample Response

Function:

Specifies sample response schema to connect to your process.

Accepted Values:

• Selected - Configures sample response schema to connect to your process.
• Deselected - Configures a response schema with a simulation.

Default Value:

Selected

Header (Optional)

Function:

Specifies the custom headers for the REST service

Accepted Values:

• Name - Specifies a name of the custom header.
• Value - Specifies a value to use for the custom header.

Default Value:

None

Add New Record

Function:

Adds the row for Name and Value fields.

To Open this Field:

1. On the Configure Lookup screen, in the Response tab, select Enter Sample Response.

Update

Function:

Updates the row with Name and Value fields.

To Open this Field:

1. On the Configure Lookup screen, in the Response tab, click Add New Record.

Delete

Function:

Deletes the row with Name and Value fields.

To Open this Field:

1. On the Configure Lookup screen, in the Response tab, click Update.

Edit

Function:

Changes the row with Name and Value fields.

To Open this Field:

1. On the Configure Lookup screen, in the Response tab, click Update.

Sample JSON/XML

Function:

Specifies an example response payload to connect the process schema in JSON or XML format.

Accepted Values:

Sample payload data in XML or JSON format.

Default Value:

None

Payload

Function:

Specifies JSON or XML response payload to connect to the process schema.

Accepted Values:

• XML
• JSON

Default Value:

JSON

Simulate

Opens this Screen:

REST Response Configuration > Simulate

To Open this Field:

1. On the Configure Lookup screen, in the Response tab, click Get Response from Simulation.

Function of this Screen:

Configures the response settings with a simulated REST method call.

Map Schema

Opens this Screen:

Schema Mapper

Function of this Screen:

Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..

Example:

Refer to:

• (Example) Schema Mapper

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.