1. Overview

From version 7.1.0.375 RC2, open source BI Helical Insight is providing JSON specification support across it’s various modules like Report Designer, Canned Report, Dashboard Designer and semantic model layer. The specification exposes the configuration of a report or dashboard in a structured JSON format. Users can inspect the configuration, copy it for reuse, or edit the JSON to make supported changes.

This capability can make report and dashboard creation more efficient, support reuse of existing configurations, and simplify migration or recreation work when a compatible JSON structure is available.

Key idea: Configure a report or dashboard visually, then use its specification as a reusable JSON representation.

2. Benefits

  • Faster creation: Start from an existing specification instead of configuring every component again.
  • Reuse and sharing: Copy a specification and share it with another Helical Insight user as a starting point.
  • Easier maintenance: Inspect or edit supported configuration values in one structured view.
  • Migration assistance: Use JSON from another BI platform as a reference and map or convert its configuration to the structure expected by Helical Insight.
  • AI-assisted configuration: An AI application can help draft JSON for a desired report or dashboard layout, which can then be reviewed and applied.

3. Using JSON in the Ad-Hoc Report Designer

3.1 Open Report Spec

Follow these steps:

  1. Open the required report in the Report Designer.
  2. Locate the Visualization panel on the right side of the designer.
  3. Select the three-dot (…) hamburger menu beside the Visualization heading.
  4. Choose Report Spec from the menu. The Report Spec panel opens and displays the report configuration as JSON.

JSON Support across various modules

3.2 View, Copy, and Edit the JSON

The Report Spec panel displays the report’s JSON configuration in an editor. The panel also provides controls for searching within the JSON, copying the specification, and saving changes (as shown by the controls at the top of the panel).

  • Review the JSON to understand how the report is configured.
  • Use the copy control to copy the specification when you want to reuse or share it.
  • Edit the JSON when you need to change supported configuration properties.
  • Use the save control after making changes, where applicable, and validate the report in the designer.

JSON Support across various modules

A copied report specification can be shared with another Helical Insight user or retained as a template for a similar report. The receiving user can use it as a starting point and adjust fields, filters, and other configuration values as required.

4. Using JSON in the Dashboard Designer

4.1 Open Dashboard Spec

Follow these steps:

  1. Open the required dashboard in the Dashboard Designer.
  2. Locate the Dashboard Spec control in the top toolbar. In the supplied interface, this is the document-shaped icon with the Dashboard Spec tooltip.
  3. Click on it and you can view the JSON of the dashboard.

JSON Support across various modules

5. Using JSON in the Canned Report Designer

5.1 Open Canned Report Spec

Open the required canned report in the Canned Report Designer.

JSON Support across various modules

In the Canned Report Designer, locate the document-shaped icon in the top toolbar. Hover over the icon to confirm the Canned Report Spec tooltip, then select it to open the Canned Report Spec panel.

6. Using JSON in the Semantic Model Layer

Semantic model layer is created on top of metadata and is used by InstantBI AI module to ask questions from the data. There is JSON support in that module as well.

The Model Spec provides a complete representation of the Semantic Model configuration in JSON format. Every action performed in the Semantic Model Designer — such as adding fields, creating hierarchies, defining domains, assigning topics, aliases, other instructions and configuring field properties — is automatically reflected in the JSON.

This allows users to view the underlying configuration of their Semantic Model in one place. Advanced users can also directly inspect and modify the JSON configuration when required.

Model Spec Toolbar Options

The Model Spec toolbar provides the following options:

  • View Raw JSON: Opens the complete Semantic Model configuration in JSON format, allowing users to inspect the configuration and make manual modifications when required.
  • Copy JSON: Copies the entire Semantic Model configuration to the clipboard. This can be used for backup purposes, sharing the configuration with other team members, or reusing the model in another Helical Insight instance.
  • Paste JSON: Allows users to paste a previously copied JSON configuration to import and recreate or update the Semantic Model without manually configuring each component. Find & Replace option is also available.

JSON Support across various modules

7. Important Considerations

  • Keep a backup of the original JSON before making changes.
  • Ensure the JSON is syntactically valid, including quotation marks, commas, brackets, and braces.
  • Use field names, table names, data source identifiers, and component properties that exist in the target Helical Insight environment.
  • When moving JSON between environments, check whether data source IDs, schemas, permissions, and other environment-specific values need to be updated.
  • JSON generated by another BI product or an AI application may require conversion or correction before it can be used.
  • After applying changes, preview the output and confirm that the report or dashboard behaves as expected.

Need Help with Helical Insight?

In case of any questions, please reach out on support@helicalinsight.com or raise your questions here https://forum.helicalinsight.com/.

Leave a Reply

Helical Insight’s self-service capabilities is one to reckon with. It allows you to simply drag and drop columns, add filters, apply aggregate functions if required, and create reports and dashboards on the fly. For advanced users, the self-service component has ability to add javascript, HTML, HTML5, CSS, CSS3 and AJAX. These customizations allow you to create dynamic reports and dashboards. You can also add new charts inside the self-service component, add new kind of aggregate functions and customize it using our APIs.
Helical Insight’s self-service capabilities is one to reckon with. It allows you to simply drag and drop columns, add filters, apply aggregate functions if required, and create reports and dashboards on the fly. For advanced users, the self-service component has ability to add javascript, HTML, HTML5, CSS, CSS3 and AJAX. These customizations allow you to create dynamic reports and dashboards. You can also add new charts inside the self-service component, add new kind of aggregate functions and customize it using our APIs.
Helical Insight, via simple browser based interface of Canned Reporting module, also allows to create pixel perfect printer friendly document kind of reports also like Invoice, P&L Statement, Balance sheet etc.
Helical Insight, via simple browser based interface of Canned Reporting module, also allows to create pixel perfect printer friendly document kind of reports also like Invoice, P&L Statement, Balance sheet etc.
If you have a product, built on any platform like Dot Net or Java or PHP or Ruby, you can easily embed Helical Insight within it using iFrames or webservices, for quick value add through instant visualization of data.
If you have a product, built on any platform like Dot Net or Java or PHP or Ruby, you can easily embed Helical Insight within it using iFrames or webservices, for quick value add through instant visualization of data.
Being a 100% browser-based BI tool, you can connect with your database and analyse across any location and device. There is no need to download or install heavy memory-consuming developer tools – All you need is a Browser application! We are battle-tested on most of the commonly used browsers.
Being a 100% browser-based BI tool, you can connect with your database and analyse across any location and device. There is no need to download or install heavy memory-consuming developer tools – All you need is a Browser application! We are battle-tested on most of the commonly used browsers.
We have organization level security where the Superadmin can create, delete and modify roles. Dashboards and reports can be added to that organization. This ensures multitenancy.
We have organization level security where the Superadmin can create, delete and modify roles. Dashboards and reports can be added to that organization. This ensures multitenancy.
We have organization level security where the Superadmin can create, delete and modify roles. Dashboards and reports can be added to that organization. This ensures multitenancy.
We have organization level security where the Superadmin can create, delete and modify roles. Dashboards and reports can be added to that organization. This ensures multitenancy.
A first-of-its-kind Open-Source BI framework, Helical Insight is completely API-driven. This allows you to add functionalities, including but not limited to adding a new exporting type, new datasource type, core functionality expansion, new charting in adhoc etc., at any place whenever you wish, using your own in-house developers.
A first-of-its-kind Open-Source BI framework, Helical Insight is completely API-driven. This allows you to add functionalities, including but not limited to adding a new exporting type, new datasource type, core functionality expansion, new charting in adhoc etc., at any place whenever you wish, using your own in-house developers.
It handles huge volumes of data effectively. Caching, Pagination, Load-Balancing and In-Memory not only provides you with amazing experience, but also and does not burden the database server more than required. Further effective use of computing power gives best performance and complex calculations even on the big data even with smaller machines for your personal use. Filtering, Sorting, Cube Analysis, Inter Panel Communication on the dashboards all at lightning speed. Thereby, making best open-source Business Intelligence solution in the market.
It handles huge volumes of data effectively. Caching, Pagination, Load-Balancing and In-Memory not only provides you with amazing experience, but also and does not burden the database server more than required. Further effective use of computing power gives best performance and complex calculations even on the big data even with smaller machines for your personal use. Filtering, Sorting, Cube Analysis, Inter Panel Communication on the dashboards all at lightning speed. Thereby, making best open-source Business Intelligence solution in the market.
With advance NLP algorithm, business users simply ask questions like, “show me sales of last quarter”, “average monthly sales of my products”. Let the application give the power to users without knowledge of query language or underlying data architecture
With advance NLP algorithm, business users simply ask questions like, “show me sales of last quarter”, “average monthly sales of my products”. Let the application give the power to users without knowledge of query language or underlying data architecture
Our application is compatible with almost all databases, be it RDBMS, or columnar database, or even flat files like spreadsheets or csv files. You can even connect to your own custom database via JDBC connection. Further, our database connection can be switched dynamically based on logged in users or its organization or other parameters. So, all your clients can use the same reports and dashboards without worrying about any data security breech.
Our application is compatible with almost all databases, be it RDBMS, or columnar database, or even flat files like spreadsheets or csv files. You can even connect to your own custom database via JDBC connection. Further, our database connection can be switched dynamically based on logged in users or its organization or other parameters. So, all your clients can use the same reports and dashboards without worrying about any data security breech.
Our application can be installed on an in-house server where you have full control of your data and its security. Or on cloud where it is accessible to larger audience without overheads and maintenance of the servers. One solution that works for all.
Our application can be installed on an in-house server where you have full control of your data and its security. Or on cloud where it is accessible to larger audience without overheads and maintenance of the servers. One solution that works for all.
Different companies have different business processes that the existing BI tools do not encompass. Helical Insight permits you to design your own workflows and specify what functional module of BI gets triggered
Different companies have different business processes that the existing BI tools do not encompass. Helical Insight permits you to design your own workflows and specify what functional module of BI gets triggered