ClearPoint allows you to create an HTML report template useful for publishing information from ClearPoint on outward-facing websites. Additionally, HTML report templates can be reused with each new reporting period to republish your results.
Creating a published report template
Select Documents from the Control Panel
Click on HTML Exports under Templates
A list of previously created templates will appear
Click on the Plus icon to create a new template
Under Template Name, enter the name of the new template, in this example, ‘HTML Report Central Division’.
By default, the Window Width will be set to 1024px.
This can be adjusted if you would like a wider or narrower HTML report. Standard window widths range from 1024px to 1440px.
Provide a Link for the permanent URL for the report.
The link name you enter will be appended to the URL, in this example ‘central division’.
This is the URL you will direct users to in order to view the report.
You have the following 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.
Navigate to 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.
Selecting Include Linked Pages does not include detail pages from summary reports included in the HTML report via a data grid custom field.
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
Once you are done with your configuration, click Save
You will find your newly created template under HTML Reports.
Scheduling an HTML Export
Setting a schedule for an HTML Export ensures your export is using the most recent information from ClearPoint.
Select Documents from the Control Panel
Click on HTML Exports under Templates
Open the template you are going to be working with, in this example, ‘HTML Report Central Division’.
Navigate to the Schedules tab
Click on the Plus icon
You will find a prepopulated Schedule Name, you have the option to rename it
Click the green check box next to Enabled to configure a 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 Run 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 be processed within a few minutes.
Mark the checkbox next to Recurrence to specify a frequency.
Choose the Recurrence from the options Daily, Weekly, and Monthly in the Repeats dropdown, and indicate the frequency by typing the number of days, weeks, or months.
Additionally, you can select the End By Date by typing in a date or clicking the calendar button and selecting a date.
Once you are done with your configuration, click Save.
You will find your newly created template with the Schedule label under HTML Reports.
Add recipients to an HTML Export
You can configure a list of users that will receive a notification when the report is published. This is an excellent option for sharing important information with stakeholders.
Select Documents from the Control Panel
Click on HTML Exports under Templates
Open the template you are going to be working with, in this example, ‘HTML Report Central Division’.
Navigate to the Recipients tab
Under Recipients select which users should receive a notification that the report has been published
Click Save
Generating published reports
Generating an HTML report
Select Documents from the Control Panel
Click on HTML Exports under Templates
Locate the template you are going to be working with, in this example, ‘HTML Report Central Division’.
Click on the Play icon
Use the Select Reporting Period from the dropdown menu
Mark the checkbox next to Include Recipients
Select the recipients from the dropdown menu
Click Generate
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.
Obtaining the Published Report URL
When you open the report, you will notice a long URL in your browser, this URL is specific to the particular version of the report you are viewing. The URL changes every time a new report is generated.
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.
Select Documents from the Control Panel
Click on HTML Exports under Templates
Click on the three dots icon next to the template you are going to be working with, in this example, ‘HTML Report Central Division’.
Click on Edit Template
Under Link, you will find a shorter 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.
Note: 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.
Report Generation Percent Complete
Select Documents from the Control Panel
Click on HTML Exports under Templates
Click the dropdown arrow
When a report is in the process of being generated, 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.
