Remote Lookup (Beta)

  • 2 minute(s) read
Prev Next

Remote lookup fills in form fields with data from your own web service. This article covers how to set up a remote lookup in the Form Builder. It also shows the data your service receives and returns.

Note

Remote lookup is in beta and available by request. To turn it on for your account, contact FastField Support.

How remote lookup works

A remote lookup is a type of lookup mapping. Instead of searching a Lookup List or Data Table, it sends the user's answers to a URL you provide.

  1. A user answers the search fields in the FastField mobile app.

  2. The app sends those answers to your URL as JSON in an HTTP POST.

  3. Your service returns a field key and value for each field to fill in.

  4. The app fills in the matching fields on the form.

Note

Remote lookup doesn't work in the web app or the form preview.

Set up a remote lookup

  1. In the Form Builder, select Settings in the bottom toolbar, then select Lookup Mappings.

  2. Select Add Mapping, then enter a Mapping Name.

  3. In Lookup Type, select Remote Lookup.

The Lookup Type menu in a new mapping, with Remote Lookup

  1. In HTTP URL, enter the address of your service. Use an HTTPS address.

  2. If your service needs sign-in details, turn on Basic Auth and enter a Username and Password. Or turn on Token Auth and enter a Token Key and Token Value.

A remote lookup mapping with an HTTP URL and Token Auth turned on

  1. Under Search Fields, select the form field to send in Field. Select + Add Search Field to send more fields.

You can send List, Global List, Lookup List, DataTable List, Static Text, Bar Code, NFC Reader, and Web Link fields.

  1. Select Save, then select Save Draft.

Test your service

Under Testing, select Sample POST JSON or Sample Return JSON to download an example of each message. Use them to build and test your service.

The Search Fields and Testing sections of a remote lookup mapping

JSON sent to your URL

FastField sends the mapping name and each search field's key and value. If you use authentication, the sign-in details go in the authorization part of the call.

{
  "mappingName": "Flowers",
  "searchMappings": [
    {
      "searchField": "lookuplistpicker_1",
      "searchValue": "testdata1"
    }
  ]
}

JSON your service returns

Return 1 record with the field key and value of each field to fill in. The app ignores any field key that isn't in the form.

{
  "mappingName": "Flowers",
  "resultMappings": [
    {
      "fieldKey": "field_1",
      "value": "Test Data"
    },
    {
      "fieldKey": "field_2",
      "value": "More Test Data"
    }
  ]
}

Note

The Assistant can't set up remote lookups.

What's next