انتقل إلى المحتوى
For the complete DHIS2 documentation index, see llms.txt.

Using the Event Reports app

About the Event Reports app

With the Event Reports app you can analyse events in two types of reports:

  • Aggregated event reports: Pivot table-style analysis with aggregated numbers of events

    By selecting Aggregated values from the top-left menu you can use the Event Reports app to create pivot tables with aggregated numbers of events. An event report is always based on a program. You can do analysis based on a range of dimensions. Each dimension can have a corresponding filter. Dimensions can be selected from the left-side menu. Similar to the pivot tables app, aggregated event reports may be limited by the amount of RAM accessible by the browser. If your requested table exceeds a set size, you will recieve a warning prompt asking whether or not you want to continue.

  • Individual event reports: Lists of events

    By selecting Events from the top-left menu you can use the Event Reports app to make searches or queries for events based on a flexible set of criteria. The report will be displayed as a table with one row per event. Each dimension can be used as a column in the table or as a filter. Each dimension can have a criteria (filter). Data elements of type option set allows for "in" criteria, where multiple options can be selected. Numeric values can be compared to filter values using greater than, equal or less than operators.

Create an event report

  1. Open the Event Reports app.

  2. Select Aggregated values or Events.

  3. In the menu to the left, select the meta data you want to analyse.

  4. Click Layout and arrange the dimensions.

    You can keep the default selection if you want.

  5. Click Update.

Select dimension items

An event report is always based on a program and you can do analysis based on a range of dimensions. For programs with category combinations, you can use program categories and category option group sets as dimensions for tables and charts. Each dimension item can have a corresponding filter.

  1. Select data elements:

    1. Click Data.

    2. Select a program and a program stage.

      The data elements associated with the selected program are listed under Available. Each data element acts as a dimension.

    3. Select the data elements you need by double-clicking their names.

      Data elements can be filtered by type (Data elements, Program attributes, Program indicators) and are prefixed to make them easily recognizable.

      After selecting a data element, it is visible under Selected data items.

    4. (Optional) For each data element, specify a filter with operators such as "greater than", "in" or "equal" together with a filter value.

  2. Select periods.

    1. Click Periods.

    2. Select one or several periods.

      You have three period options: relative periods, fixed periods and start/end dates. You can combine fixed periods and relative periods in the same chart. You cannot combine fixed periods and relative periods with start/end dates in the same chart. Overlapping periods are filtered so that they only appear once.

      • Fixed periods: In the Select period type box, select a period type. You can select any number of fixed periods from any period type. Fixed periods can for example be "January 2014".

      • Relative periods: In the lower part of the Periods section, select as many relative periods as you like. The names are relative to the current date. This means that if the current month is March and you select Last month, the month of February is included in the chart. Relative periods has the advantage that it keeps the data in the report up to date as time goes.

      • Start/end dates: In the list under the Periods tab, select Start/end dates. This period type lets you specify flexible dates for the time span in the report.

  3. Select organisation units.

    1. Click Organisation units.

    2. Click the gearbox icon.

    3. Select a Selection mode and an organisation unit.

      There are three different selection modes:

      Selection modes
      Selection mode Description
      Select organisation units Lets you select the organisation units you want to appear in the chart from the organization tree.

      Select User org unit to disable the organisation unit tree and only select the organisation unit that is related to your profile.

      Select User sub-units to disable the organisation unit tree and only select the sub-units of the organisation unit that is related to your profile.

      Select User sub-x2-units to disable the organisation unit tree and only select organisation units two levels down from the organisation unit that is related to your profile.

      This functionality is useful for administrators to create a meaningful "system" favorite. With this option checked all users find their respective organisation unit when they open the favorite.
      Select levels Lets you select all organisation units at one or more levels, for example national or district level.

      You can also select the parent organisation unit in the tree, which makes it easy to select for example, all facilities inside one or more districts.
      Select groups Lets you select all organisation units inside one or several groups and parent organisation units at the same time, for example hospitals or chiefdoms.
  4. Click Update.

Select series, category and filter

You can define which data dimension you want to appear as columns, rows and filters in the pivot table. Each data element appears as individual dimensions and can be placed on any of the axes.

Note

Data elements of continuous value types (real numbers/decimal numbers) can only be used as filters, and will automatically be positioned as filters in the layout dialog. The reason for this is that continuous number cannot be grouped into sensible ranges and used on columns and rows.

  1. Click Layout.

  2. Drag and drop the dimensions to the appropriate space.

  3. Click Update.

Change the display of your table

You can customize the display of an event report.

  1. Click Options.

  2. Set the options as required. Available options are different between aggregated event reports and individual event reports.

    Event reports options
    Option Description Available for report type
    Data Show column totals Displays totals at the end of each column in the pivot table. Aggregated event report
    Show column sub-totals Displays sub-totals for each column in the pivot table. Aggregated event report
    Show row totals Displays totals at the end of each row in the pivot table. Aggregated event report
    Show row sub-totals Displays sub-totals for each row in the pivot table. Aggregated event report
    Show dimension labels Displays labels for dimensions. Aggregated event report
    Hide empty rows Hides empty rows in the pivot table. Aggregated event report
    Hide n/a data Hides data tagged as N/A from the chart. Aggregated event report
    Include only completed events Includes only completed events in the aggregation process. This is useful when you want for example to exclude partial events in indicator calculations. Aggregated event report

    Individual event report
    Limit Sets a limit of the maximum number of rows that you can display in the table, combined with a setting for showing top or bottom values. Aggregated event report
    Output type Defines the output type. The output types are Event, Enrollment and Tracked entity instance. Aggregated event report
    Program status Filters data based on the program status: All, Active, Completed or Cancelled. Aggregated event report
    Event status Filters data based on the event status: All, Active, Completed, Scheduled, Overdue or Skipped. Aggregated event report
    Organisation units Show hierarchy Includes the names of all parents of each organisation unit in labels. Aggregated event report
    Style Display density Controls the size of the cells in the table. You can set it to Comfortable, Normal or Compact.

    Compact is useful when you want to fit large tables into the browser screen.
    Aggregated event report

    Individual event report
    Font size Controls the size of the table text font. You can set it to Large, Normal or Small. Aggregated event report

    Individual event report
    Digit group separator Controls which character to separate groups of digits or "thousands". You can set it to Comma, Space or None. Aggregated event report

    Individual event report
  3. Click Update.

Download chart data source

You can download the data source behind an event report in HTML, JSON, XML, Microsoft Excel or CSV formats.

  1. Click Download.

  2. Under Plain data source, click the format you want to download.

    Available formats
    Format Description
    HTML Creates HTML table based on selected meta data
    JSON Downloads data values in JSON format based on selected meta data
    XML Downloads data values in XML format based on selected meta data
    Microsoft Excel Downloads data values in Microsoft Excel format based on selected meta data
    CSV Downloads data values in CSV format based on selected meta data

Manage favorites

Saving your charts or pivot tables as favorites makes it easy to find them later. You can also choose to share them with other users as an interpretation or display them on the dashboard.

You view the details and interpretations of your favorites in the Pivot Table, Data Visualizer, Event Visualizer, Event Reports apps. Use the Favorites menu to manage your favorites.

Open a favorite

  1. Click Favorites > Open.

  2. Enter the name of a favorite in the search field, or click Prev and Next to display favorites.

  3. Click the name of the favorite you want to open.

Save a favorite

  1. Click Favorites > Save as.

  2. Enter a Name and a Description for your favorite. The description field supports a rich text format, see the interpretations section for more details.

  3. Click Save.

Rename a favorite

  1. Click Favorites > Rename.

  2. Enter the new name for your favorite.

  3. Click Update.

Write an interpretation for a favorite

An interpretation is a link to a resource with a description of the data at a given period. This information is visible in the Dashboard app. To create an interpretation, you first need to create a favorite. If you've shared your favorite with other people, the interpretation you write is visible to those people.

  1. Click Favorites > Write interpretation.

  2. In the text field, type a comment, question or interpretation. You can also mention other users with '@username'. Start by typing '@' plus the first letters of the username or real name and a mentioning bar will display the available users. Mentioned users will receive an internal DHIS2 message with the interpretation or comment. You can see the interpretation in the Dashboard app.

    It is possible to format the text with bold, italic by using the Markdown style markers * and _ for bold and italic respectively. Keyboard shortcuts are also available: Ctrl/Cmd + B and Ctrl/Cmd + I. A limited set of smilies is supported and can be used by typing one of the following character combinations: :) :-) :( :-( :+1 :-1. URLs are automatically detected and converted into a clickable link.

  3. Search for a user group that you want to share your favorite with, then click the + icon.

  4. Change sharing settings for the user groups you want to modify.

    • Can edit and view: Everyone can view and edit the object.

    • Can view only: Everyone can view the object.

    • None: The public won't have access to the object. This setting is only applicable to Public access.

  5. Click Share.

Subscribe to a favorite

When you are subscribed to a favorite, you receive internal messages whenever another user likes/creates/updates an interpretation or creates/update an interpretation comment of this favorite.

  1. Open a favorite.

  2. Click >>> in the top right of the workspace.

  3. Click on the upper-right bell icon to subscribe to this favorite.

  1. Click Favorites > Get link.

  2. Select one of the following:

    • Open in this app: You get a URL for the favorite which you can share with other users by email or chat.

    • Open in web api: You get a URL of the API resource. By default this is an HTML resource, but you can change the file extension to ".json" or ".csv".

Delete a favorite

  1. Click Favorites > Delete.

  2. Click OK.

View interpretations based on relative periods

To view interpretations for relative periods, such as a year ago:

  1. Open a favorite with interpretations.

  2. Click >>> in the top right of the workspace.

  3. Click an interpretation. Your chart displays the data and the date based on when the interpretation was created.To view other interpretations, click them.

Visualize an event report as a chart

When you have made an event report you can open it as a chart:

Click Chart > Open this chart as table.