Reports¶
Overview¶
You can access the reports functionality via the Main Menu (hamburger icon) on the Dashboard toolbar.
Click the Reports menu to open the Dashboard Reports page.
Buttons at the top of the page allow you to trigger the schedule, run the report, delete the report, or to clone (copy) the report. Cloning allows you to create a copy that you can customize to add new recipients or a different time zone, for example.
The Reports page also provides options for scheduling and arranging dashboards into reports.
The table describes options for working with reports:
Plus icon (+) |
Click the Plus icon (+) at Reports to add a new report. |
Run |
To run a report manually, select the report, then click Run. In the Print dialog that displays, choose a date for the report, and click Print to run the query and generate the report. You can view the progress and details of the query as it runs, and when it’s done, click Download to download the report so you can save it locally or to a network location. |
Clone |
To clone a report, select the relevant report, then click Clone. This allows you to create a new report based on settings in the cloned report. |
Trigger Schedule |
To manually trigger the schedule for a scheduled report, select the report, then click Trigger Schedule. For reports executed via a schedule, the system writes the report log details to the database (to the lxt_perf_data table). Event data display in a Dashboard widget ( lxt_perf_data widget), where you can view progress and print the details. |
Schedule and Arrange Dashboards into Reports¶
To schedule and arrange dashboards into reports:
Click the left panel Reports menu to open the Report Wizard.
In the Configure tab, click the Plus icon + at Reports to add a new report.
In the Report Name field, give your new report a custom name.
Choose the output format. Options are PDF, CSV, JSON, or XLS.
Note
Outputting to Excel workbooks (
.xls
) creates a new tab for each widget inside a single Excel workbook file.Configuration options on the page depend on the output format you choose. For example, only the PDF output format allows you to define widget layout per page.
At Start Date and End Date, select a start date, and report end date options.
At Time Zone, choose a time zone region and city.
Note
The system uses a city library that represents most zone locations. If your city is not available, choose one that matches the time zone you require.
At Report Interval, choose the period to query data for the report. For example, Last 12 hours.
At Repeats, choose how often you want to repeat the running of this report. Options are: Never, Daily, Weekly, Monthly.
At Descriptions Placement, choose whether to display widget descriptions below the chart(s).
At Widget Layout Per Page, select the number of widgets to print on a page
At Users, click the Plus icon (+) to add recipients (one or more), then select the users who should receive the report.
Note
Non-admin users can also add other users to reports.
At Destination, choose whether to:
only display the report on the GUI: Display only, i.e. no destination
send the report via Email
send the report via SFTP
Note
Reports can be sent via SFTP to a host destination.
Under File name option, if the Override default File name checkbox is selected, report filename options are available to include the username, date and time (
HH_mm_ss
) with the name (separated by an underscore_
).The date format is obtained from the User Settings: (
MMM-D-YY
orD-MMM-YY
)
At Transform, choose formatting options.
For the output format you chose (PDF, CSV, JSON, or XLS), define whether to transform epoch to formatted time, and if your selected file output format is CSV, you can also define whether to remove backend formatting in the generated CSV file.
Note
If you’ve chosen the option to remove backend formatting (CSV output only), then all data in the CSV (each cell) will have minimum formatting applied. This speeds up file generation for reports, and when you wish to download a CSV file (via a dashboard widget). This option is thus useful where the file is large.
At Dashboards, drag the dashboards you want to include in the report, to the Selected Dashboards field.
At Summary Page, use the text editor to design a summary page (including images) that will be placed at the top of the report.
Click Save.