Context Key Reference

Here are descriptions of how to use variables with a context type to perform an action when the mobile user taps a certain button.

Action Type Context

Here is a list of context types that are used for the action key.

An example of the action type in the JSON format:

{
   "type": "execute",
   "action": "$Tabs.update"
}

$Class

This context type is applied in the case of integration with the CG Cloud solution.
Variable Versions Data Type Description

$Class.generateCGCloudTasks

v1

–

To generate records from the current Visit record using the CG Cloud features.

For more information, go to CG Cloud.

$System

Variable Versions Data Type Description

$System.recordSync.run

v1

–

To run the quick record synchronization.

$Tabs

Variable Versions Data Type Description

$Tabs.update

v1

–

Update tabs to display based on the conditions. For example, the next tab appearance depends on the entered value in the specific field on the current tab.

$Tabs.close

v1

–

Close the CT Layouts if all the validations are being passed.

Data Type Context

Here is a list of context types that are used for the value key. The field key contains the API name of the field to fill out with the value.

An example of the action type in the JSON format:

{
   "type": "setValue",
   "field": "ActualStartGeolocation__c",
   "value": "$System.GeoCoordinates"
}

$System

Variable Versions Data Type Description

$System.geoCoordinates

v1

Geolocation

To write the current user geolocation in the specified field in the field key.

$System.date

v1

Date

To write the current date in the specified field in the field key.

$System.dateTime

v1

Date/Time

To write the current date and time in the specified field in the field key.

$Tabs

Variable Versions Data Type Description

$Tabs.current.isFirst

v1

Boolean

Return true if the current tab is the first of the displayed tabs.

$Tabs.current.isLast

v1

Boolean

Return true if the current tab is the last of the displayed tabs.

$Tabs.first.statusValue

v1

String

The value of statusValue attribute of the first tab of displayed tabs.

$Tabs.last.statusValue

v1

String

The value of statusValue attribute of the last tab of displayed tabs.

$Tabs.next.statusValue

v1

String

The value of statusValue attribute of the next tab of displayed tabs or of the current tab if current tab the last shown tab.

If the displayed tabs are changed (for example, the action $Tabs.update has been performed) and the current tab is removed from the list of displayed tabs, then define the absolute position of the current tab from the list of tabs (JSON.tabs):

  • If at least one of the next tabs (in absolute position from JSON.tabs) is displayed then the value of the statusValue attribute of the closest one.

  • If none of the next tabs (in absolute position from JSON.tabs) are displayed then the value of the statusValue attribute of the last displayed tab.

$Tabs.previous.statusValue

v1

String

The value of statusValue attribute of the previous tab of displayed tabs or of the current tab if current tab the first shown tab.

If the displayed tabs are changed (for example, the action $Tabs.update has been performed) and the current tab is removed from the list of displayed tabs, then define the absolute position of the current tab from the list of tabs (JSON.tabs):

  • If at least one of the previous tabs (in absolute position from JSON.tabs) is displayed then the value of the statusValue attribute of the closest one.

  • If none of the previous tabs (in absolute position from JSON.tabs) are displayed then the value of the statusValue attribute of the last displayed tab.

$Tabs.current.statusCategory

v1

String

Return the status group of the status assigned to the current tab.

$Tabs.next.statusCategory

v1

String

Return the status group of the status assigned to the tab next to the current tab.

Navigate Type Context

Here is a list of context types that are used for the destination key.

An example of the action type in the JSON format:

{
   "type": "navigate",
   "destination": "$Tabs.next"
}

$Tabs

Variable Versions Data Type Description

$Tabs.first

v1

–

Navigate a mobile user to the first tab of the displayed tabs.

$Tabs.last

v1

–

Navigate a mobile user to the last tab of the displayed tabs.

$Tabs.next

v1

–

Navigate a mobile user to the next tab of the displayed tabs.

$Tabs.previous

v1

–

Navigate a mobile user to the previous tab of the displayed tabs.
``