In UserGuiding, segmentation means to divide end-users into groups, or segments. Later on, each group you've created can be matched with a specific guide or a hotspot.

By this way, you can set the right coupling in which your guide appears before its right spectator.  

For instance, when you create a guide to welcome people who've just signed in to your platform, its match should be "the new users segment". People who're already familiar to your platform, don't need to see this guide.

When you need to create a segment only specific to your web platform, you need to create an attribute first. Custom attributes are basically segmentation properties that you define yourself.

Let's say we have a webpage in which end-users are separated into two groups as clients and administrators. And we have two different guides, each of which is a specific product tour for its user group/segment.

Client Guide is for  Clients to see.
Administrators Guide is for  Administrators to see.

  • Here,  first, we're going to create two custom attributes for clients and administrators. 

  • Second, we're going to create two user segments by using the attributes we've created. 

  • Finally, we're going to designate each segment to its relevant guide.

*Usage of the Custom Attribute feature requires experience over coding. It is recommended to ask the help of a developer.

  1. Find segmentation in UserGuiding Panel and and select Custom Attributes tab. Then click + NEW ATTRIBUTE button.

  2. Create attributes both for the client and the administrator.

Client custom attribute

In the above image, the ‘client' is the key field in your event layer and we call it identifier of the custom attribute, which is the variable name.

Data format could be Text, Number, Boolean or Date. We have chosen Boolean.

Here, we've chosen UserGuiding as the data source. 

Administrator custom attribute

   3. Now, switch to the Segmentation tab and create two segments by using these two attributes that'll show up on the dropdown menu of properties.

For Client segment, we choose ‘client’ as the custom attribute.

For Administrator segment, we choose the 'administrator' custom attribute.

   4. Now, it's time to match our guides, which we've already created, with their segments. 

The assumption here is that you've already set a container to the guides and activated them.  

In the guides page,  find the Client guide, go to its setting page via the gear icon on the right side of the row. Then, follow the same steps for the Administrator guide.

Then, find the Segmentation section and select the "Custom Segmentation" option. 

For the Client guide, select the "Client  Segment".

For the Administrator guide, select the "Administrator Segment".

   5. Save your action and click on green PUBLISH CHANGES button from the header section.

   6. Now, it is time to set the codes that belong to the custom attributes with respect to user types in our web application. 

We can see the code of an attribute in Segmentation > Custom Attributes tab by clicking on the code icon on the right side of its row. 

   7. Let’s copy the code below and insert it into our application (A developer can decide on the snippet's location).

   8. We need change the code with respect to the user type.

If a client visits our application, the following snippet is executed in our code.

And, s/he sees the Client guide.

If an administrator visits our application, the following snippet is executed in our code. 

Then, the s/he sees the Administrator guide.

Related Articles:
Creating Custom Attributes
Custom Attribute Data Sources

Did this answer your question?