Skip to content

Commit 0214c38

Browse files
committed
add: document how to order reports
1 parent e443d71 commit 0214c38

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/customization/reports.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ The recording of one or more failure messages will automatically flag a report a
9797

9898
To perform additional tasks, such as sending an email or calling a webhook, after a report has been run, extend the `post_run()` method. The status of the report is available as `self.failed` and the results object is `self.result`.
9999

100+
By default, reports within a module are unordered and 'randomly' displayed in the reports list page. If you want to order reports, you can defined the `report_order` variable at the end
101+
of your module. The `report_order` variable is a tuple which contains each Report class in a specific order.
102+
103+
```
104+
from extras.reports import Report
105+
106+
class DeviceConnectionsReport(Report)
107+
pass
108+
109+
class DeviceIPsReport(Report)
110+
pass
111+
112+
report_order = (DeviceIPsReport, DeviceConnectionsReport)
113+
```
114+
100115
Once you have created a report, it will appear in the reports list. Initially, reports will have no results associated with them. To generate results, run the report.
101116

102117
## Running Reports

0 commit comments

Comments
 (0)