Follow

FastField Integration Options

The following diagram illustrates the main flow of data throughout the FastField application stack:

sample

There are several ways in which collected data can be delivered/retrieved:

  1. Data captured in the FastField mobile apps is sent to the FastField Cloud Services retrieved as a CSV, Excel, PDF, or JSON document.

  2. After form submission, data can be viewed via the FastField Dashboard services

  3. Additionally, data can be viewed and exported via the standard filtering and reporting modules

  4. Form submissions can also be relayed to customers via email, FTP/SFTP in CSV, Excel, PDF or Json formats)

  5. or Direct Post delivery, form submission data is sent directly from the mobile apps to your server. The FastField integration options are explained in further detail throughout this documentation.


Integration Settings

You can setup your account to leverage the various FastField integration options by setting the Form Submission Destination Types, the Form Submission Format Types and their associated settings via the Account section in the administration portal.

Form Submission Destination Types

SettingDescription
Vault (Default) This is the default destination. When chosen, all forms will be stored in the FastField data vault. Note: When choosing this destination type, form submission data can only be processed in JSON format.
FTP Use this destination to send form submissions to your FTP server.
SFTP Use this destination to send form submissions to your SFTP server. Note: When choosing this destination type, your server must be setup to use the SSH File Transfer Protocol.
Email

There is a video on how to set this up here.

Use this destination to have form submissions sent to one or more of your email addresses. To send send to multiple email addresses, separate each with commas (,).

Note: when using Email destination you can to set merge tags for form fields into the email subject and body when you configure form integration. The following meta-data fields are currently supported: FormName, UpdatedAt (created date), UserName (created by), SubmissionId (unique submission id). Any top level (non-subform) fields can also be merged into the subject and body. (Click here for a list of supported field types)

For example, in the email subject field use the following string to have the form name, submission date, submitter and a custom field on your form (employeeid) merged into the email subject (notice bracket syntax):

[FormName] was submitted on [UpdatedAt] by [UserName] (Employee ID: [employeeid])

HttpPost Also known as Direct Post, use this destination to have form submissions sent to your HTTP REST service endpoint that accepts JSON form submission data POSTed directly from the FastField apps. See the Form Submissions to Custom Endpoint section for details. Note: When choosing this destination type, form submission data can only be processed in JSON format.

Form Submission Format Types

SettingDescription
JSON (Default) This is the default format. When chosen, all forms will be sent in JSON format.
PDF Use this format to send form submissions data in Adobe PDF format. FastField provides a generic PDF format that will be used when formatting submission data as a PDF document. FastField also supports custom PDF reporting which will be used instead of the generic PDF format when available.
Excel Use this format to send form submissions data in Excel format. When form submission data is sent in Excel format, sub-forms and multi-photo data will be included in separate Worksheets in the same Workbook (file) as the root data.
CSV Use this format to send form submissions in CSV format. Note: When form submission data is sent in CSV format, no sub-form or multi-photo data will sent so avoid using these on your forms if you choose to use CSV format.
XML Use this format to send form submissions in XML format.
Prophet Use this format to send data in the Prophet platform required format.

Form Level Integration Settings

Note that each form can be configured to override the various account level integration settings. This gives you the flexibility to change the integration options uniquely between each form you setup in FastField.

To override the account level integration settings on a form, open the Configuration screen for that form, click on the Advanced, then Integration tabs. Set any integration options as needed then click the Save button.


Form Submissions to Custom Endpoint (Direct POST)

In a custom integration scenario, form data can be posted from the FastField apps to your HTTP REST service endpoint. Form data will be sent in JSON format via an HTTP post to a your endpoint and media will be saved to an Amazon S3 storage bucket that you setup and control.

This type of integration allows customers to handle their data as they choose and to bypass the traditional FastField data storage mechanisms.

Body

The body of the post includes the raw JSON document posted from the FastField application.

The JSON structure contains the field keys and their respective values extracted from the form. Media assets sent to your Amazon S3 storage bucket can be tied back to the form submission using the Guid based file names in the JSON data.

Sample Form Submission JSON

{
    "rep_tried_the_listed_phone": true,
    "unit_photo": "73e0d68e-a648-43e9-9299-518cb81e8359.jpg",
    "unable_to_locate": true,
    "collateral_located": true,
    "field_rep_asked_neighbor": true,
    "license_plate": "df48dfc1-f7a5-4c02-bfb5-eb87df4d1e2f.jpg",
    "audio_cond_notes": "1f49d2f0-7d21-44b4-a686-3dd26144eddf.caf",
    "client_updated_phone_numbers": [
        {
            "cell_n": 64455555
        },
        {
            "work_n": 64542333
        }
    ],
    "lic_numb_verified": true,
    "apartment_phone": "",
    "contact_made": [
        "No Direct Contact"
    ],
    "address_is_gated_or_secured?": true,
    "comments": "",
    "field_rep_asked_best_time_to_call": true,
    "formId": 1073,
    "field_rep_initiated_call_to_client": true,
    "mileage_val": 7374,
    "damage_on_vehicle": "0acbda09-2321-482c-b3fb-a4934bfdd05c.png",
    "asked_for_condition": true,
    "asked_whereabouts": true,
    "chase_date": "2013-12-18",
    "submissionId": "0c93f7dd-0ac0-4d71-8517-84d86d80e914",
    "co-operative": true,
    "mileage_verified": true,
    "addressed_standard_and_specifc_request": true,
    "field_rep_contact_results": [
        "Refused"
    ],
    "customer_filed?": true,
    "rep_advise_customer": true,
    "userId": 15,
    "utilities_appear_to_be_on": true,
    "hear_phone_ring_inside_the_home?": true,
    "reason_for_delinquency": [
        "Refused"
    ],
    "3rd_p_contact_was_made_at": [
        "Neighboring Address"
    ],
    "adviced_cust": true,
    "sign_here": "94e06dd1-22c6-4427-9abd-42dc04efa1e1.jpg",
    "filing_type": [
        "Chapter 13"
    ],
    "home_appear_to_look_occupied": true,
    "address_is": [
        "CONDO"
    ],
    "vehicles_spotted": true,
    "rep_updated_all_contact_info": true,
    "gen_cond": [
        "Poor"
    ],
    "listing_agent": [
        {
            "list_agent_phone_number": "",
            "cell_number": 8383,
            "zip": 8383
        }
    ],
    "exact_address_requested": true,
    "front_view_of_home": "2985a081-cac3-4edf-b60c-59fbef0d5c26.png",
    "property_for_sale": true,
    "formVersion": 13,
    "formName": "Field Call Checklist",
    "accountId": 1,
    "updatedAt": "2013-12-18T22:54:34.335Z",
    "userName": "user"
}

Response:

A HTTP response code of 200 will indicate to the application that the form data was received successfully by the service. Any other return codes will result in an error being displayed in the application. The form will remain in the sync folder until the user initiates a re-sync.

Field Type Values

The following table outlines the field types and possible values for standard FastField Form submissions:

Field TypeData TypeDomain of ValuesExampleNotes
Switch Boolean true, false true true=Yes, false=No
Yes/No/NA(Three State) Integer 1, 0, -1 1 1=Yes, 0=No, -1=N/A
Photo String N/A 73e0d68e-a648-43e9-9299-518cb81e8359.jpg File Name of Jpg or PNG stored in Amazon S3 bucket
Numeric Numeric (Integer or Double based on Field Definition) Any Numeric Value 10 9,223,372,036,854,775,807 is the maximum value.
Rating Integer Numeric value from 1 to 10 5  
Date/Time  String of the date and time in ISO 8601 date format Any Valid Date 2014-01-16T15:12:56.808+00:00  
Long Text (Multi-Line) String Any String Value Text Value  
Static Text String Any String Value Text Value  
Video String N/A 73e0d68e-a648-43e9-9299-518cb81e8359.m4v File Name of Jpg or PNG stored in Amazon S3 bucket
Audio String N/A 73e0d68e-a648-43e9-9299-518cb81e8359.caf File Name of Jpg or PNG stored in Amazon S3 bucket
Formatted Numeric String String value formatted to mask 555-55-5555  
Signature String N/A 73e0d68e-a648-43e9-9299-518cb81e8359.jpg File Name of Jpg or PNG stored in Amazon S3 bucket
Calculation (Computed Label) Double Any Numeric Value 25.25  
Sub-form Array of sub-form key value property Objects Any array that contains sub-form key value property Objects See Example Below  
List String Array See Example Below  
Location / GPS Location Object N/A See Example Below  

Subform Value Example:

"subform_1": [
{
    "name": "john",
    "phone": "555-555-5555"
},
{
    "name": "jim",
    "phone": "555-555-5555"
}]

List Selector Value Example:

"interests" : [ 
    "Arts & Entertainment", 
    "Autos & Vehicles", 
    "Books & Literature"
]

Location Selector Example:

"location_of_review" : {
    "horizontal_accuracy" : 0,
    "vertical_accuracy" : 0,
    "longitude" : 0,
    "latitude" : 0
}

Securing Your Custom Endpoint for Direct POST

For direct post integrations (FastField App to Client Hosted Service), the apps will authenticate against your custom endpoint via Basic Authentication using username and password credentials that are configured in your account settings.

Custom Endpoint Setup

To setup your account to post data to a custom endpoint, please contact us as fastfieldsupport@mergemobile.com


General Integration Notes

  1. Invalid session tokens and authorization will return a 401 code with description.
  2. When an object is not found you will get a 404 code with description.
  3. General server errors will return a code 500 with description.

Questions / Support

For questions regarding these services or the FastField application, please contact us at fastfieldsupport@mergemobile.com

Merge Mobile, Inc. - Confidential & Proprietary Information

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk