ARDI Documentation - report_list

Adding a Report

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Adding a Report Adding a report to the system requires direct server access - you'll need to be able to create files and folders on the reporting server. Once you've got access to the report folder, you add a report to the Report List by following the steps below

Reporting Administration

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Reporting Administration The report list addon allows you to add custom Python reports to your ARDI system, using your combined ARDI data to create your own visualisations. These are made available on your ARDI website and can also be distributed via email as regularly scheduled reports.

Azure Communication Services

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Azure Communication Services ACS is a useful tool for sending email if you have an ARDI server with cloud (or at least Azure) access. Once you've created an Azure Communication Services resource in Azure, you can also create an Email Communication Service

Regenerating Bulk Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Regenerating Bulk Reports In some cases - particularly when you're using a library such as KPICapture to record KPIs and analytic values - you might want to re-generate a number of past reports. The reporting addon provides this through the backgen endpoint.

Bookmarking Specific Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Bookmarking Specific Reports You can get a link (or create a bookmark) that always takes you to the latest version of any report. There are a couple of steps involved... Get the Report Link Open the report page. Then right-click on the report preview on the reports page and choose

Adding Descriptions to Bundles

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Adding Descriptions to Bundles Individual report bundles can have unique descriptions that appear on the Subscription page. Add a >.txt file to the subs folder under the report directory. The content of that file will be added directly underneath the 'subscribe' button. This file can contain simple

Report Bundles

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Bundles A bundle is a set of reports that are consolidated into a single file. Bundling reports together allows you to send them out as routine emails. Bundles are also available through the web interface - the reporting addon offers the latest version of each bundle as a single PDF file, along with the last several (usually 14) versions of the bundle in the

Report Bundles

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Bundles A report bundle is a set of PDF reports that are 'bundled' together into a single file. This is usually because they are related to one-another in some way - such as being about the same topic (ie. a set of Control Reports), being produced at the same time (a set of Daily Reports), or because they are relevant to the same audience (a set of Maintenance reports).

Checking Transmissions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Checking Transmissions You can get a look into the process of transmitting a bundle of reports through the Transmission option under Administration|Report Settings. A log file is created every time a particular bundle is distributed (usually via a scheduled task). This allows you to view a summary of the most recent 'transmission' of your reports.

Common Report List Issues

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Common Report List Issues An Old Version of a Report Keeps Appearing A Disabled Report Keeps Appearing Emails Are Not Being Sent Reports Fail With No Error Messages

Configuring Delivery Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Configuring Delivery Methods If delivering to a service (or any other non-email destination), you'll first need to set it up. This is done using Python Scripts. Each script is installed into the base of your report folder. It should be named method.py, where 'method' is a single-word name for the destination.

Custom Delivery Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Custom Delivery Methods A custom delivery method can be created in Python. Your script will be called with a single parameter - the path to a JSON file that contains all of the information about the delivery. JSON Content The content of the file will look like this

Custom Delivery Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Custom Delivery Methods A custom email method can be created in Python. Create a file named push_method.py, where method is the name of the communication method you want to create. For example, push_gchat.py would be a good name for a system that sends messages via Google Chat.

Creating Report Bundles

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Creating Report Bundles You can create a new report bundle or edit an existing one by going to Administration|Report Settings and choosing 'Report Bundles' from the list of options. Here, you'll be shown a list of the available bundles. [400] Click on an existing

Adding Footers to Emails

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Adding Footers to Emails Individual report bundles can have custom footers that are attached to the end of your emails. Add a >.footer file to the subs folder - the content of that file will be added to the body of the email every time reports are sent out.

Embedding Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Embedding Reports You can embed reports in other web-based systems. The report list addon provides a few ways you can do this. Using Links You can give people direct access to the most recent copy of a report through a web link. /reportlist/dlbundle?name=

Failure Reporting

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Failure Reporting If a report fails, there are several ways you may be able to pick this up. If a report prints the word FAILED as the last line of output, the addon will mark the report as a failure and highlight this in the web interface. Reports based on our new

A Disabled/Hidden Report Keeps Appearing

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

A Disabled/Hidden Report Keeps Appearing In general, this issue isn't caused by our system, but is instead caused by report deployment methods. Check the server to ensure that the report has really been removed from the server. If the issue continues, you can place a '#' at the start of the reports name in the

Emails Not Being Sent

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Emails Not Being Sent This is a complex issue. There are several steps in sending email, and a failure in any one of those steps can result in your message not arriving. While this guide can't resolve any-and-all issues, we can walk you through some of the basic steps.

Troubleshooting: An Out-Of-Date Report Appears

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Troubleshooting: An Out-Of-Date Report Appears In some cases, you might find that a report appears and is sent out, but it is for an earlier date range. There are a couple of possible solutions to the problem. ---------- Option 1 The reporting addon finds the 'latest' copy of a report in an extremely simple way - it sorts the PDF reports in your folder in descending order and uses the first one it finds.

Report File Extensions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report File Extensions Although it was originally designed for PDF reports, the reporting addon allows you to create any type of output you'd like. For example, you can create video or audio reports, PowerPoint presentations or spreadsheets. Adjusting the

Installing Libraries

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Installing Libraries ARDI is designed to run on a wide range of different systems and a huge variety of applications. Because of this, we don't include everything with an ARDI installation. If you use new features, drivers or modules, you might need to install extra

Legacy Report Settings

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Legacy Report Settings The legacy report settings format was for older versions of the addon - as the complexity of the system grew, a more modular format was required. The report list addon will automatically convert a legacy settings.txt file to the new

Logging and Diagnostics

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Logging and Diagnostics The reporting system offers log files to help you diagnose issues. Generation Log You'll find this in the log.txt next to the Python file. It includes the full command-line syntax used to launch the Python script, so you can run it manually and debug any issues.

Maintaining Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Maintaining Reports You can make small changes to your report configuration - such as renaming reports, changing folders and durations etc. - under Individual Reports, found in Administration|Report Settings. [400] Editing a Single Report To change any of the options in a single report, simply click its name.

Alternative Email Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Alternative Email Methods It's getting harder and harder to use SMTP - the original email protocol - to send messages, as many cloud-based solutions are making it increasingly difficult to let devices and computers send messages automatically. The ReportList addon also allows you to customise the way reports are sent to email addresses. This is done in

Personalised Subscriptions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Personalised Subscriptions This feature allows individual users and report-destinations to 'personalise' the reports they receive. Although users can't add new reports to any of the bundles on offer, they can remove pages that they don't have any interest in.

Re-Sending Past Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Re-Sending Past Reports The normal instructions for Re-Sending Reports are focused around re-sending todays reports. If for any reason you are trying to re-generate and re-send a set of reports from a previous point in time, you'll need to use the manual method of triggering report transmission.

Re-Sending Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Re-Sending Reports Occasionally reports will be generated during an outage or other data disruption, meaning that you'd like to regenerate and re-send them. If you've noticed the problem quickly, there's an easy way to re-send your reports. If more than a reporting period (ie. shift/day/week) has passed, you might need the more complex

Reusing Report Code

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Reusing Report Code You can re-use a single report Python script for multiple different reports at different time-ranges (for instance, a Daily, Morning and Afternoon version of the same report), without having to duplicate your code. Setting Up Your New Report

Report Bundles

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Bundles A Report Bundle is a group of related reports that will be sent out together. You can create a bundle for any purpose you like. Common report bundles include... * Daily Summaries * Daily Technical Reports * Shift End Reports *

Adding Comments to the Report UI

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Adding Comments to the Report UI You can add some additional information about individual reports in the web UI. This can include HTML code, so can include links to additional resources, other reports, or guides on how to read, use or respond to the contents of the report..

Report Folders

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Folders You usually don't want all of your reports appearing in one large list - it's confusing to the user and makes it hard for people to find the information they are looking for. The report addon allows you to organise your reports into

Report Names

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Names The report name is a simple, human-readable name that the report will have in the report web interface. Placing a 'hash' (#) symbol at the start of the name will remove the report from the web interface - this is useful when you want to hide a report from end-users when it is undergoing maintenance.

The Report Page

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

The Report Page The Report Page allows you to access a single report. [400] There are several sections to this page. Most Recent The preview of the most recent report can be found at the top (top-left) of the page. This is a snapshot of the most recent version of the report. Click this preview to be taken to the full file (ie. the PDF file or MP4 video).

The Reports Directory

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

The Reports Directory The reports directory lives in your site folder. This will be in a different location depending on your platform. If you are trying to use the default site, your path will be... PlatformFolderWindowsc:\Program Files (x86)\Optrix\ardi\web\sites\default\reports

Reusing & Rebranding Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Reusing & Rebranding Reports In some cases, you may want to use a particular report multiple times. This comes up quite a lot when you're doing shift reporting, where you'll want the same report for the morning shift that you have for the afternoon shift.

Scheduling Report Distribution

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Scheduling Report Distribution Once you have a bundle and one or more subscriptions, you can schedule your report(s) for distribution. Using the Scheduled Addon To do this, we strongly suggest using the ARDI Scheduled addon, which makes creating, modifying and maintaining your report schedules much easier.

Scheduling Your Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Scheduling Your Reports The Schedule Addon The ReportList addon integrates with the Schedule addon, allowing you to easily set up regular report transmission. The Manual Way Reports can be sent manually at any time by using a web URL. This URL is

Sending Reports to Sharepoint

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Sending Reports to Sharepoint To send reports up to a Teams or Sharepoint site, you'll first need to set up an Entra (previously Azure AD) application that has the correct permissions to write to the Sharepoint/Teams folder. Create a JSON configuration file to store your

Setting Up Report Email

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Setting Up Report Email Assuming you've set all of your SMTP details correctly in your settings file, you'll most likely want to send out occasional reports via email. The Report List Addon is designed to handle large numbers of reports - allocating individual reports to each person is a time-consuming task that would usually result in problems.

Setting Up Reporting

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Setting Up Reporting When you first open the ReportList addon (from Reports in the sidebar), a default reporting configuration will be imported. This includes some of the standard report-generation libraries, a small logo, and a single sample report.

Setting Up Scheduled Transmission

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Setting Up Scheduled Transmission This step has changed noticably from earlier versions of the addon. For customers still using the older version, see Setting Up Report Email ARDI allows you to schedule the creation and transmission of reports. Although most users choose to send reports as emails, the system also supports the ability to directly deliver your reports to online services, such as Sharepoint, Slack and Discord.

Setting Up Subscriptions and Delivery Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Setting Up Subscriptions and Delivery Methods Subscriptions represent delivery to a destination. The most common type of destination is an email address. In these email subscriptions, an email addresses may be subscribed to any of your bundles, and they'll be packaged up and sent to those addresses in a regular email message.

Report Setting File

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Setting File There are two versions of the report addons configuration file - the older txt file, and the newer json version. For information on the older syntax, see the legacy settings page. { "sitename": "My Site", "sidecode": "SITE", "timezone": "Australia/Sydney", "server": "localhost/s/default", "domain": "my.email.domain", "smtphost": "SMTP server", "smtpport": 43, "smtpuser": "username", "smtppass": "password", "smtpfrom": "From Email Address", …

Settings & Tweaks

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Settings & Tweaks Most of the adjustments to the system are made through the settings file. However, there are a few things you can do to the reporting addon that can easily be missed. Reusing and Rebranding Adding Comments to the Report UI Adding Custom Email Footers

Subscribing to Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Subscribing to Reports The Report Subscription page allows you to select which reports a user is subscribed to. [400] Simply click on the grey Click To Subscribe buttons to subscribe to a report, or the green Subscribed buttons to unsubscribe from a report.

Subscriptions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Subscriptions If your administrator allows it, you can subscribe yourself to specific bundles of reports. For example, you might choose to subscribe yourself to the 'Daily Overview' bundle, which includes basic KPIs and figures about the previous 24 hours. Entering Your Address

Report Time Expression

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report Time Expression There are other options you can use to set up the timing of your report. Rolling Reports By default, reports will 'roll' into the next reporting period based on the start date and the number of hours the report covers. In the Info.txt file, the first line is the reports

Publishing Reports to Discord

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Publishing Reports to Discord Before you use this script, you'll need to make a webhook on the channel you'd like to publish your reports to. Then, paste the channel URL over <> in the code below, and paste it into your publish.py file in the reports folder.

Using the Report List

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Using the Report List The Reporting addon gives you access to a range of reports from your ARDI system. Reports can be distributed a variety of ways, and they can also be accessed directly from your ARDI web server. Choose Reports from the ARDI sidebar on the left of the page.

AI Report Analysis

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

AI Report Analysis ARDI can analyse your report output and - with some training from your users - use machine learning to tell the difference between a 'normal' and an 'abnormal' report. This helps combat report fatigue - people skimming over reports without really reading them - by highlighting those reports that appear to have unusual information.

Report List Addon

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Report List Addon The Reporting or ReportList addon gives you access to custom reports using ARDI data. Using the Report List Creating and Administering

Reports

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Reports ARDIs reporting engine is very flexible when it comes to what a 'report' actually is. Any task that works across a period of time can be a report, no matter what type of output it produces. This not only includes creating your traditional, PDF-style reports, but can also include

Writing a Report in Python and MatPlotLib

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Writing a Report in Python and MatPlotLib This article is not a complete tutorial on using Pandas and MatPlotLib. These two libraries are extremely useful for creating reports, but they are also rather large and complex topics to cover in a small space.