Reports
Reporting in NetXMS is provided by a separate server-side reporting component (nxreportd), based on JasperReports.
It is not part of the core server and must be installed and configured by an administrator.
Reports generate formatted documents from monitoring data and can be run on demand or scheduled for automatic generation.
NetXMS does not ship with any report definitions. Report packages are provided separately and are uploaded by an administrator using the Report Definitions view in the Configuration perspective.
Accessing Reports
Open the Reporting perspective in the management console. It lists all reports deployed on the reporting server. The perspective is always present; if it is empty, the reporting server may not be installed or configured — contact your administrator.
Running a Report
-
Select a report in the Reporting perspective
-
Fill in the report parameters (the set of parameters is defined by each report)
-
Select Execute report (F9)
-
The generated result appears in the Results section of the report view
Depending on the report definition, parameters can be of the following types: String, Number, Numeric condition, Boolean, Date, Timestamp, Object, Object list, Multi-select, Severity, Severity list, Alarm state, Event, and User.
Viewing Report Results
Generated reports are listed in the Results section of the report view. Available actions are Render to PDF, Render to XLSX, Preview (also opened by double-clicking a result), and Delete. Carbone-based reports can only be rendered to XLSX — PDF rendering and preview are disabled for them.
Results are retained on the server for a configurable period (default: 3650 days), after which they are automatically removed.
Scheduling Reports
Reports can be scheduled for automatic generation:
-
Select a report in the Reporting perspective
-
Fill in the report parameters — the values entered in the form at the moment of scheduling are used for each automatic execution
-
Select Schedule report execution… (Ctrl+S, or Cmd+S on macOS)
-
Configure the schedule on the General page of the Report Execution Schedule dialog
-
Optionally, on the Notifications page, enable sending a notification on completion, specify recipients, and choose whether to attach the rendered PDF or XLSX file
Configured schedules are listed in the Schedules section of the report view.
Custom Reports
Report definitions are created using Jaspersoft Studio and uploaded by an administrator via Upload… in the Report Definitions view of the Configuration perspective (accepts .jar and .zip packages).
The view shows whether each definition is deployed on the reporting server and allows deleting definitions.
For details on reporting server installation, configuration, and report development, see Reporting in the Administrator Guide.