TABLE OF CONTENTS
- Options
- Incoming App Link
- Conditional Formula (optional)
- Screen to Open
- Screen Parameters (optional)
- Conditional Formula (optional)
Our deep linking functionality provides the ability to directly launch into a specific screen in the app using special URLs that are similar to web links. These links can be emailed or otherwise passed to other app users and will launch the app when the user taps or clicks on the link (assuming the app is already installed). An App Link looks something like this:
formsonfire://somescreen
We also support app-launching capability via an NFC scan on Android, so you can tap an NFC tag and launch your app based on what is read on the tag.
To access the app linking section, navigate to Admin -> App Setup from the left-side menu on the platform. You should see the "launch options" link in the navigation bar under the word App Setup. Once on the Launch Options page, you can create launch rules and app links that will launch the app directly into specified screens.
Options
Email link
Consider using our redirect URL to avoid mail filter issues. Although some email clients (like Gmail) do not allow app launch URLs due to security issues, you can get around this by using the URL example provided below. This will redirect the user to a public branded launch screen webpage which will launch the desired app URL.
Example:
https://secure.formsonfire.com/appredirect?link=formsonfire://inspection?site=hello&Condition=123
Click here to see an example of what the user will see when using this redirect.
Sync on Launch
When this checkbox option is enabled, the app will instead display a blocking overlay before executing the app link, forcing the user and app to wait for the sync to finish. This is useful for cases where you wish to ensure users have the latest data before they start working with the app.
Without this checked, the app will perform all data syncing in the background, allowing the user to immediately start working while the sync is still in progress.
Creating the App Link
The incoming app link has two parts to it.
- First is the URL scheme, which is the part before the :// piece. This will vary based on whether you are using our standard app or if you have your own branded version of our native app technology. Either way, this part is fixed and will not change - it's simply part of the app links you create.
- The second editable portion describes the screen into which the user will be launched. We recommend that you use the target screen's actual name to make your app links more descriptive - e.g., formsonfire://inspection where the target screen is named "Inspection."
App links can also include descriptive query string syntax that will illustrate the parameters to be passed - e.g., formsonfire://inspection?site=1234&condition=2 where site is the first parameter's name and 1234 is its value. The first parameter requires a '?' in front and subsequent parameter sets must be separated with an '&'. Note that these parameters are optional; they only work if matching screen parameters have been defined in the Screen Parameters property (see 2 sections below), and even then are unnecessary as long as screen parameters have been defined. It is the screen parameters, not the query string syntax, that pass parameters into the launched screen. Similarly, it is the Screen to Open property (see the section below) rather than the link here that determines the target screen.
Conditional Formula (optional)
In most scenarios, the app link alone will be distinct enough to define your Launch Rule. However, in some cases, you may want the same app link to launch one of several Screens, based on the parameter values on the link.
Alternatively, you may wish to make a Launch Rule conditional against the same app link and then specify differing results using a formula that has a True/False result.
The first rule with a True formula result will be executed by the app.
Refer to app link parameter values via {{parameterName}} syntax.
e.g. if the incoming app link is: yourcompany://inspection?perform=Yes
then a formula of: {{perform}} = 'Yes' will be True.
Screen to Open
This is the target app Screen that will be opened.
Screen Parameters (optional)
Pass query string parameter values from your launch URL into the target Screen by using {{parameterName}} syntax.
For Form targets, you can preset target fields with "dataname:value," pipe-separated.
e.g., field1:{{client}}|field4:hello
For Listing & Map targets, you can pass in a formula for filtering the target rows. Use {{target[column]}} for target columns.
e.g., {{target[3]}} = {{client}}
For Detail targets, pass a value to match the first column of the target data row.
e.g., {{client}}
Conditional Formula (optional)
In most scenarios, the app link and screen parameters alone will be distinct enough to define your Launch Rule. However, in some cases, you may want the same app link to launch one of several Screens based on the parameter values in the link. Alternatively, you may wish to make a Launch Rule conditional based on the user's metadata - e.g., only allow Project Managers to open the link.
For these cases, define multiple Rules against the same app link and then specify differing results using a formula that has a True/False result. The first rule with a True formula result will be executed by the app. Refer to app link parameter values via the {{parameterName}} syntax. E.g., if the incoming app link is: formsonfire://inspection?perform=Yes then a formula of: {{perform}} = 'Yes' will be True.
Sending Multiple Values to a Choices Field
In a situation where you have to input multiple values into a "Choices" field designed for multiple selections, your app's deep link would resemble the following example. Here, the various values for the choices field are separated by pipes:
Example:
https://secure.formsonfire..com/appredirect?link=formsonfire://my_generic_test_app?the_choices_field=Red|Blue|Green|Black
In the sample above, the data name for the choices field on the target form is "the_choices field" and the values "Red|Blue|Green|Black" will be passed to that field when the link is clicked and the app opens. To ensure you can pass parameters to your choices field successfully, make sure that you have the "Multiple Choice" checkbox field selected as shown below. 
Sending app links via email
Bypass email filtering problems by utilizing our redirection feature. Certain email platforms, such as Gmail, restrict app launch URLs for security reasons. To circumvent this, follow the URL sample given below. It will guide the user to a publicly accessible, branded launch page, which then initiates the intended app URL.
Example: https://secure.formsonfire.com/appredirect?link=formsonfire://inspection?site=hello&Condition=123