Deploying and installing Qlik add-ins for Microsoft Office | Qlik Cloud Help
Skip to main content Skip to complementary content

Deploying and installing Qlik add-ins for Microsoft Office

Deploy and install Qlik add-ins for Microsoft Office to allow users in your organization to create report templates. Upload report templates created with the add-ins into the Qlik Cloud application to generate report output from report tasks.

video thumbnail

Qlik add-ins for Microsoft Office can be deployed and installed for compatible web and desktop versions of Excel, PowerPoint, and Word within Microsoft 365.

Add-ins are installed using a manifest file. This manifest file is required for the Microsoft 365 administrator (or possibly a user, in certain installation methods) to deploy and install add-ins for themselves or users in their organization. A manifest file allows installation of add-ins for a single Qlik Cloud tenant.

Information noteAn OAuth client configuration is required to generate a manifest file and link. For instructions, see Prepare and obtain the add-in manifest.

What are Qlik add-ins for Microsoft Office?

Qlik add-ins for Microsoft Office are:

  • Qlik add-in for Microsoft Excel

  • Qlik add-in for Microsoft PowerPoint

  • Qlik add-in for Microsoft Word

Functionality is similar across the add-ins. In the add-in window, you can add application content in the form of tables, images, variables, and expressions. After adding content using the add-ins, you have several options for formatting and styling it using the default Microsoft Office functionality.

Choose an installation workflow

After you obtain the manifest file or URL, choose the workflow that matches how you want to deploy the add-in:

Workflow 1 is the recommended option for production deployments. Workflows 2 through 4 are best for testing, trial use, or isolated user setups.

Qlik add-in button shown in a web version of Microsoft Excel

Ribbon bar in Microsoft Excel showing the Qlik add-in icon to indicate the add-in has been activated

For more information, see Designing report templates with Qlik add-ins for Microsoft Office.

Before you start

These steps apply to all installation workflows.

Requirement 1: Meet system and software requirements

Requirement 2: Create an OAuth client

Requirement 3: Prepare and obtain the add-in manifest

Workflow 1: Centralized deployment

It is recommended that Qlik add-ins for Microsoft Office are made available with centralized deployment and installation. Centralized deployment requires action from a Microsoft 365 administrator in your organization.

With centralized deployment, the add-in manifest is loaded into your organization’s Microsoft 365 admin center and distributed to users as a pre-configured installation. Distribution can be restricted to members of specific security groups.

Information noteWith centralized deployment, add-ins are installed for Excel, PowerPoint, and Word. There is no option to install add-ins individually.

Use this workflow when:

  • You want the add-ins to be permanently installed for members of your organization

  • You want to manage distribution to your organization members

Warning noteDeployment of Qlik add-ins for Microsoft Office is not tied to access to the Qlik Cloud tenant. If you distribute add-ins to users who do not have access to Qlik Cloud, they will be able to view and start the add-ins. However, the add-ins will prompt the user to log into Qlik Cloud. Functionality will be blocked if login is not successful.

Complete the following sections in order.

Deploy and install with the Microsoft 365 admin center

Centralized deployment is completed by a Microsoft 365 system administrator.

  1. Obtain the add-in manifest file or manifest URL after creating an OAuth client. See Prepare and obtain the add-in manifest.

  2. Distribute the add-in according to the official Microsoft documentation: Deploy and publish Office Add-ins. Note that distribution through centralized deployment is only possible by using the Microsoft 365 admin center.

With the above procedure, the add-ins are installed for users who are given access to them. Users then activate add-ins in their version of Excel, PowerPoint, or Word.

Activate an add-in after centralized deployment

After a Microsoft administrator has installed a Qlik add-in for your organization, you can activate and use it if you have been given access to it.

Depending on the version of your Microsoft Office application, these steps might be slightly different. Refer to the official Microsoft documentation for full details.

  1. Open a desktop or web version of Excel, PowerPoint, or Word.

  2. Go to HomeAdd-ins > Get Add-ins.

  3. In the ADMIN MANAGED tab of the dialog, select the Qlik add-in.

The Qlik add-in icon is added to your ribbon bar.

View, manage, and install add-ins for Excel, PowerPoint, and Word

Remove an add-in

If your installation uses a centralized deployment, you might not be able to uninstall the add-in. This depends on the policy used by your Microsoft 365 administrator.

Workflows 2-4: Self-managed installation options

Sideloading and network share installation are suitable ways to quickly obtain access to add-ins for testing or trial purposes. They are not suitable methods for deploying add-ins for production and enterprise-scale use cases.

Warning noteTo self-install add-ins using sideloading or network share, you may need permissions from your organization and on your local machine. These permissions may be managed by your organization or Microsoft 365 administrator. If you are unable to self-install an add-in, consult the official Microsoft documentation for Office add-ins, or contact your system administrator.
Warning noteDownloading the manifest and sideloading add-ins is possible without restrictions. It is possible to install the manifest even if you do not have access to Qlik Cloud. However, you are immediately prompted to log into Qlik Cloud after installation. Add-ins will not work if you are not logged in.
Qlik Cloud Government note

In Office 365 Government Community Cloud High (GCCH), Qlik add-ins for Microsoft Office can only be installed via centralized deployment. Installing via sideloading or network share is not supported.

Depending on your version of Excel, PowerPoint, or Word, as well as other factors, add-ins loaded with these methods might eventually be removed from your ribbon bar. When this happens, re-upload the manifest into the Microsoft Office application.

Workflow 2: Sideload an add-in on the web

Workflow 3: Install an add-in on desktop Microsoft Office applications using a Windows network share

Workflow 4: Sideload an add-in on desktop macOS applications

Adding multiple Qlik add-ins to Excel, PowerPoint, or Word

Each added Qlik add-in allows use of the add-in for a single Qlik Cloud tenant.

Behavior and limitations are as follows:

  • In your Excel, PowerPoint, or Word application, only one add-in (connected to a single Qlik Cloud tenant) is supported for use at a single time.

  • If you need to work with add-ins for multiple Qlik Cloud tenants, you must switch between tenants by deploying or installing the add-in you want to use directly before you start to use it. If your add-in is still connecting to the previously selected tenant, restart your Office application or reload the browser page.

  • Having a Qlik add-in centrally deployed for one Qlik Cloud tenant may prevent your ability to sideload the add-in for different tenants.

  • Depending on your version of Microsoft Excel, PowerPoint, or Word, and the browser in use, when multiple add-ins are loaded, the ribbon bar might show icons for each of them, or only one icon holding the latest deployed instance. The former can happen, for example, when using older versions of Microsoft Excel, PowerPoint, or Word.

  • In Office 365 Government Community Cloud High (GCCH), Qlik add-ins for Microsoft Office can only be installed via centralized deployment. Installing via sideloading or network share is not supported. Office 365 GCC and GCCH support working with a single Qlik Cloud Government or Qlik Cloud Government - DoD tenant at a time.

Troubleshooting

This section provides tips for resolving common deployment and installation issues.

For additional troubleshooting tips, see Troubleshooting - In-application reporting.

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!