Skip to main content

Exports & Share information - Managing HTML templates

This article explains how to manage HTML report templates in ClearPoint.

Ted Jackson avatar
Written by Ted Jackson
Updated over 2 weeks ago

HTML report templates allow you to publish ClearPoint information to external websites, intranets, or portals. Templates can be reused each reporting period so your published report always reflects the newest data.


Creating an HTML Report Template

  1. From the left-hand navigation, click Documents.

  2. Select the Templates page.

  3. Open the HTML Reports tab.

  4. Click Add Template (+).

  5. Under Template Name, enter the name of the template (e.g., HTML Report โ€“ Central Division).

  6. Select the Scorecard to be included.

  7. Choose a Default Template Object.

  8. Select a Template Layout.

  9. Click Save.

Configure Template Details

  1. Click the kebab menu (โ‹ฎ) and select Edit Template.

  2. Navigate to the Template tab.

  3. In the Template tab you can:

    1. Update the Template Name.

    2. Adjust the Window Width if needed.

      • Defaults to 1024px

      • Typical width range: 1024โ€“1440px

    3. Enter a Link value to define the permanent URL for your published report.

      • Example: entering central-division creates a stable link that always points to the most recent version.

    4. Report Options allows you to toggle different options:

      • Include Top Menu.

      • Enable Accessibility Plugin.

      • Keep published report private.


Adding Content to the Template

  1. Navigate to the Scorecards tab.

  2. Select which Scorecards should be included.

    • Each selected scorecard becomes a tab in the HTML report.

  3. Click into each scorecard to choose:

    • Summary Reports

    • Detail Pages

Additional Options

  • Include Linked Pages

    • Automatically includes the detail pages for any elements appearing in the selected summary reports.

    • Note: This does not include detail pages pulled into summary reports via a data grid custom field.

  1. After selecting content, open the Contents tab to review all included pages.

  2. Click Save.

Your new template now appears in Templates โ†’ HTML Reports.


Scheduling an HTML Export

Schedules ensure your published report stays up to date automatically.

  1. Navigate to the Schedules tab.

  2. Click Add Schedule (+).

Configure Schedule Details

  1. Modify the Schedule Name (e.g., HTML Report - Central Division).

  2. Select the First Run Date.

  3. Choose a Run Time.

    • The export will begin at this time and finish within a few minutes.

  4. Click Save.

๐Ÿ’ก The template will now automatically regenerate at the scheduled times.


Adding Recipients to an HTML Export

Recipients receive a notification when a new version of the report is published.

  1. Navigate to the Recipients tab.

  2. Select the ClearPoint users who should receive notifications.

    1. Optionally you can Select All

  3. Click Save.

๐Ÿ’ก Only ClearPoint users can be added as recipients.


Generating an HTML Report

  1. Open Documents โ†’ Templates โ†’ HTML Reports.

  2. Click the Run (โ–ถ) button.

  3. Choose the Reporting Period.

  4. Click Confirm.

The report will begin processing. Depending on report size, this may take several minutes.

Once complete:

  • A new export appears under the templateโ€™s dropdown list.

  • A link to the exported version becomes available in Documents โ†’ HTML Reports.

Did this answer your question?