Using contextual Data Sets

Modified on Wed, 15 Jan at 4:06 AM

Contextual Data Sets in your App provide contextual information about the App User, Workspace, and CafeX Platform.

App Studio provides the following contextual Data Sets:

System Data Sets: Provide your App with the information about the App itself.
User Data Sets: Provide your App with data about the current User.
Workspace Field Data Set: Provide your App with custom data defined by your App, typically provided at the time of Workspace creation.

You can reference the values of contextual Data Sets like any other Data Set, using mustaches in expression fields.

Using the System Data Set

Your App can make use of System Data sets that provide your App with critical metadata about its environment.
The following data is available using the System Data Sets:

Data Set	Description
appId	A UUID for your App within your tenant. Use this when you have multiple Apps that share common resources and require distinction.
workspaceId	A UUID for the Workspace. Use this when you have an App that creates multiple Workspaces that you need to distinguish.
viewId	A UUID for the custom view within the Workspace.

Using the User Data Set

The User Data Set provides contextual information about the current User interacting with your App.
The following data is available using the User Data Set:

Data Set field	Description
user.avatar	The User's default avatar or profile image.
user.displayName	The display name of the User, as found in their profile.
user.email	The User's email address.
user.id	A UUID for the User.
user.initials	The User's initials.
user.tenantId	A UUID for the User's Tenant. Useful for cross-tenant applications that may use this to manage users.

Using Workspace Fields Data Set

Workspace fields store simple data and metadata required by your Apps. Generally, these fields store data that is necessary for your App to load at the time of Workspace creation. These fields remain available for the entire lifetime of a Workspace, but they are primarily used to store the attributes provided by the Workspace Creation Service.

All of your Workspace Fields can be found within a single Data Set with the name: workspaceLabels. To reference these fields in an expression field, use mustaches. For example, to reference a Workspace Field with the name exampleField, you provide the following mustache:

{{workspaceLabels.exampleField}}