Data References

Prev Next

When defining an action in App Manager, you can use a special template syntax to populate values from the context of the action.

NOTE: Data references are available in menu and action definitions created in App Manager. They are not supported elsewhere at this time.

For instance, you can use this template syntax to pre-fill a form’s fields with user data on which the action is performed:

App Manager actions page showing prefilled form values

At runtime, the app will replace the template with the actual values.

IMPORTANT: Attempting to access an invalid field name will result in an error.

In addition to accessing properties of a user, you can also access properties of the load and stop.

Depending on where an action is used, different context values are available. For example, an action at the load level cannot access properties of the stop, because a load has multiple stops, and it’s not clear which stop’s properties should be substituted. Valid field names that have null values will be replaced by the empty string.

The available properties are listed in the tables below:

User Property

Value

user.full_name

The proper full name of the user.

user.username

The username of the user.

user.api_token

The token used to identify and authenticate the user in future API calls to web services.

user.web_token

The token used to identify and authenticate the user for browser menu items and actions when the protocol of the url property is HTTPS.

user.custom.*

Fields from the custom data returned in the most recent authentication response. For example, if you define custom as {"fleet": "dryvan"}, the data reference  {{user.custom.fleet}} will be replaced with dryvan at runtime.

Load Property

Value

load.id

The unique and stable identifier for the load.

load.order_number

The Order/Load number.

Stop Property

Value

stop.stop_number

The number used to specify the order of the specific stop.

Resources

API