Remote lookup enables you to retrieve lookup data from a remote source using a configured service. With this feature, you can specify an HTTP URL that will provide the required lookup data based on specific search criteria. This feature is enabled by request only, so please reach out to our Support Team.
Note: Remote lookup will not work in the web app or preview mode.
How to Set Up Remote Lookup
- Open your form in the Form Builder and go to Advanced Options > Lookup Mappings.
- Create a new mapping and choose Remote Lookup Access as the lookup type.
- Enter the HTTP URL where JSON search criteria will be sent. This call will fetch the matching lookup result.
- You have the choice to use basic username/password authentication or token-based authentication. If needed, enable the respective checkbox and provide your authentication details.
- Select the form fields that will be included in the remote URL call to search for the requested lookup data record. Allowable field types include List Selector, Global List Selector, Lookup List Selector, Static Text, Bar Code Reader, and NFC Reader.
Testing
JSON Posted to Your URL:
Here is an example JSON payload that will be sent via an HTTP POST call to the specified URL. It's recommended to use SSL (HTTPS) for the call. If authentication is used, the provided credentials will be included in the authorization portion of the call. While the JSON structure is correct, the content in this example is not valid data, but you can use it to test our service.
{"mappingName": "Flowers","searchMappings": [{"searchField": "lookuplistpicker_1","searchValue": "testdata1"}]}The following is an example of the expected JSON format to be returned by your service from our POST to you. The basic concept is that you will return one record containing a Field Keys list and the associated value. You will need to ensure the field key you send back exists in the form, or it will be ignored.
Expected JSON Response from Your Service:
Here is an example of the expected JSON format to be returned by your service from our POST to you. The basic concept is that you will return one record containing a field keys list and the associated value. You will need to ensure the field key you send back exists in the form or it will be ignored.
{"mappingName": "Flowers","resultMappings": [{"fieldKey": "field_1","value": "Test Data"},{"fieldKey": "field_2","value": "More Test Data"}]}Mapping
The application will handle the display of the resulting call. When call results are returned, the values will be automatically mapped to the form, utilizing the field key to associate the value correctly.