Launch action syntax

Available with the ArcGIS Indoors Pro or ArcGIS Indoors Maps extension.

ArcGIS Indoors includes support for launch actions to third-party apps directly from the info panel in Indoor Viewer and the info card in Indoors mobile apps. Launch actions can be configured from the Configure Indoors Launch Actions pane in ArcGIS Pro, and can be modified when you configure a Viewer app in your ArcGIS organization.

URL syntax

Launch actions are enabled by URLs, and the syntax must follow common URL conventions. For example, special characters in the arguments must be URL encoded, and the argument or value pairs must be separated with standard URL conventions.

For Indoors, values must be contained in curly brackets and match the following syntax:

?arg={Layer.Attribute}&arg={Attribute}

Note:

The layer is optional and, if it's not included, the default is the active item in the Indoors app. Many use cases require passing attributes from a different layer in the map or scene. This is supported with the layer operator. Arguments and values are not case sensitive.

See the samples below.

Single value

?Name={KNOWNAS}&building={facility_name}&space={Units.Name}

Multiple values

?center={shape.y},{shape.x}

Value from another feature class

&site={FACILITIES.SITE_ID}

Pass value to a specific field

&field:room={units.name}

Supported argument and value formats

The launch action URL can support either passing a value with a generic argument (field={Units.UNIT_ID}) or pointing the value at a specific field in the Survey123 form (field:room={Units.Name}).

In addition, multiple arguments can be listed together, and you can add text between them.

Example

https://<MySurveyURL>?Name={knownas}&office=office%3A%20{units.NAME}&loc={shape.x},{shape.y},{shape.z}

Integration with ArcGIS Survey123

ArcGIS Survey123 can be accessed by certain user types. Launch actions can be configured to use Survey123 in the absence of other supported worker order or ticketing systems.

To customize the experience of the action button with Survey123, append a valid argument or value pairs to the URL.

When you create a survey in your ArcGIS Online organization, the URL to share the survey is shortened by default. To enable launch actions, you must use the full URL when appending arguments and pairs.

To get the full URL for an existing survey, complete the following steps:

1. In Survey123, click the My Surveys tab and click the survey for which you want to create a launch action.
2. Click the Collaborate tab and click Share survey.
3. Copy the shortened URL into a browser, and load the survey.

   The full URL appears in the address bar.

4. Copy the full URL from the address bar.

You can append arguments and pairs to this URL as necessary when configuring launch actions.

Example: Base URL for default behavior

https://survey123.arcgis.com/share/surveyformGUID?portalUrl=https://myportal.myorg.com/portal

Example: Custom

This example overrides the default room input with the name field from the Units layer.

https://survey123.arcgis.com/share/surveyformGUID?portalUrl=https://myportal.myorg.com/portal&field:room={Units.NAME}

Example: Launch the Survey123 native app on mobile devices

arcgis-survey123://?itemID=surveyformGUID&portalUrl=https://myportal.myorg.com/portal&field:comments={Units.NAME}

Note:

When using URLs specific to native mobile apps and configuring launch actions for use in Viewer, the URLs are not supported for desktop users. Only use a native app's URL when defining launch actions for workflows that support the native Indoors apps or Viewer accessed from a mobile browser.

Integration with third-party systems

You can also configure the action button to open a third-party URL and pass attribute values to it, provided that the third-party system supports URL configurable forms or parameters that cause actions upon launch. Use a URL that calls the system in the Indoors app configuration with an appropriate URL for the integrated system. Common uses include linking to third-party work order management systems or asset management systems.

Consider the following when working with third-party systems:

• The field: operator may be different.
• Web forms that support URL arguments may require additional configuration.
• Consult the integrated system vendor for details on whether and how this works.

Note:

Depending on the business system being used, some characters may not be supported, such as the # or + characters.

Integration with work order management systems

Indoors supports launching external asset and work order management systems. The action button on the info panel Viewer and info card in Indoors mobile apps can be configured to open either a web form or third-party native app. The form or third-party app can be used to record new information such as incidents or requests associated with a space, asset, or other item in Indoors or open an existing work order in a third-party work order management app.

Indoors supports passing work order and Indoors layer attributes as a query string in the URL. The syntax must follow the URL/URI schema for Indoors and work order app system to support launch actions.

The attribute value must be enclosed in curly brackets and match the following syntax:

?arg={Work order Attribute}&arg={Layer.Attribute}

Additional syntax samples are provided below.

Single value from work order layer

?arg={workorderid}

Multiple values from work order layer

?arg={workorderid}&arg={priority}

Value from work order and Indoors layer

?arg={workorderid}&arg={Layer.Attribute}

ServiceNow URL

The following sample passes the work order number as a parameter and opens an existing work order:

https://<MyServerURL>/nav_to.do?uri=task.do?sysparm_query=number={workorderid}

Review more examples that involve configuring launch actions for ServiceNow.