Skip to main content

Generate and share a composed report

Open Composed reports to make a report document for one target and one period. A composed report puts tables, charts and text from report templates in one document. Composed reports explains how a composition works.

Before you start​

  • The composed reports module must be on. Your administrator turns it on for your deployment. Scheduling also needs the scheduled reports module.
  • All roles can open and generate composed reports. To create, edit or schedule a composition, you must have the SuperUser role or higher.
  • A composition must exist. If the list is empty, a SuperUser or higher can click New composition to make one.

Open a report​

  1. In the menu, open Composed reports. The Composed Reports page shows the compositions.
  2. Click the composition. Use Search compositions to find it in a long list.
  3. In the toolbar, select the target. The field label shows the target type of the composition: Region, Facility or Source.
  4. Select the period. The period control follows the period type of the composition: day, week, month, quarter, year or a custom date range.
  5. Click Open report.

Result​

The report shows as a document on the page. The product stores it as a generated report. The generated report is a snapshot: a later change to the composition or to a calculation setting does not change it.

When a stored report exists for the same composition version, target and period, Open report shows that stored report. It does not generate the report again.

Export the report​

After the report shows on the page, click PDF, CSV or Excel in the toolbar. The browser downloads the file.

FormatUse
PDFA fixed document for submission or archive.
ExcelA workbook with the tables.
CSVThe table data for further processing.
  1. After the report shows on the page, click Share. The Share report dialog opens.
  2. Optional: turn on Allow downloads to let viewers download PDF, CSV and Excel files. It is off by default.
  3. Optional: change the expiry. Set an expiry is on by default, with a date 30 days from now. Turn it off for a link that does not expire.
  4. Optional: turn on Require a password and type the password.
  5. Click Create link.
  6. Click Copy to copy the link. The dialog shows the link only once.
  7. Click Done.

Anyone with the link can view the report. When the link has a password, the viewer must enter it before the report opens.

To stop a link, open Share again. In Active links, revoke the link. Revoking the link does not delete the generated report.

Schedule the report​

You must have the SuperUser role or higher. Other users do not see the More actions menu. Ask a SuperUser to make the schedule.

  1. On the composition page, click the More actions menu, then Schedule & history. The Manage report panel opens.
  2. On the Schedule tab, click Add schedule.
  3. Set the schedule. Add the email Recipients and select the Export formats.
  4. Click Create schedule.

The product then generates and emails the report on the schedule. A scheduled run does not create share links. To pause, resume, edit or delete a schedule, use the buttons next to it on the Schedule tab.

Find or delete a generated report​

You must have the SuperUser role or higher. Other users do not see the More actions menu. Ask a SuperUser to find or delete the report for you.

  1. On the composition page, click the More actions menu, then Schedule & history.
  2. Click the History tab. It lists the generated reports of the composition.
  3. Use the buttons of a report to open it, share it or delete it.

Deleting a generated report also removes all its share links. You cannot undo this.

Common problems​

ProblemWhat to do
"Composed reporting is not enabled for your organization."Ask your administrator to turn on the composed reports module.
"No targets available"The composition has no targets yet. A SuperUser or higher must check its boundary and target scope.
"No completed months"A yearly report includes the months up to the last completed month. Choose an earlier year.
"Some blocks could not be rendered"The report opened, but some blocks failed. Read the message next to the badge.
"The report could not be opened."Click Try again.
The report does not show a changed limit or setting.A generated report does not change, and Open report shows the stored report. Calculate the periods again first. Then a SuperUser or higher deletes the stored report in History. This also ends its share links. Then open the report again.
You lost the share link.The dialog shows a link only once. Create a new link, and revoke the old one.
A viewer sees "Report unavailable".The link has expired or was revoked. Create a new link.