Report Generation

Report Builder

All Reports created by the admin will be listed under the Report Builder, This functionality allows you to generate reports; for instance, generating a Long term data storage report is accessible via the report builder.

The following fields will be displayed.

• Report Name: This field displays the name of the report.
• Description: Here, you will find a brief description of the report’s content and purpose.
• Status: This indicates whether the report is currently active or inactive.
• Schedule: If applicable, this field will display the frequency at which the report is set to generate (e.g., weekly, daily, or monthly).  Administrators can configure this.
• Created By: Provides the name of the user who initially created the report.
• Created At: Shows the date and time when the report was first created.
• Modified By: Displays the name of the user who last made changes to the report.
• Modified At:  Indicates the date and time of the most recent modification.
• Actions: There are three action buttons under this.

• • Edit: Modify the report, manage permissions, or make copies.
  • Delete: Delete the respective report.
  • Generate Reports: This allows you to generate reports.

In addition, there are other options available at the top of the table

1. Search Box: Users can locate a specific report by entering its name into the search box.
2. Add Filters: Users can perform searches by applying filters, including Name, Description, Created at, and Modified at. Multiple filters can be applied simultaneously.
3. Enable: To enable a report, select its checkbox, which activates the ‘Enable’ button. Click Enable to make the report accessible for users to generate. You can enable multiple reports simultaneously.
4. Disable: To disable a report, select its checkbox, which activates the ‘Disable’ button. Click Disable. Disable reports are not available for users to generate reports. You can disable multiple reports simultaneously.
5. Delete: Check the report’s checkbox, then click Delete. You can delete multiple reports together.
6. + Create New Report: This button will enable the users to create a new Report.

Creating New Report

To create a report:

1. Go to the Report Builder tab.
2. Click on the + button (Create New Report).

3. On clicking, you will be redirected to the following page.

Creating a Report consists of two steps and an optional step:

Step 1: Basic Details

Step 2: Manage Report Contents

Step 3: Schedule to Generate and Distribute (Optional)

Step 1: Basic Details

Enter the following details and click on the next tab

• Name of the Report
• Description (Optional)

Step 2: Manage Report Contents

This section has 3 tabs to select the source of the Report. The following are the sources:

1. Dashboard
2. Data Source
3. Data Model

💡Note: Only one source can be chosen at a time for generating reports.

Now, let’s generate the reports using each of these sources.

Dashboard

• Pick the dashboard you need for making reports.
• To create reports from a dashboard, tick the checkbox next to its name.
• The chosen dashboard appears on the right in the ‘Sort Dashboard’ section.
• You can arrange the order of dashboards there.

💡Note: You can select up to 3 dashboards at once for generating reports. To replace a selected dashboard, click delete, and then proceed with your desired selections.

Time Filter

From the Time Filter option, set the exact time range for the reports you want to generate.

Additionally, you can download the reports. Just click the Download button to get the report.

When you click Download,  the report will be downloaded directly to your local system from the user interface.

Now, let’s create the Reports using the Data Source.

Data Source

Supported data sources include:

1. NoSQL Timelion Query
2. NoSQL DSL Query
3. Long-Term Storage SQL Query
4. Internal Storage SQL

a) NoSQL Timelion Query

The user can provide the ES Timelion query in the ES Query.

b) NoSQL DSL Query

 The user should provide the NoSQL Query along with the respective index for that query

You can refer to the annexure, for a sample Elasticsearch Queries

c) Long-Term Storage SQL Query:

For the Long-Term Storage SQL Query, the user can provide the Long-term data store query.

d) Internal Storage SQL Query:

For the Internal Storage SQL Query, the user can provide the MySQL query.

You can refer to the annexure, for a sample Long-term storage Queries

Data Summarization for Long term data storage

The user can generate a report based on the raw data, daily data, hourly data, and weekly data.

Users need to write queries with the raw table name irrespective of the time period. If the query has a time filter, the system will identify the table from which the data has to be fetched as per the time period.

• Sample query: Select * from rawdata where time>= ‘$start_time’ and time<=’$end_time’;

Dynamic Filters in Long term data storage

The Admin Users can include dynamic filters in the SQL query based on their use case. Using Dynamic Filters, the admin user can grant users permission to view and edit reports based on the specific user utilizing that report.

Charts in Long term data storage

The admin user can pick from three chart types: Line chart, Area chart, and Vertical Bar chart for their reports. They can also add a chart title and choose values for the X-axis and Y-axis.

💡Note: Only numerical values are available under the Y-axis

i) Line Chart– The generated report will be visible in the line chart format.

ii) Area Chart– The generated report will be visible in the Area Chart format.

iii) Vertical Bar Chart– The generated report will be visible in the bar chart format.

Customize Columns

The Admin user can edit the text of the header column by clicking on Customize Columns. The user can omit the columns that are not required in the report by unchecking them.

Therefore, this is all about creating reports using a Data source. Now, let’s move on to creating Reports using the Data Model.

Data Model

Select the required Data Model and Metric. Click on Submit to preview the data.

Step 3: Schedule to Generate and Distribute (Optional)

The step consists of 3 collapsible sections as follows:

1. Report Format
2. Configure Email
3. Manage Schedule

Report Format

• Pick the format: PDF and/or CSV. (The user can generate the same report in both formats simultaneously)
• Optionally add a cover page using HTML code.
• Optionally add a footer using HTML code.

💡Note: The CSV format can not be used to generate Reports for

 1. Dashboard as a report

 2. Long-term data storage report using chart

Configure Email

• Email Subject (Optional)
• Email Description (Optional)
• Email Groups (Optional)
• Email ID (Optional)

Manage Schedule

This section is used for the scheduling frequency of the report.

Click on the Radio button to toggle Schedule Reports.

• Schedule At: For one-time scheduling, select “Schedule At” time.

• Periodic schedule: For regular reports, choose the Periodic Schedule Option.

After setting everything, click Save to create the Report. You’ll see the new Report on the Report Builder page.

Analytics Reports Preferences

This feature lets you choose how date fields appear in reports. The default format is DD/MM/YYYY hh:mm: ss.

Delete Report

You can delete the reports either using the Delete button at the top or under the Action column.

• Check the report’s checkbox, then click Delete.
• You can delete multiple reports together.
• Confirm the deletion in the window that appears.

View

To view the Report, click on the clickable report name.

On clicking, you will be redirected to the following page. Here you would only be able to view the reports.

Edit

To Edit the Report, click on the Edit button located under the Action column of the respective Report.

On clicking, you will be redirected to the following page

To make any changes in Reports, the following action buttons are available in the top right corner.

1. Permissions
2. Generate Report
3. Cancel and Update
4. Duplicate Report

Permissions

With object-level permissions, the user who has admin permission will be able to edit and delete the report. Click on Permissions to manage Object Level Permissions in Reports.

The screen will look like this.

For every role, you can give 3 types of permission.

• View: The selected user can only view the Reports.
• Modify: The selected can also modify and make changes to the Reports.
• None: There are no permissions given.

Generate Report

You can generate reports from this tab, or you can access the Generate Report button under the Action column. More information is available in the following section.

Cancel and Update

After making changes at any step according to your desired configuration, proceed to click the Update button to save the changes. Otherwise, click the Cancel button to discard the changes made. For instance, if you want to edit the Report-DataModel report, click on the edit button under the Actions column, and make the changes.

After making changes, click on Update.

The changes made have been updated.

Duplicate Reports

This option will allow you to duplicate existing reports if you wish to use the existing reports as a template.

On clicking the Duplicate report the pop-up will appear, and by default, the report name will be suffixed as  ” _copy”  to have uniqueness. For example, a duplicate DataModel report will be named Report-DataModel_copy. Users can also rename the report at a  later time.

Click on Save to make a copy of the report.

Further Reading

Generate On-Demand Report 

Generated Reports