Managing HTML templates
ClearPoint allows you to create an HTML report template. These reports are useful for publishing information from ClearPoint on outward facing websites. It can be reused with each new reporting period to republish your results. This article covers managing HTML templates.
In This Article
Creating a published report template
Under Documents, click into HTML Exports from the menu options on the left-hand panel.
A list of previously created templates will appear. Click on the plus icon in the upper right hand corner. A new window will appear.
First, provide the template with a Name. By default, the Window Width will be set to 1024. This can be adjusted if you would like a wider or narrower HTML report. Standard window widths range from 1024px to 1440px. Finally, provide a Link for the permanent URL for the report. This is the URL you will direct users to in order to view the report.
Under Report Options, you can choose to Include Top Menu for navigational purposes, though it is not always necessary since HTML reports are created with working hyperlinks. You can also choose to Keep the published report private so the link is not accessible to the public. In this case, when the report is generated, it will not be published publicly. Instead, users can download a .zip file that contains the entire report and publish it on their own intranet.
Check the box next to Enable accessibility plugin to share results with citizens or stakeholders in a user-friendly and accessible manner. Viewers will have the option to click the accessibility icon and enable the features as needed. Learn more about the accessibility plugin here.
Once template settings are configured, click on the Scorecards tab. Here, you can select which scorecards you would like to include in the report.
When you select a scorecard, it will appear as a tab on the left. From there, click into the scorecard from which you would like to add reports or detail pages.
Use the tabs on the top to navigate to each element type to select summary reports and detail pages to include in the report. Please note that attachments included in published reports will be accessible to visitors to the page. Please publish your sensitive information with caution!
When Include Linked Pages is selected, all elements featured in the included summary reports will have their detail pages automatically included in the report.
Once the appropriate summary reports and detail pages are selected to be included in the report, the Contents tab will feature a list of all selected pages.
Scheduling an HTML Export
Setting a schedule for an HTML Export ensures your export is using the most recent information from ClearPoint. If you would like to set a schedule, click on the Schedules tab. Click the green plus icon in the top right-hand corner. A new window will appear.
Name the schedule. Click the green check box next to Enabled to enable the schedule. Select the First Run Date by typing in the starting date for the schedule, or clicking the calendar button and selecting a date. Select the time by typing in the time you would like the HTML export to run, or using the up and down arrow toggles. The scheduled export will be added to the queue at the selected time and will process within a few minutes.
You have the option to select the date you would like the HTML export to stop running on a schedule. Select the End By Date by typing in a date or clicking the calendar button and selecting a date. Choose the recurrence from the options Daily, Weekly, Monthly in the Repeats dropdown, and indicate the frequency by typing the number of days, weeks, or months.
The On field will change depending on the recurrence selected earlier. Select the check box and/or use the dropdown menus to indicate the specific day in the time period that the HTML export will be scheduled to run on. Click Save, and the schedule will be set for this HTML export.
Add recipients to an HTML Export
If you would like users other than yourself to receive a notification when the report is published, click into Recipients. Select which users should receive a notification that the report has been published. Click Save, and your published report template will be available to use. When finished, Save.
Generating published reports
Generating an HTML report
To generate your HTML report, click on the blue play icon for your desired report.
If you want to send the export to certain recipients, check the box next to Include Recipients. For more information on how to add recipients refer to the section above on adding recipients to an HTML Export.
Click the Generate button. This will begin the generation process. Depending on the size of the report, this can take anywhere from a few minutes to an hour.
Click on the dropdown arrow next to the report template to view the report’s most recent export. To see a list of your three most recent exports, click on the Published Reports icon in the top right corner.
Private reports will be labeled with a Private label. These reports are not published to a live site. Instead, they are only available for download.
Reports will be listed in reverse chronological order, with the most recent reports at the top.
To view the report in your browser, click the open window icon for the desired report. Only the most recent version of an HTML report is published and available for online viewing. All reports can be downloaded at any time, regardless of age or private status.
Obtaining the Published Report URL
When you click open window icon to browse your published report, you will see a long URL in your browser that is specific to the particular version of the report you’re viewing. This long URL is changed each time you generate your report.
However, there is a shorter link available that will always redirect to the most recent version of your report. That way, you can embed it more easily in your website or intranet, or have your leadership bookmark a single link to view up-to-date information.
To access this shorter link, toggle back to the HTML Exports templates page. Click the pencil icon next to the desired report.
Under the Link you can provide a short URL that will remain consistent, even as the report is updated with new information. Copy the URL to use wherever you would like to have the most recent version of your report available automatically. This is the best link to share with people who want to always see the new report. Whenever they open the short URL, the report will automatically load the most recent version of the report.
Report Generation Percent Complete
When a report is generating, you can see the percent completion of the generation before it is ready to view. This will give you a visual estimate of how much time is left in the generation process.
