Messaging Keys and Parameters

The following keys are currently supported. All of the keys listed can be used in conjunction with all others, and they may be specified in any order.

IMPORTANT: The wltoopen key, in addition to the wr and markuptypeid parameters used to specify the wl key, are supported on iPad and Android only.

Key name	Value type	Description
`lat`	float, up to 3 decimal places	The latitude and longitude of the GPS coordinates to which ArcFM Mobile zooms upon launch, expressed in decimal degrees. If either `lat` or `long` is specified, then the other value in the pair must also be specified.
`long`	float, up to 3 decimal places
`scale`	integer	The scale at which ArcFM Mobile zooms upon launch. For example, a value of 3000 sets the scale to 3,000:1. The scale key may only be used if lat and long are also specified.
`basemap`	string	The name of the basemap accessible by the user.
`operationalMap`	string	The name of the operational map accessible by the user.
`bringToFront`	Boolean	Specifies ArcFM Mobile’s focus behavior. If true, ArcFM Mobile comes to the foreground when the command is executed. If false and the app is already running, ArcFM Mobile does not come to the foreground. If this value is not included, the app’s default focus behavior applies. Note that the `bringToFront` parameter only applies to the Windows version of ArcFM Mobile. In certain situations, Windows may not bring the app into focus even if this parameter is set to true.
`includeCurrentLocation`	Boolean	Indicates whether to include a user’s current GPS location on the map, if their device can provide it.
`wl`	compound	Places a work location graphic in the map and focuses the map at the given coordinates. It can optionally include a label, be associated with specific markup types, and be associated with an existing as-builting job. Multiple work locations can be included in a single command. See Work Location (`wl`) Key for full usage details.
`wltoopen`	compound	Automatically opens a markup job at a work location graphic included in the same command so that the user needn’t tap on the work location to start a markup job there. See Work Location to Open (`wltoopen`) Key for full usage details.
`workrequestid`	compound	Opens an as-builting job that is assigned to the user. See Work Request ID (`workrequestid`) Key for full usage details.
`assignmenttitle`	string	Attempts to find an assignment by its title (`assignmenttitle`) or by its ID (`assignmentid`) and then open it. These two parameters have a very similar effect to Work Request ID and Design ID—their purpose is to open an assignment. If more than one of these parameters is provided, the order of precedence is as follows: Work Request ID and/or Design ID are found — try to open the assignment that is associated with either of these Designer-related IDs. Assignment ID — try to open an assignment with the specified ID. Assignment Title — try to open the first assignment with the specified title. If a parameter is present, but the assignment can’t be found, an error is thrown. However, note that a fallback parameter is not checked for validity. For example, if the work request ID and the assignment ID are provided, and the work request ID is incorrect, an error is thrown without checking the assignment ID for validity. TIP: More information on workflow assignments, including how to find an assignment’s `assignmenttitle` or `assignmentid` can be found in the migration to dynamic workflows documentation in the Solution Center Configuration Guide.
`assignmentid`	string