vitalsBI

Documentation

 

Overview

Welcome to VitalsBI Documentation!

Use the search box or the navigation tree on your left to find your way around.
Here are some shortcuts to some of the main sections.

 

VitalsBI Concepts and Terminology

Learn about the different concepts that together make up VitalsBI, and get an overview of the VitalsBI Architecture.

 

Creating Dashboards

Learn all about creating the dashboards that answer your business needs. See all the different visualizations (charts) and features that work together to create powerful analytics.

 

Using Dashboards

Get the most out of your dashboards by learning how to work with dashboards that were created for you.

 

Managing & Sharing Dashboards

This section shows you how to organize your dashboards and more importantly, how to share them across the organization.

 

FAQs

Find answers to frequently asked questions.

 

Release Notes

Check out the latest new features and fixes.

Last updated on May 31, 2017

Basic Concepts and Terminology

The following sections will introduce you to basic concepts and terminology used within the vitalsBI system, including:

 

Last updated on May 28, 2017

vitalsBI Architecture

The vitalsBI system is comprised of the following components.

ElastiCube Manager

The ElastiCube Manager is a visual environment in which you create ElastiCubes. The ElastiCube Manager enables you to structure and import multiple data sources, create relationships between data, and perform ETL (Extract, Transform, and Load) processes to prepare data for analysis and visualization. The ElastiCube Manager is an administrative level function that is managed by the vitalsBI Client Support Team. For questions about the ElastiCube Manager, please contact vitalsBI Client Support.

ElastiCube Server

The ElastiCube Server is installed locally on your computer and enables access to ElastiCubes. Both the vitalsBI Web Application and the ElastiCube Manager query the ElastiCube Server and receive results.

vitalsBI Server Console

The vitalsBI Server Console provides administration functions for managing ElastiCubes on the ElastiCube Server.

vitalsBI Web Application

The vitalsBI Web application is an interactive web application that provides the user interface in which users can design, share, view and explore dashboards. The vitalsBI Web application runs in popular web browsers and enables access to the vitalsBI server.  Dashboards can also be viewed on mobile devices.

vitalsBI Web Server

The vitalsBI Web Server is installed locally on your computer and hosts the vitalsBI Web application.

Last updated on May 31, 2017

Designers and Viewers

Note: In previous versions, Designers and Viewers were known as Contributors and Consumers.

vitalsBI Administrators can access the management settings. vitalsBI Client Support Team are the Administrators and manage users and user groups, manage connected ElastiCubes, define the web configuration, connect to Active Directory, and more Please contact vitalsBI Client Support about administrative level functions.

vitalsBI Designers can create, design, edit and share dashboards. vitalsBI designers determine whether the user with who they share a dashboard has editing rights (is a designer) or only viewing rights (viewer).

vitalsBI Viewers can view, explore, drill down, make selections and filter the dashboards that designers share with them. Viewers only require a standard web browser; no plugins or downloads. They cannot create new dashboards or edit existing ones.

 

Feature Admin Designer Viewer
Server and User Management Yes No No
Create New Dashboard Yes Yes No
Share Dashboard Yes Yes No
Create New Widget Yes Yes No
Edit, Modify, Export Widget Yes Yes No
Add Dashboard Filters Yes Yes No
Create and Manager Folders Yes Yes No
Drill in Dashboards Yes Yes Yes
Access Dashboards on Mobile Yes Yes Yes
Receive Email Reports Yes Yes Yes
Export Dashboard to PDF Yes Yes Yes
Last updated on May 31, 2017

ElastiCubes

ElastiCubes are vitalsBI’s proprietary super-fast data stores. ElastiCubes are specifically designed to withstand the extensive querying typically required by business intelligence applications.

ElastiCubes enables you to mash up terabytes of data from a variety of sources, for example:

  • Traditional relational databases, such as SQL Server, MySQL or Oracle.
  • File-based data sources, such as spreadsheets (Excel) and CSV files.
  • Online web services, such as Salesforce.com, Google AdWords, Google Analytics, Zendesk and more.

ElastiCubes are based on vitalsBI’s proprietary In-Chip technology, which leverages the vitalsBI engine. Read more about the technology behind ElastiCube in vitalsBI’s technology section.

ElastiCubes are created and managed in the vitalsBI ElastiCube Manager.

ElastiCube Sets

vitalsBI ElastiCube Sets are collections of ElastiCubes with identical schemas that support high availability by allowing you to query running ElastiCubes within the ElastiCube Set while other ElastiCubes are in a building state.

Last updated on May 31, 2017

Widgets

Each widget is a dynamic visualization of data. You pick the type of data to appear in a widget and you pick the type of visualization (chart type).

A few examples of widgets are displayed below:

Column Chart Widget

Indicator Widget

Pie Widget

Pivot Widget

Scatter Chart Widget

To learn more about the different widget types, see Choosing the Right Widgets for Your Dashboard in Creating Dashboards.

Last updated on May 31, 2017

Dashboards

A dashboard is a collection of one or more widgets that visualize the data that you select and design.

You define which widgets appear in the dashboard, their design, how they are organized and the filtering of the data that appears.

You can access your own dashboards and dashboards others shared with you.

vitalsBI allows you to create as many dashboards as you need. No limitations! When you create a dashboard, you are the dashboard’s owner. Owners can share dashboards that they have created with other vitalsBI users (Viewers and Designers).

vitalsBI provides a variety of built-in automatic dashboard sharing features. You can easily share a dashboard with others in the vitalsBI environment or have a dashboard automatically delivered to your chosen recipients by email (on a scheduled basis or upon each data update).

Last updated on May 28, 2017

Fields

Widgets are composed of fields that represent the data in your data sources. You create widgets by simply selecting from the fields displayed in a Data Browser, which appears in various places across the product. Each field represents a column of data in the ElastiCube.

When designing widgets, fields can be categorized into two groups:

  • Numeric Fields: Numbers (quantified data), such as salaries, sales, scores, number of clicks and so on. This is data that you may want to aggregate or calculate. For example, the sum of sales or the average of costs.
  • Descriptive Fields: Items used to label and categorize, such as Products, Locations, Categories and so on.

Generally, widgets combine both these types of fields.

For example, to show the sales of a product over time, Sales is the numeric data and both Products and Time are descriptive data.

Descriptive data can be considered as numeric when it is simply a count of the number of items. For example, Activities can be considered numeric when it is a count of the number of Activities. A number can be considered as descriptive when it is an actual entity. For example, an identification ID or phone number.

Last updated on May 31, 2017

Other Terminology

Authorized Users

“Authorized Users” means authorized users granted access to use the Software, either as part of the Bundled Software or in connection with the Business Scope, on a named basis as detailed in the Sales Order. Authorized Users are named and shall receive a personal login and password which should be maintained securely by Licensee or the applicable End Customer, as the case may be, from unauthorized use.

An Unlimited Viewer license allows unlimited Viewers to be authorized to access the specific vitalsBI Server. Please note that while there is no legal limit to the number of Viewers, the technical capacity of the server may limit the number of Viewers that may actually access the vitalsBI Server.

Core

“Core” shall be a collection of one or more processor threads and a set of shared execution resources. A processor thread is the architectural state within a processor that tracks execution of a software program thread/task. Hyperthreading and other current and future technologies that materially expand the processing capacity of a Core shall not be permitted to increase the licensed processing capacity of the Core-based licenses granted under this Agreement unless otherwise agreed by the parties.

Dashboards

“Dashboards” means the graphic representation of data extracted from the Datasource(s) as designed and created by Designers and/or Administrators using the Software in accordance with this Agreement.

Designer(s)

“Designer(s)” means the Authorized User(s) who are Personnel of the Licensee or End Customer that are authorized to create, edit and share Dashboards.

Personnel

“Personnel” shall mean employees and contractors of Licensee or, where applicable, of End Customers, where such personnel’s access to the Software and/or the Bundled Software is controlled by Licensee or the applicable End Customer.

Row

“Row” shall be a single record in a table of a vitalsBI ElastiCube. For licensing purposes, only Rows in tables that were added to the Elasticube from external sources are counted (i.e., Base table). If a base table is used by several ElastiCubes, it is counted only once.

Viewer(s)

“Viewer(s)” means the Authorized User(s) who are Personnel of the Licensee or End Customers that are authorized to view and filter the Dashboards that Designers share with them via a standard web browser.

Last updated on May 28, 2017

Creating Dashboards

This section describes how to create a new dashboard.

There are two ways you can create dashboards, first, through the vitalsBI Web Application, and second, through the vitalsBI REST API.

The difference between these two methods is the vitalsBI Web Application provides a UI and how you populate the dashboard with widgets.

When creating a dashboard through the vitalsBI Web Application, you build an ElastiCube or select a data set, create a dashboard, and then populate it with widgets.

To create a dashboard through the REST API, you define the dashboard and then populate it with widgets that already exist through their widget IDs.

Last updated on May 31, 2017

Creating a Dashboard through the vitalsBI Web Application

Note: This section is for users with dashboard editing rights (usually with a user role of Designer, and as determined by the user license).

Tip! If you have dashboard editing rights, you should see the editing buttons in the top-right corner of the dashboard.

Note: Each vitalsBI Web Dashboard is based on the data selected from one or more ElastiCubes or data sets. The instructions below assume that the required ElastiCube(s) and data set(s) have already been created. You can also use the sample ElastiCubes that are installed with vitalsBI if you have not yet created your own.

To create a dashboard:

  1. In the HOME page, click the ‘+’ symbol above the Dashboards list.
    OR
    Right-click on the folder menu and select New Dashboard.

 


The following window appears:

  1. Click the name of the Data Set displayed to select the ElastiCube or data set you want to work with. ElastiCubes have the   next to their name while data sets have the   icon next to their name.
  2. Click the name of the TITLE, and enter a name for the dashboard. This name will appear at the top of the dashboard, and in the My DASHBOARDS list.
  3. Click CREATE.

You are then automatically guided through the process of creating your first Widget in the Widget Wizard, as described in Adding Widgets to a Dashboard.

Last updated on May 31, 2017

Creating Dashboards through the REST API

The vitalsBI REST API enables you to programmatically create dashboards by defining the basic properties of a dashboard such as Title, ElastiCube (datasource), and owner. After defining the properties of the dashboard, you define its visualizations by including the widget IDs of pre-existing widgets.

To create a dashboard through the REST API:

  1. In the vitalsBI Web Application, click ADMIN at the top right, and then REST API, followed by REST API Reference.
  2. In the top-right corner of the page, select version 1.0 of the REST API.
  3. In the body of your call, define the values of the following keys:
Key Value
Title String that defines the name of the dashboard as displayed in the vitalsBI Web Application.
desc String that represents a short description of the dashboard.
datasource Object that defines the data source where the dashboard pulls its data.

This object contains the following elements:

title: The name of the ElastiCube.
id: The address and name of the ElastiCube where the dashboard queries its data from.
address: The address of the dashboard.
database: The name of the ElastiCube where the data is pulled from by the dashboard.
fullname: The name of the ElastiCube.

filters This object defines the dashboard filters that the user add goes to the “filters” object in the .dash file.

This object contains the following elements:

datatype: The type of data affected by the filter, for example, text.
title: The name of the filter displayed in the Filters pane.

layout Object that defines what widgets are displayed in the dashboard and their layout.

This object contains the following elements:

type: String that defines how the layout of the dashboard. This value should be “columnar”.
columns: Array objects that defines the width of each column in the dashboard and how widgets are displayed in each column.
cells: Object that contains the subcells.
subcells: Object that contains the elements objects where widgets are defined.
elements: This objects contains the widget and defines its dimensions within the ElastiCube.

defaultFilters This object defines the default filters of a dashboard. When a user selects “Set as my default filters” from the Filters menu in the vitalsBI Web Application, the filters are defined in this object.

4.  Click POST. The Dashboard is added to the Dashboards list in the vitalsBI Web Application.

Last updated on May 31, 2017

Introduction to Adding Widgets

To create widgets quickly and intuitively, you can use the Widget Wizard. The Widget Wizard automatically guides you through a very simple process of creating a widget while offering the best recommendations for displaying the data that you select.

Almost always, simply accepting the wizard’s recommendations will help you create a great Widget. However, if you want more control over your Widget’s appearance and behavior, click the Advanced Configuration option in the bottom left of the wizard to access a rich variety of additional design options, as described in Using the Widget Designer.

Last updated on May 31, 2017

Using the Widget Wizard

To add a widget to the dashboard:

  1. If this is your first widget, click Select Data. The vitalsBI Data Browser opens, and from there you can select one of the fields (columns) from this dashboard’s ElastiCube. If you already have widgets in your dashboard, then click the    button.
    Note: To select data from a different ElastiCube, click from on the right side of the NEW WIDGET window, and select an ElastiCube.
  2. You can add a title to your widget now or after creating your widget.
  3. In the Data Browser, select a field to add to your widget. The field that you select is automatically displayed in a suggested widget. When only a single numeric field is selected, it is displayed as an INDICATOR Widget. A single descriptive field is displayed as a PIVOT Widget.

Single Numeric Field

Single Descriptive Field

But your widget is not really interesting yet, because it has only one field!

Repeat the step above to add more fields to the widget.

As you add fields, the relevant options are displayed as buttons to the left of your selection.

The fields that you select are listed across the top left of the wizard.

You can click on each visualization button to display the selected fields in that visualization/chart.

For example, the same Widget as above could be displayed as a PIE CHART:

Tip: vitalsBI provides its best recommendation for your widget design. However, if you want more control, you can click the Advanced Configuration option on the bottom left of the window to provide a rich variety of additional design options, as described in Using the Widget Designer.

Data Browser

In the Data Browser, you can select and add fields (columns) from an ElastiCube to your widget.

An icon appears to the left of each field to indicate its data type:

Date

Alphanumeric string

Numeric

As you type into the Data Browser, the list is dynamically filtered to only show the fields that contain the text you typed.

Simply clicking a field to add it to the widget generally provides great results, however there are more options in the Data Browser.

  • Hover over a field in the Data Browser and click More … to display additional aggregation (quick functions) and filtering options.
  • Click on the   button to define formulas (free-form expressions) that define the field values and filters of a widget. A rich variety of functions are provided for you to use in the formula that you define.

Last updated on May 31, 2017

Using the Widget Designer

The Widget Designer lets you fine-tune a widget’s appearance and behavior.

Opening the Widget Designer

To display the Widget Designer:

  • On the Dashboard, click the Pencil (Edit) button   that appears in the top-right corner of a Widget.

  • Alternatively, while creating a new widget, in the Widget Wizard, click the Advanced Configuration option that appears at the bottom-left of each window. The Widget Designer is then displayed showing the widget in the same state as in the Widget Wizard preview.

 

The Widget Designer – A Quick Tour

The Widget Designer enables you to select the data to be included in a widget in addition to providing a variety of options for customizing the visualization used to show the data.

 

  1. Adding Data to the Widget (Data Panel): Used for selecting the values that you want to appear in the widget and those needed for grouping the data. The options differ depending on the visualization (chart type).
  2. Adding a title to the dashboard: Click Set a Title and type in a new title for the widget.
    You can also add a widget title directly from the dashboard without entering the widget designer.
  3.  Previewing the Widget: The center of the window displays the current design and content of the widget, which automatically changes each time you select a different option in this window.
  4. Selecting the Widget Visualization: Enables you to change the visualization of the widget.
  5. Accessing More Options: Displays a menu  of additional options for the widget.
  6. Filtering the Widget (Filter Panel): Lets you manage the filters that affect this widget. Learn more in the filtering page.
  7. Designing the Widget (Design Panel): Provides a variety of options for fine-tuning the appearance of the Widget, including labels, legends, line types and more. Some of these options need to be turned on (ON   ) for you to configure them. The options differ depending on the visualization (chart type).
  8. Update on every change: Selected – Data changes are automatically and dynamically updated in the display. Not selected –  you have to click UPDATE to display your latest changes in the widget. Clearing this checkbox may be useful when you are working with very large datasets where query times might be slower.

Fine-tuning a Widget

  • To get an overview of the different widgets available, click here.
Last updated on May 31, 2017

Choosing the Right Widget

The following guide will help you choose which widgets or charts to use in your dashboard. In addition to having lots of charts to choose from, you can also customize the design of each chart, as well as filter the data presented in the chart.

Indicator

Use the Indicator widget to display one or two numeric values as a number, gauge or ticker. You can also add additional titles and a color-coded indicator icon representing the value, such as a green up arrow or a red down arrow.

   

Gauge Indicator

Numeric Indicator

Click here to read more.

Line Chart

The line chart is one of the most commonly used charts. You can use the line chart for various business cases, including:

  • Comparing data over time and viewing trends. Example: Analyze sales revenue for the past year.
  • Comparing changes over the same period of time for more than one group or category. Example: Analyze expenditures of different business units for the past year.

A line chart with a ‘break by’ category

Click here to read more.

Column Chart

The column chart can be used for comparing items and comparing data over time. The chart can include multiple values on both the X and Y axis, as well as a break down by categories displayed on the Y axis.

You can also combine the column chart with a line chart.

   

Column Chart

Column and Line Chart

Click here to read more.

Bar Chart

Use the bar chart to compare many items. The bar chart typically presents categories or items (descriptive data) displayed along the Y axis, with their values displayed on the X axis. You can also break up the values by another category or groups.

Click here to read more.

Pie Chart

Use the Pie chart to display proportional data, and/or percentages.

Click here to read more.

Area Chart

An Area chart is very similar to a Line chart except that the areas under each line are filled in (colored), and it is possible to display them as stacked. We recommend this chart to display absolute or relative (stacked) values over a time period.

Click here to read more.

Polar Chart

Use the polar (radar) chart to compare multiple categories/variables with a spacial perspective in a radial chart.

Click here to read more.

Pivot Table

Pivot tables are one of the most useful widgets for visualizing data. You can quickly summarize and analyze large amounts of data.

Make use of additional features such as color formatting and data bars to enhance the visual aspects.

   

Example using color formatting

Example using data bars

Click here to read more.

Table

The Table widget displays a broader view of your data, presenting raw and non-aggregated data in columns, with as much fields and metrics as needed.

Click here to read more.

Scatter Chart

Use the The SCATTER chart to display the distribution and relationship of two variables. The circles on the chart represent the categories being compared (circle color), and the size or numeric data (indicated by the circle size).

Example: Compare revenue and units sold by gender.

Click here to read more.

Scatter Map

Use a scatter map to visualize geographical data as data points on a map.

You can visualize up to two sets of numeric data using circle color and size to represent your data.

Click here to read more.

Area Map

Area Maps allow you to visualize geographical data as polygons on a map.

You can use your data to affect the color of the areas.

Click here to read more.

Sunburst Widget

The Sunburst widget is similar to a pie chart but is multi-dimensional. Whereas a pie chart combines one field and one numeric value, the Sunburst widget can display multiple rings, one for each field. Each ring in the Sunburst shows a breakdown of its parent ring slice.

Click here to read more.

Treemap

The Treemap is a multi-dimensional widget that displays hierarchical data in the form of nested rectangles. You can use this type of chart in different scenarios, for example, instead of a column chart when you want to compare many categories and sub-categories.

Click here to read more.

Calendar Heatmap

The Calendar Heatmap widget visualizes values over days in a calendar-like view, making it easy to identify daily patterns or anomalies.

You can choose to display the data in a number of ways including 1, 3, 6 or 12 months at a time. In addition, you can display a classic or week view.

Click here to read more.

Last updated on June 9, 2017

Indicator

The INDICATOR Widget provides various options for displaying one or two numeric values as a number, gauge, or ticker. It also provides the option to add additional titles and a color-coded indicator icon representing the value, such as a green up arrow or a red down arrow.

Adding Data

  • Click ADD + in the VALUE panel to select one field whose name and value will be shown as the MAIN TITLE and MAIN VALUE, as shown below.
  • Click ADD + in the SECONDARY panel to select one field whose name and value will be shown as the SECONDARY TITLE and SECONDARY VALUE, as shown below.

Numeric Indicator

Gauge Indicator

For a gauge, select the minimum and maximum values that can be represented by the gauge. These values can either be set as a fixed numeric value that you specify or as another numeric field that you select using the Data Browser (thus making the value dynamic).

In an INDICATOR Widget, you can also define whether an icon appears in the Widget and the icon’s color. For example, you can define a red arrow pointing downwards for a negative value.

Designing the Indicator

Fine-tune the appearance of the INDICATOR Widget, using the following tools:

  • INDICATOR TYPE: Select whether the INDICATOR appears in Numeric form or as a Gauge.   
   
Numeric Gauge

Note: If you significantly shorten the height of an INDICATOR Widget in the dashboard, it automatically turns into a Ticker type Widget.

  • SKIN: Select the skin of the gauge.
  • COMPONENTS: Select which labels to include in the widget.
  • INDICATOR SUB TYPE (for numeric indicator only): You can choose a another skin option.
Last updated on June 9, 2017

Line Chart

The line chart can be used for various business cases, including:

  • Comparing data over time, for example: to analyze sales revenue for the past year.
  • Comparing changes over the same period of time for more than one group or category. Example: Analyze expenditures of different business units for the past year.

Adding Data

  • Add data to the X axis.
    • Click Add + to select the field(s) that will be represented on the X-AXIS.
    • Typically, the x-axis of a Line chart is used to represent time.
    • You must add at least one item to the x-axis, and at most, two items.
    • When you add two x-axis items, the chart’s x-axes are combined and a separate plot (line) is displayed for each unique value of the second selected x-axis.
  • Add data to the Y axis.
    • In the VALUES area, click ADD + and select the field whose value determines the height of the lines in the chart.
    • Typically, the y-axis of a line chart is used to represent numeric data.
    • You must add at least one field.
    • If you add more than one field, then each item is represented in the chart by its own line and color.

Another version of the same chart includes the following differences:

  • The second value has been changed into a column chart.
  • The second value has been added to the right axis. This is a useful option when the values are using a considerably different scale.

Both options are available by right-clicking on the value.

  • (Optional) Select a field by which to break up the data. Click ADD +.
    • Each item that is a member of the field added to BREAK BY is represented by its own line in the chart, and is automatically added to the chart’s legend.
    • You can add only one BREAK BY field.
    • The BREAK BY option is only available when you have a single field in the y-axis.

Designing the Line Chart

Fine-tune the appearance of the line chart, using the following tools:

  • LINE WIDTH:  Select either ThinBold (default)or Thick.
  • LINE TYPE: Select how the line appears in the widget: Straight (default) or Smooth.
  • LEGEND: Toggle the legend on or off, and select its position in the chart.
  • VALUE LABELS: Toggle labels on or off, and define how labels are displayed: HorizontalVertical or Diagonal.
  • MARKERS: Select whether to show or hide markers over data points. Select Full or Hollow, and Small or Large markers.
  • X-AXIS:
    • Grid Lines: Show (default) or hide grid lines.
    • Labels: Show (default) or hide labels.
    • Title: Select the checkbox to display the x-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
    • Values on Axis: To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values. To restore any of the values to their default states, click on the reset button.
  • Y-AXIS
    • Grid Lines: Show (default) or hide grid lines.
    • Logarithmic: Displays a logarithmic scale instead of a linear scale on the axis.
    • Labels: Show (default) or hide labels.
    • Title: Select the checkbox to display the y-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
    • Values on Axis: To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values. To restore any of the values to their default states, click on the reset button.

Last updated on June 9, 2017

Column Chart

The column chart can be used in different business scenarios, especially for comparing items, and comparing data over time. The chart can include multiple values on both the X and Y axis, as well as a breakdown by categories displayed on the Y axis.

Adding Data

  • In the CATEGORIES panel, click ADD + to select the field(s) whose values will be placed on the X-AXIS.
    • Typically, the X-AXIS of a COLUMN CHART is descriptive data.
    • You must add at least one item to CATEGORIES, and at most, two items.
    • When two CATEGORY items are added, then the chart’s X-AXES are automatically grouped.
    • To change the order of the categories, drag a category up or down in the CATEGORIES list.

 

ONE CATEGORY ITEM

TWO CATEGORY ITEMS

  • In the VALUES area, select the field whose value determines the height of the columns by clicking ADD +.
    • Typically, the Y‑AXIS of a COLUMN CHART is used to represent numeric data.
    • You must add at least one field to VALUES.
    • When more than one VALUE is added, then each item is represented in the chart by its own color and area.
  • BREAK BY: Select a field by which to break (group) the data represented in this chart by clicking ADD +. Each group is represented by a different column and is automatically added to the chart’s legend.
    • This is an optional field, and operates under the following conditions:
      • At most one BREAK BY field can be added.
      • The BREAK BY option is available only when a single field was added to VALUES (Y-AXIS).
      • Only a single field can be added to VALUES, if the BREAK BY option, described below, was used.

Designing the Column Chart

Fine-tune the appearance of the COLUMN CHART Widget, using the following tools:

  • COLUMN TYPE: Select how columns are represented in the Widget:
    • Classic: Columns are displayed side by side.
    • Stacked: Columns are stacked on top of each other and do not overlap. The tooltips over the columns show the percentage distribution among the VALUES.
    • Stacked 100: Columns are stacked on top of each other (but do not overlap) and the combined column is stretched to represent 100%. This option is most commonly used when the relative distribution of the values is more important than their aggregation.

Selecting the Column Type

Classic Stacked Stacked 100
     
  • LEGEND: Specify whether to show or hide the LEGEND and its position.
  • VALUE LABELS: Specify whether to show or hide labels showing values in the COLUMN CHART. You can also select the angle of the labels.

  • X-AXIS: Enable or disable the following options:
    • Grid Lines: Shows (Default) / hides.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the x-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
  • Y-AXIS: Enable or disable the following options:
    • Grid Lines: Shows (Default) / hides.
    • Logarithmic: Displays using orders of magnitude.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the y-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
    • Values on Axis: To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values. To restore any of the values to their default states, click on the reset button.
  • Auto Zoom: When a widget contains more data than can comfortably be displayed in one view, Auto Zoom will resize the chart to include more data, and in some cases adds a zoom bar under the widget. The zoom bar enables you to scroll right and left and to zoom in/out of different parts of the width of the widget.
Last updated on June 9, 2017

Bar Chart

The bar chart is commonly used to compare many items. The bar chart typically presents categories or items (descriptive data) displayed along the Y axis, with their values displayed on the X axis. You can also break up the values by another category or groups.

Adding Data

  • In the CATEGORIES panel, click ADD+ to select the field(s) whose values will be placed on the Y-AXIS.
    • Typically, the Y-AXIS of a BAR CHART is descriptive data.
    • You must add at least one item to CATEGORIES, and a maximum of two items.
    • When you add two fields to CATEGORIES, then the chart’s Y-AXES are combined.
  • In VALUES, select the fields whose values determine the length of each column.
    • Typically, the values of a BAR CHART are used to represent numeric data.
    • You must add at least one field to VALUES. When you add more than one value, each item is represented in the chart by its own color and area.
  • (Optional) Select a field by which to break (group) the data represented in this chart by clicking ADD +.
    • Each group is represented by a different column and is automatically added to the chart’s legend.
    • BREAK BY is optional, and operates under the following conditions:
      • You can add at most one BREAK BY field.
      • The BREAK BY option is available only when a single field was added to VALUES (Y-AXIS).
      • You can only add a single field to VALUES if the BREAK BY option was used.

Designing the Bar Chart

Fine-tune the appearance of the Bar Chart widget. The design options are the same as for Column Chart.

Last updated on June 9, 2017

Pie Chart

The Pie chart is used to display proportional data, and/or percentages.

Adding Data

  • In the CATEGORIES panel, click ADD + to select the data that will be displayed in the PIE CHART. You can add only one field. Typically, the categories of a PIE CHART contain descriptive data.
    • Note: All slices that are smaller or equal to 3% are grouped together into a slice called Other.
    • You can hover over this slice to display its breakdown.
  • In the VALUES area, select the field whose values determine the size of the pie slice by clicking ADD +. VALUES are typically used to represent numeric data.
    • Note: You can add only one field.

Designing the Pie Chart

Fine-tune the appearance of the PIE CHART widget, using the following tools:

  • PIE TYPE: Select how the pie appears.

 

  • LEGEND: Specify whether to show or hide the LEGEND, and select its position.
  • LABELS: Select which labels to display on the pie chart, as indicated below:

Last updated on June 9, 2017

Area Chart

An AREA CHART is very similar to a LINE CHART except that the areas under each line are filled in (colored), and it is possible to display them as stacked. The chart is recommended for displaying absolute or relative (stacked) values over a time period.

Adding Data

  • Click ADD + to select the field(s) whose values will be placed on the X-AXIS. Typically, the X-AXIS of an AREA CHART is used to represent time.
    • You must add at least one item to the X-AXIS. You can add at most two items.
    • When you add two X-AXIS items, the chart’s two X-AXIS are combined.
  • In the VALUES area, click ADD + to select the field whose value determines the height of the area in the chart. Typically, the Y‑AXIS of an AREA CHART is used to represent numeric data.
    • You must add at least one field to VALUES.
    • When you add more than one VALUE, then each item is represented in the chart by its own color and area.
  • BREAK BY (optional): Click ADD + to select a field by which to break up (group) the data represented in this chart.
    • Each field added to BREAK BY is represented by its own area in the chart and is automatically added to the chart’s legend.
    • This is an optional field, and operates under the following conditions:
      • You can add at most one BREAK BY field.
      • The BREAK BY option is available only when a single field was added to VALUES (Y-AXIS).
      • You can add only a single field to VALUES, if the BREAK BY option was used.

 

Designing the Area Chart

Fine-tune the appearance of the AREA CHART widget, using the following tools:

  • AREA TYPE: Select how areas are represented in the widget:
    • Classic: Areas overlap, meaning that smaller areas appear on top of larger areas and cover them. The colors indicate the distribution between the VALUES.
    • Stacked: Areas are stacked on top of each other and do not overlap. Hover over the columns to see the percentage distribution among the VALUES.
    • Stacked 100: Areas are stacked on top of each other (but do not overlap). The combined area is stretched to the top in order to represent 100%. This option is most commonly used when the relative distribution of the values is more important than their aggregation.
  • LINE TYPE: Select how the line appears in the widget: Straight (Default) or Smooth.
  • LINE WIDTH: Select either ThinBold (Default) or Thick.
  • LEGEND: Specify whether to show or hide the LEGEND and its position.
  • VALUE LABELS: Specify whether to show or hide labels showing values in the AREA CHART.
  • MARKERS: Specify whether to show or hide markers over data points.
  • X-AXIS:
    • Grid Lines: Shows (Default) / hides.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the x-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
  • Y-AXIS
    • Grid Lines: Shows (Default) / hides.
    • Logarithmic: Displays using orders of magnitude.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the y-axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
    • Values on Axis: To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values. To restore any of the values to their default states, click on the reset button. 
Last updated on June 9, 2017

Polar Chart

Use the polar (radar) chart to compare multiple categories/variables with a spacial perspective in a radial chart.

Adding Data

  • Click ADD + to select the field whose values will be represented as columns in the circle.
    • Each Category gets its own data point.
    • Typically, the CATEGORIES of a POLAR CHART are descriptive data.
  • In the VALUES area, click ADD+ to select the field whose values determine the distance of the column from the center of the polar circle.
    • This is typically used to represent numeric data.
    • When you select more than one value, they are stacked on top of each other.
  • Select a field by which to break (group) the data in this chart by clicking ADD +.
    • Each field added to BREAK BY is represented by its own column and color in the chart and is automatically added to the chart’s legend.
      • This is an optional field.
      • You can add at most one BREAK BY field.
      • The BREAK BY option is available only when a single field was added to VALUES (Y-AXIS).

 

Designing the Polar Chart

Fine-tune the appearance of the POLAR CHART Widget, using the following tools.

  • POLAR TYPE: Select the type of chart.

  • LEGEND: Specify whether to show or hide the LEGEND, and select its position.
  • VALUE LABELS: Specify whether to show or hide labels indicating the values. Select the orientation of these labels: Horizontal (Default), Diagonal or Vertical.
  • CATEGORIES:
    • Grid Lines: Shows (Default) / hides.
    • Labels: Shows (Default) / hides.
  • AXIS:
    • Grid Lines: Shows (Default) / hides.
    • Logarithmic: Displays using orders of magnitude.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the axis title. To edit the title, type in a new title. Click outside the text box to apply the new value.
    • Values on Axis: To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values. To restore any of the values to their default states, click on the reset button. 
Last updated on June 9, 2017

Pivot Table

PIVOT tables are one of the most useful widgets for visualizing data. They enable you to quickly summarize and analyze large amounts of data.

Adding Data

Select the data to appear in the PIVOT.

  • In the ROWS panel, click ADD + to select the field(s) whose values will be placed in the rows of the PIVOT table.

When more than one ROW is selected, the ROWS are broken into sub-rows (groups). For example, the following shows Condition added as a second ROW:

  • In the COLUMNS panel, click ADD + to select the field(s) whose values will be placed in the columns of the PIVOT table.
    • You can drag and drop the fields that you added to COLUMNS to the ROWS area and vice versa.
  • In the VALUES panel, select a field whose values will appear in the ROWS and COLUMNS of the PIVOT table.
    • Tip: Right-click the value to add data bars to your pivot table.

SUBTOTALS

You can add subtotals to one or more rows, and define how to calculate subtotals.

To add subtotals to rows:

  • Click on the menu of the ROW in the Data Panel, or right-click on the row name (header) in the widget, and select Subtotals.

To define how to calculate the subtotals:

  • Click on the menu of the VALUE in the data panel, or right-click on the value name (header) in the widget, and then click Subtotal by and the method.

The default option is Auto, which aggregates all the data. The other custom options (Sum, Min, Max, etc.) calculate only the values in the rows above the subtotal.

Look at the following example:

In the top example, using the Auto option, the subtotal for average revenue aggregates all the sales and revenue data, thus representing a true subtotal of the average revenue for the Asia region.

In the bottom example, Average is used to calculate the subtotal, and therefore calculates the average of all the average revenue values in the rows above the subtotal.

GRAND TOTALS

Grand totals aggregate the rows in the pivot table.

To add grand totals:

  • Click on the menu of the row in the data panel, or right-click on the row name (header) in the widget, and then click Grand total.

Grand totals is affected by subtotals if defined.  In the following example, the Grand total for Average Sales is 10, representing the average sales for two regions (Asia and Europe). In the example below, Average Sales has a subtotal (see above) set to Sum, and therefore the Grand total is the total of the rows above.

Designing the Pivot Table

Fine-tune the appearance of the PIVOT table, using the following tools.

  • PAGE SIZE: Specify how many rows appear in each page. Paging options are provided accordingly.
  • COLORS: Select the properties in the table to which you want to add color.

Select how the rows and columns of the PIVOT table are highlighted.

Exception Highlighting

Conditional formatting can be used for exception highlighting in a Pivot table. For example, as shown below:

Last updated on June 9, 2017

Table

The TABLE widget displays a broader view of your data, presenting raw and non-aggregated data in columns, with as much fields and metrics as needed.

Adding Data

  • Click ADD + to select the field(s) that you want to add to the table. To rearrange the order of the columns, click and drag a column up or down.

Designing the Table Panel

Fine-tune the appearance of the Table widget, using the following tools:

  • BORDERS: Select the borders to display in the table.

  • COLUMN WIDTH: You can resize the column widths as follows:
    • Fit to Window Size: Columns are resized automatically to fit the contents in the window.
    • Fit to Content: You can manually resize the column widths by dragging the column separator.

  • COLORS: Select whether to color (highlight) alternating columns and rows, and the table header.
  • WORD WRAP: Select whether to wrap texts in headers and rows.

  • INFINITE SCROLL: Toggle the INFINITE SCROLL option on or off:
    • On: Include all items in a single page with scrolling. Additional data loads as you scroll down in the page.
    • Off: Specify how many rows you want in a single page. Above the specified number, you will have paging options.

 

Last updated on June 9, 2017

Scatter Chart

The SCATTER chart displays the distribution of two variables on an X-Axis, Y-Axis, and two additional dimensions of data that are shown as colored circles scattered across the chart:

  • POINT: A field that for each of its members a scatter point is drawn.
  • SIZE: An optional field represented by the size of the circles. If omitted, all scatter points are equal in size. If used, the circle size is relative to their value.

Adding Data

  • In the X-AXIS panel, click ADD + to select the field whose values will be placed on the X-AXIS.
    • Typically, the X-AXIS of a SCATTER CHART is used to represent numeric data. Alternatively, Descriptive data is also supported. You can only add one field.
  • In the Y-AXIS panel, click ADD + to select the field whose values will be placed on the Y-AXIS.
    • Typically, the Y‑AXIS of a SCATTER CHART is used to represent numeric data. Alternatively, descriptive data is also supported. You can only add one field.
  • In the POINT panel, click ADD + to select the point field.
    • The point area determines the field to be scattered across the chart as circles; one point (circle) appears on the chart for each member of this field. These fields must be descriptive data (not numeric data).
    • You can only add a point if either the X-AXIS or the Y-Axis was defined to represent numeric data.
  • BREAK BY / COLOR: Select a field by which to break (group) the fields in the chart. This must be a descriptive field. If you select descriptive data, then the points in the chart are grouped into the members of the field. Each member is represented by a different color.ORSelect a field by which to color the fields in the chart. This must be a numeric field. If you select numeric data, then the point color is a gradient where the highest value is the darkest color and the lowest value is the lightest color.
  • In the SIZE panel, select the field that determines the size of the circle. It must be numeric data.

Designing the Scatter Chart

Fine tune the appearance of the SCATTER CHART widget, using the following tools.

  • LEGEND: Specify whether to show or hide the LEGEND, and select its position.
  • MARKER SIZE: Change the size of the circles. If you are not using a POINT value, the slider will change the size of all the points on the map. If you are using the POINT value, drag each side of the slider to determine the relative minimum and maximum circle sizes.
  • VALUE LABELS: Specify whether to show or hide labels indicating the values of each point (circle). Select the orientation of these labels: Horizontal (Default), Diagonal or Vertical.
  • X-AXIS and Y-AXIS:
    • Grid Lines: Shows (Default) / hides.
    • Logarithmic: Displays using orders of magnitude.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the axis title. To edit the title, type in a new title. Click outside the text box to apply the new value. To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values.
    • Values on Axis: To restore any of the values to their default states, click on the reset button. 
Last updated on June 9, 2017

Scatter Map

Scatter Maps allow you to visualize geographical data as data points on a map.

The map distinguishes data using different colors and sizes for the data points on the map.

Adding Data

In the LOCATION panel, you can add any field(s) that contain geographic data, and the map will find the most appropriate point. Supported Location types:

  • Country
  • City
  • State/Province
  • Latitude/Longitude (for example: 37.5601, -122.50131, but not 37.5601° N, 122.50131° W).

For example, if you have a country field, using it by itself will visualize the countries on the map.
If instead you have a city field, using it will visualize the cities on the map automatically.

Improving Geographic Accuracy

Use multiple geographic fields

To improve accuracy, it is recommended to use more than one geographic level. For example, if you have both a country and a city field, add both of them to the LOCATION panel.

Define the location type

Clicking on the geographic field’s menu will present a location type sub-menu, which contains the following options:

  • Auto
  • Country
  • State/Province
  • City

By default, Auto is always selected. This option always tries to figure out which fits best. For better accuracy, you can specify the appropriate location type.

Using Latitude and Longitude data

To visualize latitude and longitude data, you have to add one field containing latitude data, and another field containing longitude data, in this order.

COLOR

Select a numeric field here to color the scatter points on the map according to their value and color rule.

The value of the field is displayed in the tooltip of the scatter point on the map. Hover over the point to see it.

SIZE

Select a numeric field here to make the size of the scatter points on the map relative to their value in the field’s value range.

DETAILS

You can select additional data (numeric or descriptive) that will appear when hovering over the data point in the map.

Designing the Scatter Map

Fine-tune the appearance of the SCATTER MAP Widget, using the following tools.

  • MARKER STYLE: Choose between various marker styles.

  • MARKER SIZE: Select the relative size for the markers.

When the SIZE has a field in it, the slider has two levers controlling the minimum and maximum size of the points.

 

Last updated on June 9, 2017

Area Map

Area Maps allow you to visualize geographical data as polygons on a map.

You can use your data to affect the color of the areas.

Adding Data

Area Maps support fields that contain either countries or US states.

By default, a world map is used. If you add a field containing countries, they will be presented in the world map.

If you add a field containing US states, make sure to select USA from MAP TYPE in the design panel on the right.

COLOR

Select a numeric field here to color the areas on the map according to their value and color rule.

The value of the field is displayed in the tooltip of the area on the map. Hover over the area to see it.

Designing the Area Map

Fine tune the appearance of the AREA MAP widget using the following tools.

  • MAP TYPE: Choose between a world map or a US state map.

Last updated on June 9, 2017

Box & Whisker Plot

The box & whisker plot, or box plot, widget is a convenient way of visually describing the distribution, variability, and center of a data set along an axis.

Box plots are divided into four quartiles. The middle quartiles are represented by a box that contains 50% of the data and the median value. The upper and lower quartiles contain the maximum and minimum values and the remaining 50% of the data. These quartiles are represented by lines called whiskers.

The maximum and minimum values can be adjusted when defining your box plot. By default, these values are within 1.5 times of the IQR (Interquartile Range), however you can set them to the actual maximum and minimum values or to within one standard deviation of the mean of your data.

Box plots divide five descriptive statistics into four equal quartiles. You can view these statistics by hovering over the box plot.

Installing the Box Plot Widget

  • Download the attachment and unzip the contents into your C:\Program Files\vitalsBI\PrismWeb\plugins\ folder. After those files have been unzipped there, you may also have to restart the web server.
  • Create a new widget. The Box & Whisker Plot chart is displayed in the list of options.
  • Select the Box & Whisker Plot chart from the chart types menu.
  • Click Create. The widget is added to the dashboard.

Adding Data

  • In the X-AXIS panel, click ADD + to select the field whose values will be placed on the X-AXIS. The X-AXIS of a box plot is used to represent numeric data.
  • In the Values panel, click ADD + to select

Design the Box Plot

Fine tune the appearance of the box plot widget with the following tools.

  • WHISKER VALUES: Defines how the whiskers are calculated and displayed.
    • IQR (Interquartile Range): Default setting. The whisker values are calculated within 1.5 times the IQR (the difference between the 1st and 3rd quartiles).
    • Extremums: The whiskers values include the maximum and minimum values in the calculation.
    • Standard Deviation: The whisker values are calculated to one standard deviation above and below the mean of the data.
  • BOX: Specify whether to display a full or hollow box.
  • VALUE LABELS: Specify whether to show or hide labels indicating the values of each point (circle). Select the orientation of these labels: Horizontal (Default), Diagonal or Vertical.
  • LEGEND: Specify whether to show or hide the LEGEND, and select its position.
  • SHOW OUTLIERS: Specify whether to show or hide labels indicating the values of each point (circle). Select the orientation of these labels: Horizontal (Default), Diagonal or Vertical.
  • X-AXIS and Y-AXIS:
    • Grid Lines: Shows (Default) / hides.
    • Labels: Shows (Default) / hides.
    • Title: Select the checkbox to display the axis title. To edit the title, type in a new title. Click outside the text box to apply the new value. To change the default minimum, maximum or interval values on the axis, type in the new values, and click outside the text boxes to apply the new values.
    • Values on Axis: To restore any of the values to their default states, click on the reset button.
  • Auto Zoom: When a widget contains more data than can comfortably be displayed in one view, Auto Zoom will resize the chart to include more data, and in some cases adds a zoom bar under the widget. The zoom bar enables you to scroll right and left and to zoom in/out of different parts of the width of the widget.
Last updated on June 9, 2017

Sunburst Widget

The Sunburst widget is similar to a pie chart but is multi-dimensional. Whereas a pie chart combines one field and one numeric value, the Sunburst widget can display multiple rings, one for each field. Each ring in the Sunburst shows a breakdown of its parent ring slice.

Adding Data

  • In the CATEGORIES panel, select the fields whose values will be represented as slices of the ring.
    • Typically, the CATEGORIES of a SUNBURST widget contain descriptive data. Multiple fields can be added, so that each field is represented as a ring whose values are broken up by its parent ring slice.
    • You can reorder the fields using drag and drop.
  • In the VALUES panel, click ADD + to select the field whose values determine the size of the ring. VALUES are typically used to represent numeric data.
    • You can only add one field.

Designing the Sunburst Widget

Fine-tune the appearance of the SUNBURST widget using the following tools.

  • CENTER: Select which info is presented in the center of the Sunburst widget when hovering over a ring slice:
    • Value – Show the actual numeric value associated with the selected slice.
    • Contribution – Show the contribution (percentage) of the selected slice to the entire field.
    • Contribution to parent – Show the contribution (percentage) of the selected slice to its parent ring slice.
  • TOOLTIP: Determine whether to show the actual value or contribution in the slice tooltip when hovering over it.
  • LEGEND: Specify whether to show or hide the LEGEND, and select its position in the widget.
Last updated on June 9, 2017

Treemap

The Treemap is a multi-dimensional widget that displays hierarchical data in the form of nested rectangles. This type of chart can be used in different scenarios, for example, instead of a column chart if you have to compare too many categories and subcategories.

Adding Data

  • In the CATEGORIES panel, click ADD+ to select the fields whose values will be represented as rectangles in the chart.
    • Typically, the CATEGORIES of a Treemap widget contain descriptive data.
    • You can add up to three fields, so that a rectangle hierarchy is created.
    • You can reorder the fields using drag and drop.
  • In the SIZE panel, select the field whose values determine the size of the rectangles by clicking ADD +. VALUES are typically used to represent numeric data.
    • You can add only one field.
  • In the COLOR panel, click ADD + to select the field to use as the color basis for your rectangles. The following coloring scenarios are supported:
    • Color by a numeric value: If you choose a numeric value, then each rectangle will be colored according to its value in the field’s range of values. You can manipulate the coloring rules in the color formatting menu.
    • Color by field members: If you choose a field, then all rectangles that are members of that field will be colored the same. For example, if you choose to color by the field that is also used as the first category, then the entire Treemap will be split into groups of colors, like in the image at the top of this page. If you choose to color by the field that is used as the second category, then all rectangles that share the same value will also share the same color, as in the image below:

Note: You can only color by a field that is also used in the CATEGORIES panel. If you choose a field that is not there, it will be automatically added.

Designing the Treemap

Fine-tune the appearance of the TREEMAP widget, using the following tools:

  • CAPTIONS: Control which info is presented in the treemap. A checkbox will be visible for each field that is used in the CATEGORIES panel. Turning a field on/off will determine if the field member name will be visible inside the Treemap. Note that this info will always be available in the tooltip when hovering over a rectangle, regardless of the on/off setting.
  • TOOLTIP: Select whether to show the actual value or contribution in the rectangle tooltip when hovering over it.
Last updated on June 9, 2017

Calendar Heatmap

The Calendar Heatmap widget visualizes values over days in a calendar-like view, making it easy to identify daily patterns or anomalies.

Adding Data

  • In the DATE panel, select the date field that you want to be used as the calendar.
    • The calendar’s range will be between the minimum and maximum date values within the field.
  • In the COLOR panel, click  ADD + to select the field that determines which days to color.

Designing the Heatmap

Fine-tune the appearance of the Calendar Heatmap widget, using the following tools.

  • MONTHS: Select how many months should be presented at once: 1 (One Month View), 3 (Quarter View), 6 (Half-Year View) or 12 (Year View).

When more months exist than currently visible, paging arrows are displayed to move between months.

  • CALENDAR TYPE: Select between two types of view modes:
    • Classic – Each month is presented in typical calendar format.
    • Week View – Months are ordered by weekdays from top to bottom.

  • WEEK BEGINS ON: Select the first day of the week to be represented in the calendar.

MORE CONFIGURATION OPTIONS

  • Grey Out Weekends – If on, the weekend days will be colored grey in the calendar.
  • Show Day Number – Toggle whether to show the calendar day numbers inside the widget.
  • Show Day Name – Toggle whether to show the day name abbreviations on the calendar.
Last updated on June 9, 2017

Text Widgets

Add text widgets to create titles and texts that stand out, and when you want to add more descriptive explanations to the dashboard and surrounding visualizations.

In the widget’s settings, you can find plenty of options for creating different text styles. Some examples of what you can do include changing the font color, selecting a background color, adding hyperlinks, and defining the text alignment.

To add a text widget:

  1. Click on the Text Widget icon in the top menu.
    A new Text Widget appears in your dashboard.
  2. Type in your text.
  3. Use the tools in the widget’s toolbar to format your text. See some examples below.
  4. When done, click outside of the widget area to save the text and formatting.

 

To select a font style:

  1. Click anywhere in the relevant paragraph.
  2. From the styles drop-down list, select one of the five predefined styles.

 

To add a hyperlink:

  1. Select the word or text fragment to which you want to add a link.
  2. Click on the hyperlink icon, and enter the hyperlink.
  3. You can also select which text to display instead of the selected (linked) text, and whether to open the link in the same window, or in a new window.

 

To change the background color:

  1. Click on the paint bucket icon to open the color palette.
  2. Select a color from the palette, or enter a custom color (Hexadecimal format).


 

Last updated on June 9, 2017

Viewing Dashboards

You can view dashboards that you created and dashboards that were shared with you. A dashboard that was shared with you appears with this  icon in the Dashboards list.

You may receive an email with a link or you may simply see a new dashboard in your Dashboards list on the HOME page.

To view a dashboard:

  • Click on the link in the email. If you do not have a vitalsBI account, you will be automatically guided through the activation process.
    OR
  • Browse to your vitalsBI Web page, log in and click the name of the dashboard in the Dashboards list on the HOME page.
Last updated on May 31, 2017

Interacting with Filters as a Viewer

Viewers can interact with filters for analyzing data. Through the Filters pane, you can modify filters in a dashboard and change the way values are sorted in a visualization. This is useful for focusing on data displayed in dashboards that have been shared by the dashboard’s owner.

As a Viewer, you can select and deselect filter visuals on a dashboard. Each time you interact with a filter, for example by selecting or entering a value, the filter is immediately applied to your dashboard. After you have configured the relevant filters, you can save it as your default filters view.

Viewers can interact with filters as follows:

  • Make a different selection in the filter controls displayed in the FILTER panel on the right side of the dashboard, as shown below:

OR

  • Click on the pencil icon next to the filter name (shown above) in the dashboard to display the Filter Definition window.

Last updated on May 31, 2017

Changing vitalsBI’s Language

The default language of the vitalsBI Web Application is English, however, Administrators can set the default language for a vitalsBI server from the Admin section. If you are an Administrator and want to set the language for your system, users groups, or users, see Changing the vitalsBI Web Application’s Language.

If your users would like to set another language for their vitalsBI Web Application other than the language defined by the Administrator, they can select a language from vitalsBI Web Application User Options or from the Login page.

vitalsBI has translated the following languages:

  • Chinese (Simple)
  • French (France)
  • German
  • Japanese
  • Portuguese (BR)
  • Russian
  • Spanish (ES)
  • Spanish (LA)
  • Italian

In addition, any languages that your company has translated will appear in the list according to the name defined in the translated system files.

Note, the following content is not being translated:

  • Built-in Javascript editor
  • ElastiCube Manager and Server Console
  • vitalsBI documentation and online help
  • REST API and documentation
  • vitalsBI automated emails

 

To change your system’s language:

  • Select the language from the Login page of the vitalsBI Web Application.

OR
In the vitalsBI Web Application User Options, open the languages list and select the language you want to display.

After setting the user’s language, the vitalsBI Web Application will automatically be displayed in the selected language in future sessions.

Last updated on May 31, 2017

Drilling Down in a Widget

You can drill down in most widgets to get an in-depth view of a selected value.

In the following example, the pie chart on the left shows a breakdown by gender. This is the original chart as created by the dashboard’s designer. On the right side, the chart shows a breakdown or drill down showing age groups of the ‘female’ segment from the original pie chart.

With vitalsBI you can drill down from any field to any field, unless disabled by the dashboard’s designer.

To drill down into a chart:

  1. Right-click on the item in the widget into which you want to drill down.
  2. To manually select the drill hierarchy path, select Drill Into, and then in the In the Data Browser, select the field into which to drill down. If you have already drilled into this chart, then you will have shortcuts to previously selected fields, or select Choose Another Field to select a different field for the first time.
    or
    Select a predefined drill hierarchy (if available).

To drill up to a higher level, click on a breadcrumb. To drill all the way up, click on the X icon.

Last updated on May 31, 2017

Making Selections in a Widget

You can click on a specific portion of a widget to select it. Doing so filters the dashboard according to the selected data by adding a filter to the dashboard’s FILTERS panel.

You can also use the selection to drill down in the widget (see Drilling Down in a Widget).

To select an item in a widget for filtering:

  • Left-click an item in a widget to automatically select it and add a dashboard filter according to the selection.
  • For multiple selection, use the Ctrl key. When released, a menu will appear. Click SELECT.
  • In chart widgets, you can drag and draw the area to be selected, as shown below:

Last updated on May 31, 2017

Zooming In/Out in Charts

When a widget contains more data than can comfortably be displayed in one view, a zoom bar may be displayed under the widget. The zoom bar enables you to scroll right and left and to zoom in/out of different parts of the widget.

The dark gray vertical bars to the left and right of the scroll bar represent what is shown in the widget:

To zoom into an area of the chart:

  • Drag the bars closer together and position them immediately to the right and left of the area to be displayed.

To zoom out:

  • Drag the bars further apart.
Last updated on May 31, 2017

Resizing the X-AXIS to Expose Labels

The x-axis on the chart can be resized to reveal long or hidden labels.

Drag the x-axis up or down to reveal more or less of the labels.

Last updated on May 31, 2017

Creating PDF Reports

When you need to take copies of your dashboards with you for meetings or sharing with others, you can generate a PDF report of your dashboard.

By clicking the   icon on your dashboard, you can customize your dashboard’s appearance through the PDF Report Settings page. After you have defined how your dashboard is to be displayed, you can download your dashboard locally as a PDF.

To create a PDF report:

  1. From your dashboard menu, click the PDF icon  . The PDF Report Settings page is displayed.
  2. Customize how your dashboard is displayed in the PDF. For more information, see Customizing PDF Reports.
  3. Click . The dashboard is downloaded locally as a PDF file.
Last updated on May 31, 2017

Customizing PDF Reports

If you need to share dashboards with other users, or create a hardcopy for yourself, vitalsBI allows you to send an email report to your users or export your dashboard to PDF. Dashboards in email reports or PDFs though look different compared to online dashboard as they serve different purposes. Through the vitalsBI PDF Report Settings, you can customize and create nicely formatted email reports and PDFs according to your requirements. The vitalsBI PDF Report Settings allow you to define both the content and design of your report quickly and easily.

From the PDF Report Settings page, you have two modes, Edit mode, for customizing your PDF, and View mode, for seeing how the dashboard will be displayed in the PDF. In Edit Mode, all the settings you can apply to your report are displayed in the left menu.

In Edit mode, you can set the size of your report, your dashboard’s orientation, its layout, and what is displayed in the header and footer on your report.

After you have customized your report, you can save the settings and use them when sharing reports, or download the report as a PDF.

To customize a PDF report:

  1. In your dashboard’s menu, click .  The PDF Report Settings page is displayed.
  2. Toggle the mode to Edit Mode.
  3. Edit the dashboard by selecting any of the following options:
Setting Description
Paper Size The size of the email report in the PDF.
Orientation The orientation of the dashboard in the PDF, landscape or portrait. Landscape orientations display the dashboard horizontally while portrait orientations display the dashboard vertically.
Header The design and content of your report’s header. The header is displayed on the top of each page or your PDF report.

From the Header list, you can define how your header is to be displayed:
Compact, Medium, Large, or No Header.

After you have set the design, you can determine what information is included in the header.

Title: Select to display the dashboard name at the top of the PDF.
Dashboard As Of: Select to display the ElastiCube name and last build time at the top of the PDF.
Dataset Name: Select to display the name of the ElastiCube that contains the dashboard’s data.
Dashboard Filters: Select to display dashboard filter selections.

Footer The content displayed in the footer section of each page of your report. You can display the following information:

Page Number: Select to display the page number on each page of the report.

4. Click Save to save your settings when sharing reports or  to download your report.

Last updated on May 31, 2017

Downloading a Dashboard as an Image

You can download the dashboard as an image. This can be useful for including the dashboard in a presentation, web site, etc.

To download the image:

  1. Click the download button at the top right of the screen, and click Download Image.
  2. You can also define the following additional settings:
    • Show Dashboard Title: Turning this on will display the dashboard name at the top of the PDF.
    • Show Dashboard Filters: Turning this on will display a summary of the dashboard filter selections at the top of the PDF.
    • Show ElastiCube Info: Turning this on will display the ElastiCube name and last build time at the top of the PDF.
Last updated on May 31, 2017

Exporting Widgets to CSV/Excel

You can export widgets in the CSV format. This is also useful for using with Excel.

Only the displayed (filtered) data is exported according to the currently selected filters.

To export a widget to csv:

  • In dashboard view, click on the widget’s menu, and select Download > CSV File.
  • In edit widget view, click on the download icon, and select Download CSV.
Last updated on May 31, 2017

Downloading a Widget as an Image

You can download a widget as an image (png format).

To download the widget as an image:

  • In dashboard view, click on the widget’s menu, and select Download > Image.
  • In edit widget view, click on the download icon, and select Download Image.

When viewing the dashboard

When viewing the widget

Tip: The image size will reflect the size of the widget on the screen when you download it. To create a larger image, we recommend enlarging the widget space in the dashboard, or to open the widget in edit view, to get the bigger picture.

Last updated on May 31, 2017

Exporting Table Widgets to PDF

You can export table widgets in PDF format. While you may only see a partial amount of your table’s rows in a dashboard, when you export your table to PDF, the entire table is included.

Through the PDF Report Settings page, you can customize how your table is displayed in your PDF report including the table’s orientation and page size.

To export a Table widget to PDF:

  1. In the Widget menu, select Download > PDF File.

    The PDF Report Settings page is displayed.

 

2. You can apply the following settings:

Setting Description
Paper Size The page size of the PDF report.
Orientation The orientation of the dashboard in the PDF, landscape or portrait. Landscape orientations display the dashboard horizontally while portrait orientations display the dashboard vertically.
Header Select Title to display the widget’s title in the header of the PDF report.
Footer Select Page Number to display page numbers for each page of the PDF report.

3. In the Preview area, click the title to edit the text, size, and alignment of the title.

4. Click the Download  to download your report.

Last updated on May 31, 2017

Managing and Sharing Dashboards

This documentation in this section describes how to manage and share Dashboards.

Here are some shortcuts to some of the main sections.

Last updated on May 31, 2017

Organizing Dashboards

This chapter describes how to manage and share Dashboards.

This chapter is only for vitalsBI users who have dashboard editing rights (Designers).

Organizing Dashboards in Folders

You can organize your dashboards into folders and sub-folders within any of your folders to improve how your viewers navigate the Dashboard list.

To create a folder:

  1. In the Dashboard list, click + and select New Folder.

    The new folder is added to the dashboards list.
  2. Hover over the new folder and click    > Rename to name the folder.
    To create additional sub-folders within your folders, hover over the folder and select > New Folder and repeat Step 2.

 

Locating a Dashboard

You can quickly and easily locate dashboards without having to navigate through your entire list of dashboards. When you enter any characters in the Search field, the list of dashboards is filtered according to the characters found within your dashboard titles.

To locate a dashboard:

  1. In the Dashboard list, click  to display the Search field.
  2. In the Search field, enter the title of your dashboard. Any dashboards that contain the characters you entered are displayed.

Deleting a Dashboard

To delete a Dashboard:

  • Click on the menu   button of the Dashboard to be deleted in the list in the HOME page, and select Delete.

    OR
    Click the Dashboard Menu  button and select Delete Dashboard.

 Copying a Dashboard

Copying a dashboard (even one that was shared with you) creates a new copy of the dashboard with a different name. This new dashboard is totally separate from the original and you are its owner, meaning that you have full editing rights. When you copy a dashboard, the new dashboard is added below the copied dashboard in your Dashboard list with the same name plus a number in the order it was created.

For example, Tutorial(1) and Tutorial(2) are copies of Tutorial, while Tutorial(2)(1) is a copy of Tutorial(2):

To copy a Dashboard:

  • Right-click the dashboard’s name in the Dashboard list in the HOME page and select Make a Copy.
Last updated on May 31, 2017

Exporting and Importing Dashboards

vitalsBI supports exporting and importing of dashboards. This is useful for copying dashboards between separate vitalsBI installations, and also for making backups.

Dashboards are exported as files with a dash extension, which can then be imported.

Exporting a Dashboard

Administrators and Designers can export dashboards and import them into multiple instances of vitalsBI from the vitalsBI Web Application. When you export a dashboard or multiple dashboards, a single .dash file is created. Afterwards, when the .dash file is imported into another instance of vitalsBI, all the dashboards are added to the main Dashboard list.

To export dashboards to a .dash file:

Option #1 (Single dashboard)

In the Dashboard list on the left of the vitalsBI environment, click the dashboard’s menu and click Export Dashboard.

Option #2 (Single dashboard)

Open the dashboard’s menu and click Export.

Option #3 (Multiple dashboards)

In the Dashboard list on the left of the vitalsBI environment, click  . This displays checkboxes next to all of your dashboards and folders. Select the relevant dashboards and folders to be exported and click  .

All of these methods prompt you to download the .dash file and save it to disk.

After you have downloaded the exported file, you or your users can import it into their instance of vitalsBI. For more information, see Importing Dashboards.

 

Importing a Dashboard

To import a dashboard:

  1. Hover over Dashboards list in the home page and click the ‘+’ symbol. Select Import Dashboard from the menu. You can also right-click anywhere in the dashboards list, or click on the menu of one of your existing folders to import a dashboard into a folder.
  2. Select your exported dash file. The dashboard will be added to your list of dashboards or folder. You can drag it from there to your desired location in the tree.

Last updated on May 31, 2017

Sharing Dashboards

Owners can share dashboards that they have created with other vitalsBI users (Viewers and Designers). An owner is any Designer who has created a dashboard. When you share a dashboard, you can define whether the recipient has editing rights:

  • Designers have editing rights.
  • Viewers have viewing/filtering rights.

After you share a dashboard, or for any dashboard shared with you, in the Dashboards list the   icon appears next to the dashboard.

You can hover over the dashboard in the Dashboards list to view ownership details.

When you share your dashboard, you can configure vitalsBI to send periodic email notifications containing the dashboard inside the email’s body to your dashboard’s recipients.

 

Working with Shared Dashboards

A dashboard recipient can edit the dashboard if you grant them permission, but the changes they make in the dashboard do not affect your copy of the dashboard. The recipient’s changes are automatically performed on a separate copy of the dashboard (to which only they have access).

Dashboard recipients can revert to your latest shared copy at any time by right-clicking the dashboard’s name in the Dashboards list on the left of the vitalsBI environment and selecting Restore Dashboard.

When you share a dashboard that’s contained within a folder, the dashboard is shared using the same structure (under the same folder).

When a Designer shares a dashboard with you, you become a recipient and all of the above applies to you.

To share a Dashboard:

  1. In the heading of your dashboard, click the Share  button.

    OR
    In the Dashboards list, select  > Share for the dashboard you want to share.
  2. Enter the emails or groups of users with whom to share the dashboard. Selecting Everyone specifies that this dashboard is shared with all vitalsBI users and user groups.
    The contact information of the people you add is listed in the center of the window and is displayed the next time you open this window.
    If a person does not have a vitalsBI account, they receive a link that guides them through the activation process.
    vitalsBI users are defined by your vitalsBI administrator.
  3. In the dropdown menu next to each user/user group select whether the user is a designer with editing rights (Can edit) or a viewer (Can view).
  4. Toggle the Email Reports  button next to each user/user group on/off to define whether the user receives scheduled email reports of the dashboard. Read more on email reports below.
  5. The Dashboard URL field at the bottom displays a direct link to this dashboard that you can copy/paste.
  6. Click Save.

Publishing Dashboards to Recipients

When an owner modifies a dashboard, for example, by adding a new widget, the dashboard is not automatically updated for recipients. The owner of a dashboard must publish their updated dashboard to update the dashboards of their recipients and the dashboard recipients must refresh the dashboard before any of the owner’s changes are applied.

To publish a dashboard to your recipients:

  • In the heading of your dashboard, click REPUBLISH.
    OR
    In the Dashboards list, right-click the dashboard’s name and select  >  REPUBLISH.

 

Updating a Shared Dashboard

When a recipient modifies a shared dashboard, those changes remain local unless the recipient updates their dashboard to match the dashboard of the owner. If the recipient updates their shared dashboard to match the dashboard of the owner, any of their local changes to the dashboard are overwritten. vitalsBI recommends that recipients save any local versions of a shared dashboard as a new dashboard before updating a dashboard.

To update a shared dashboard:

  1. In the heading of your dashboard, click  > Restore Dashboard.
    OR
    In the Dashboards list, right-click the dashboard’s name and select  >  Restore Dashboard.
  2. Click YES to confirm that you want to update the shared dashboard.

 

Changing Ownership of a Dashboard

The owner of a dashboard can transfer ownership of the dashboard to an Admin or another Designer. Transferring ownership of dashboards can be useful when the original owner leaves your company and you do not want to lose their dashboards.

When you transfer ownership, the dashboard remains as a shared dashboard within your Dashboards list, and you become a dashboard recipient. As a dashboard recipient, you are limited to how you can modify the dashboard as described in Working with Shared Dashboards.

To transfer ownership of a dashboard:

  1. In the heading of the dashboard you want to transfer ownership of, click the Share button.
    OR
    In the Dashboards list, select Share of the dashboard.
    The Share window is displayed.
  2. Enter the name of the Admin or Designer you want to transfer ownership to.
  3. In the User Privilege list of the user you want to make an owner, select Make Owner.
  4. Click Save. A Warning message is displayed.
  5. Click OK to confirm that you want to transfer ownership to the user.

 

Sending Email Dashboard Reports

After you share your dashboard, you can configure the vitalsBI Scheduler to send periodic email reports containing a static version of the dashboard that can be clicked to access the dashboard or PDFs containing images of your dashboard.

From your dashboard, you can configure how many emails the Scheduler sends and when.

To test how the report is to be displayed to your shared users, in the Shared Dashboard window, click the Send me a report now link, which generates an email report sent to your email address immediately.

To schedule email notifications:

  1. In your dashboard, click the Share icon to display the Share window.
  2. In the Shared Dashboard window, click the   tab.
  3. Select the type of report you want to send. There are two types of email reports you can send:
    Email Report: The email report is attached as an image file.
    PDF Attachment: The email report is attached as a PDF. You can define how the dashboard is to be displayed in the PDF through the PDF Report Settings page by clicking Edit/View PDF Report. For more information, see Customizing PDF Reports.
  4. In the Schedule area, select the frequency for sending email notifications. You can select one of the following options:
    Option Description
    Every ElastiCube update, no more than X emails per day Select to send a report each time you update the ElastiCube up to the amount of emails you define in the Number box.

    In the Number box, type or select the amount of emails that can be sent a day, regardless of the amount of builds.

    Daily Select to send one email report according to the time you define.

    In the Everyday box, select the days the scheduled report is to be sent. You can select multiple days by clicking the day.

    Select the Hour and the Time Zone that the email is to be sent on the days you selected.

5. Click Save.

Last updated on May 31, 2017

Email Troubleshooting

If you are not receiving email notifications, check your spam filter and email junk folder. If you still believe you have experienced a problem with email notifications, please contact vitalsBI Client Support.

Last updated on May 31, 2017

Overview

vitalsBI Pulse is a centralized location where you can stay on top of your most important KPIs across multiple dashboards or manage your data and build alerts.

For example, you can consolidate and monitor important aspects of your business by adding Indicator widgets from various dashboards to the vitalsBI Pulse page.

Then, you can create alerts to notify you when certain thresholds are met or anomalies in your data are detected. vitalsBI Pulse provides you with access to your most important data and notifies you when to act.

The following sections describe vitalsBI alerts and managing alerts and KPIs in your vitalsBI Pulse page.

Last updated on June 5, 2017

vitalsBI Alerts

vitalsBI offers two types of alerts you can define, data alerts and system alerts.

Data alerts are triggered by changes to your data. vitalsBI provides several options for defining the type of changes that trigger data alerts including threshold based alerts, automatic anomaly detection, and Always which is triggered by any change to your data. For example, if you have an Indicator widget that represents total sales, vitalsBI can notify you when a threshold you defined is met or exceeded.

System alerts can be configured to be sent following build attempts.

When creating an alert, you can customize your notifications, the channel through which they are sent, and how often a notification is sent following a data or system event.

After you create an alert, the alert is added to the vitalsBI Pulse page where you can manage the alert and its notifications. For example, you can delete alerts or enable and disable notifications.

If you want to make a similar alert, for example, alerts with different notifications for different groups of users, you can duplicate the alert and modify its settings.

When an alert is triggered, you and your users are notified through the channel you defined when creating the alert and through the Pulse Feed. The Pulse Feed is displayed in the vitalsBI Web Application and shows a list of your most recent triggered alerts.

 

These sections describe how to create data and build alerts and how to manage them:

Last updated on June 5, 2017

Creating Data Alerts

Data alerts are triggered by conditions you define for your widgets. For example, if you have an Indicator widget that represents your company’s revenue, you can define an alert that notifies you when this revenue reaches or falls below a certain threshold.

vitalsBI supports alerts for the following widgets:

Indicator Widgets

Area Chart Widgets

Bar Chart Widgets

Column Chart

Line Chart

For each type of widget you can add to Pulse, you can monitor a single value. For example, for Column charts you can monitor the value of a single column. To monitor multiple values, you can add each value you want to monitor to Pulse separately.

When creating data alerts, you define the condition that triggers the alert. vitalsBI provides three alert conditions that can trigger an alert:

 Threshold

vitalsBI notifies you when a threshold is reached following a build. This condition is useful for monitoring metrics that follow a regular, cyclical schedule.

 Automatic

vitalsBI automatically notifies you when the vitalsBI alert engine identifies an anomaly in your data based on machine learning algorithms. The vitalsBI algorithm actively learns from your data and eliminates noise to identify anomalies in your data. vitalsBI’s anomaly detection is based on a smoothing algorithm that takes the latest values into account. The more times an ElastiCube is built, the more accurate vitalsBI becomes at identifying any anomalies and notifying you.

 Always

vitalsBI notifies you anytime there is a change to your widget’s data. This condition is useful for metrics that do not frequently change.

In addition, you can configure advanced settings that determine who receives the alert and what channel the alert is sent through. For more information see Advanced Settings.

To create a Data alert:

  1. From an indicator widget’s menu, select Add To Pulse.
  2. The Add to Pulse window is displayed.
  3. In the Name field, enter a meaningful name that represents your alert.
  4. In the Alert Condition area, select the condition that triggers the alerts.
    Threshold: vitalsBI defines the threshold value as the current value displayed in the widget. You can increase or decrease this value and define the equality and relational operators that determine when the threshold is met.

    Automatic: vitalsBI automatically identifies anomalies in your data and alerts you.

    Always: vitalsBI notifies you every time the data changes.
  5. Click ADD to create the alert. The alert is added to vitalsBI Pulse.

For additional advanced configuration options, see Advanced Settings.

Last updated on June 5, 2017

Creating Build Alerts

VitalsBI Administrators can set build alerts, which is an administrative level function, to notify themselves or other users when a build fails or succeeds. The standard process vitalsBI administrators follow for building ElastiCubes for clients is to physically monitor the builds.

Build alerts allow for remote monitoring of ElastiCube builds.

vitslaBI Administrators are experienced in creating build alerts from the Admin section of the vitalsBI Web Application.  If you would like to be notified when your ElastiCubes are being built, please notify your vitalsBI administrator to create a build alert and add you to the notification.

Last updated on June 5, 2017

Advanced Settings

Notifying Additional Users

When an alert is triggered, Administrators and Designers can notify additional vitalsBI users and groups by configuring the alert’s advanced settings. Viewers cannot share alerts with additional users.

Users who are notified receive a notification through vitalsBI Pulse and any other additional channels you define.

To notify additional users:

  1. For Data Alerts, select Advanced Options> .
  2. Enter the email address, vitalsBI username, or group name of the users you want to notify when an alert is triggered. Entering Everyone specifies that all vitalsBI users and user groups associated with your account are notified.
    The contact information of the people you add is listed in the center of the window and is displayed the next time you open this window.
  3. Click Add to add the alert to Pulse.
Last updated on June 5, 2017

Setting Notification Channels

By default, your users are notified via their email addresses when registered with vitalsBI. In addition, vitalsBI supports a variety of workflows by sending notifications across multiple applications and services. For example, your users can receive notifications through the vitalsBI mobile application, Zapier, Slack, and other 3rd party services via webhooks.

To define how users are notified:

  1. For Data Alerts, select Advanced Options.
  2. In the Notifications area, select the relevant channel for your notification. The default channel, Email, is already selected.

You can select one or more of the following channels:

3. Click Save.

Mobile

The vitalsBI Mobile app, available in version 7 in the Fall of 2017, enables users to view vitalsBI dashboards through their mobile devices. You or your users can receive notifications through the vitalsBI Mobile app. After selecting the users you want to notify, any users with a vitalsBI user account and the vitalsBI Mobile app will receive a notification when an alert is triggered.

Slack

Slack is a real-time team collaboration messaging platform that allows you to receive incoming Webhooks from external sources such as vitalsBI. To send notifications through Slack, you need to enter the URL and optionally, your Slack channel or username, where the notification is to be displayed.  Please contact vitalsBI Client Support if you decide to use and want to configure Slack.

You can obtain these details by adding the Incoming WebHooks app into your Slack configuration.

To obtain a Webhook URL and channel from Slack:

  1. Add the Incoming WebHooks app to Slack. You can find this app in Slack’s App Directory.
  2. In the Incoming WebHooks app page, click Add Configuration.
  3. After you add the Incoming WebHooks app, you can select which channel to post the notifications to. The channel name is optional and displays the notification in the channel associated with your WebHook URL. In the Post to Channel area, select the channel where the notification is to be displayed and click Add Incoming WebHooks integration.
  4. In the Setup Instructions the Webhook URL is displayed. Copy the Webhook URL.
  5. In vitalsBI when sending notifications through Slack, in the URL field, enter the URL copied in the previous step and in the #channel/@username field, enter the channel name if you have defined one.

Zapier

Zapier is an online service that lets you create automated actions connecting disparate business apps and services such as vitalsBI. To receive notifications through Zapier, you must create a Zap and provide vitalsBI with the relevant URL when configuring your alerts’ notifications.

When an alert is triggered, vitalsBI sends the notification to the Webhook you define in Zapier.

To obtain a Webhook URL from Zapier:

  1. Log in to Zapier and click Make a Zap. The Trigger App page is displayed.
  2. From the Trigger App page select Webhooks. The Connect to Webhooks by Zapier page is displayed.
  3. In Step 1> Set Up Webhook, click Copy to clipboard to copy the Webhook URL you need to provide to vitalsBI.
  4. In vitalsBI, when sending notifications through Zapier, in the URL field, enter the URL copied in the previous step.

Webhooks

Webhooks are a system of automated notifications that indicate that an event occurred, in this case an alert being triggered. To send notifications through additional 3rd party channels, you can select Webhook and enter the Webhook name and URL.

Your Webhook server listens for incoming messages from vitalsBI across the URL specified in the URL field.

When vitalsBI sends notifications to your custom Webhook, they are sent within a JSON payload. Your Wehbook provider must interpret the payload and display the notification to your users. The following are examples of notifications sent in a JSON payload and a description of the contents of the payload:

 

Data Events

{ type: 'kpi',
 name: 'Total Sales',
 message: 'Hello World',
 originDashboardLink: '58128745677f52dc0f000019',
 measure: 'Revenue',
 value: 39759625.51502721,
 condition: 'none',
 filters:
  [ { asDimension: false,
      title: 'Category',
      value: 'Include all',
      jaql: [Object],
      panel: 'scope' },
    { asDimension: false,
      title: 'Gender',
      value: 'Include all',
      jaql: [Object],
      panel: 'scope' } ]
Build Events

{ type: 'build',
  name: 'Success Event',
  measure: null,
  value: 1,
  condition: 'none',
  filters: null }

 

Name Type Description
Type String Type of alert. ‘kpi’ for data events and ‘build’ for build events.
Name String Name of the alert.
Message String Notification message.
originDashboardLink String Dashboard ID provided by vitalsBI. You can find the dashboard ID from the URL of the dashboard.
For example, the ID of the dashboard below if:http://localhost:8081/app/main#/dashboards/573b4322048e5e382a000001
value Double For data events when a threshold condition is applied, this is the value of the threshold.

For build events, the value is 0 for failed builds and 1 for successful builds.

condition String Type of condition that generated the alert.
filters Object Object that defines filters applied to the dashboard.
Last updated on June 5, 2017

Configuring Additional Options

You can configure how often and when a notification is sent after an event is triggered. For example, you can limit the amount of notification sent to one when a data alert is triggered. This is useful if you build your ElastiCubes frequently, but do not need multiple notifications.

To configure additional options:

  1. When adding or editing a widget to Pulse, in the Advanced Options window, select >Additional Options.
  2. For data alerts:
    • Select Notify only once after a condition is met to limit how many notifications are sent to notification after an event occurs.
    • Select Notify when a condition is no longer met to notify users after the event is no longer triggered.
  3. Click Add to save the alert.
Last updated on June 5, 2017

vitalsBI Pulse

vitalsBI Pulse can be personalized to your needs so you can stay on top of your most important KPIs across all your dashboards and your latest ElastiCube builds. By adding important KPIs from your dashboards to vitalsBI Pulse, you can get a comprehensive picture of your data from a single location.

vitalsBI Pulse contains tiles that display information from your dashboards and the status of your ElastiCube builds.

Within vitalsBI Pulse, there are two types of tiles, data tiles that display your Indicator widgets’ current status and recent history and build tiles that display the latest status of your ElastiCube builds.

You can access vitalsBI Pulse from the menu bar of the vitalsBI Web Application.

By hovering over the header of any tile in vitalsBI Pulse, you can view additional options that provide more information.

The  icon opens a new tab in your browser. For data tiles the dashboard where the related Indicator widget originated is displayed and for build tiles the ElastiCubes page in the Admin area is displayed.

The  icon is a tooltip that describes the tile in more detail. For data tiles the tooltip describes who added the tile to Pulse and when it was added. Build tile tooltips describe when the tile was created, which ElastiCube is being monitored, and under what conditions an alert is triggered when alerts are enabled.

The  icon displays a menu for managing tiles in vitalsBI Pulse. For more information regarding managing tiles in vitalsBI Pulse, see Managing Tiles in vitalsBI Pulse.

Adding Tiles to vitalsBI Pulse

To keep track of your important KPIs and ElastiCube builds, you add the relevant data and build tiles to vitalsBI Pulse.

The flow for adding tiles to vitalsBI Pulse is the same for creating alerts for Indicator widgets and ElastiCube builds. For more information about these flows, see the following topics:

For data tiles, see the section on creating data alerts.

For build tiles, contact your vitalsBI administrator.

Each of these flows adds tiles to vitalsBI Pulse and creates an alert. If you want to monitor your data and ElastiCube builds without alerts, see Deactivating Notifications section below. If you need assistance deactivating alerts please contact your vitalsBI administrator.

Managing Tiles in vitalsBI Pulse

After you have created alerts or added tiles to vitalsBI Pulse, you can manage those tiles from vitalsBI Pulse. Through the vitalsBI Pulse page, you can duplicate alerts and modify them, disable notifications, and delete alerts.

Duplicating Tiles in vitalsBI Pulse

You can create copies of alerts and modify them to quickly generate new alerts with different notification messages or notify various groups across separate channels.

For example, if you want to notify Group 1 via email and Group 2 via Slack when the same event occurs, you can duplicate an alert and modify the notification channel.

To duplicate a tile:

  1. In the vitalsBI Web Application, select Pulse.
  2. In the relevant alert’s menu, select Duplicate. A copy of the alert is created and the Add to Pulse window is displayed.

 

You can modify the alert’s settings from the Add to Pulse window. For more information about these settings, click here.

Deactivating Your Notifications

Each time you add a tile to vitalsBI Pulse or create an alert, by default, you will receive notifications when the event is triggered. If you want to just monitor KPIs from vitalsBI Pulse, or you do not what an receive any notifications, you can disable notifications from being sent by toggling the notifications. When you toggle the notifications, you no longer receive notifications when an alert is triggered, however, other users with whom the alert was shared will continue to be notified. See Deactivating Notifications for All Users to turn off notifications for everyone associated with an alert.

To deactivate notifications:

  1. In the vitalsBI Web Application, select Pulse.
  2. From the Tile menu of the relevant alert, toggle Receive Notifications.

Deactivating Notifications for All Users

If you have added an alert that is no longer relevant or you want to deactivate the alert for all users, you can turn off the alert.

When you turn off an alert, no users are notified when the event that triggers the alert occurs.

To deactivate notifications for all users:

  1. In the vitalsBI Web Application, select Pulse.
  2. From the Tile menu of the relevant alert, select Turn Off. A confirmation dialog box is displayed.
  3. Click Yes to confirm that you want to turn off all notifications for the alert. The alert is turned off.

Alerts that have been turned off appear in the Pulse page as shaded tiles. You can reactivate the alert by selecting Turn On from the Tile menu.

Deleting Tiles in vitalsBI Pulse

When a tile is no longer needed, you can delete the tile through the vitalsBI Pulse page.

Deleting an alert removes it from the vitalsBI Pulse page and users are no longer notified.

To delete an alert:

  1. In the vitalsBI Web Application, select Pulse.
  2. In the relevant alert’s menu, select Delete.

Removing vitalsBI Pulse

You can remove the vitalsBI Pulse from visibility and and prevent it from being used.  To remove vitalsBI Pulse from use, please contact your vitalsBI administrator and make a formal request

Last updated on June 5, 2017

Installed Release

6.6.0.10327

Release Date: April 18, 2017

Release Summary

  • Official release of VitalsBI V6.6

New Features and Improvements

Introducing VitalsBI Live Connect

  • Access, govern and visualize live data directly from SQL Server, MySql, Postgres, and Redshift for an immediate view of your data
  • Present live and ElastiCube data in the same dashboard for a more complete analysis
  • Refresh widgets with live data automatically or manually from the VitalsBI Web Application

Enhanced VitalsBI Reports

  • Transform dashboards into professional, and easy-to-read PDF reports
  • Export Table widgets into customized multi-page PDF reports
  • Control how dashboards look and feel with predefined paper sizes and customized headers and footers
  • Preview reports from the Report Settings window before sharing

New VitalsBI Migration Capabilities

  • Easily copy dashboards across environments from the VitalsBI Web Application
  • Import and export multiple dashboards in a single dash file

Internationalization and Localization

  • VitalsBI supports multiple languages on the same VitalsBI server
  • Users can select their preferred language from the VitalsBI Web Application
  • Translate more VitalsBI metadata including widget titles, dashboard names, and folder names
  • Define default languages for new users and groups
  • Italian now supported

Security

  • Improved security for VitalsBI user passwords which are now encrypted with a stronger encryption methodology

Dashboard Enhancements

  • Perform operations (export/delete/copy to server) on multiple dashboards and folders at once
  • Support for filters from multiple data sources in the same dashboard

Mobile Filters

  • New filtering functionality included in the VitalsBI mobile app.

Data Connectors

  • Bing
  • Box
  • Google AdWords API has been updated to the latest version, v201702. Google Adwords API v201607  supported by VitalsBI v6.5.1 and earlier has been deprecated.
  • ServiceNow, Youtube, Youtube Analytics are available for general release
  • Accumulative builds for numeric data supported for Facebook, DynamoDB, HubSpot
  • Improved rate limitation handling for Facebook
  • VitalsBI now supports the following for Splunk:
    • Importing the latest artifact from a list instead of the first (oldest) one
    • Importing data from specific Splunk apps

Other

  • ElastiCube performance enhancements including faster queries when used in conjunction with Rank filtering, Statistical functions, and Distinct Count
  • Many more REST API capabilities
  • More PSM.exe commands added for automating ElastiCube model changes
  • Windows 2016 is now supported

Selected Bug Fixes

  • In some cases, builds failed with the message: “Failed to Load Elasticube <name of the EC> Process” for several build types and during various build stages
  • In certain scenarios, builds failed with the message “Connection Lost”, during the calculation of custom tables
  • Occasionally, the Dashboard navigation tree did not load as expected or after a significant amount of time
  • Inner arrays in Custom REST Connectors were not handled as expected for certain data sources
  • Importing tables from Google Analytics failed in some cases with the message: “GA analytics query returned wrong results” thrown by the data source
  • The full Google Analytics paths were not displayed in tooltips in the ElastiCube Manager
  • Exported CSV files with certain escape characters were not displayed as expected
  • When applying date-related filters to Calendar Heatmaps, the widget was not displayed as expected
  • When changing connectivity settings, Change Source Provider did not change the source for each table for a data source
  • Calendar heatmap widgets were not displayed correctly when uBlock was installed
  • The GET /elasticubes/{elasticube}/Sql endpoint with certain queries returned a parsing error
  • The POST /elasticubes/ attach and detach endpoints did not work as expected
  • When changing the Min and Max values of a Gauge widget, the values were not updated in certain scenarios
  • After upgrading to VitalsBI V6.5, some existing Active Directory users experienced login issues

Limitations

VitalsBI Live Connect

The current features are not supported by live connections:

  • Pulse alerts
  • Box & Whisker and Heatmaps
  • R is not currently supported
  • Some functions are not currently supported
  • Changing live data sources for dashboards

VitalsBI Reports

  • The current plug-ins are not supported in VitalsBI Reports:
    • Accordion
    • Forecasting
Last updated on May 31, 2017

Community

Consult our user forums to find new ideas and solutions.

Knowledge Base

Read, watch, and make the most out of vitalsBI.

Submit a request

Stuck? Get help from our Support Team.

Case Studies

Discover your next win. Read our success stories

Pin It on Pinterest