Single Select Lookup > Web Service

Background and Setup

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Good to Know

Limitations
These technical limitations apply to Web Service and WCF support in process activities and lookups:
- Arrays of primitive data types.
  Arrays of primitive data types — for example, string, Boolean, integer, decimal — are not supported as input or output data types because this interferes with the deserialization of the array object.
  However this does work with an array of complex classes and custom classes or a list of primitive data types.
  
  If you have a service that returns an array of primitive data types, these workarounds are suggested:
  - Return a list objects instead of arrays — for example, List<string>, instead of string[]
  - Create a custom class that encapsulates that property — for example, a class that has a property of type string.
  - If you do not have control over the service, you can write a wrapper service that encapsulates the call to the underlying service and converts the array to a list object, or create a custom class that encapsulates that property.
- Dictionary objects.
  Dictionary objects are not supported as input or output data type because XMLSerializer interferes with the deserialization of the dictionary object.
- Circular references.
  Circular references are not supported in input and output objects — for example, if a class called Person contains a field of type Person that references the same class. Such a circular structure cannot be loaded in the XML Mapper.
- Nested WSDLs.
  Web services with nested WSDLs are not supported. Consider making your service use single WSDL, or use the .Net Proxy activity.
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

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.
On the Select Data Source Type screen, select Web Service.
Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Fields

Field Name	Definition
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	Opens this Screen: Access Token for Web Service Function of this Screen: Configure an access token to connect to a web service.
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: (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	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.

Fields

Field Name	Definition
Web Method	Description: Specifies the name of the method to call. Allowed Values: A method name from the list. Default Value: None Accepts Variables: No
Endpoint URL	Description: Specifies the URL of the endpoint of the web service or WCF service you want to connect. Allowed 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 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	Description: 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: In the Web Method list, select your method. 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: (Example) Schema Mapper
Custom Headers	Description: Specifies the custom headers required for the web service. To Open this Field: In the Web Method list, select your method that accepts custom headers. Allowed Values: To open the Custom Headers screen, click the Ellipses (...) button. Default Value: None
Add Other SOAP Headers	Description: Specifies to add more SOAP headers. These SOAP headers may give application-specific about the SOAP message, such as authentication. To Open this Field: In the Web Method list, select your method that accepts custom headers. Allowed 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.

Fields

Field Name	Definition
Name	Description: Specifies the names of the custom headers. Allowed Values: Read only.
Value	Description: Specifies a value to use for the custom header. Allowed Values: A process data variable One line of text that can have spaces. Default Value: None Accepts Variables: Yes

Configure Lookup > Response tab

Connects the response data from the NetSuite call to your app.

Fields

Field Name	Definition
Web Method	Description: Specifies the name of the method to call. Allowed Values: A method name from the list. Default Value: None Accepts Variables: No
Endpoint URL	Description: Specifies the URL of the endpoint of the web service or WCF service you want to connect. Allowed 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 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	Description: Specifies if the web service response connects 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: (Example) Schema Mapper
Store the Response In This Variable	Description: 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. Allowed Values: A process data variable. Default Value: None Accepts Variables: No

Configure Lookup > Error Messages tab

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

Fields

Field Name	Definition
Web Method	Description: Specifies the name of the method to call. Allowed Values: A method name from the list. Default Value: None Accepts Variables: No
Endpoint URL	Description: Specifies the URL of the endpoint of the web service or WCF service you want to connect. Allowed 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 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	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.