How to use the HTTP Request Data Maps to integrate submitted forms data
- Open the form for which you want to create a data map.
- Choose (Form Settings), then scroll to the right and click the Data Maps tab.
- Click (Add button) to open the Data Mapping window.
- Choose HTTP Request as the data map type, then name your form map. The form map is the name for the set of information you’re mapping. Because you can create multiple maps for each form, use a name that will help you identify the information in the map.
- If the endpoint you are calling is secured through a token, select the data source that you configured in the Data Connection window. The authorization will be called to secure a token prior to calling the request URL. If you have a static token, or do not require authorization to the endpoint, leave this field blank.
- Select the request type. Consult the documentation for your endpoint for guidance on which request type should be used.
Select Post to send data to a server to create or update a resource.
Select Put to send or replace data to a server to create or update a resource.
Select Patch to apply partial modifications to a resource.
Select Delete to delete a resource from the server. -
Enter the request URL. This is the endpoint that is called to perform the data map functionality. As part of this URL, you can select fields on the form whose values will then be sent as part of the URL. Some endpoints require a field or fields be used to identify the target record(s) in the system you are integrating to. Selecting these merge fields allows the call to have the value of the field on the form to be embedded in the call. For example, a REST endpoint is configured to update a work order. It might require the caller to use a patch request type and the URL looks like https://<your server>/api/workorders(workorderid) where workorderid is the ID of the work order you are updating. On your form you have a field called Work Order Number. When building the URL you would enter the path listed above https>//<your server>/api/workorders(work order number) where the work order number is selected from the merge fields.
-
Enter the request header, which is sent along with the request, providing information such as the type of client making the request, and authentication credentials. Any information entered in this field will override the header if you select a data source.
- Select the fields you want to include in the data in the other application. If you want to the mapped data to include the user and date of submission, include the Submitted By and Submitted On fields. You don’t need to add all the fields and, because you can create multiple maps for each form, you can create a HTTP request connection for some fields on your form and a separate one for others. If you know what you’ll be using the data for, it will help you create an appropriate map.
- You can rename any fields for use in the other application. We recommend shortening long form field names to a few words, such as when you use a long question as a field name but need to report on that data collected. For example, you could rename “Voltage_Record Voltages L1-L2_Reading” as in the screenshot above to “Voltages L1-L2.” You can’t use the same name twice in a data map, so if your form has multiple tables with the same labels, you’ll need to be careful when renaming.
- Specify if you want to use a JSON or XML file to integrate the data.
- If you want to preview the information that is going to be sent, click Preview to open the Preview window.
- Select a form submission and the JSON of what will be sent when the data map executes will be displayed. Any errors that may occur for the data map is displayed too.
- Click Save, then click OK to close the Form Settings window.
- Your map is set up and you can complete the integration in the other application. When forms are submitted, you should see data from the form appearing in the integrating application.
- View the Data Maps Log to ensure the data map ran successfully. We recommend that you specify an email to send the Data Map event error log reports to ensure the right personnel is aware of the errors and failures.