Zephr User Guide

User Attributes

166 views 0

In Zephr, the User Attributes area sets the series of fields you capture against your customers. These fields become the building blocks of your registration forms and paywalls.

User Attributes are used in a lot of places. On a user’s Identity page, you will see the information that they have provided against those fields. In registration and data capture forms your User Attributes are available as fields to add to your form, and within rules, User Attributes can be used to segment users based upon the information they have provided you.

With this in mind, setting up your User Attributes is one of the first tasks you’ll do when you start using Zephr.

Default Fields

Before adding your own User Attributes, it’s important to know that some information is stored by Zephr, by default, so you won’t need to add certain fields as user attributes.

By default, Zephr stores a user’s email address, username, password, and registration date, along with a unique user ID (the Zephr ID), and a tracking ID. As such, none of these fields need to be added as user attributes. Instead, add any additional information you wish to store, such as First and Last Name, Country, Job Title, or Favourite Colour.

Adding User Attributes

Navigate to the Identity Module of your Zephr Admin Console, then click User Attributes.

Here you will find your User Attributes screen, which details the User Attributes you have set up as data points to store against your users.

List of Existing User Attributes

Click the Add A User Attribute button. Here you can set the details for your new User Attribute.

Give your User Attribute a Label, then select the type of field from the dropdown list.

If you select a multi-choice HTML field type from the drop-down list, such as Select, you’ll automatically be presented with the option to create input fields to populate the selection. This is done by choosing Add an Option.

Adding a Selectlist Option

Other optional fields include Internal Description to provide an internal reference for administrators and Public Description to explain a field in more detail for front-end users.

Choose if the field is mandatory by ticking the Mandatory Field checkbox.

Note: When considering if a User Attribute should be a Mandatory Field, remember Mandatory Fields need to be provided in ALL cases where a User is being created, whether that’s by the end-user on your website, via API, or via manual entry in the Zephr Identity area.

If it is mandatory, you’ll need to ensure the field is available on all public Registration Forms. If there are instances where you will not want users to provide this information, we recommend you leave this unchecked. When unchecked, you may still choose to make it required for end-users, by ticking the Required box on your forms.

Once you’ve entered the relevant details, click Save, or click the arrow next to Save and choose the Save & Add Another option.

Creating a User Attribute

Once you’ve added you User Attributes, navigate to Identity > Users and click into a User Profile or, if you don’t have any users yet, click Add New User. Here you’ll see the fields you created ready to have data stored against them.

Editing User Attributes

To edit a User Attribute, navigate to the Identity Module in your Zephr Admin Console, then click User Attributes. Locate the Attribute you wish to alter and click the Edit button.

Make the appropriate changes to your User Attribute, then click Save.

Note: When using multi-choice fields, such as selectlists, removing an Option will, in turn, remove the data store for Users who have chosen this option previously.

Deleting User Attributes

To delete a User Attribute, navigate to the Identity Module in your Zephr Admin Console, then click User Attributes. From your list of User Attributes, locate the Attribute you wish to alter and click the Delete button.

Once you confirm the deletion of the field, data stored for current users within this field will be deleted and the field will be removed from your users’ Identity pages, and in any forms it was used in.

Reordering your User Attributes

The order of the User Attributes determines the order in which you see this information on an individual user profile and within the broader user list.

To reorder your User Attributes, navigate to the Identity Module, then click User Attributes. Use the drag & drop option to the left of each field name to reorder as required.

These changes will be reflected in both an individual user’s profile, and on the user list (with the two highest User Attributes being displayed next to the email address).