Manage Analytics Reports
For supported software information, click here.
The Analytics nodes in an Analytics cluster collect data from SD-WAN Versa Operating SystemTM (VOSTM) devices and store it in datastores. You can generate reports from the data on the Analytics Reporting screen using the Analytics report template builder, simply called the template builder. Reports generated from report templates display charts and tables of the data that is currently stored in the Analytics datastores. When Analytics datastore data expires, it is removed from the datastore. To capture current data before it expires so that you can maintain a historical record and for future examination, you generate Analytics reports that run periodically. You can also generate Analytics reports immediately, on demand.
You create and generate Analytics reports from the Analytics > Reporting tab. From this tab you can also load and view existing reports, save the reports to remote systems, and perform other report management tasks.
To use the Analytics reports, you first configure and save a report template for a single tenant. Then, you use the saved report template to generate a report, which is called a completed report. You can generate completed reports either immediately or at a preset time or times. The completed reports are stored in the Analytics database in either PDF or CSV format. You can configure the Analytics node to send a notification email when a completed report is generated, and this email can contain a copy of the report.
This article describes how to configure reports using the Analytics template builder and manage Analytics reports.
For information about datastore retention and expiration times, see Analytics Datastore Limits in Versa Analytics Scaling Recommendations.
Note: Analytics aggregator clusters present the following differences from standard Analytics clusters when generating reports:
-
For log tables (grid data), PDF and CSV reports, including scheduled reports, are limited to a maximum of 500 rows. To generate a report with more than 500 entries in a log table, you must generate an exported report from the report preview area. This process generates multiple exported reports, one for each child cluster of the aggregator cluster. See Export Logs from the Preview Area, below.
-
For reports that include statistics metrics, data is summed after the aggregator node receives data from all the child clusters.
-
For summary (pie, column, and bar) charts, in the consolidation process for top-N values, the top M values (where M > N) are determined by the child clusters, and the data is then consolidated on the aggregator node.
-
For top-N time series charts, the top-N summary is computed across the clusters, and for the top-N values, N time series queries are triggered.
For more information about aggregator clusters, see Configure Analytics Aggregator Nodes.
Report Template Overview
On the Analytics Reporting screen, you use the Analytics template builder to create and generate reports from the data in the Analytics datastores. To create a report, you create what is called a report template. In the report template, you select a tenant, you define the charts and tables that you want to include in the completed report, and you specify the time period for the data to include in the report. Each report template, and hence each report, applies to a single tenant only.
You create a report template on the Analytics template builder screen. To navigate to the template builder screen, you select Analytics > Reporting > Build > Builder.
The template builder screen, which is shown in the screenshot below, contains the following components:
- Chart and table definition area—Displays drop-down menus on which you can define charts and tables to include in a report template. When you click Add or Update in this area, a preview of the chart or table displays in the preview area. Each of the fields in the chart and table definition area is discussed in more detail in the sections below.
- Tenant menu—Allows you to select the tenant for which to generate a report. The drop-down menu lists all the tenants included in datastores in the Analytics cluster. Each report template is for a single tenant.
- Preview area—Displays a preview of all charts and tables that are included in the report template.
- Time period menu—Allows you to select the time period of the data to include in the report. You can choose a preselected or a custom time period. The preselected time periods are the last 5, 15, or 30 minutes, the last 1 hour or 12 hours, the last 7 or 30 days, and the last month. These time periods are relative to the time when the report is generated from the template. For a custom time range, you can define a custom range of minutes, hours, days, weeks, or months, and you can define a date and time range. All nodes in the Analytics cluster must use NTP to synchronize their times to ensure accuracy for the selected time period.
- Report template name—Displays the name of the saved report template. If you have not saved a report template, no name displays in this area.
- Report template menu bar—Contains menu items for saving and deleting report templates, and for generating sample CSV and PDF reports from the current template.
When you first create a report template, you can generate a sample report, but the template exists only in memory and is lost if you refresh your browser window or select a different report template. To retain the report template, you must save it. It is then stored in the Analytics database. For a report template that has been saved, you can configure the Analytics cluster to periodically generate a completed report from the template. You can also generate a report from a stored template manually at any time.
The following sections discuss each of the fields in the chart and table definition area of the template builder screen.
Service
In the Service field in the chart and table definition area on the template builder screen, you define the type of information to report about in the chart or table. You identify the information to include by its service type. The following are the available types of services:
- SD-WAN—SD-WAN information such as site usage, SLA, and QoE
- Secure Access—Secure access information such as user statistics and failed and successful access attempts
- Security—Security information such as top applications, top threats, and top URLs
- Carrier-Grade NAT—NAT information such as top post-NAT source IP addresses, top destination and source addresses, and CGNAT logs
- Traffic Monitoring—Traffic monitoring information such as top applications, top HTTP hosts, and traffic monitoring logs
- System—VOS device information such as device alarms logs, appliance monitoring, and WAN interface utilization
Report Type and Metrics
In the Report Type field in the chart and table definition area on the template builder screen, you choose the type of report. The type of reports available depends on the value you choose in the Service field. For a list of all report types, see List of Services, Report Types, and Metrics, below.
A report type describes the type of data to include in a chart or table. This data is obtained from a table in the Analytics database or search engine datastore, both referred to as datastores, and the entries in the datastore table are identified by a set of one or more fields. The set of fields is called the report type key, or simply the key, and data for all charts and tables for the report type is grouped by this key. Keys can include multiple fields, and it is the combination of values in these fields that uniquely identifies a row. Charts and tables in the template, except those containing logs, include one or more numeric fields from the datastore table, and each numeric field is called a metric. For each key value, a chart or table displays a calculation on its metrics for the time period of the template. For example, for report type VRF Usage Per Site, the key is the combination of fields Site and VRF Name. In the following figure, the user has selected report type VRF Usage Per Site, chart type Pie Chart, metric Sessions, and time period last day. The table on the right displays the number of sessions for the last day for each key value, and this information is represented in the pie chart on the left.
For each metric, charts and tables display the following computations for each key value:
- For pie, bar, and column charts—Values for the metrics are summed over the time period
- For tables—Values for the metrics are summed over the time period except for statistics metrics (see Statistics Metrics, below)
- For area, line, and stacked-bar charts—Values for the metrics are summed over time intervals, called the resolution, within the time period
Bar and column charts can display up to two metrics and pie and status-over-time charts display exactly one metric.
The fields for report types in category Logs are all treated as string fields, and therefore these report types have no metrics and can be displayed only as tables. For a list of report types and their categories, see List of Services, Report Types, and Metrics, below.
Statistics Metrics
Some report types include additional metrics for tables only. Called statistics metrics, these are companions to other metrics and include five additional columns for that metric: the minimum, maximum, average, median, and 95th percentile values calculated over the time period. The statistics metric name is the standard metric name with the word stats appended to it, for example Transmit Volume Stats is the statistics metric for Transmit Volume. You can select a statistics metric without selecting its companion.
For Releases 22.1.1 and later, you can select individual statistics metrics.
The following example for service SD-WAN and report type Access Circuit Usage for SD-WAN, displays a table with metric Sessions and with statistics metrics Sessions Min and Sessions Max.
List of Services, Report Types, and Metrics
When adding a chart or table definition, you select a service and an associated report type and metric. The table below lists the services available in the chart and table definition area and the report types and metrics associated with them. For any service listed in the first column, its available report types are listed in the third column, and the key and choices of metrics available for that report type are listed in the fourth and fifth columns respectively. When a key consists of multiple fields, it is shown as a comma-separated list of field names. For example, for service SD-WAN, report type Access Circuit Available Bandwidth is available along with this report type's key and metric choices: Uplink Bandwidth, Downlink Bandwidth, Uplink Bandwidth Stats, and Downlink Bandwidth Stats. Report types are grouped into the categories listed in the second column.
| Service | Report Type Category | Report Type |
Key (For keys consisting of two or more fields, field names are separated by commas) |
Metrics (Asterisk indicates available only for tables) |
|---|---|---|---|---|
|
SD-WAN
|
General |
|
|
|
|
|
|||
|
|
|
||
|
|
|
||
| Application |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
| Availability |
|
|
|
|
|
|
|
||
|
|
|
||
| SLA |
|
|
|
|
|
|
|||
|
|
|||
|
|
|
||
|
|
|
||
|
|
|
||
| QoE |
|
|
|
|
| Traffic Steering |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
| VRF |
|
|
|
|
|
|
|||
| QoS |
|
|
|
|
| APM |
|
|
|
|
|
|
|||
| MOS |
|
|
|
|
| Logs |
|
|
(No metrics) | |
| Secure Access | General |
|
|
|
|
|
|
||
|
|
|||
|
|
|||
|
|
|
||
|
|
|
||
|
User (Available through Versa Networks cloud-hosted services only) |
|
|
|
|
|
|
|
||
|
SASE (Available through Versa Networks cloud-hosted services only) |
|
|
|
|
|
|
|
||
|
|
|
||
|
|
|||
| Security | NGFW |
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
| URL filtering |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
DNS filtering (Available through Versa Networks cloud-hosted services only) |
|
|
||
|
DNS tunneling (Available through Versa Networks cloud-hosted services only) |
|
|
||
|
DNS proxy (Available through Versa Networks cloud-hosted services only) |
|
|
||
| Threats |
|
|
|
|
|
|
|||
|
|
|||
| Malwares |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
| Vulnerabilities |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
| Identity |
|
|
|
|
|
|
|||
|
|
|||
|
DLP For Releases 22.1.3 and later
|
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
ATP For Releases 22.1.3 and later |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
SASE web For Releases 22.1.3 and later |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
| Logs |
|
|
(No metrics)
|
|
| Carrier Grade NAT | General |
|
|
|
|
|
|||
|
|
|||
|
|
|||
| Logs |
|
|
(No metrics) |
|
| Traffic Monitoring | General |
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
| Web monitoring |
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
| Logs |
|
|
(No metrics) | |
| System
|
General |
|
|
|
|
|
|
||
|
|
|
||
|
|
|
||
| Interfaces |
|
|
|
|
|
LTE (Available through Versa Networks cloud-hosted services only) |
|
|
|
|
|
|
|
||
|
|
(No metrics) | ||
|
WiFi (Available through Versa Networks cloud-hosted services only) |
|
|
(No metrics) | |
| Logs |
|
|
(No metrics) |
|
|
Analytics cluster usage (Available through Versa Networks cloud-hosted services only) |
|
|
(No metrics) |
Appliance
In the Appliance field in the chart and table definition area on the template builder screen, you select which VOS devices (also called appliances) to include data for in the report. You can select the following options from the Appliance drop-down menu:
- All—Add a single chart or table with data for all VOS devices contained in the datastore table for the report type.
- Single appliance—Add a single chart or table for the selected VOS device.
- Multiple appliances—Add a separate chart or table for each VOS device that you select. The result is that the template builder adds multiple charts or tables to the template. You can alternately add a combined chart for the following types of charts: area charts, line charts, and stacked bar charts.
Analytics reports sometimes refer to VOS devices (appliances) as sites.
Chart Type
In the Chart Type field in the chart and table definition area on the template builder screen, you select the graphical format in which to display data in the report. You can choose from seven chart styles and one table style. Not all styles are available for all report types.
The template builder screen offers the following styles:
- Summary charts—Provide global top N statistics for the total time period for a single metric. N can be changed using the field “Number of rows." The default is 10 rows. There are three types of summary charts:
- Pie chart
- Bar chart
- Column chart
- Time series charts—Provide a view of the data over the specified time period (every hour, every day, etc.). There are four types of time series charts:
- Area chart
- Line chart
- Stacked bar chart
- Status-over-time chart (see the Status-Over-Time Chart section for more information)
- Table view—Provides an aggregated view of the data for one or more metrics for the specified time period, with the ability to sort on most rows.
Status-Over-Time Chart
Status-over-time charts display a horizontal rectangular bar for each key value for the times listed along the x axis, where green represents good or up, yellow represents fair or degraded, and red represents poor or down performance. For report types that offer status-over-time charts, such as the report types Sites Availability over Time and Quality of Experience per Path, status-over-time is the only available chart type.
There is no icon representing status over time in the chart type section of the template builder screen.
The following example displays a status-over-time chart for service SD-WAN, report type Sites Availability over Time, All appliances.
Filters
In the Report Type field in the chart and table definition area on the template builder screen, you specify a filter to limit the data in a chart or table to only records that match search criteria. The Filter popup window displays one or two criteria menu bars, which you can use to perform searches for fields containing either string or numeric data. You use one menu bar to search string fields and a separate menu bar to search numeric fields. The fields listed in the drop-down menus reflect the current report type. You cannot filter based on statistics metrics. You can filter on most, but not all, string fields. If you select a new service or report type, any previously defined filter is cleared and the criteria menu bars are re-populated.
The following are the possible criteria menu bars:
Numeric criteria menu bar—(For Releases 21.2.1 and later) Allows you to select records using a numerical comparison operator.
String criteria menu bars—Allows you to select records using a search pattern. There are two versions, as displayed below. The first version selects records that match a given pattern and the second version selects records that either match or do not match a given pattern.
When you add multiple string criteria for the same field, the filter uses OR logic to match the string criteria on that field. When a filter contains multiple criteria, same-field string criteria are evaluated first, and then the filter uses AND logic to match records that meet all other string and numeric criteria.
Numeric Criteria
To match numeric fields, select the field from the numeric criteria menu bar. Select the great than >, less than <, equals =, or not equals ≠ operator and then enter a numeric value for comparison. The fields listed in the first drop-down menu are metrics for the current report type, and the numerical comparison is applied to the sum of the metric over the time period.
When entering numeric values, you can use K for kilobytes, M for megabytes, and G for gigabytes. For example, you can enter 2K instead of 2000 or 3M instead of 3000000.
For example, for service SD-WAN and report type Site to Site Path SLA, to include only site to site entries with a delay value of greater than 40.0 ms, choose Delay, the great than > operator, and enter value 40.0.
Example filter output:
String Criteria
To match string fields, use one of the following two string criteria menu bars:
The following are the rules for creating string criteria:
- Select a field from the drop-down menu and then enter a pattern that matches the entire field. If using the second version of the string criteria menu bar, also select the Is Equal To option. Patterns are case sensitive.
For example, for service SD-WAN and report type Sites Availability, to display entries with site names matching SDWAN-Branch4, select the Site field and use pattern SDWAN-Branch4.
Example filter output:
- Do not enter a partial pattern.
For example, to display entries with site names containing the character 2, you cannot enter the pattern 2.
Example filter output:
-
To match any number of characters in a pattern, use the asterisk (*) as a wildcard character.
For example, for service SD-WAN and report type Sites Availability, to define a table with site names containing the string Controller, select the field Site and enter the search pattern *Controller*.
Example filter output:
-
If the string criteria menu bar offers the Does Not Equal option, you can search for records that do not match the pattern by selecting this option.
Build a Report Template
The template builder screen displays the current report template. You can build a new template, or you can load an existing template and edit it from this screen. You must save the report template before you can manage it using the Analytics > Reports > Manage tab. You assign a name when saving the report template, and all items associated with the report template are identified by this name, including:
- Saved reports—The saved report template.
- Completed reports—Any report generated from the report template. Since all completed reports generated from a saved template have the same name, the Analytics application assigns a unique ID number to distinguish between the reports.
- Scheduled reports—A set of time parameters for automatic report generation using the saved report template. The Analytics application generates completed reports automatically based on these parameters.
When you save a report template, you can choose a PDF template to use when generating a completed report. PDF templates are stored in directory /opt/versa/var/van-app/templates/reporting on the Analytics node you choose in Step 2 in the procedure below. See the file default.html in this directory for more information on creating a PDF template for Analytics reports.
Add a Report Template
To add a report template:
- In Director view, select the Analytics tab. The following screen displays.
- In the drop-down menu in the top left corner, select a node in the Analytics cluster containing the datastores used to generate the reports.
- Select
Reports > Build > 
Builder. The template builder screen displays.
- Select a tenant from the first drop-down menu and a time period from the second drop-down menu in the main pane.
- Add one or more chart or table definitions, as described in Add or Modify a Chart or Table Definition. Previews of the charts and tables display in the preview area. Adding the first chart or table definition activates the report template menu bar.
- In the report template menu bar, click the
Save icon to display the Save and Schedule popup window.
- In the Name field, enter a report template name.
- In the PDF Template field, select a template. For more information about PDF templates, see Build a Report Template.
- To schedule report generation from the template, click the Schedule box and then follow Steps 5 through 8 in Schedule Report Generation.
- Click OK. The report template name displays above the preview area.
- To perform other operations on the report template, select an icon from the report template menu bar.
Icon Action 
Trash iconDelete the current report template. This clears the preview area. 
Collapse iconCollapse all chart and table previews. 
PDF iconGenerate a sample report from the current report template, in PDF format. A browser-specific window displays allowing you to save the information in a local file. Sample reports are not stored in the Analytics database. 
CSV iconGenerate a sample report from the current report template, in CSV format. A browser-specific window displays allowing you to save the information in a local file. Sample reports are not stored in the Analytics database. 
Save iconSave the current report template.
Modify a Report Template
To modify a report template:
- In Director view, select Analytics > Reports > Build >
Load. The Load a Report menu displays.
- Select a tenant from the Tenant drop-down menu. To limit the menu to a subset of tenants, click the drop-down menu and then enter a search string in the box.
The Analytics application fetches the names of saved report templates for the selected tenant and populates the Saved Reports drop-down menu.
- Select a report template from the Saved Reports drop-down menu. If the Saved Reports menu is empty, then no saved report templates exist for the selected tenant.
- Click Load. The report template displays in the preview area.
- Click the Builder icon. The chart and table definition area displays.
- Add or modify chart or table definitions, as described in Add or Modify a Chart or Table Definition.
- Select the Save icon from the report template menu bar, then click OK.
Add or Modify a Chart or Table Definition
You use the chart and table definition area to add and modify chart and table definitions that are part of the current report template.
Add a Chart or Table
To add a chart or table definition to the current report template:
- Ensure that you are on the template builder screen and the report template to be edited displays on the screen. For more information, see Report Template Overview, above.
- In the chart and table definition area, select information for the following fields.
Field Description Service Select a service:
- SD-WAN—SD-WAN information such as site usage, SLA, and QoE.
- Secure Access—Secure access information such as user statistics and failed and successful access attempts.
- Security—Security information such as top applications, top threats, and top URLs.
- Carrier Grade NAT—NAT information such as top post NAT source, top destination and sources addresses, and CGNAT logs.
- Traffic Monitoring—Traffic monitoring information such as top applications, top HTTP hosts, and traffic monitoring logs.
- System—VOS device information such as device alarms logs, appliance monitoring, and WAN interface utilization.
Default: SD-WAN
Report Type Select a report type. Only report types specific to the selected service display in the menu. For a list of services and their available reports types, see List of Services, Report Types, and Metrics.
Appliance Select one or more VOS device from the drop-down menu or select All to include all VOS devices. To limit the menu to a subset of VOS devices, click the drop-down menu and then enter a search string in the box. For more information, see Appliance. 
Default: All
Chart Type (optional) Select a chart type, or select table. Only charts available for the selected report type display. For report types that support only tables or status-over-time charts, this field does not display. For a description of the chart types, see Chart Type.
Include Subtenants (optional) (For Releases 22.1.4 and later) For report types Appliance Usage and Tenant Usage, which are listed under service type System, only: Select to include subtenant data in the chart. Combine Charts (optional) (For Releases 21.1.1 and later) For area charts, line charts, and stacked bar charts only: Select to define a combined chart instead of individual charts when you select multiple individual VOS devices in the Appliance field, above.
Resolution (optional) For area charts, line charts, and stacked bar charts only: This setting indicates the interval within the selected time period that the Analytics application uses to either sum or average the data for the chart metric. Metrics sessions, volume TX, and volume RX are summed and other metrics are averaged over the interval. The interval choices are:
- Minute—The data is summed or averaged in resolutions of either 5 or 15 minutes, depending on the configuration.
- Hourly—The data is summed or averaged per hour.
- Daily—The data is summed or averaged per day.
Note: The day change is calculated based on UTC time, which might not match your local time zone. - Auto—Resolution is set to minute when the time period is less than 24 hours, hourly when the time period is between 24 hours and 7 days, and daily when the time period is greater than 7 days.
Note: Selecting resolution minute or hour for a large time period, such as 7 days or more, is very CPU and memory intensive and reports take longer to generate.
Default: Auto
Filter Select the Click to Set Filter box, and then:
- Enter a search criterion. For more information, see Filters.
- To add additional search criteria, click the
Add icon for an existing criterion of the same type, numeric or string. - To remove a search criteria click the Minus icon, or, click Clear to clear all search criteria.
- Click OK to add the filter.
Metrics Select one or more metrics to include in the table or chart. For more information on metrics, see Report Type and Metrics. For a list of available report types and their associated metrics, see List of Services, Report Types, and Metrics.
Default: The first metric listed in the table in section List of Services, Report Types, and Metrics.
Number of Rows For pie, bar, and column charts: Enter the number of top (largest) values to display. All other entries are grouped into an Others category.
For line, area, and stacked-bar charts: Enter the number of top values to display. Other entries are not included in the chart.
For status-over-time charts: Enter the number of key values to display. Other entries are not included in the chart.
For tables: Enter the number of rows to include in the table. This field only affects the CSV and PDF reports you generate from the template; the table in the preview area still includes all rows. It is not recommended that you use this option to export large log tables, those containing more than 100,000 rows, to a report. To export large log tables, use the export feature to create an exported report; see Export Logs from the Preview Area.
Default: 10Maximum for Analytics aggregator nodes: 500
For example, in the chart below, the number of rows equals 5. In the pie chart, the top 5 sites are represented individually and then all other sites are grouped together into the Others category.
Report Name Enter a name for the chart or table. This name is used to label the chart or table, both in the preview area and when generating a report from the report template. - Click the Add icon. The chart or table definition is added to the report template and a preview of the chart or table displays in the preview area.
- To collapse the preview of a chart or table, select the collapse icon.
- To delete a chart or table from the report template, select the
delete icon.
Modify a Chart or Table
You can modify some parameters for a chart or table after you have added it to a report template. You cannot modify the service, report type, or appliance. To change these parameters, you must delete the existing chart or table and add a new one. You can select a different time period for a report template after charts and tables have been defined. All existing charts and tables are updated to the new time period and their previews automatically refresh.
To modify a chart or table definition:
- In the preview for the chart or table to be modified, click the pencil icon.
Update and Cancel icons display in the chart and table definition area, and the parameters used to define the chart or table are preselected in the drop-down menus.
- Modify the items in the chart and table definition area as described in Step 2 of Add a Chart or Table.
- Click Update to save the changes or click Cancel.
Export Logs from the Preview Area
For Releases 21.2.1 and later.
Some report types display logs. These report types are listed as report type category Logs in the Report Types table, see List of Services, Report Types, and Metrics. These report types are only available as tables, and their table preview displays an Export button which you can select to store a copy of the logs contained in the table. The copy of the logs, called an exported report, is stored in the Analytics database using the table preview name. Exported reports display in the Analytics > Reports > Manage > Exported Reports screen, where you can download them for the next seven days. After seven days, exported reports are automatically deleted from the database.
Note that for Analytics aggregator nodes, exporting logs from the report preview area generates multiple exported reports, one for each child cluster.
To export logs and view exported reports:
- In Director view, select Analytics > Reports > Build > Builder. The template builder screen displays.
- Either use the report template currently displaying on the template builder screen or load an existing report template using the Load screen.
- In the Chart and Table Definition area, add a table definition for a report type containing logs. These report types are listed under report type category Logs in the table in the List of Services, Report Types, and Metrics section. For information on adding a table definition, see Add or Modify a Chart or Table Definition. A table preview displays in the preview area. The example below displays a preview for a table with service SD-WAN, report type Traffic Logs.
- In the table preview, click the Export icon. Wait a moment while the logs are saved into an exported report in the database. Once the save is complete, the Export icon is replaced with a Download icon.
- To download the exported report immediately to your local system, click the Download icon. A system-specific dialog displays allowing you to download the exported report.
- To view a list of all exported reports, select Analytics > Reports > Manage > Exported Reports.
- To download an exported report, select the Download icon in the last column. A system-specific dialog displays enabling you to download the exported report to your local system.
Schedule Report Generation
You can schedule a report to be generated, either immediately or at a preset time, when you save its report template. You can view generated reports, known as completed reports, from the Analytics > Reports > Manage > Completed Reports screen. To view a list of all reports scheduled to be generated, see Manage the Report Generation Schedule.
With most templates, you enter the generation schedule on the Save and Schedule screen, and the Analytics cluster generates a single completed report from the template at the scheduled times. However, in Releases 21.1.1 and later, when all the charts and tables in a template are created for the same single VOS device (appliance), the Save and Schedule window offers an additional drop-down menu called Copy Settings To from which you can select additional VOS devices. In this circumstance the Analytics application generates multiple completed reports, one per VOS device, from the single template. The Analytics application substitutes each selected VOS devices as the Appliance for each chart and table when generating the report and prepends the name of the VOS device to the template name when naming each completed report.
To schedule a report:
- In Director view, select Analytics > Reports > Build > Builder.
- Ensure the report template displays in the preview area. If it is not displayed, upload the report template as described in Steps 1 through 5 in Modify a Report Template.
- In the report template menu bar, click the Save icon to display the Save and Schedule popup window.
- Click the Schedule box to expand the window.
- Click one of the following fields and then enter information specific to the field.
Field Description Now Click to immediately generate a report from the template. Hourly Click to automatically generate a report from the template once per hour, then enter an interval in hours. Daily Click to automatically generate a report from the template once per day, then enter the daily time. Weekly Click to automatically generate a report from the template once per week, then enter the weekly day and time. Monthly Click to automatically generate a report from the template once per month, then enter the monthly day and time. -
To set an expiration time for reports generated hourly, daily, weekly, or monthly, click the Expiration box and then select an expiration date.
-
To automatically send a copy of the report to a set of email addresses, enter a comma-separated list of email address In the Email Notification Recipients field. To attach the report in PDF or CSV format to the email, click the PDF or CSV box. SMTP for Analytics must be configured for this option to operate. For information about configuring SMTP for Analytics, see Configure SMTP in Perform Initial Software Configuration.
-
(For Releases 21.1.1 and later.) For templates that include the same single appliance for all charts and tables, select additional appliances from the Copy Settings To drop-down menu. For more information, see Schedule Report Generation.
-
Click OK.
Manage Report Generation
After you create a report template on the template builder screen, you can generate a report. Generated reports are stored in the Analytics database, and you can export a CSV or PDF version of the report. This section describes how to manage completed reports, saved report templates, and the report generation schedule.
You manage report generation from the Analytics > Reports > Manage menu:
This menu includes the following terms:
- Completed reports—Reports generated from a saved report template. Completed reports are identified by their report template name and assigned a unique ID number.
- Scheduled reports—The report generation schedule, which consists of entries containing times to generate reports from saved report templates.
- Saved reports—Report templates saved from the template builder screen.
- Exported reports—A list of log sets exported from the preview area on the template builder screen. See Export Logs from the Preview Area.
Manage Saved Report Templates
You manage report templates for an organization from the Saved Reports screen.
To manage saved report templates:
- In Director view, select Analytics > Reports > Manage. The following screen displays.
- Select an organization from the drop-down menu in the main pane.
- In the left menu bar, select Saved Reports. The Saved Reports screen for the selected organization displays with the following fields.
Field Description ID Unique ID number assigned to the report template. Name Report template name. Date Timestamp when the report template was last saved. Owner Name of the user who saved the report template. - To delete one or more report templates, click the box or boxes in the column in front of the template ID number and then click Delete.
- To schedule the Analytics application to generate a report for one or more templates, click the box or boxes in the column in front of the template ID number and then click Schedule; then, follow Steps 5 through 8 in Schedule Report Generation.
Manage the Report Generation Schedule
You can view a list of times that reports are scheduled to be generated and edit the generation schedule from the Scheduled Reports screen. Each organization has a separate report generation schedule.
To view and edit the report generation schedule:
- In Director view, select Analytics > Reports > Manage. The following screen displays.
- Select an organization from the drop-down menu in the main pane.
- In the left menu bar, select Scheduled Reports. The Scheduled Reports screen for the selected organization displays with the following fields.
Field Description ID ID number of the entry for the current row (the current entry). Name Name of the report template used to generate the scheduled report. Schedule Time specification of when the report is to be generated. Timezone Timezone. Date Date the current entry was added to the schedule. Expiration Time Time the current entry expires. State State of the current entry. Next Run Time Next time the current entry is scheduled to be run. Last Run Time Last time a report was generated using the current entry. Owner Name of the user who added the entry to the schedule. Actions Click the 
Trash icon to delete the current entry. - To delete one or more entries, click the box in the first column of each entry and then click the
Delete icon. - To edit the generation time for an entry:
- Click the box in first column for the entry.
- Click the
Edit icon. The Rescheduling window displays. - Follow Steps 5 through 8 in Schedule Report Generation.
Manage Completed Reports
Reports generated from report templates, known as completed reports, are stored under the name of their report template and assigned a unique ID. You can download a copy of the report in CSV or PDF format to your local system. You can delete completed reports.
To manage completed reports:
- In Director view, select Analytics > Reports > Manage. The following screen displays.
- Select an organization from the drop-down menu in the main pane.
- In the left menu bar, select Completed Reports. The Completed Reports screen displays with the following fields.
Field Description ID ID number of the completed report. Name Name of the report template used to generate the completed report. Date Date and time that the completed report was generated. Schedule The schedule entry used to generate the report. For example, the completed report with ID number 424 was generated from the schedule entry for report template Tenant 1 Site Availability Report that indicates every 2 hours. You can view the report generation schedule from the Scheduled Reports screen; see Manage the Report Generation Schedule. Owner Name of user that scheduled the report. - To download a CSV copy of a completed report, click the
CSV icon in the Actions column. A system-specific window displays allowing you to save the information in a local file. - To download a PDF copy of a completed report, click the
PDF icon in the Actions column. A system-specific window displays allowing you to save the information in a local file. - To delete completed reports, click the box in front of each report and then click the Delete icon. The following items may assist you in selecting a large number of entries:
- You can select a larger number, such as 500, from the Show Entries drop-down menu to display more entries.
- You can select all entries displayed on the screen by clicking the box in the first column heading.
- You can de-select individual selected entries by clicking on the box at the beginning of the entry.
Supported Software Information
Releases 20.2.1 and later support all content described in this article except:
- Release 21.1.1 adds support for combining multiple appliances into a single area chart, line chart, or stacked bar chart; you can create a per-appliance report using a report template and apply it to other appliances; you can add a chart or table of report types Link Availability or Link Availability Over Time.
- Release 21.2.1 adds support for report type Application Usage per Type; you can add numeric comparison criteria to a filter; you can export logs from the preview area.
- Release 21.2.3 adds support for report types Tenant Usage for SD-WAN and Tenant Usage for DIA.
- Versa Networks cloud-hosted services adds support for many report types.
- Releases 22.1.1 adds support for selecting individual statistics metrics.
- Releases 22.1.4 adds support for the Appliance Usage reports, Tenant Usage reports, and the Subtenants field.