Creating a New Report

Step-by-Step Instructions

Create a New Report

Step 1: Open Create New Report

1. Navigate to Observability Studios > Report Studio.
2. Click + Create New Report.
3. The Create Report page opens.

Step 2: Enter Basic Details

Enter the following details:

1. Name of the Report
2. Description — optional

Click Next.

Step 3: Manage Report Contents

Select one source for the report.

Available sources:

1. Dashboard
2. Data Source
3. Data Model

note

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

Create Report Using Dashboard

1. Select Dashboard as the report source.
2. Select the required dashboard by ticking the checkbox beside its name.
3. The selected dashboard appears in the Sort Dashboard section.
4. Arrange the order of selected dashboards as required.
5. Set the required Time Filter.
6. Click Download if an instant report is required from the UI.
7. Continue to scheduling and distribution.

note

Users can select up to 3 dashboards at once. To replace a selected dashboard, click Delete in the Sort Dashboard section and select another dashboard.

Create Report Using Data Source

Before selecting the data source, select the database.

Supported data sources include:

Database	Supported Query Types
ES	NoSQL DSL query, NoSQL Timelion query
PSQL	Internal Storage SQL query, Long-Term Storage SQL query
Hyperscale	SQL query

Select only one report source at a time. Use Dashboard for dashboard-based reports, Data Source for ES, PSQL, or Hyperscale queries, and Data Model when the report should use a selected data model and metric.

ES Database: NoSQL Timelion Query

1. Select ES database.
2. Select NoSQL Timelion Query.
3. Provide the ES Timelion query in the ES Query field.
4. Choose a column filter to select columns for the generated report.

5. Select the report type:
   • Table
   • Chart
   • Both
6. If Chart is selected, choose the chart type:
   • Line Chart
   • Vertical Bar Chart
   • Area Chart
7. Select the fields for the X-axis and Y-axis.

8. Click Apply to display the report preview.

note

Only numerical values are available under the Y-axis.

ES Database: NoSQL DSL Query

1. Select ES database.
2. Select NoSQL DSL Query.
3. Provide the NoSQL query.
4. Provide the respective index for the query.

5. Choose a column filter.
6. Select the report type:
   • Table
   • Chart
   • Both
7. If Chart is selected, choose the chart type:
   • Line Chart
   • Vertical Bar Chart
   • Area Chart
8. Select the fields for the X-axis and Y-axis.
9. Click Apply to display the report preview.

The annexure includes sample Elasticsearch queries.

PSQL Database: Long-Term Storage SQL Query

1. Select PSQL database.
2. Select Long-Term Storage SQL Query.
3. Provide the long-term data store query.
4. Choose a column filter.
5. Select the report type:
   • Table
   • Chart
   • Both
6. If Chart is selected, choose the chart type:
   • Line Chart
   • Vertical Bar Chart
   • Area Chart
7. Select the X-axis and Y-axis fields.
8. Click Apply to display the report preview.

The annexure includes sample long-term storage queries.

PSQL Database: Internal Storage SQL Query

1. Select PSQL database.
2. Select Internal Storage SQL Query.
3. Provide the MySQL query.
4. Choose a column filter.
5. Select the report type:
   • Table
   • Chart
   • Both
6. If Chart is selected, choose the chart type:
   • Line Chart
   • Vertical Bar Chart
   • Area Chart
7. Select the X-axis and Y-axis fields.
8. Click Apply to display the report preview.

Hyperscale Database

1. Select Hyperscale as the data store.
2. Provide the SQL query.
3. Choose a column filter.
4. Select the report type:
   • Table
   • Chart
   • Both
5. If Chart is selected, choose the chart type:
   • Line Chart
   • Vertical Bar Chart
   • Area Chart
6. Select the X-axis and Y-axis fields.
7. Click Apply to display the report preview.

Hyperscale provides the provision for creating reports using a data model query.

Data Summarization for Long-Term Data Storage

Users can generate reports based on:

• Raw data
• Daily data
• Hourly data
• Weekly data

Users need to write queries using the raw table name irrespective of the time period. If the query includes a time filter, the system identifies the table from which data must be fetched based on the selected time period.

Sample query:

select \* from rawdata where time\>='$start\_time' and time\<='$end\_time'

Create Report Using Data Model

1. Select Data Model as the source.
2. Select the required Data Model.
3. Select the required Metric.
4. Click Submit to preview the data.

Schedule to Generate and Distribute

This step contains three collapsible sections:

1. Manage Schedule
2. Report Format
3. Configure Distribution Channels

Manage Schedule

Use this section to configure report scheduling.

1. Use the radio button to toggle scheduled reports.
2. For one-time scheduling, select Schedule At time.
3. For recurring reports, choose Recurring Schedule.

Report Format

Select the required format:

• PDF
• CSV

The same report can be generated in both formats simultaneously.

note

CSV format cannot be used to generate reports for:

1. Dashboard as a report
2. Long-term data storage report using chart

Configure Distribution Channels

If Configure Distribution Channels is selected, an Email ID is mandatory.

The available fields are:

• Email ID
• Email Groups — optional
• Email Subject — optional
• Email Description — optional

After completing all configurations, click Finish. The new report appears on the Report Studio page.

Analytics Reports Preferences

Analytics Reports Preferences allow users to choose how date fields appear in reports.

Default date format:

DD/MM/YYYY hh:mm:ss 

Manage Existing Reports

Delete Report

Reports can be deleted from the Report Studio listing page.

1. Select the report checkbox.
2. Click Delete.
3. Confirm the deletion in the confirmation window.

Multiple reports can be deleted together.

note

There are two report deletion cases:

• Deleting report templates from Report Studio.
• Deleting generated reports from the Generated Reports tab.

Enable Reports

1. Select the report checkbox.
2. Click Enable.
3. The report becomes accessible for users to generate.

Multiple reports can be enabled together.

Disable Reports

1. Select the report checkbox.
2. Click Disable.
3. Disabled reports are not available for users to generate.

Multiple reports can be disabled together.

View Report Configuration

1. Click the clickable report name.
2. The report configuration page opens in view-only mode.

Users can only view the report configuration from this page.

Preview and Generate

Users can preview and generate reports from Report Studio. For generation details, refer to the Generate On-Demand Report flow.

note

To view downloaded dashboards as intended, ensure User-Specific Views are set up. Refer to User Management and RBAC User-Specific Views for configuration details.

Edit Report

1. Click Edit under the Actions column.
2. The report configuration page opens.
3. Make the required changes at any step.

The top-right corner includes:

• Permissions
• Duplicate Report

Permissions

Object-level permissions control report access.

Users with admin permission can edit and delete reports. Click Permissions to manage object-level permissions for reports.

Permission types:

Permission	Description
View	Selected user can only view reports.
Modify	Selected user can modify and make changes to reports.
None	No permission is given.

Duplicate Reports

Use Duplicate Report to create a copy of an existing report.

1. Click Duplicate Report.
2. A pop-up appears.
3. By default, the duplicate report name is suffixed with _copy.
4. Users can rename the report later.
5. Click Save to create the copy.

Example:A duplicate of Datamodel is named Datamodel_copy.

tip

Prevent Duplicate Report Generation: If report generation is already in progress, the user is notified that the same report cannot be generated again until the initial generation is successful.

What Happens After the Steps

After a report is created:

• The report appears in Report Studio.
• Users can generate the report if it is enabled.
• If scheduling is configured, the report is generated based on the selected schedule.
• If distribution channels are configured, the report is sent using the configured email details.
• Users can view, edit, delete, duplicate, enable, disable, or preview and generate the report based on permissions.
• Generated report outputs are available under Generated Reports in the Reports module.

Tips / Best Practices

• Use Report Studio for reusable report templates.
• Use Reports for on-demand generation and generated report access.
• Select only one source at a time while creating reports.
• Use dashboard reports when the report should be based on existing dashboards.
• Use Data Source reports when report content depends on queries.
• Use Data Model reports when the report should use a selected Data Model and Metric.
• Use column filters to control the columns displayed in generated reports.
• Use preview before scheduling or finishing report creation.
• Use object-level permissions to control view and modify access.
• Use duplicate reports when an existing report can be reused as a template.
• Enable only reports that should be available for users to generate.

Troubleshooting

1. Issue: Report is not available for users to generate.

   • Possible Cause: The report may be disabled.
   • Solution: Select the report checkbox in Report Studio and click Enable. Enabled reports become accessible for users to generate.

2. Issue: Users can generate an unwanted report.

   • Possible Cause: The report may still be enabled.
   • Solution: Select the report checkbox and click Disable. Disabled reports are not available for users to generate.

3. Issue: CSV format is not available for a report.

   • Possible Cause: CSV format is not supported for Dashboard as a report or Long-term data storage report using chart.
   • Solution: Use PDF format for these report types, or change the report configuration where CSV is supported.

4. Issue: Y-axis field is not available while creating a chart.

   • Possible Cause: Only numerical values are available under the Y-axis.
   • Solution: Select a numerical field for the Y-axis.

5. Issue: Report cannot be generated again.

   • Possible Cause: The same report is already being generated.
   • Solution: Wait until the current report generation is successful. The system prevents duplicate report generation while generation is in progress.

6. Issue: Dashboard report does not appear as expected after download.

   • Possible Cause: User-Specific Views may not be configured.
   • Solution: Ensure User-Specific Views are set up. Refer to User Management and RBAC User-Specific Views.

7. Issue: User cannot modify a report.

   • Possible Cause: The user may not have Modify permission.
   • Solution: Open Permissions and assign the required permission. Available permission types are View, Modify, and None.

FAQs

What is the difference between Reports and Report Studio?

Reports under Observability Hub > Reports is used to execute configured reports, generate on-demand reports, view generated reports, download reports, track failed reports, and delete generated report outputs.

Report Studio under Observability Studios > Report Studio is used to create, configure, schedule, enable, disable, edit, duplicate, delete, and manage report templates.

What types of reports are available in vuSmartMaps?

The Reports module provides pre-built reports covering key areas such as Application, Business Journey, Infrastructure Components, and Network Devices. Users can also create custom reports based on dashboards, data sources, or data models.

How can I generate an on-demand report?

Go to Observability Hub > Reports, open the Execute Reports tab, and click Preview and Generate Report under the Actions column. Select the report range, update the report name if required, choose the report format, optionally configure distribution channels, and click Generate.

The report is generated in the background and appears under the Generated Reports tab.

Where can I find generated reports?

All generated reports are available under the Generated Reports tab in Observability Hub > Reports. This tab shows the report name, status, applied filters, downloaded count, and available actions such as download and delete.

How can I check why a report failed?

Open the Generated Reports tab and click the Failed status for the report. A tracking information panel appears with details that help diagnose the cause of the failure.

Which report formats are supported?

Reports can be generated in PDF and/or CSV format. The same report can be generated in both formats simultaneously.

However, CSV cannot be used for Dashboard as a report or for Long-term data storage reports using chart.

What sources can be used to create a report in Report Studio?

Report Studio supports three report sources: Dashboard, Data Source, and Data Model. Only one source can be selected at a time while creating a report.

How many dashboards can be selected for a dashboard-based report?

Users can select up to 3 dashboards at once for generating reports. Selected dashboards appear in the Sort Dashboard section, where their order can be arranged.

To replace a selected dashboard, delete it from the Sort Dashboard section and select another dashboard.

What happens when a report is disabled?

A disabled report is not available for users to generate. To disable a report, select its checkbox in Report Studio and click Disable. Multiple reports can be disabled at the same time.

Can I duplicate an existing report?

Yes. Report Studio allows users to duplicate an existing report and use it as a template.

When a report is duplicated, the new report name is suffixed with _copy by default to maintain uniqueness. For example, a duplicated Datamodel report is named Datamodel_copy.

Users can rename the report later and click Save to create the copy.