Creating a Report

Building a report requires the “Manage Reports” ability and some familiarity with SQL. To create a report if you’re not familiar with SQL, try using Data Explorer.

How to create a report

There are three ways to create a report:

   
1. Start from scratch Click “Reports” on the main navigation menu, then click “New Report” and select “Blank Report.” create report.png
2. Duplicate an existing report Open the report you want to copy and click the Duplicate icon. duplicate report.png
3. Copy a report across health centers( note: only for users with access to multiple health centers)
1. Open the report you want to copy.
2. Click the Clipboard icon to copy the report definition.
3. Log in to the other health center.
4. Go to the Reports page.
5. Click New Report and select “Import Report”.
6. Paste your copied code into the text area.
7. Click Import.		 copy definition.png

Specify report details

  1. Give the report a name and description. Note: report descriptions can be formatted with MarkDown, which allows for headings, bold text, links, images, and more.
  2. Choose the report Owner.
  3. Add the report to one or more Report Sets.

Configure report access

  1. Choose the report Status. The report status primarily determines whether the report is visible in the report list for report viewers (i.e. users with the “View Reports” ability). There are 4 statuses you can choose from:

    • Draft: The “Draft” status is for reports that are still being created or edited. Report viewers cannot see draft reports in the Reports list, but they can access them if provided with a direct link.
    • Published: The “Published” status is for reports that are finalized, validated, and actively used by your organization. These reports are visible to report viewers in the Reports list.
    • Published (hidden): The “Published (hidden)” status applies to reports that are finalized and published but not displayed in the Reports list for report viewers. Use this status to keep the Reports list uncluttered, especially for reports created specifically for Dashboards.
    • Archived: The “Archived” status is for reports that have been retired or are no longer relevant. Archived reports are not visible to report viewers in the Reports list.
  2. Choose “Exposes PHI” if the report results will include any Protected Health Information. This will further restrict access to the report based on how PHI restrictions are configured for your health center.
  3. Choose “Restricted” if you want to further restrict access to the report to a list of specific users or roles.Reports-restricted-options.png( Note: users with the “Manage Reports” ability will always retain access.)

Select primary use

Keep your reports organized by specifying how you intend this report to be used. While this doesn’t impact any functionality in Relevant, it helps categorize your reports for future reference.

  • Standalone report: The report will be run from the Reports module.
  • Dashboard only: The report will be used as a Dashboard tile only.
  • Both: The report will be used in both the Report module and as a Dashboard tile.

Add parameters and SQL queries

  1. Click “Add parameter” to add any desired parameters to the report, and then add references to the parameters in the Results SQL. Read more about parameters.
  2. Write a query in the “Results SQL” box. This must be a single SELECT query. Use the “Schema Browser” to reference which schemas, tables, and columns are available.
  3. If necessary, add additional SQL commands in the “Temp tables and functions SQL” box.
  4. Click “Run” to view your report results. Pro-tip: you can use the keyboard shortcut CTRL + ENTER to run your report.

Add additional report views

After running your report, click “Add view” and choose how you would like to view your data. There are 3 types of views that you can add:

  1. Data Grid: a spreadsheet-like view that includes filtering, grouping, and pivot tables.
  2. Pivot Table: a quick way to create charts or an alternative if the Data Grid pivot tables don’t meet your needs.
  3. Vega-Lite: build custom data visualizations using the Vega-Lite grammar.

Save report

  1. Click “Save and continue editing” to save your progress without leaving the editor.
  2. When you are done, click “Save” to return to the report’s show page.