Skip to main content Skip to complementary content
Qlik Resources
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal

Getting started with HTML reports

HTML report templates are developed with the HTML designer. This designer is available directly within an analytics app.

Interface overview

For an overview of the HTML designer, see Navigating the HTML designer.

Creating a new HTML template

Do the following:

  1. In your app, use the drop down menu in the navigation bar and select Reporting.

  2. Switch to the Templates tab.

  3. In the top right, click Create new > HTML template.

  4. Enter a Name for the template.

The HTML designer opens.

Editing a template

You can edit existing HTML templates that have already been added in the app. When you edit a template, the HTML designer opens directly in the app, where you can make changes to the existing template.

Do the following:

  1. In the Reporting section of an app, switch to the Templates tab.

  2. Click Three-dot icon next to an HTML template, and click Edit Edit.

The HTML designer opens.

Saving your work

Autosave is turned on by default in the HTML designer. Changes are automatically saved every 30 seconds. You can also manually save your work more frequently if needed—for example, if you are done editing and would like to close your browser. To manually save, click Save template in the top right corner.

Autosave can also be turned off if needed. To turn off this feature, switch Autosave off in the top right corner.

Your template cannot be saved (including with autosave) if you add HTML content that is not allowed in the template. When prohibited content is present in the template, you must first sanitize the contents, either automatically or by manually removing non-compliant code, before saving. For more information about sanitization and a list of allowed HTML code, see Allowlist for code in HTML templates.

Previewing your work

As you add content to your report template, it is helpful to preview the output in its current form. You can easily export a copy of the generated report when working in the HTML designer.

Do the following:

  • When editing a template, click Preview template in the top right corner of the interface.

You can continue working on your template while the preview is being generated.

Exporting an HTML template

You can export a copy of the template to your local machine. The template is exported in .qhtml format.

Do the following:

  1. In the Reporting section of an app, switch to the Templates tab.

  2. Click Three-dot menu next to a template.

  3. Click Download Download.

After exporting the template, you can upload it into the same app—or a copy of the app—to create new variations or add the template to a published app. See Uploading an existing HTML template.

Uploading an existing HTML template

You can upload an existing HTML template file (in .qhtml format) into the app. This action is common when you have developed a template against a copy of the app in a development space, and need to re-upload the template after the app has been published to a managed space.

To upload the template into an app, any Qlik Sense objects referenced in the template must also exist in the app.

Do the following:

  1. Before starting, export the HTML template you want to use. See Exporting an HTML template.

  2. In the Reporting section of an app, switch to the Templates tab.

  3. In the top right, click Upload template.

  4. Click Browse, and select a compatible .qhtml file from your computer.

Other actions

For an HTML template listed in the Templates tab, click Three-dot menu to access the following additional options:

  • Edit Rename: Change the name of a template within the app.

  • Upload Upload new version: Update the template with a new version, in .qhtml format. There are requirements for the app objects in the template. The action is blocked if the new template version is not compatible with the current app.

  • Trash can Delete: Delete the template.

    Information noteDeleted templates cannot be recovered.

  • Report On-demand: Change the on-demand reporting settings for the template. See: Configuring on-demand reporting

For more information about template management in the app, see Managing report templates.

Permissions

Working with HTML templates includes:

  • Viewing templates

  • Creating, editing, and deleting templates

  • Uploading and downloading templates

  • Configuring on-demand reporting for the templates

To work with HTML templates, you need:

Space permissions

To perform the above actions with HTML templates in an app located in a shared space, you need one of the following space roles in the space:

  • Owner (of space)

  • Can manage

  • Can edit data in applications

  • Can edit

To perform the above actions with HTML templates in an app located in a managed space, you need one of the following space roles in the space:

  • Owner (of space)

  • Can manage

  • Can operate (Professional or Full User entitlement only)

If you are working with an app in your personal space, you need the Private Analytics Content Creator security role in the tenant to perform these actions.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here