Publishing and Un‐Publishing Public Reports - greenriver/hmis-warehouse GitHub Wiki

Specific reports in the Warehouse can be published to public areas through the Publish feature and then embedded within other websites. These reports include:

  • All Neighbors System Dashboard
  • Homeless Populations Report Generator
  • Number Homeless Report Generator
  • Number Housed Report Generator
  • Percent Homeless Comparison Report Generator
  • Point-in-Time by Month Report Generator
  • Point-in-Time Report Generator
  • State-Level Homelessness Report Generator

How to Publish a Public Report

  1. Navigate to the report in the Warehouse and run the report using the desired Universe Selection.
  2. After the report runs, there will be an option at the top of the report to publish. -Specify a new Folder name if you want to make the report unique from other previously published versions. -If you are publishing the report for the first time ever or if you want to replace a previously published report with this new version, leave this field blank (or set to the value filled in by default if this report was previously published to a particular folder). -Click Publish. -If the report has been published previously, a disclaimer will appear indicating that the existing published report will be un-published and replaced with the new report. To proceed, click OK. Publishing the report may take a few minutes.

Example of Publish Details

Example of Publishing Disclaimer

  1. After the report has been published, a URL will be displayed, which you can click on to preview the published version of the report. Embed code will also be displayed, which you can copy/paste into the html of the website you would like to embed the report on. For example: if you are embedding the report on a page within your content management system, such as Drupal or Wordpress, you can paste the embed code into the source code or text view when editing the page in your CMS. Note: once the report is published, the report cannot be deleted from the report run table, it would need to be un-published first.

Example of Published Report Public Link and Embed Code

FAQ

How do I un-publish a report?

A report can be un-published by publishing a new version of the report, with the same Folder if applicable, or by clicking the Un-Publish button in the Publishing details section of the report. Note: un-publishing a report will prevent anyone from accessing the published version of the report. If the report is embedded in a public website, that page may not function correctly since it will no longer be able to load the report that no longer exists. You can remove the embed code from your website if you want to stop it from trying to load the report.

Example of Un-publish Option

Can I publish the same report to multiple sites?

Yes, you can utilize the same embed code to display the same report on multiple web pages or sites.

Can I publish different versions of the same report?

Yes, by specifying a new sub-folder you can publish a unique version of the report.

Example of Specified Folder

How do I know which version of the report is published?

You can see which version of a public report has been published by navigating to the report run table. In the table there is a column labeled Published?. Reports marked with a green checkmark in this column have been published.

Example of a Published Report on the Report Run Table