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.
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 Cloudtenant.
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:
Requirement 1: Meet system and software requirements
Qlik Cloud Government note
Qlik add-ins for Microsoft Office are supported for developing report templates against applications in Qlik Cloud Government or Qlik Cloud Government - DoD tenants.
To install and use Qlik add-ins, users must meet the following requirements.
Qlik add-in for Microsoft Excel
For Windows installations:
Windows 10 v.1903 or higher
Microsoft 365 v.16.0.11629 or higher
For macOS installations:
macOS v.14 or higher
Microsoft 365 v.16.83 or higher
Also, to run the Qlik add-in for Microsoft Excel, you must have a Microsoft Excel installation with ExcelAPI 1.9 or newer. To check if your Excel installation is compliant, refer to the official Microsoft documentation at Excel JavaScript API requirement sets.
If your ExcelAPI is lower than the minimum required version, an error is shown indicating that the Qlik add-in requires a newer version of Microsoft Excel.
Example of an error message during installation of the add-in
You may need to click on the white area on the right in Microsoft Excel and press F5 to update the page to see the error.
If you see this error, upgrade your Microsoft Excel installation.
Qlik add-in for Microsoft PowerPoint
For Windows installations:
Windows 10 v.1903 or higher
Microsoft 365 version 2504 (build 18730.20030) or higher
For macOS installations:
macOS v.14 or higher
Microsoft 365 v.16.96 or higher
Qlik add-in for Microsoft Word
For Windows installations:
Windows 10 v.1903 or higher
Microsoft 365 version 2208 (build 15601.20148) or higher
For macOS installations:
macOS v.14 or higher
Microsoft 365 v.16.64 or higher
Requirement 2: Create an OAuth client
An OAuth client configuration is required to install Qlik add-ins for Microsoft Office. Add-ins are used by report developers to prepare report templates for in-application reporting with Qlik Cloud.
For OAuth to work in the add-ins, the OAuth client needs to be configured with the exact configuration shown below.
Do the following:
In Qlik Cloud, click in the top left corner.
Select Administration.
Go to OAuth.
Click Create new.
In the Client type dropdown menu, select Single-page app. More fields will appear.
Insert a Name. The Description is optional.
At minimum, select the checkbox to include the user_default scope. You can include other scopes in the configuration, but without user_default, installation will not work.
In the Add redirect URLs field, insert the URL of the Qlik Cloud tenant, followed by this fixed string: /office-add-ins/oAuthLoginSuccess.html
The result should look like this: https://<tenant or alias hostname>.<region>.qlikcloud.com/office-add-ins/oAuthLoginSuccess.html. For example: http://example-company-123.us.qlikcloud.com/office-add-ins/oAuthLoginSuccess.html
Click Add.
In the Add allowed origins field, insert your tenant URL and click Add.
Click Create.
The Copy your Client ID window appears. You can choose to copy the Client ID to clipboard, or click Done to close the window.
After creating the OAuth client, get the updated manifest XML link from the Administration activity center. Go to the Settings page and select the Email and reports tab. In the Sharing and reports section, select Qlik add-ins for Microsoft Office. Use the provided link to deploy and install the add-in.
Requirement 3: Prepare and obtain the add-in manifest
You install Qlik add-ins for Microsoft Office in the Microsoft environment using a manifest XML file, or a link to it.
For centralized deployment, the manifest often needs to be provided in the form of a URL.
For self-managed installations, the manifest is often provided in the form of a file.
A manifest file is specific to a single Qlik Cloudtenant. You use the same manifest file to install the add-ins for Excel, PowerPoint, and Word.
An OAuth client configuration is required to install the add-in. After you have configured the OAuth client, obtain the manifest file link, as well as the manifest file itself, from the Administration activity center.
Do the following:
Create the OAuth client in the Qlik Cloud tenant using the required configuration. For full instructions, see Create an OAuth client.
In Qlik Cloud, click in the top left corner.
Select Administration.
Go to Settings.
In the Sharing and reports section, go to Qlik add-ins for Microsoft Office.
In the drop down menu, select the OAuth client configuration you have set up for activating OAuth in the add-in.
Click Download to download the manifest, or Copy to copy the link to it.
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.
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.
Do the following:
Open a desktop or web version of Excel, PowerPoint, or Word.
Go to Home > Add-ins > Get Add-ins.
In the ADMIN MANAGED tab of the dialog, select the Qlik 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
To sideload an add-in using Excel, PowerPoint, or Word on the web, the user uploads the manifest file to their browser.
Sideloading is supported by Microsoft 365 web versions of Excel, PowerPoint, or Word.
Use this workflow when:
You need to access the add-in quickly.
You want to test add-in functionality in isolation.
You want to test the add-in without requiring intervention from a Microsoft 365 administrator.
In the Office Add-ins dialog, click Upload My Add-in.
Browse to the add-in manifest file, and then select Upload.
If required, sign into your Qlik Cloud account.
Removing a sideloaded add-in
To remove a sideloaded add-in, clear the cache of the web browser with which you are using the add-in.
Workflow 3: Install an add-in on desktop Microsoft Office applications using a Windows network share
To install add-ins on a desktop version of Excel, PowerPoint, or Word without centralized deployment, you can set up a network share and load the manifest into it. This can only be done on a Windows operating system.
Follow the guidelines below to sideload add-ins via network share. The instructions are adapted from the official Microsoft documentation. See Sideload Office Add-ins for testing from a network share or other Microsoft resources for more information.
Step 1: Create and share a folder
Do the following:
Create a folder to host the Qlik add-in. For example: C:\Qlik Office add-ins
In the Windows File Explorer, go to the parent folder, or drive letter, of the folder you want to use as your shared folder catalog. For example: C:\
Right-click the folder and select Properties.
Open the Sharing tab and then click the Share... button.
Share... button
In the dialog window, add yourself and any other users and/or groups with whom you want to share your add-in. You will need at least Read/Write permission to the folder. After you have finished choosing people to share with, click Share.
When you see confirmation that your folder has been shared, make note of the full network path that is displayed immediately following the folder name. Click Done to close the dialog window.
Confirmation of successfully shared folder with full network path
Click Close to close the Properties dialog window.
Step 2: Manually configure the shared folder as a trusted catalog
Do the following:
Open a new blank workbook in the desktop version of Excel, PowerPoint, or Word.
Click the File tab, and then click Options in the bottom left corner.
Click Trust Center, and then click the Trust Center Settings... button.
Trust Center Settings... button
Click Trusted Add-in Catalogs.
Trusted Add-in Catalogs tab
In the Catalog Url box, enter the full network path to the folder that you shared previously.
Click Add catalog.
Check the Show in Menu checkbox for the newly added item, and then click OK to close the Trust Center dialog window.
Trusted Add-in Catalogs tab in Trust Center dialog, with newly added catalog path
Click OK to close the dialog window.
Close and re-open the application so your changes take effect.
Step 3: Sideload the add-in
Do the following:
Add the add-in manifest XML file to the shared folder.
In ExcelPowerPoint, or Word, click Add-ins on the Home tab of the ribbon.
Click More Add-ins.
Click SHARED FOLDER at the top of the Office Add-ins dialog box.
Select Qlik to insert the add-in.
You might see a dialog window that says something like the following: Qlik wants to display a new window. Click Allow.
Removing an add-in installed through network share
Do the following:
If you have Excel, PowerPoint, or Word open, close it.
Delete the contents of this folder: %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\
Workflow 4: Sideload an add-in on desktop macOS applications
For macOS, add-ins can be installed on Microsoft 365 desktop versions of Excel, PowerPoint, or Word. For the system and software requirements, see System and software requirements.
Follow the guidelines below. The instructions are adapted from the official Microsoft documentation. For full instructions, refer to the official Microsoft documentation: Sideload an add-in in Office on Mac
Do the following:
Open the Finder application on your computer.
Enter the following keyboard combination: Command+Shift+G
The Go to folder menu opens.
Enter one of the following paths depending on the Microsoft Office application:
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 Cloudtenant.
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.
When a user tries to authenticate to a reporting add-in for Microsoft Excel, Microsoft PowerPoint, or Microsoft Word, their authentication pop-up dialog might be blank. Alternatively, the user could instead see an error in the dialog (particularly, 12006).
For a user to work with a Qlik add-in for Microsoft Office, the authentication flow requires a redirect between your tenant and the identity provider hosted in a different domain. Your identity provider is setting a Cross-Origin-Opener-Policy with restrictive settings. As a result, the cross-domain communication part of the authentication flow is blocked, preventing login information to be correctly returned to the add-in.
Proposed action
The following resolution should be performed by a network administrator who is responsible for setting up identity providers.
Do the following:
Set the response header from your IDP to your dialog to:
You might see the following error message when you first open the Qlik add-in for Microsoft Office after activating it:
The security settings in your browser prevent us from creating a dialog box.
Possible cause
Your web browser is blocking the add-in authentication dialog from opening as a pop-up.
Proposed action
If you are using a web version of the Microsoft Office application, you need to allow the browser to open pop-ups. This depends on your browser and version, but possible solutions include:
Selecting an option in the web address bar to allow the pop-ups.
Opening the browser settings and selecting the option to allow pop-ups.
A file outlining the structure, content, and data that is included in generated reports. With in-application reporting, you can create templates using Qlik add-ins for Microsoft Office, the embedded PixelPerfect designer, or the embedded HTML designer.
A task created in a Qlik Sense application that converts one or more report templates into report output, applying data reduction as defined by the selected report filters. The report output is delivered according to the configured distribution settings.
Similar terms: Distribution list, report template, report filter
A file outlining the structure, content, and data that is included in generated reports. With in-application reporting, you can create templates using Qlik add-ins for Microsoft Office, the embedded PixelPerfect designer, or the embedded HTML designer.