Create an Analytics view and add modules

πŸ’¬

Get access to the Analytics view

Reach out to our Customer Success team to add the Analytics view functionality to your Formant organization. You can reach us through the Intercom messenger in the bottom-right corner of this page, or at [email protected].

This guide will teach you how to add and configure an Analytics view to your device in Formant.

Video walkthrough

Check out the video below to see an example of an Analytics configuration, and see a step-by-step walkthrough of how to create an Analytics view and add modules:

Step-by-step instructions

Step 1: Create an Analytics view

  1. In Formant, in the upper-left corner, open the menu and select the device for which you want to view Analytics.
  2. In the header, click the right chevron >> Add View >> Analytics, or type Shift + D and select Analytics. This will add an Analytics view to your device.

Step 2: Add a module

Click the pencil icon >> + (plus) icon to add an Analytics module.

Step 3: Configure a data source for a module

  1. Under Values, click Add..., and then select your data source: Tasks or Streams:
    1. Tasks: Select a task summary which contains the data you want to visualize.
    2. Streams: You can plot historical stream data for your device directly from Formant.
Choosing a data source for a Chart module in an Analytics view.

Choosing a data source for a Chart module in an Analytics view.

πŸ“˜

Task summaries

To visualize task summaries, you must first upload a task summary format, and then task summaries in that format, to Formant via the Task Summary API. For more information, see Task summaries.

  1. Once your module has been created, you can configure the data presentation via the built-in editor, or using your own custom SQL queries:
Built-in Analytics module features.

Built-in Analytics module features.

PropertyUsage
NameDisplay name of this analytics module.
VisualizationVisualization type for this analytics module.

Visualizations available: Line, Bar, Table, Pie, Summary.
ValuesData series to plot in this analytics module.
Group byX-axis groupings for this data set.

Groupings available: None, Hour, Date, Day of week, Week, Month, Year
AdvancedClick this button to open the SQL editor. You can see the SQL query which is generating the current data visualization, and customize this with your own SQL to create custom visualizations.

Step 4 (optional): Use a custom SQL query

To customize the SQL query used to generate your data visualization, click the Advanced button. This will open the SQL editor for this module, where you can enter your own SQL query and customize your data visualization:

Writing a custom SQL query.

Writing a custom SQL query.

πŸ‘‹

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].