Configuration Guide (v2022.3.1.0)

Created by Vijendra Sawant, Modified on Tue, 30 May 2023 at 07:11 PM by Vijendra Sawant


 

 

  

Configuration Guide

 

 

 

 

Revision Date:  05 December, 2022

This documentation has been created for software version 2022.4.0.0.

It is also valid for subsequent software versions as long as no new document version is shipped with the product.

 

 

Suite 105, 220 Davidson Ave, Somerset, NJ, USA 08873

 

Support

For more information, visit

https://www.whiz.ai/contact

 

Copyright © 2022 whiz.ai All Rights Reserved.

Trademarks owned by whiz.ai

 

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure that this document is an accurate representation of the steps to deploy WHIZ.AI platform. However, the development of the software is a continuous process. So, small inconsistencies may occur. 

 

We would appreciate any feedback on this document 

Send comments via email 

To: assistant@whiz.ai 




Table of Contents

Introduction

Preface

About this Configuration Guide

Intended Audience

Related Documents

Contacting WhizAI 

Getting Started

Pre-requisites

Configurations in WhizAI 

Model Management Configurations

Configuring hierarchies for Info modal 

Configuring default time operator for Growing/Declining queries. 

Configuring Top N Additional Metadata

Configuring Top N threshold

Hiding metric for Top N response

Configuring cacheable/non-cacheable entities

Data Modeler - Moving existing Airflow driven solution pipeline configurations to Data Modeler UI solution

Visualization Configurations

Configuring the Title of the Response

Configuring timeline visualization for multidimensional query

Chart and Table Responses: Add hyperlinks to data values

Enabling Map Visualization

Configuring to Hide/show "Partial Data" bubble in visualization, table, and reports

Configuring action fields (Editable Columns) 

Configuring Smart Totals

Configuring Anomalies and Key Drivers Analysis

Configuring new layout for pinboards from User Interface

Natural Language Generation (NLG) Configurations

Configuring sample NLQs by languages

 

Introduction

WhizAI is the first and only purpose-built cognitive insights platform for life sciences, empowering users to get answers to their business questions by simply asking via voice, text on web and mobile. 

 

WhizAI is trained on the language and data of life sciences, enabling it to answer even the most complex questions from billions of records in seconds. Fast, easy and scalable, WhizAI is the trusted partner of choice at the top global life sciences companies. Asked. Answered. Instantly. 

Learn more at https://whiz.ai/        

 

 

 



 

Preface

About this Configuration Guide

This configuration guide details the prerequisites, configuration, and operation that you must perform while configuring the WhizAI application.

Intended Audience

This guide is intended for the customer’s IT team, WhizAI partners and development team seeking information on the different steps in the WhizAI configuration process.

Related Documents

Along with this configuration guide, you can refer to the WhizAI User Manual to know how to access WhizAI and its different features.

Contacting WhizAI

For any support, you can reach WhizAI support team through our:

 

 

 

 

 

 

 

 

Getting Started

This section describes how to perform configurations for the WhizAI application. To perform these configurations, you must ensure that the application service database or ZooKeeper is set up on your machine. A database is an organized collection of data where you can manage and store your data from a WhizAI application. Also, ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.

 

For example, PostgreSQL is a relational database that stores data points in rows, with columns as different data attributes. Also, a table stores multiple related rows. It supports both SQL and JSON format. 

Pre-requisites

Before you begin configuring the WhizAI application, you need to ensure that you meet the following prerequisites to be installed on your machine:

 

 

Software

 

 

Details

 

DBeaver Universal Database Tool

 

Database Client         

 

PuTTY

 

SSH Config Manager 

 

SuperPuTTY

 

 

SSH Client       

 

PuTTYGen

 

 

Key Generator

 

Python/ Text IDE

 

Edit Python and Text Files

 

WinSCP

 

 

SFTP Client

 

Postman

 

 

Postman


 

 

 

Configurations in WhizAI

This guide will help you get started with configuring WhizAI application. This configuration guide explains the basic steps to perform while configuring the WhizAI application.

 

The configurations are divided into the following areas:

 

Model Management Configurations

Configuring hierarchies for Info modal

Description

Using this configuration, you can add hierarchies to

  • Info page: This info page can be accessed by clicking ‘Info’ from the Conversation box in WhizAI Explorer.
  • Add Filters dialog for pinboards and cards and all the filters on a pinboard

The Info page lists the hierarchies, whereas, the Add Filters dialog and the filters on a pinboard shows the list of dimensions in the hierarchy. 

Procedure

To perform this configuration, you must add the following details to the application service database.

Adding configuration to Info page:

To add the configuration for Info page, go to application service database > hierarchy_info table.

Add details as shown in the following table:

Column

Description

Example Value

id

Hierarchy Info ID

3001

locale

Language

en

name

Name of the Hierarchy 

Geography

hierarchy_id

ID of hierarchy from entity_hierarchy Table

 3001

 After this configuration is added, you can see the hierarchies on the Info page.

Adding configuration to Add Filters dialog, and the filters on a pinboard: 

To add the configuration to Add Filters dialog, and the filters on a pinboard, go to application service database > entity_hierarchy table.

Add details as shown in the following table:

Column

Description

Example Value

id 

Hierarchy ID

 

3001

hierarchy

Name of the Hierarchy

 

Geography

levels

Hierarchy Dimension List

 

State, City and Zip

model

Model Name

 

 Sales

 

After this configuration is added, you can see the list of dimensions in hierarchies.

Result

After you add the hierarchies to the Info page, it is displayed on the User Interface as shown in the following figure.


After you add the hierarchies to the Add Filters dialog and filters on the pinboard, it is displayed on the User Interface as shown in the following figure.

Add filters dialog:

 

Filters on pinboard:

 

 

 

 

Configuring default time operator for Growing/Declining queries.

Description

For growing/declining query, you can change the default behavior of the default time period which helps to calculate the growth. Suppose the default time behavior is Period over Period (PoP), and if you want to change it to Year over Year (YoY) then you can use this configuration.

Procedure

To perform this configuration, you must add configuration details to the application service database.

For example, if you ask WhizAI ‘Show me growing Region’, for which a default time behavior is Period over Period (PoP).

Now, you can change the default time behavior from Period over Period (PoP) to Year over Year (YoY).

To perform this configuration, follow the steps listed below: 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned in the table below:

 

 

Columns

 

Description

 

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

 

created_at

 

Timestamp of when the data model was added.

 

 

updated_at

 

Timestamp of when the data model was updated.

 

 

source_type

 

Type of the database.

 

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

 

 

 

  1. From the data_sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

 

  1. In the value section, add the following configuration details, 

“modification_moment_intent“: “yoy“

Result

After this configuration is performed, you can see default time behavior is changed to YOY for query ‘Show me growing Region’.

 

 

Configuring Top N Additional Metadata

Description

Using this configuration, you can enable the visualization for additional dimensions for higher levels of hierarchy in a Top N query.

Procedure

To perform this configuration, you must add the configuration details to the application service database.

For example, for dimension ‘Account’ you can add the additional dimension ‘Territory’ so that you can get an aggregate account territory information.

To perform this configuration, follow the steps listed below:

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

  1. Now, add the dimensions and the given key values as shown in the following Insert statement:

"topn_additional_dimensions": 

{

    "HCOName": {

      "Territory": {}

    }

  }

The below table provides description for the key values: 

Parameters

Description

topn_additional_dimensions

Specifies that additional dimension is added for the Top N query.

HCOName

Name of the HCO

Territory

Additional dimension ‘Territory’

Result:

After performing this configuration, when you ask WhizAI ‘Show me Top accounts’, the response table displays the additional dimension territory as shown in the following figure:

 

 

 

 

 

Configuring Top N threshold

Description

Using this configuration, you can set out the default number of records on the response. Therefore, when you ask a query, WhizAI understands, and shows you the default number of records. 

Procedure

To perform this configuration, you must add configuration details to the application service database.

For example, if you set the property "default_threshold": 20, and ask a query such as ‘Show me top Customers’ then WhizAI understands by default and shows the list of top 20 customers

To perform this configuration, follow the steps listed below:

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

4.  Now, add the given key values as shown in the following Insert statement: 

"default_threshold": 20

 Result:

After performing this configuration, when you ask WhizAI ‘Show me top 20 customers’ then WhizAI understands by default and shows the list of top 20 customers.

 

 

Hiding metric for Top N response 

Description

Using this configuration, you can hide the metrics for the Top N response, when a certain dimension or group of dimensions are part of the response.

Procedure

To perform this configuration, you must add configuration details to the application service database.

For example, if you set the property ‘hide_metric_for_dimensions: [["contract"]]’ and ask a query ‘Show me list of contracts’ the response table will not show the metrics.

To perform this configuration, follow the steps listed below:

1. Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

 

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

OR 

4.  Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

Now, add the given key values as shown in the following Insert statement: 

hide_metric_for_dimensions: [["contract"]]

Result:

After performing this configuration, the response table does not display the metrics as show in the following figure:

 

 

 

Configuring cacheable/non-cacheable entities

Description

When you ask a question, WhizAI identifies the context such as metrics and filters from the previously used question. If you do not want the context, then use this configuration to see the result for follow up query. 

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

For example, if you add the ‘Number of Writers’ metric as a non-cacheable entity, then it will not be set in the context. 

 

To perform this configuration, follow the below steps:

 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data_sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

 

4.  In the value section, add the following configuration details, 

 

"non_cacheable_entities": [

    {

      "code": "Number of Writers",

      "entity": "Metrics"

Result

After you perform this configuration, it reflects on User Interface as shown in the below figure:

 

 

 

 

 

 

 

 

Data Modeler - Moving existing Airflow driven solution pipeline configurations to Data Modeler UI solution

(Configuration introduced in v2022.3.1.2)

 

Now, you can move existing Airflow driven solution pipeline configurations to Data Modeler and run the pipeline on the UI.


 
Prerequisite: Make sure you have WhizDMimport dag available and enabled on the Airflow v2.2.5.

 

 

To move existing pipeline configurations:

 

Go to WhizDMimport dag:

 

1.  Click Trigger DAG .

 

2.  Click Trigger DAG w/ config.

 

 

3.  Provide a valid configuration JSON as shown in the following figure and click Trigger.

 

 

       Note: For more information on this configuration, refer Understanding the WhizDMimport configuration JSON.

 

4.  You can check the status of the DAG as shown in the following figure.

 

 

After a successful DAG run, all the pipelines will be available on the Modeler UI. You can Edit, Configure, and Run these imported pipelines on the Data Modele UI.

 

 

Understanding the WhizDMimport configuration JSON

 

Following table explains different fields in the WhiDMimport configuration.

 

JSON field

Description/Function

code

This is Unique Identifier of your choice 

application_base_url

This is application url with the port number:
 
http://whiz-application:9999 
 

region

It is AWS S3 region corresponding to access key

username

Login credential: This is your login ID

password

Login credential: This is your login password

s3_access_key

AWS S3 access key, to be provided by customer

s3_secret_key

AWS S3 secret key, to be provided by customer

s3_bucket

Bucket to be used for data storage

current_solution_dir

Directory used for existing ETLs by the Airflow driven DAGs.

 

Visualization Configurations

Configuring the Title of the Response 

Description

Using this configuration, you can configure the text of a response title, i.e, add or change the words to be displayed in the title. Also, you can configure certain words to be displayed in a supported language within the response title, and so on.

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

For example, when you ask WhizAI in Spanish language ‘Muéstrame las 10 mejores cuentas’  then it shows the response as shown in the following figure.

 

 

Now, for the response in Spanish you can change the word ‘Cima’ (in Spanish) as ‘Top’ (in English):

 

To perform this configuration, follow the step listed below:

 

1.  Go to the application service database > translations table.

 

2.  Enter the code of the language, (es) for Spanish in the locale column.

 

3.  Enter the visualization of the response as visualisation.top in the key column.

 

4.  Enter the title of the response as Top in the value column.

5.  Save the changes.

 

 

6.  Restart the whiz-app and whiz-application service. Hence, restarting a server closes all the processes that are running and starts them again.

 

You can enter the required values in the key column to get the appropriate response. The values are as given below:

visualisation:

     worst: "Worst"

     top: "Top"

     with: "with"

     by: "by"

     and: "and"

     for: "for"

     vs: "v/s"

     date_format: '%Y-%m-%d'

     day: Daily

     week: Weekly

     month: Monthly

     quarter: Quarterly

     year: Yearly

     top_n_table_flow:

       header: "%{desc} %{len} %{dim} %{metadata_filter_str} %{union} %{top_n_metric_title_txt} %{conds}" 

     druid_aggregation_flow:

       header: "Aggregation of %{ner_similar_metadata_name}"

     druid_aggregation_timeseries_flow:

       header: "%{ner_title} %{metric_name} for %{aggr_name} %{granularity_title}"

     druid_aggregation_topn_flow:

       header: "%{topn_title} for %{aggr_names}"

     druid_comparision_flow:

       header: "Comparison of %{entity_names}"

     druid_comparison_timeseries_flow:

       header: "%{ner_title} %{metric_name} by %{entity_name} %{granularity_title}"

     druid_comparison_topn_flow:

       header: "%{topn_title} for %{entity_names}"

     druid_timeseries_table_flow:

       header: "%{ner_title} %{metric_name} %{granularity_title}"

     rich_table_flow:

       header: "%{metric_name} by %{dimension} %{granularity_title}"

     partial: "Partial"

Result

After applying the configuration, the title is displayed as Top in the response table.

 

 

 

 

 

 

Configuring timeline visualization for multidimensional query

Description:

 

Using this configuration, you can enable the timeline visualization on pinboards as well as on responses for multidimensional query. 

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

For example, if you want to add the timeline visualization for dimensions ‘Response date’ and ‘Region’, then you have to add some key values into the data_sources table.

 

To perform this configuration, follow the steps listed below:

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

4. In the value section, add the following configuration details, metadata > data source code.  

       Note : You can skip this step, if it is already present in the values section.

Now, add the dimensions ‘Response date’ and, ‘Region’ and the given key values as shown in the following Insert statement:

{

           "level": "Response date",

           "timeline": {

             "group_ids": [

              0,

              1

            ],

             "time": true,

             "show_dimension_name": false,

             "values": {

               "start": [

                 "null"

              ],

               "end": [

                 "Not Reimbursed Yet"

              ]

            }

          }

        },

        {

          "level": "Region",

           "precedence": 0,

           "timeline": {

             "group_ids": [

              0

            ],

             "time": false

          }

        }       

The below table provides description for the key values: 

Parameters

Description

level

Metadata code, for example, ‘Region’

timeline

Identifies the configuration that you have added is a ‘Timeline’ configuration. 

time

 

Following values can be added:

 

  • TRUE: Time ‘true’ indicates that dimension is a time dimension.

 

  • FALSE:  Time ‘false’ indicates that dimension is not a time dimension.

group_ids 

Using the values of this key group, a group of dimensions is created that helps to create the timeline visualization. 

values

The ‘values’ key is present only when the ‘time’ value is set ‘true’.

Under ‘values’ you can add keys ‘start’ or ‘end’:

  • START:  The record is displayed on the response at the start of the timeline visualization.

 

  • END: The record is displayed on the response at the end of the timeline visualization.

precedence

 

This key is mandatory, in this key you need to add the values to configure the order of the dimensions.

You can add this key to any dimension, (except time dimension or when the time key is set as TRUE). 

Result

After performing this configuration, when you ask WhizAI ‘Show me response date by regions’ then in the response you can see the timeline visualization option as shown in the following figure:

 

 

 

Chart and Table Responses: Add hyperlinks to data values

Description

Using this configuration, you can add the hyperlinks on cards associated with the corresponding dimension values. When you click on these links it redirects you to the external tab where you can view the data or image for further analysis.

Procedure:

To perform this configuration, you must add configuration details to the application service database.

 

For example, if you want to add the hyperlinks for dimensions ‘Region’, then you have to add some key values into the data_sources table.

 

To perform this configuration, follow the steps listed below:

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

 

3.  From the data_sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

  1. In the value section, add the following configuration details, metadata(“dimension_additional_details”) > data source code ("link" and "image").

       Note : You can skip this step, if it is already present in the values section.

Now, add the dimensions ‘Region’ and the given key values as shown in the following Insert statement:

"dimension_additional_details": {

    "link": {

      "title": {

        "en": "View link"

      }

    },

    "image": {

      "title": {

        "en": "View Image"

      }

    },

    "dimensions": {

      "Region": [

        {

          "image_url": {

            "type": "image",

            "source": "detail_region",

            "ignore_timestamp": false

          }

        },

        {

          "link_url": {

            "type": "link",

            "source": "detail_region",

            "ignore_timestamp": false

          }

        }

      ],

The below table provides description for the key values: 

      Parameters

         Description

dimension_additional_details

Name of the dimension where you want to show the hyperlink

link

Title and the code of the supported language.

dimension

The dimension name for which the hyperlink needs to be added.

URL column name

The URL name.

type

The type of hyperlink (link or image)

source

The data source name to add the image or hyperlink.

 

ignore_timestamp

 

  • Add value ‘true’ if the data source is time independent.
  • Add value ‘false’ if the data source is time dependent

Result:

After performing this configuration, when you ask WhizAI ‘Show me trx by region’, you see the following response. 

 

When you hover a cursor over any dimension value it shows the options for ‘View link’ and ‘View image’ as shown in the following image.

 

 

Enabling Map Visualization

Description

Using this configuration, you can enable the map visualization for states and countries. 

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

Follow the steps listed below to enable the map visualization for states and countries.

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

4.  In the value section, add the following configuration details, metadata > data source code.  

       Note : You can skip this step, if it is already present in the values section.

 

5.  Now, add the dimensions and the given key values as shown in the following Insert statement:

"metadata": {

    "sales": {

      "dimensions": [

        {

          "level": "Country",

          "type": "geo",

          "map_level": "Country"

        },

        {

          "level": "State",

          "type": "geo",

          "map_level": "State"

        }

      ]

    }

  }

The below table provides description for the key values: 

Parameters

Description

level

Metadata code, for example, Country and State

type

Type of the visualization

map level

Map Level for the countries and state

Result:

After adding this configuration, you can see the map visualization for states and countries.

 

Map for countries:

 

 

Map for states:

 

 

 

 

Configuring to Hide/show "Partial Data" bubble in visualization, table, and reports

Description

Using this configuration, you can hide or show ‘Partial Data’ text in the visualization.

Procedure

To perform this configuration, follow the steps listed below:

 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

 

3.  From the data_sources table, click the values given in the properties column against the data model name, as required. 

 

OR 

 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

 

  1. Now, add the given key values as shown in the following Insert statement:

“show_partial“: false

 

 

Parameters

 

 Description


 

 

 

show_partial

 

True: The ‘Partial’ is displayed in the visualization.

 

False: The ‘Partial’ is not displayed in the visualization.

 

Result:

After performing this configuration, you can hide/show the Partial data as shown in the following figure:

 

 

 

 

 

 

 

 

Configuring action fields (Editable Columns)

Description

Using this configuration, you can configure the certain cards on pinboards, so that they show an actionable metric column. 

 

Therefore, you can update the actions performed against a particular record from the dropdown lists in this column.

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

For example, if you want to add actionable columns for the dimensions ‘Customer’, then you have to add some key values into the data_sources table.

 

To perform this configuration, follow the steps listed below:

 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data_sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

4.  In the value section, add the configuration details, metadata (Status) > data source code (customer_status).    

       Note : You can skip this step, if this detail is present in the values section.

 

5.  Now, add the dimensions ‘Customer’ and the given key values as shown in the following Insert statement:

 

"Status": {

               "source": {

                              "code": "customer_status",

                              "type": "sql"

               },

               "dimensionality": [

                              "Customer"

               ],

               "dataType": "string",

               "time_invariant": true,

               "editable": true,

               "required": false,

               "ignore_timestamp": true,

               "lookup": {

                              "0": "Yes",

                              "1": "No",

                              "2": "Not Applicable"

               },

 

 

Parameters 

 

Description

 

 

dimensionality

 

The name of the dimension. 

 

 

dataType

 

Type of metric.

 

 

time_invariant

 

The time invariant. To make this metric time invariant, add the value as TRUE.

 

 

editable

 

Indicates whether the metric is editable or not.

 

 

required

 

Indicates that all the values should be present.

 

 

ignore_timestamp

 

Indicates that the metric does not have a timestamp. Set this metric as TRUE as this metric does not have timestamp dependency.

 

 

lookup

 

Indicates actionable values which are set against the record.

 

 

Result:

After performing this configuration when you ask ‘Show me customer by status’ the response table displays the actionable columns as shown in the following figure:

 

 

 

Configuring Smart Totals

Description

Using this configuration, you can configure the totals for computed metrics for all the applicable responses. The totals are calculated based on computational calculations.

 

For example, if you perform this configuration for computation TRx Marketshare and ask WhizAI ‘Show me region by brand for TRx marketshare’ then in the response table, you will see the total percentage of each brand against all the regions.

Procedure

To perform this configuration, you must add configuration details to the application service database.

 

To perform this configuration, follow the below steps:

 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data_sources table, click the values given in the properties column against the data model name, as required. 

OR 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

 

4.  In the value section, add the following configuration details.

 

"MarketShare": {

       "fraction_size": 2,

       "aggreable": true,

       "units": "%",

       "prefix_unit": false,

       "metric_type": "percent",

       "dimensions_for_which_sum_will_be_used_for_total": [

         "Product Name"

       ],

       "metrics": [

         "TRx",

         "NBRX",

         "NRx",

         "Total Units",

         "Naive Volume",

         "Switch Volume",

         "PDOT"

       ]

     }

 

The below table provides description for the required parameters: 

 

 

Parameters

         

Description

 

 

 

aggreable

 

True: If the value is set as TRUE then the smart total is displayed in the response.

 

False: If the value is set as FALSE then the smart total is not displayed in the response.

 

 

Result:

After performing this configuration when you ask ‘Show me region by brand for TRx marketshare’ the response table displays the smart total as shown in the following figure:

 

 

 

 

 

 


 

Configuring Anomalies and Key Drivers Analysis 

(Enabled in v2022.4.0.0)

Description

Using this configuration, you can enable the Anomalies and Key Drivers analysis tabs from Insight Workbench.

 

The ‘Insight Workbench’ interface has the following two tabs:

 

Anomalies: Helps identify the anomalous behavior of your business metric.

 

Key Drivers: Helps find out the top driving factor of your business metric. 

Procedure

You can configure the Anomalies and Key Drivers analysis using the below-mentioned steps:

 

  • Enabling Anomalies and Key Drivers tab 
  • Enabling the Contributors tab for Key Drivers Analysis
  • Insight Workbench role-based access
  • Configuring Anomalies and Key Drivers Analysis from User Interface

 

Enabling Anomalies and Key Drivers tab 

 

Using this configuration, you can enable the Anomalies and Key Drivers analysis tab. Also, you can run anomaly detection on a response that shows a trendline with weekly, monthly, quarterly, and yearly data for metrics and scope.

 

To enable the Anomalies and Key Drivers analysis follow the steps listed below:

 

1.  Go to the application service database > data_sources table.

 

2.  In the data_sources table you can see the columns as mentioned below:

 

Columns

 

Description

 

code

 

Code of the data model.

 

name

 

Name of the data model.

 

properties

 

List of all the data models.

 

created_at

 

Timestamp of when the data model was added.

 

updated_at

 

Timestamp of when the data model was updated.

 

source_type

 

Type of the database.

 

metadata

 

Information about other datasets.

 

 

active

 

Active status

 

3.  From the data sources table, click the values given in the properties column against the data model name, as required. 

 

OR 

 

Click the Panels button from the top right corner of the data_sources table. The Value section opens to the right-hand side. 

4.  Now, add the given key values as shown in the following Insert statement: 

"insightConfigurations": {

    "keyInfluencer": {

      "metrics": {

        "TRx": {

          "metrics": [

            "NBRx"

          ],

          "dimensions": {

            "Age Group": [],

            "Customer Tier": [],

            "Customer Type": [],

            "Gender": [],

            "Primary Specialty Group Name": []

          }

        },

        "NRx": {

          "metrics": {

                    "TRx": {

                        "computations": [

                              "Growth",

                              "MarketShare"

                  ],

         "base": false

            } 

      },

          "dimensions": {

            "Age Group": [],

            "Customer Type": [],

            "Formulary status": [],

            "Product Decile Group": [],

            "Target Status": []

          }

        }

      }

    }

  },

  "insights": true,

The below table provides a description for the key values: 

Parameters

Description

anomaly

TRUE: The anomaly is supported on NLQ if this value is set as true.

FALSE:  The anomaly is not supported on NLQ if this value is set as false.

insights

This is a mandatory key. 

TRUE: Set a value true to enable the anomaly and key drivers analysis.

FALSE:  Set a value false to disable the anomaly and key drivers analysis.

insightConfigurations

Add this key to configure the specific factors for metrics.

Under ‘keyInfluencer’ add metrics and dimensions.

base

 

TRUE: When you set this value as true then both computed and base metrics are supported.

 

FALSE:   When you set this value as false then only computed metrics are supported.

 

 

Result:

After performing this configuration, the Anomaly and Key Drivers analysis tabs are displayed on the User Interface as shown in the following figure.

 

Enabling the Contributors tab for Key Drivers Analysis

 

When you add the configuration details into the entity_configurations table and perform the Key Drivers analysis, you can view the data for computations Average and Contribution under the Contributor tab.

 

To view the details for computations Average and Contributions on Key Drivers analysis:

 

  1. Go to the application service database > entity_configurations table.

 

  1. Add the details in the columns as given in the table below:

 

Column Name

Key Parameters

identifier_rule

{

  "type": "Calculation",

  "entity": "DynamicIntent",

  "subtype": "AverageInsights"

}

configuration

{

     "desc": {

       "url": "executeScript",

       "name": "Average",

       "prefix": true,

       "default": {

         "hidden": true,

         "sorting": "descending",

         "default_filter": {

           "dynamicArgs": {

             "denMetricName": "distinct_weeks",

             "postAggregations": [

            {

                 "fn": "/",

                 "name": "Weekly Average TRx",

                 "type": "arithmetic",

                 "fields": [

                {

                     "name": "",

                     "type": "fieldAccess",

                     "fieldName": ""

                   },

                {

                     "name": "distinct_weeks",

                     "type": "thetaSketchEstimate",

                     "field": {

                       "name": "distinct_weeks",

                       "type": "fieldAccess",

                       "fieldName": "distinct_weeks"

                     }

                }

              ]

            }

          ],

             "averageAggregation": {

               "name": "distinct_weeks",

               "type": "thetaSketch",

               "fieldName": "__time",

               "isInputThetaSketch": false

          }

        }

      }

    },

       "script_name": "WhizAverage"

  }

}

Result:

After performing this configuration, you can view the details for computations Average and Contributions on Key Drivers analysis.

 

 

Insight Workbench role-based access

 

Using this configuration, an admin user can enable or disable the Insights Workbench option and Advanced Option for board users (other than admin user/s).

 

To perform this configuration, follow the steps listed below:

 

1.  Go to application service database > users table.

 

2.  Click the Permission column against the user for whom you want to enable/disable the Insights Workbench option. 

 

3.  Add the below insert statement in the value section.

 

{

  "insights": {

    "enabled": true

  }

}

 

The below table provides a description for the key values: 

Parameters

Description

Insights

Insights key

enabled

True: Set this value as true to enable the Insights Workbench and Advanced Option for the board user

False: Set this value as false to disable Insights Workbench and Advanced Option for the board user

 

Result: After performing this configuration, you can see the result as shown in the following figures:

 

Insights Workbench Enable:

 

 

Advanced Option Enable:

 

Insights Workbench not available

 

 

 

Advanced Option not available

 

Configuring Anomalies and Key Drivers Analysis from User Interface

 

After making the changes in the application service database, you can enable or disable the anomalies or key drivers analysis from the user interface.

 

To enable the anomaly or key drivers analysis from the user interface follow the steps listed below:

 

1.  Go to Admin console > Users & Security > Users.

 

2.  From your user's profile name, click the Edit User icon.

 

3.  Enter the Tag name as ‘system’ and click Save.

 

 

       Note : To view the update changes, you have to refresh the browser.

 

4.  Now, go to Admin console > Content Manager > Utilities.

 

As you can see Anomaly and Key Drivers are enabled.

 

Configuring new layout for pinboards from User Interface

 

To enable the new layout for pinboards from user interface follow the steps listed below:

  1. Go to Admin console > Users & Security > Users.
  2. For the user's profile name, click the Edit User icon.
  3. Add the ‘system’ tag and then click Save.

 

 

       Note : To view the update changes, you have to refresh the browser.

 

4.  Now, go to Admin console > Content Manager > Utilities.

 

As you can see the Pinboard Managers is enabled.

 

 

 

 

 

 


 

Natural Language Generation (NLG) Configurations

Configuring sample NLQs by languages

Description

Using this configuration, you can add Natural Language Questions (NLQs) to be displayed on the ‘Info’ page on WhizAI Explorer. These NLQs help you get started with understanding the data model. 

 

As a part of this configuration, you have to add certain details to the statements table in the application service database. The “statements” table defines the list of sample queries that will be displayed when you click the Info page. 

 Procedure

To perform this configuration, you must make changes to the application service database.

 

For example, if you have to display the NLQ: 'Show me sales by region’ on the Info page, then you have to add certain details to the statements table in the application service database. 

 

To perform this configuration, follow the steps listed below:

 

  1. Go to the application service database > statements table and enter the following details:

 

Add the details from the table below:

 

Column Name

Description

Example Value

data_source_id

   ID of the data model

77

statements

A statement that you want to show in the NLQ.

Show me sales by region

description

Description of the statement. (If required)

Null

lang

Code of the language 

en

 

 

2.  Click Save.

Result

After you perform this configuration the NLQ ‘Show me sales by region’ is displayed in the ‘Info’ page on WhizAI Explorer as shown in the following figure.

 

 

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article