10.12. Manage push reports

10.12.1. About push reports

Push reports allows you to increase awareness and usage of data analysis by sending reports with charts, tables and maps directly to users e-mail addresses.

  • A push report gets its content from existing dashboards.

  • A push report lists the dashboard items in the same order as on the dashboard.

  • A push report can only contain dashboard items with charts, maps or tables.

  • You create the push report and its schedule in the Maintenance app.

  • The Title and Message parameters you set up in the Maintenance app, are included in each report. The Name you give the report is not included in the report. Instead, the name is used to identify the push analysis object in the system. This way a report can be named one thing, and the title of the report can be another.

  • When you run a push report job, the system compiles a list of recipients from the user groups you've selected. The system then generates a report for each member of the selected user groups. Each of the dashboard items are generated specifically for each user. This means that the data included in the report reflects the data the user has access to. All users could therefore get the same report (if all the data is "static") or custom reports (if all the data is "dynamic"), or a combination of the two.

  • Push reports are sent by e-mail to the recipients, not through the internal DHIS2 messaging system. If a user doesn't have a valid e-mail, or if the job fails, no e-mails are sent. In this case, the problem is logged on the server.

[Note]Note

The data generated in the push reports is public so verify that you don't include any sensitive data.

Example 10.17. Push report


In the Maintenance app, you manage the following push reports objects:

Table 10.19. Push reports objects in the Maintenance app

Object type

Available functions

Push analysis

Create, edit, clone, delete, show details, translate, preview and run


10.12.2. Create a push report

  1. Open the Maintenance app and click Other > Push analysis.

  2. Click the add button.

  3. In the Name field, type the name of the scheduled report.

    This name is not included in the report e-mail. Instead, the name is used to identify the push analysis object in the system.

  4. (Optional) In the Code field, assign a code.

  5. Add a report Title.

    This title is included in the report e-mail.

  6. (Optional) Add a Message.

    This message is included in the report e-mail.

  7. Select a Dashboard to base the report on.

  8. Select and assign the user groups you want to send the report to.

  9. Select a Scheduling frequency: Daily, Weekly or Monthly.

    [Note]Note

    If you schedule a push report to "Monthly" and "31", the scheduled report job will not run if the month has less than 31 days.

  10. (Optional) Select Enable to activate the push report job.

    The job won't run until you activate it.

  11. Click Save.

10.12.3. Preview push reports

  1. Open the Maintenance app and click Other > Push analysis.

  2. In the push report list, locate the push report you want to preview.

  3. Click the options menu and select Preview.

    A preview of the push report opens in a new window.

10.12.4. Run push report jobs

  1. Open the Maintenance app and click Other > Push analysis.

  2. In the push report list, locate the push report you want to run.

  3. Click the options menu and select Run now.

    The push report job runs immediately.

10.12.5. Edit metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to edit.

  2. In the object list, click the options menu and select Edit.

  3. Modify the options you want.

  4. Click Save.

10.12.6. Clone metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to clone.

  2. In the object list, click the options menu and select Clone.

  3. Modify the options you want.

  4. Click Save.

10.12.7. Delete metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to delete.

  2. In the object list, click the options menu and select Delete.

  3. Click Confirm.

10.12.8. Display details of metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to view.

  2. In the object list, click the options menu and select Show details.

10.12.9. Translate metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to translate.

  2. In the object list, click the options menu and select Translate.

  3. Select a locale.

  4. Type a Name, Short name and Description.

  5. Click Save.