Auto-Lookup > Web Service > Multiple Columns

This topic shows how to create a lookup with web service as the data source based on multiple columns for the Auto-Lookup form control.

Background and Setup

Video: Show Data from a Web Service on an eForm

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 Web Service.

    Select Web Service
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

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 Web Service
Function of this Screen:
Configure an access token to connect to a web service.

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 more than one column from your data source.

Figure: Configure Lookup > Request tab

Request tab

Fields

Field Name Definition

Web Method

Function:
Specifies the name of the method to call.
Accepted Values:
A method name from the list.
Default Value:
None
Accepts Process Data Variables:
No

Endpoint URL

Function:
Specifies the URL of the endpoint of the web service or WCF service you want to connect.
Accepted Values:
A valid endpoint URL.
Default Value:
None.

However, once a web service is connected, the endpoint URL shows if it is defined in the WSDL file.

Accepts Process Data Variables:
No
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?

Request Mapping

Function:
Connects the web service request to your process schema. This is mandatory only if the request passes data from the process schema to parameters in the web method.
To Open this Field:
  1. In the Web Method list, select your method.
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

Custom Headers

Function:
Specifies the custom headers required for the web service.
To Open this Field:
  1. In the Web Method list, select your method that accepts custom headers.
Accepted Values:
To open the Custom Headers screen, click the Ellipses (...) button.
Default Value:
None

Add Other SOAP Headers

Function:
Specifies to add more SOAP headers.

These SOAP headers may give application-specific about the SOAP message, such as authentication.

To Open this Field:
  1. In the Web Method list, select your method that accepts custom headers.
Accepted Values:
  • Deselected - Does not add other SOAP headers.
  • Selected - Enables the text box where you can add SOAP headers.
Default Value:
Deselected

Custom Headers

Configures the custom headers for your web service.

Figure: Custom Headers screen

Custom Headers screen

Fields

Field Name Definition

Name

Function:
Specifies the names of the custom headers.
Accepted Values:
Read only.

Value

Function:
Specifies a value to use for the custom header.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes

Configure Lookup > Response tab

Connects the response data from the web service call to your app

Figure: Configure Lookup > Response tab

Response tab

Fields

Field Name Definition

Web Method

Function:
Specifies the name of the method to call.
Accepted Values:
A method name from the list.
Default Value:
None
Accepts Process Data Variables:
No

Endpoint URL

Function:
Specifies the URL of the endpoint of the web service or WCF service you want to connect.
Accepted Values:
A valid endpoint URL.
Default Value:
None.

However, once a web service is connected, the endpoint URL shows if it is defined in the WSDL file.

Accepts Process Data Variables:
No
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?

Map Response to AgilePoint Schema

Function:
Specifies if the web service response connects 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

Store the Response In This Variable

Function:
Specifies the name of the process data variable that stores the response to a method call. The call must be a web service, Web Service Extension, WCF service, or web application.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
No

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

Web Method

Function:
Specifies the name of the method to call.
Accepted Values:
A method name from the list.
Default Value:
None
Accepts Process Data Variables:
No

Endpoint URL

Function:
Specifies the URL of the endpoint of the web service or WCF service you want to connect.
Accepted Values:
A valid endpoint URL.
Default Value:
None.

However, once a web service is connected, the endpoint URL shows if it is defined in the WSDL file.

Accepts Process Data Variables:
No
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?

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.