App link syntax

This topic describes the syntax used in Nintex Mobile app links.

Syntax

The following examples describe the syntax of a Nintex Mobile link, where ACTION represents the optional action for the link and PARAMETERS represents the optional parameters specified for the link.

Nintex Mobile (uses the "nintexmobile" URL scheme): 

nintexmobile://[{ACTION}][?{PARAMETERS}]

Nintex App Studio (uses the custom URL scheme defined for your app): 

[CUSTOMURLSCHEME]://[{ACTION}][?{PARAMETERS}]

Specifying nintexmobile:// with no action or parameters launches the Nintex Mobile app; specifying [CUSTOMURLSCHEME]:// with no action or parameters launches the custom-branded app for which the scheme was defined.

Action descriptions

This section describes the actions available for use in the {ACTION} portion of the Nintex Mobile link syntax.

nintexmobile://[{ACTION}][?{PARAMETERS}]

Action Description

form

Navigates to the form indicated by specified parameters.

Parameter descriptions

This section describes the parameters available for use in the {PARAMETERS} portion of the Nintex Mobile link syntax.

nintexmobile://[{ACTION}][?{PARAMETERS}]

A parameter is a name-value pair, using equals (=) between the name and value. Separate parameters using ampersands (&).

All parameter values should be URL encoded. For information on URL encoding, see http://www.w3schools.com/tags/ref_urlencode.asp.

Form navigation parameters

This section describes the parameters that identify the form to display, customize messages, and automatically submit the form.

Form navigation parameters apply only when the ACTION is set to form.

Parameter Data type Description

ntx-autosubmit

String

Optional. Automatic submission. Use with true value to automatically submit the identified form with the indicated values in specified form fields (see Form field pre-population).

Default value: false

ntx-category

String

Optional. Form category. Use to uniquely identify a form when multiple forms of the same name exist.

This parameter is used only when the ntx-name parameter is specified.

ntx-id

String

Optional. Unique form identifier on the server.

The ntx-id parameter has precedence over the ntx-name parameter; if the specified value for ntx-id is found, then the ntx-name parameter is ignored.

ntx-msgError

String

Optional. Custom heading text to display when automatic submission (ntx-autosubmit parameter) fails.

Default value: empty

Default heading text: Validation issues prevent submission

ntx-msgLoading

String

Optional. Custom heading text to display during processing and loading of the Nintex Mobile link.

Default value: empty

Default heading text: Working on it

ntx-msgSuccess

String

Optional. Custom heading text to display when automatic submission (ntx-autosubmit parameter) succeeds.

Default value: empty

Default heading text when not specified: Done

ntx-name

String

Optional. Form name.

Note: Form names are case-sensitive.

The ntx-id parameter has precedence over the ntx-name parameter; if the specified value for ntx-id is found, then the ntx-name parameter is ignored.

ntx-returnUrl

String

Optional. Redirect URL for use when customer navigates away from specified form.

Example redirect URLs:

  • Host website: https%3A%2F%2Fcrestan.com%2Fmyformcompleted.aspx
  • Facebook app: fb%3A%2F%2Fprofile%2F123456

Upon redirection, Nintex Mobile appends an ntx-action parameter to the supplied ntx-returnUrl parameter to indicate whether or not the form was submitted. Possible values for the ntx-action parameter follow.

  • success
  • cancel

For the example host website above, the URLs used for redirection are as follows.

  • Customer successfully submits the form: 

    https://crestan.com/myformcompleted.aspx?ntx-action=success

  • Customer cancels form submission:

    https://crestan.com/myformcompleted.aspx?ntx-action=cancel

Form field pre-population

This section describes requirements for pre-populating fields in identified forms.

Form field pre-population applies only when the ACTION is set to form and a form is identified.

To pre-populate a form field, specify the field name (control name) as a name-value pair, using equals (=) between the name and value.

Note: Control names are case-sensitive. The words "name" and "id" are reserved for backwards-compatibility in Nintex Mobile links. While the reserved words can be used in association with the "form" option, they cannot be used elsewhere in the link. For example, do not use reserved words to reference form fields. If you want to build links that prepopulate fields that use reserved words as names, you must rename the fields first.

For example, let's say you want to build a Nintex Mobile link for a QR code that pre-populates the field "Title" to say "Front Door" for a security check protocol. Furthermore, you want to autosubmit the form and customize the loading and success messages. In this case, you would create the following link.

nintexmobile://form?ntx-name=Security%20Check&Title=Front%20Door&ntx-autosubmit=true&ntx-msgLoading=Loading%20Security%20Form&ntx-msgSuccess

This link uses the "nintexmobile" URL scheme for the Nintex Mobile app. To build links for a custom-branded app developed in Nintex App Studio, use the custom URL scheme specified for that app.

Follow parameter guidelines (ampersand separation, URL encoding). No referenced form field names can start with "ntx-" as "ntx-" is a reserved prefix for link parameters.

Note: Legacy Nintex Mobile links are supported for backwards compatibility only. For example, a link using the legacy parameter name as in nintexmobile://form?name=Expense%20Report is supported. However, if the parameter ntx-autosubmit is added to this link, then the app assumes that the link has been updated and it ignores any legacy parameters (such as name). 

Related information

App link reference