Skip to main content

Managing extensions

Extensions are managed in the Management Console on the Extensions page.

Note: Third-party extensions are supported in Qlik Sense Enterprise SaaS - Government (US). However, the use of third-party extensions might need to be defined and approved as part of an Agency Authority to Operate, depending on the security and compliance requirements your organization follows.

Extensions that contain resource requests to external resources must have its origins allowlisted in the Content Security Policy, else the extension will be blocked from rendering.

Tip: We recommend reviewing extensions and their code before uploading. See Visualization extensions for more information.

Extensions overview

In the Extensions page of the Management Console, the following properties are shown.

Extensions properties
Property Description

Name

This is the metadata name contained in the QEXT file, which is different from the QEXT filename.

Description

Short description of the extension.

Tags

Tags for filtering.

Author

Creator of the extension.

QEXT filename

Identifier that must be unique. Filename of the extension definition file. Different from the name of the extension.

QEXT version

Metadata version contained in the QEXT file.

Published

Date of publishing.

In the table, sort by using the arrows in the properties header. Filter by using the Tags drop-down menu, or by selecting the tags in the table.

Extensions with external resources

Extensions that contain resource requests to external resources must have its origins allowlisted in the Content Security Policy, else the extension will be blocked from rendering.

See also:Managing Content Security Policy

Unsupported file formats

Maximum size of a file within an extension folder is 15 MB.

Due to security, extensions are not allowed to contain files with disallowed MIME types. An upload will fail if your extension, for example, contains an executable file or a zip file. The following MIME types are disallowed:

  • 'application/octet-stream'
  • 'application/x-coredump'
  • 'application/x-dosexec'
  • 'application/x-executable'
  • 'application/x-java-applet'
  • 'application/x-object'
  • 'application/x-sharedlib'
  • 'application/zip'
  • 'text/x-shellscript'
  • 'text/x-awk'
  • 'text/x-gawk'
  • 'text/x-msdos-batch'
  • 'text/x-nawk'
  • 'text/x-php'
Note: All files in an extension must have a file name and a file extension. Files that are not complying to this will be ignored. Examples of ignored files: .gitignore and README.

Guidelines for creating and uploading extensions

Qlik Sense SaaS and Qlik Sense Enterprise Client-Managed use different extension services, consequently they have different capabilities. You should follow these guidelines when creating and uploading visualization extensions to Qlik Sense SaaS:

  • The size of the extension ZIP file should be less than 15 MB. This ensures extensions upload without timeout or issue.

  • Minify your code files.

  • Include in an extension ZIP file only the required files for your extension to function properly. The table shows the base files required for a visualization extension.

    File extension Description
    .qext Extension metadata file
    .js JavaScript code for the extension

    .html

    HTML code for rendering the extension
    .css

    Custom CSS for styling the extension

  • Do not upload image files. GIF, PNG, JPG, and other image files should be hosted externally, either on a personal application server, an S3 bucket, or a public content management system. They can be referenced from the extension code.

    Note: It is possible to reference some code files and content from your primary extension code. Referencing external content from an extension requires implementing content security policy on the tenant. See Managing Content Security Policy for more information.
  • The Qlik Sense SaaS extension service does not support bundled extensions (A ZIP file containing other extension ZIP files).

  • Do not upload extensions that include Qlik Sense QVF or QVD files because these files are not accessible from the extension service. Remove these files before uploading the extension.

  • To upload a QVF or QVD file to the Qlik Sense SaaS tenant, do one of the following:

    • Upload an app from the Cloud hub.

    • Upload an app using qlik-cli.

    • Upload a QVD from the Cloud hub.

    • Upload a QVD using Qlik DataTransfer.

Adding a new extension

Do the following:

  1. In the Management Console, go to the Extensions section and click Add in upper the right-hand corner.
  2. In the pop-up, click Browse to select an extension file, or drop a file in the designated area.

    Note: You cannot upload an extension with the same QEXT filename as an existing one.
  3. Optionally, add tags.

  4. Click Publish.

  5. If the extension you just uploaded contain external resources, you need to allowlist the origins in the Content Security Policy. See Managing Content Security Policy.

Editing an extension

You can edit one extension at a time.

Do the following:

  1. In the Management Console, go to the Extensions section and select the check box for the extension you want to edit.
  2. In the upper the right-hand corner, click Edit.

    The editing panel is displayed with options for replacing the existing extension and adding or removing tags.

  3. Make your edits and save.

Deleting an extension

Do the following:

  1. In the Management Console, go to the Extensions section and select the check boxes for the extensions you want to delete.
  2. In the upper the right-hand corner, click Delete.
Note: Deletion of extensions can affect all resources. All users within a tenant are affected by a deletion.