Dimensions

Contents

• Overview
• Default Dimensions
• Creating New Dimensions

Overview

Dimension fields are used to classify your users' demographic information, and to segment users in the applicable for more robust reporting and targeting when launching surveys. In addition to the default dimensions, organizations can create their own custom dimensions. 

Default Dimensions

The Betterworks Engage application comes with default dimensions that provide the most essential information about users. These dimensions cannot be altered, or removed. This provides uniformity and a baseline for your users' information.

These dimensions are:

• Email ID (email address)
• First Name
• Last Name
• Role
• Status
• Insights Access
• Mobile (phone number)
• Locale
• Manager
• Manager Email
• Hire Date
• Termination Date

The following chart will show many of the default dimensions, as well as the corresponding dimension key. The dimension key is the column header that must be used in your user data files

Note: We highly recommend including as much information as possible for your users. This will ensure much more granular reporting and audience creation options for your surveys.

Dimension Name	Dimension Key	Required	Additional Info.
Email ID (email address)	email	Yes	The user's work email address. Typically, the email address ends in @yourorganizationname.com. The application can also accept email addresses that have a domain outside of your work organization. However, it's essential to have email addresses linked to your users. That is how they will log into the application (if granted access) and receive notifications about polls and/or surveys.  If a user doesn't have an email address, an admin can simply enter a placeholder (i.e. [e-mail]).
First Name	first_name	No	The user's first name.
Last Name	last_name	No	The user's surname.
Employee ID	employee_id	No	The user's employee ID number.
Mobile Number	mobile	No	The user's mobile phone number. This phone number is used to send text notifications for polls and/or surveys.  Be sure to include the country code. Also, to avoid the phone number from being converted into a formula, add a leading apostrophe (i.e. a US mobile phone number of [phone] should be entered as '[phone]).
Locale	locale	No	Locale is used to present survey questions in a user's preferred language (if multi-language surveys have been enabled). At this time, only survey questions will be presented in the designated language. Languages that we support for survey questions, and their corresponding locale values, are listed in the Betterworks Engage Toolkit (see "Languages" tab). The remainder of the on-screen text will be displayed in English unless the user employs a third-party application in their internet browser (i.e. Google Translate). The exception is French which Betterworks Engage supports fully. Refer to the aforementioned Betterworks Engage Toolkit for the list of French locale values (i.e. French - Canada is fr_ca). If the user's preferred language is English, this dimension can be left blank.
Manager	manager_email	No	The user's manager.  Adding data into this dimension automatically includes their manager in the survey reporting, providing more granular feedback.  If a user is the CEO, this field can be left blank.
Status	status	No	There are three options: candidate - Eligible for candidate and pre-hire specific surveys only. These users aren't official employees yet. employee - Currently employed user at your organization. terminated - Users who are no longer with the organization. Alumni survey audiences would be populated with this type of user. Leaving this field blank will default the user status to employee.
Role	roles	No	Roles define access rights to reporting and other administrative areas within the Betterworks Engage application (referred to as "Engage Insights Access"). It is crucial to set up the proper roles and access rights for each type of user. Built-in roles within the application include user, manager, admin, and superadmin. These are all customizable and additional roles can also be created.  user - The most basic level role. This typically doesn't have Engage Insights Access, to ensure users do not see the survey or poll reporting. manager - Can view survey reporting for direct reports, but can't upload users, change permissions, and so forth. admin - Can view more in-depth reporting, and set up users. superadmin - Has access to all reporting, can view all users, and edit them, and set permissions for each role. Leaving this value blank will default to user. For more detailed information, see this Support article.
Engage Insights Access	engage_insights_access	No	When set to "True," this will give the user access to Engage Insights and reporting. admin/superadmin users likely need this to be enabled. By default, this is set to "false" for users.
Hire Date	hire_date	No	The user's hire date (YYYY-MM-DD). This dimension is required when calculating eligibility criteria for onboarding/new hire surveys, and tenure.
Termination Date	end_employment_date	No	The user's termination date (YYYY-MMM-DD). This dimension is important to ensure any recently terminated employees will not be able to participate in any open/in-progress polls and/or surveys. It is also used to determine eligibility criteria for offboarding/exit surveys, and alumni surveys.

 

Creating New Dimensions

In addition to the default dimensions, users can create their own custom dimensions and assign them to users. To do this:

1. Go to “User Management."

2. Click "Edit Dimensions."

3. Scroll to the very bottom, where you'll see a blank text field as shown below.

4. It is within this text box that you can enter any custom dimension name of your choice. Once you enter it, click "Add." You will also have to enter the Dimension Key value for that name.

The dimension is the column header that must be used in your user data files.

Note: dimension keys must be all lowercase, and cannot have any spaces.