How To Create an Automated Report in Axiom (version 24)

 Automated Reports allow the user to send a screenshot of a specific chart or application at a specific time of day, week, or month. These images are stored as PNG files and can be sent via email if the Canary system is configured to do so. (See Configuring the Canary System to Send Email Alerts)

To create a report, click the hamburger menu of the Axiom screen in the upper left-hand corner and select Automated Reports .

The AUTOMATED REPORTS screen will appear with two tabs to select from: VIEWER and SCHEDULER. The Viewer window will display a screenshot of all the reports that have been previously generated. The Scheduler window displays a list of the reports that are scheduled to run.

To schedule an Automated Report:

1. Select the SCHEDULER tab and click the '+' icon to create a new report. The ADD REPORT menu will appear.

   

2. Using the Mode drop-down menu, choose whether the report will run: Weekly, Monthly, Advanced Cron, or Event Completed.
   • If Weekly...
     • Set the desired time (using a 24-hr clock format) and highlight the days on which you want the report to run.
   • If Monthly...
     • Set the desired time and day(s) of the month on which you want the report to run. Use 'L' in place of a number if you want the report to run on the last day of the month.
   • If Advanced Cron...
     • Cron job reports use a 3rd party library, Quartz, to run. It may be useful to understand the syntax of Quartz triggers and expressions. For this information, visit http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html 
   • If Event Completed...
     • The report will be sent upon completion of an event. These are events configured within the Canary Admin client. See How to Create an Event for more details.
       • Event Server - name of the server where the Calcs & Events service is running. This will most likely be localhost unless the Axiom Core is installed remotely from the Calcs & Events service.
       • Choose the Event Type.
       • If it is an asset-based event, an optional Event Source Path may be used to filter upon which assets will trigger the report to be sent.
3. Select an Application or Chart to be used for the report using the FILE field. A report can contain multiple pages from different applications/charts by selecting the '+' icon.
4. Optional - If selecting an application (not a chart) from step 3 which has multiple screens, the user can specify which screen to capture using the Screen Name option. By default, the report will use the first screen unless specified otherwise.
5. Optional - If selecting an application (not a chart) from step 3, the user can choose to load a specific asset using the Asset Instance option. This is only applicable if the application makes use of assets as defined in Canary Views and the screen is set to an asset type. The report will capture the specified asset instance.
6. Optional - Input an email address(es) separated by commas or semicolons to any recipient you wish to receive the report.
7. Optional - Check the box to Include Attachment if you want the email to contain a PDF of the report; otherwise, only a link will be sent containing the image.

Is Axiom Installed Remotely from the Identity Service?

If so, Axiom will need to be configured with an API token to run its reports.

1. On the server where the Identity service is installed, open the Canary Admin client and navigate to Identity tile>Security>API Tokens.
2. Copy the API token marked "Default token for Axiom Reporting."

   

3. On the server where the Axiom service is installed, open the Canary Admin client and navigate to Axiom tile>Configuration>Settings.
4. Paste the token into the Identity API Token field.

   

5. Click APPLY when the red banner appears.