Create a Lookup for Web Service

To create a lookup for a web service, do the procedure in this topic.

Figure: Lookup Details screen

Lookup Details screen

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, 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 Auto 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 Auto Lookup Auto Lookup icon form control onto your eForm.
    • Change a Auto Lookup Auto Lookup icon control:
      1. On your eForm, click the control, and click Edit Edit icon.
  3. On the Configure tab, click Add Lookup Add Lookup icon.

Procedure

  1. On the Select Data Source Type screen, select Web Service Web Service icon, and click Next.
  2. On the Lookup Details screen, in the Access Token field, select your web service access token.

    To create a new access token, click Add Token Add Token icon. For more information, refer to Access Token for Web Service.

  3. In the Lookup Name field, enter a name for your lookup.
  4. Complete this field:
    Field Name Definition

    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:
  5. Click Next.
  6. On the Configure Lookup screen, do one of these:
  7. Click Finish.
  8. In the Bind Lookup Values To A Repeating Control (Optional) field, select a form control on your form to show the results of the lookup procedure.

    You can select a form control that can show repeating data. For example, Radio Button, Drop-Down List, or List Box.

  9. Complete the Execute This Lookup On field as necessary:
    Field Name Definition

    Execute This Lookup On
    Function:
    Specifies when the control does the data lookup.
    To Open this Field:
    1. In the Lookup Source field, select your lookup from the list.
    Accepted Values:
    • Form Load - Does the lookup when the form opens.
    • Related Field Value Change - Does the lookup when the value in a related field configured in your lookup changes.
    • Specific Field Value Change - Does the lookup when a value in a specific field on the eForm changes.
    • Form Load & Related Field Value Change - Does the lookup when the form opens or when there is a change in the value of the related field.

    In these settings, "related field value" means the value of a different field that can change the data the lookup gets. For example, changing the value of request mapping fields may change the data retrieved by a REST service lookup. Changing the value of a WHERE clause field may change the data retrieved by a database lookup. This setting monitors those fields and runs the lookup if the field values change.

    Default Value:
    Form Load & Related Field Value Change
  10. Complete the Execute on Session field as necessary:
    Field Name Definition

    Execute On Session
    Function:
    Specifies the sessions the lookup runs.
    Accepted Values:
    • First Session - The lookup runs only the first time the eForm loads in the form user's browser.
    • Subsequent Sessions - The lookup does not run the first time the eForm loads in the form user's browser, but runs all subsequent times the eForm loads.
    • Specific Sessions - The lookup runs only in the sessions, or page loads, specified by the numbers in the Enter Sessions field.
    Default Value:
    First Session