Configure Lookup for Web Service > Name/Value

Configures a lookup with name/value pairs from web service.

Prerequisites

Good to Know

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 Application Explorer screen, do one of these:
  2. Do one of these:
    • Add a Single Select Lookup Auto Lookup icon control:
      1. On the eForm Builder screen, in the Toolbox, open the Advanced Controls Advanced Controls icon tab.
      2. On the Advanced Controls Advanced Controls icon tab, drag a Single Select Lookup Auto Lookup icon form control onto your eForm.
    • Change a Single Select Lookup Auto Lookup icon control:
      1. On your eForm, click the control, and click Edit Edit icon.
  3. On the Single Select Lookup screen, in the Configure tab, click Add Lookup Add Lookup icon.
  4. On the Select Data Source Type screen, select Web Service Web Service icon.
  5. Click Next.
  6. On the Lookup Details screen, select Name/Value.
  7. Click Next.

Request tab

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

Figure: Configure Lookup Request tab

Configure Lookup 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 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

Response tab

Configures to connect response data from the web service call to your process.

Figure: Configure Lookup Response tab

Configure Lookup 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 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 Custom Attribute

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

Error Messages tab

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

Figure: Configure Lookup Error Messages tab

Configure Lookup 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 Available

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

Failure Messages

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.