Using Orbita Insights, you can monitor and visualize not only the pre built data but also the custom properties that you created in the Experience Designer.

This document briefs you on how to create custom properties and use them to visualize in Insights.

Data Collection

As a Voice Experience Developer you can extend the scheme fields under the msg.analytics.attributes.<your_custom_property_name>

var _ = global.get('lodash');
var  tv_series=  ['Bones', 'Psych', 'Big Bang Theory', 'Mad Men', 'Breaking Bad', 'Modern Family', 'Game of Thrones', 'Dexter'];

rndnum = Math.floor(Math.random() * 8);

node.warn(tv_series)
node.warn(rndnum)

msg.analytics.attributes = {
    'str': `this is a string`, 
    'const': 2,
    'bool': true,
    'mycontextData': {
        // 'name': `name_${_.sample(tv_series)}`,
        'series_name': tv_series[rndnum],
        'value': `value__${_.sample(tv_series)}`
    },
};
return msg;

for every agent, there will be a separate schema.

for every agent type(flow, answer), 3 properties are available. id, name, contextData.

Context data will have more properties such as state, faq, and so on.

To address the backward compatibility, some of the data is duplicated.

These new fields are not visible in the visualization.

To get the new fields, you have to click on the Refresh button.

When a new field is added, the insights author should refresh the shcema.

Under context data, the fields are not supposed to change. If they want to change anything here, send a mail to support@orbita.ai

Attributes

Name space key is introduced so that the admin user can have their own data.

You can have your own unique names for the property names. msg.analytics.attributes.{uniqueKeyNames}

Admin should make sure that there are no conflicts with the names in the other projects.

We recommend 3 top level keys l be well structured data

going forward, we will reserve the top level name space keys for easier access.

It is recommended to have 5 branches at the maximum.

Indexed data will be kept only for 3 months. rest will be archived.

The data type values should not be different. When the same field name is used, it will work as if it has the same data type.

Data types

String (recommended), integer, boolean.

Donot use arrays

Engage Dashboard enable by default.

In insights, voiceagent.response.platformAgent.<agent_type>.contextData.<custom_field>

Data Visualization