Skip to main content
Developers portal

What can we help you with?

Configuration of attributes and segments

Kristiana
  • Updated

This article will focus on creating and editing the attribute structure. For information on how to move employees around attributes, please refer to Updating an employee record.

In this article you will find:

How to create an attribute

Attributes need to be created prior to uploading employee data in order for the segments to be created automatically.

  1. Go to Administration > Attributes 
  2. Click on the Add attribute button
  3. Give the attribute a Name and choose Attribute type (see Introduction to attributes and segments for more on attribute types)
  4. Review the Data access section, if needed (related resources: About editable attributes and how they work and Restricting access to attributes and segments)
  5. Review the Advanced setting tab, if needed
  6. Click on Save changes to save the attribute

Find below a list of the different attribute configuration options, their use cases and considerations. 

Option Use case Considerations
Employee consent (Add-on) For customers using the Peakon Include add-on, it is recommended to always use the employee consent setting when collecting sensitive personal data through employee editable attributes. 
  • An attribute that has been marked as requiring consent requiring cannot have the consent requirement setting revoked, to ensure this data is protected at all times.
  • It is not possible to add employee consent to an attribute that already exists, so this needs to be set when creating the attribute.
  • By default, the attribute is restricted both on the dashboard and employee record. If needed, administrators can grant access to restricted attributes via access control groups.
Data access to employee attributes or segment scores

Restricting an attribute controls whether an attribute or a segment is available to view in the heat map or edit on the employee record. 

When creating the attribute, Peakon Include customers can lock this setting by preventing further changes to the restricted status. This is relevant for sensitive attributes, to ensure that the restriction settings cannot be reversed.
  • Users who do not have access to view restricted attributes will still be able to view a segment of a restricted attribute if they have been set as the manager of that segment, or if the segment is a child segment of a segment they have been set as the manager of.
Targeted data collection (Add-on)

Targeted data collection allows clients using the Peakon Include add-on to use editable attributes on the same schedule, while ensuring that only a part of that schedule's employees are presented with the editable attributes option. See Configuration of editable attributes for more. 

 - 
Name and description localization

It is possible to manually add translations for attributes and segments in all dashboard languages. This means that users viewing their dashboard in a specific language will see a localized version of the attribute names.

 

If this is an employee editable attribute, it is also possible to edit the Description localization in all survey languages, which can be used to explain the meaning of the attribute to the employee. This means that when the employee opens their survey and sees the attribute options, they will be able to get additional context by looking at the attribute description.
  • All employee data will have to be imported in the default language, not in the translated language. Uploading employee data in the translated language will create new segments.
  • Translations can only be added to segments of an option type or a combination type attribute. Translations can be added to any type of attribute, but segment translations are not possible for number, employee or date attributes.
  • Translations can only be manually added to the attributes page of the dashboard. It is not possible to add translations through data uploads.
Alias

Used for importing employee data via the file upload method. Adding an alias to an attribute will allow the system to match attributes on Peakon and your data file, even when the names are not the same. It is possible to add multiple aliases by inputting a comma-separated list.

For example, if your attribute name on Peakon is “Start date” and on your data sheet the column for this attribute is called “Employed since”, you can add "Employed since" as an alias on the attribute. This will automatically map the "Employed since" attribute to the "Start date" attribute.

 -
Segment branding

Segment branding is available on the option type attribute and is used for complex organisations, where specific segments should see their own unique logo and company name on the survey and emails. This is ideal for entity branding. If turned on, it’s possible to preview the survey as a specific segment which will allow you to see the logo and segment name being used on the survey and questions.
Automatic creation of segments

This setting allows you to choose whether new segments should be created automatically from an employee upload.

By failing a data upload that doesn’t include the exact naming convention under an attribute that grants access control, the user will be advised that they need to make changes to their data sheet and choose one of the existing segments.
  • It is recommended to use this setting on attributes which are linked to access control groups, in cases where local administrators use segmentation to grant access to users.

How to create a segment

Once the attributes (ie. the 'categories') have been created, it’s possible to add segments (ie. the 'options') to the attributes.

  • For option, date, and number type attributes, this can be done manually.
  • For employee type attributes, this is done by populating employee records, which will then automatically create segments based on the reporting lines.
  • Finally, segments belonging to a combination attribute are created automatically upon creation, as a combination attribute is made up of two option type attributes. 

Manually adding segments

Option type

  1. Go to Administration, then Attributes
  2. Click on the attribute you wish to add segments to
  3. Click Add segment within that attribute
  4. Type the segment name into the field
  5. Click Add to confirm

Date or number type

  1. Go to Administration, then Attributes
  2. Click on the attribute you wish to add segments to
  3. Click Edit attribute 
  4. Expand the Ranges section
  5. Set the ranges, as needed
  6. Click Save changes to confirm

Adding segments via a file upload

When importing employee records via the file import method, segments will automatically be created if there is a column present in the file where the column header matches exactly the attribute name on Peakon (this is case sensitive).

If using the alias function on the attribute, the column header can also match one of the aliases given.

Segments will be created for each unique value found in the attribute column on the file.

Additional segment options

To edit a segment:

  1. Navigate to Administration > Attributes
  2. Find the attribute that contains the segment you wish to edit
  3. Locate the segment and click the Edit attribute button to open the slide-in panel
  4. Make the edits and click Save changes

Find below a list of the different additional configuration options, their use cases, and considerations. 

Option Use case Considerations
Status This option is used to deactivate attributes that are not in use. This will remove the attribute from employee profiles. The attribute can be reactivated at any time.
  • The associated segments with aggregated data will still remain on the dashboard and heat map as long as the visibility window permits.
Name and description

Renaming an existing segment can be used when a team changes name, for example. This should be done prior to the next data upload, so that an exact name can be found, and to avoid a duplicate segment being created.
  • The new segment name will become visible to everyone immediately.
Name and description localization

It is possible to manually add translations for segments in all dashboard languages. This means that users viewing their dashboard in a specific language will see a localized version of the segment names.

 

If this is an employee editable attribute, it is also possible to edit the Description localization in all survey languages, which can be used to explain the meaning of the segment to the employee. This means that when the employee opens their survey and sees the segment options, they will be able to get additional context by looking at the segment description.
  • All employee data will have to be imported in the default language, not in the translated language. Uploading employee data in the translated language will create new segments.
  • Translations can be added to segments of an option type or a combination attribute, but they are not possible for number, employee, or date attributes.
  • Translations can only be manually added to the attributes page of the dashboard. It is not possible to add translations through data uploads.
Dashboard access

Similar to restricting an attribute, it's possible to restrict dashboard access to a specific segment. For example, if the HR team has company-wide access to the account, but should not see their own team's results, the HR segment within the Department attribute could be restricted.
  • Users who do not have access to view restricted attributes will still be able to view a segment of a restricted attribute if they have been set as the manager of that segment, or if the segment is a child segment of a segment they have been set as the manager of
Segment logo When segment branding is enabled logos can be added to branded segments, which will be shown instead of company branding on the first page of the survey and in all survey-related emails.
  • For Premier clients, this can be used in conjunction with survey branding

 

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk