A User Property associates an attribute with an individual user. For example, an agent can retrieve information on tickets that have been assigned to them by using the user.emailAddress to search for ticket information linked to their email address in the data source.
User Properties are used like any other variable, except they are not set by a User Input Control Klip. Instead, User Properties are set by an admin and are active from the moment the user logs in to their dashboard. Like a variable, they can be used in a dynamic data source query or to filter the data displayed in a Klip.
To view or add User Properties, you must be signed into the account as an administrator or as a User with an appropriate custom role.
There are four built-in user properties in Klipfolio:
- user.emailAddress
- user.firstName
- user.lastName
- user.isAdmin
Each of the above properties replaces the variable with the relevant user information when applied.
Note: If you create a new user property for a Klip and then add the Klip to a dashboard that was previously shared via a published link, the new property won’t be recognized and the Klips in the shared dashboard will be blank. In this case, you need to delete the old link to the dashboard and send a new link to people you want to share it with. Learn more here.
Custom User Properties
You can create your own custom User Properties to populate users’ Klips with unique data based on a variable you create. For example, you can create a “department” user property to ensure that employees only view data that is categorized for their specific department. In this scenario, an employee in Customer Support will only view data associated with support, while an employee in Marketing will only see data related to marketing.
To add a custom User Property:
- Click Users in the left navigation sidebar.
If you don’t see the above option, click the button in the left navigation sidebar and select Users.
- Click a user's name, then click Properties. The four built-in User Properties and any other previously defined custom User Properties are listed.
- Click Add New User Property and fill in the Property Name and the User's Value.
Note: User Properties are case sensitive; the property name must have the same spelling and capitalization each time it is entered. - Click Create Property.
The new User Property displays in the list of Properties for each and every user but the User's Value is set on an individual basis.
Watch the video below to see an example of how to use custom User Properties.
To learn more about how user properties and other types of variables work, see Variables.