Inter-App Communication

 

About

The ProntoForms app now supports certain types of inter-app communication. You can create links from other apps which allow you to link directly to a screen within the ProntoForms app. Currently, the ProntoForms app supports:

iOS Android
  •  launching the app from another app;
  •  triggering a reconcile to ensure users have the most up-to-date forms on their device;
  • opening a particular form using the formID;
  • opening a partially-completed form with clientDataRecordID.
  • Inter-App Dispatching using the Open action.
  • launching the app from another app;
  • launching the app and showing the user a particular tab of the app;
  • opening a particular form using the formID;
  • opening a partially-completed form with formIterationID.
  • opening a form using the form name.
  • Inter-App Dispatching using the Open action

You can also launch the ProntoForms app from another Android app using Android Intents. Learn more here.

[ top ]

 

Scheme

The Scheme is the part of the link that tells your device what protocol to use when you click a ProntoForms link in another (external) app.

Example:

prontoforms://

For AT&T Mobile Forms, the Scheme becomes: 

prontoforms-mobileforms://

[ top ]

 

Host

The host or external app is where your user is coming from. It is always identified by iOS as x-callback-url in the ProntoForms inter-app communications URLs.  This tells the device where the request came from and what external app hosts the ProntoForms app.

Example:

prontoforms://x-callback-url/

[ top ]

 

Action

You can create links from the external app which allow you to link to a particular form screen or open a specific form. The example below will open a specific form when combined with additional information.

Example:

prontoforms://x-callback-url/open?

Action

Description

Supported Action Parameters

Supported x-callback Parameters

iOS

Android

launch

Launches the application

reconcile (optional)

x-source

 ✔

list

Presents the user with a particular form screen

type (optional)
reconcile (optional)

x-source

 ✔

open

Opens various forms based on the supplied parameter. Used in inter-app dispatching.

formID (optional)
Form Name* (optional)
formIterationID (optional)
dataRecordID (optional)
clientDataRecordID (optional)

x-source
x-success
x-error

* See Description in Action Parameters below.

[ top ]

 

Action Parameters

Action Parameters are pieces of additional information that allow you to:

  • trigger a reconcile to ensure users have the most up-to-date forms;
  • select which form screen to open, whether it is Inbox, Drafts, Outbox, or Sent;
  • specify a form to open;
  • open a partially-filled or complete form.

In this example, we will open the ProntoForms app and direct it to open a particular form. Each ProntoForms form has a unique ID to identify it.

prontoforms://x-callback-url/open?formID=15872001

 Note: You can find any form's unique formID or formIterationID by following the instructions on this page.

Action Parameter

Description

Type

Expected Values

iOS

Android

reconcile

Triggers a reconcile in the ProntoForms app to ensure users have the most up-to-date forms. 

boolean

0 (default)
1

type

Opens the selected ProntoForms app screen: forms, drafts, inbox, or sent.

string

forms (default)
drafts
inbox
sent

 ✔

clientDataRecordID

Opens a form started by the ProntoForms app user, usually a form saved in drafts.

string

user-defined

 ✔

dataRecordID

Opens a dispatched or completed form.

string

user-defined

 ✔

formID

Opens a specific form for the user to start filling out.

string

user-defined

 ✔

formIterationID

Opens a specific form version for the user to start filling out.

string

user-defined

 ✘

name (Form Name)

Opens a form based on the form name. This allows partial string matches. *

 string user-defined  ✔

Note: As form names are alphanumeric and may not be unique, here are guidelines for use with the Open action:

  • As the inter-app URL uses URL encoding, if there are any spaces or special characters in the form name, encode them appropriately (percent encoding).
  • Uses string matching to bring up matching form names. This means that it will bring up a list of partial matches to the string match. Users select the appropriate form if there are multiple matches.
  • All subsequent parameters/dispatched information will be parsed to the selected form. If there is information dispatched to question labels that do not exist in the form, that information will be ignored.

[ top ]

 

Emailing ProntoForms Links

Inter-app functionality can be used to create clickable links in email. This is supported in Apple Mail by following these steps:

  1. Construct the URL following the guidelines in this article.
  2. Copy/paste the URL into an email.
  3. Send email as normal.

 

Please note that while this may work with some mail clients, such as Apple Mail, many others will strip out the link for security reasons.

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

Comments