What is a scope?
A scope is a filter which applies to a collection and all its segments.
It is useful in that it can be used to control what data is available to users. More specifically, scopes can be set up to filter data dynamically on the current user.
Scopes are applied to the entire application excluding global smart actions, API & SQL charts and Collaboration & Activities.
Using a dynamic scope
Imagine a situation where you have several Operations teams each specialized in a specific country’s operations:
- France team handles customers from France
- Germany team handles customers from Germany
- …
By scoping the collection on $currentUser.team.name, Marc who belongs to the France team will only see customers from France, while Louis who belongs to the Germany team will only see customers from Germany.
Dynamic variables
In the example above, we used the team name to filter out what the user sees: $currentUser.team.name
Here the exhaustive list of available dynamic variables:
| Syntax | Result |
|---|
$currentUser.id | The id of the current user |
$currentUser.firstName | The first name of the current user |
$currentUser.lastName | The last name of the current user |
$currentUser.fullName | The full name of the current user |
$currentUser.email | The email of the current user |
$currentUser.team.id | The id of the team of the current user |
$currentUser.team.name | The name of the team of the current user |
$currentUser.tags.your-tag | The value associated with key your-tag for the current user, if any. |
$currentUser.tags.your-tag dynamic variable.
