Skip to main content

Run a report

Generate a report item​

When you run a report, Alloy generates the report's documents and uses the report's data sources to populate them with information.

A report item is created with the generated document files attached, ready for you to download.

Note

You can use workflows to automatically run reports according to a schedule or in response to item events!

Run a report​

To run any type of report in Alloy:

  1. Open the Reports dashboard card and select Run report.
alt text
  1. Choose Standard (system reports included with Alloy) or Custom report (reports designed by your organisation).
alt text
  1. Select the Report field, choose a report from the list, and then select Next.
alt text
alt text

  1. The report's data sources will be displayed. These determine what data will be included in the report. Some fields may be pre-populated by the report's author, some may need filling in by you. Those marked with an asterisk * require a value to continue!

    Edit the data sources as needed, by inputting text or selecting values from a picker. For AQS data sources, select the field to edit the query in the AQS Builder.

    Supply a meaningful Name for the report item that will be generated.

Note

Some data sources may act as a parameter for other data sources. In the example below, the Installed Date data source is used to filter the items returned by the Street Light items data source above it.

alt text

  1. Select Create to queue the report for processing. The generated report item will be displayed in the right panel with a Status of Running.

    While reports typically process in minutes, complex ones involving lots of data can take significantly longer ⏳. Alloy will email you the download link when it's ready, so feel free to close your web browser and come back later!

alt text
  1. When the report has finished processing, its Status will change. If it's Completed, the number of documents will be shown. See Downloading report documents.
alt text

If the report has Failed, hover over the Error field to see what went wrong.

alt text

Run a report from an item​

When viewing an item's details, you can use this alternative method to run any report that applies to that item's design.

This also provides access to reports that can't be run from the Reports dashboard card because they're designed to operate on a single item, e.g. Activity By Asset Reports.

To run a report from an item:

  1. Select the item to view its details in the right panel.
alt text

  1. Use the tab bar to select the Reports tab.

  2. Select More in the action bar and choose Run report.

alt text
  1. In the left panel, choose an applicable report and continue from step 4 above.
alt text
Note

If the chosen report contains any data sources with the Incoming item id tag set, they'll be automatically populated with the ID of the item you're running the report from 😎.