Scopes
Last updated
Please be sure of your agent type and version and pick the right documentation accordingly.
This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.
forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by v1.
Please check your agent type and version and read on or switch to the right documentation.
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.
To access the scope management page for a given collection, you'll need to using the Layout editor mode.
Once on the Scopes tab (1), you can set up your filter (2) and save (3). In the above screenshot, only customers with an email ending with @forestadmin.com will be displayed in the collection and all of its segments. All other customers won't be accessible.
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
...
If you set up the following scope...
...then Marc who belongs to the France team will only see customers from France. However, 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:
Using user tags
The above example is only possible if your data matches your users' details (email, team, etc). It's likely that it won't always be the case. This is why we've introduced user tags:
Using the above scope, the above user would see 1, 2 but not 3:
User tags are and allow you to freely associate your users to a value which will match against your data using the $currentUser.tags.your-tag dynamic variable:
$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.
