Gravatar for thandava_alapati@dellteam.com

Question by Thandava Phani Kumar, Feb 10, 2018 3:39 AM

​Can we create user-defined dimensions if yes, How can we create user-defined dimensions?

Can we create user-defined dimensions if yes, How can we create user-defined dimensions?

2 Replies
Gravatar for erocheleau@coveo.com

Answer by Etienne, Feb 10, 2018 5:09 AM

Here is how you can create custom dimensions:

https://onlinehelp.coveo.com/en/cloud/managing_dimensions_on_custom_metadata.htm

Gravatar for fcote@coveo.com

Answer by fcote, Feb 12, 2018 1:56 PM

Hi Thandava,

To complement the answer above, here some additional information in the context of the intermediate analytics class:

In short, you need a developer that will create the Dimension on your Search Interface (Front-End) first. Then, you need to declare it in the Platform in order for that Dimension to be used in reports.

Let's see more about this.

First, let's review the flow that an Event follow from your Search Interface to an Report.

1 - From the Search Interface to the Cloud Platform

1.1 When an user performs an Search or Click action on a OTB Coveo Search Interrface, this will generate an Event.

1.2 That Event is composed of Dimensions.

1.3 The Search Interface will automatically populated these Dimensions with values, based on the Visitor.

2 - [Inside the Cloud Platform]

2.1 The Event arrives in the Cloud Platform

2.2 The Event is stored inside the Usage Analytics Database

2.3 The Event represent a row in that Database

2.4 Each of the Dimensions of that Event represent a column

At this point, the Event and all of its Dimensions are inside the Usage Analytics Database.

However, it's not because a Dimension is inside the Usage Analytics Database that it's available in reports.

For a Dimension to be usable in Reports & Filters, it must be declared in the Admin Console > Dimension panel.

Now, let's talk about User-Defined vs System Dimensions.

System Dimensions are automatically generated for some user action when:

  • Your Search Interface (Front-End) is built using the Coveo JavaScript framework
  • That Search Interface is linked with a Coveo Cloud Organization

In addition, System Dimensions are already declared in the Platform. You don't have to configure them yourself.

For User-Defined Dimensions, you need to proceed as follow:

  1. One of your Developer has programmatically add your new Dimensions in your Search Interface (Front-End)
  2. Make sure that the Dimension is correctly sent to the Coveo Platform (easy to validate with Chrome Developer tools)
  3. Use the Admin Console > Dimension panel to add the Dimension to the Platform, making it usable in your Reports-Filters

Gravatar for thandava_alapati@dellteam.com

Comment by Thandava Phani Kumar, Feb 14, 2018 3:31 AM

Thank you Frederic

Ask a question