Getting started with using the Qlik add-in for Microsoft Excel

This topic helps you get familiar with some basic information about the Qlik add-in for Microsoft Excel, such as activating it, opening it, and connecting to Qlik Sense content. For information about adding content to your template, see Using the Qlik add-in for Microsoft Excel and related topics.

The add-in must be installed before you can start working with it. For information, see Deploying and installing the Qlik add-in for Microsoft Excel.

Requirements for using the add-in

To use the add-in to generate a report template for a Qlik Sense app in a shared space, you must have Can view permissions in that space.

To use the add-in to generate a report template for a Qlik Sense app in a managed space, you must have, at minimum, Has restricted view permissions in that space.

If you are working with a web version of Microsoft Excel for Microsoft 365, you need to allow pop-ups in your browser settings. However, keep the navigation history and cookies stored. Otherwise, you will need to install the add-in again every time you open Excel.

Activating the add-in

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

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

Do the following:

1. Open the desktop or web version of Excel.

2. Go to Home > Add-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 Microsoft 365 programs

Opening the add-in

To open the add-in, click the Qlik icon in the ribbon bar under the Home tab.

Connecting to the tenant and logging in

When you open the add-in, you are prompted to connect to the Qlik Cloud tenant that the add-in was installed for. Remember that a single add-in installation configures the add-in for one specific tenant. Click Connect.

An OAuth client configuration is required to install the add-in.

You are asked to log in the first time you connect, or if the connection is closed on the server side. When using a web version of Excel, you might be required to log in again at some later point if you do not keep navigation history and cookies stored.

Do the following:

1. When prompted to log in, follow the login procedure for your Qlik account, using your tenant's identity provider configuration as applicable.

2. In the app authorization dialog, authorize the app with the OAuth client by clicking Approve. You only have to do this after your first login to the tenant.

Selecting the Qlik Sense app for the template

After you log in, you must select the Qlik Sense space and app you want to use as source for the template you are creating. A report template uses a single app. You will only be able to add objects from one Qlik Sense app to each Excel template file.

Do the following:

1. Under Space, select the Qlik Cloud Analytics space.

2. Under App, select the Qlik Sense app from the space.

3. Click Save.

After the app has been loaded and its metadata is populated into the file, you can click to open the source app in Qlik Cloud.

After the template is connected to a source app, you can return to the tab in the add-in to change the app. For more information, see Changing the connected Qlik Sense app.

Availability of sheets in the app

When you log into the Qlik add-in for Microsoft Excel, you will only see content you have access to in the source Qlik Sense app. For example, for an app in your personal space, you can access all content. For an app in a shared space, you can only see and use content which is public in the app or private to you. Content from another user's private sheet in a shared space app cannot be seen or used.

Previewing the report

When developing a template, you will likely need to check that the output it will create is what you want. Preview the report to see what it will look like without configuring report tasks and emailing them to yourself.

To preview your report, click on the icon in the top right toolbar of the add-in. You have the following options:

• Preview as Excel (.xlsx)

• Preview as PDF

Depending on your browser configuration, your report will either appear in a browser window, or download to your computer. If you do not see a report, verify that you have allowed pop-ups in your browser.

Open the generated file to check the results.

Preparing for PDF and printed output

If your report will be generated in PDF format or printed, you might need to adjust the print settings in your template. Use the native features in Microsoft Excel to prepare the template. These settings will likely be found under Page Layout.

Some of these page setup configurations might include:

• Paper size

• Page orientation

• Selected print area

• Page breaks

The navigation experience for configuring print area and page setup will depend on your version of Excel, operating system, and possibly your web browser. For details about these Excel features, refer to the Microsoft Excel documentation for your specific environment.

Opening the source object in Qlik Sense

If you want to see the source object in Qlik Sense, select the item in the Excel workbook. Next, under Source app in the add-in, click .

If the source object is a chart, you are brought to the Qlik Sense app to view the corresponding sheet. You might need to log in to Qlik Cloud again for the app to open.

Saving your work

Save the Excel workbook as you normally would. You can re-open the .xlsx file as usual and you will see your template.

Finding the add-in version and connected server address

You can find the add-in version and the Qlik Cloud tenant (server) address.

Do the following:

1. In the add-in window, click the tab in the toolbar.

2. Next to Source app, click .

3. Click About.

4. View the tenant URL and Office Add-in version, as well as the Qlik Sense app's space and name.

Synchronizing the add-in with the Qlik Cloud tenant

If there are changes in the connected Qlik Cloud tenant, the Excel document that uses the add-in is not updated automatically. For example, you might need to refresh:

• The list of available spaces you can work with.

• The list of available apps you can work with.

• The list of available entities in the selected Qlik Sense app.

• The chart images you have used in the template. For example, if you have made selections in the source Qlik Sense app, you might want your chart images to reflect the selections in the image placeholders.

• The status of images and tables you have used in the template (for example, because they were deleted or their titles have changed).

Follow the steps below to refresh the connection metadata.

Do the following:

1. In the add-in window, click the tab in the toolbar.

2. Next to Source app, click .

3. Click Refresh all images.

This applies a global refresh. You can also perform refreshes of some individual entities and objects in the other tabs in the add-in. The icon is present when these are available.

The data and objects in a template will not update when the Qlik Sense app is edited, unless a refresh is applied.

Sharing Excel report template files

Template files only contain table tags and preview images. If another user wants to edit and preview the template, they must have:

• The Qlik add-in installed in their version of Microsoft Excel.

• Access to the Qlik Cloud tenant.

• If the app is in a shared space: Can view or higher space role in the space, or to the app (so they can connect to the app in the add-in, and access its data).

• If the app is in a managed space: Has restricted view or higher space role in the space, or to the app (so they can connect to the app in the add-in, and access its data).

However, a report template is a normal Excel workbook that contains the data available when the preview was created. You can share the template file with anyone, but only users with access to the source app will be able to connect to it in the add-in and apply refreshes. For more information about global refreshes, see Synchronizing the add-in with the Qlik Cloud tenant.

Searching for Qlik Sense objects in the add-in

You can find a specific Qlik Sense object by expanding and scrolling the list that appears on the right after clicking on the add button or you can insert a string in the search form. After pressing Enter, it will search for the string in the following fields of the inserted Qlik Sense app:

• Object ID

• Object name (Sheets included)

• Type of chart

To find the correct object quickly, it is important to use correct naming conventions while developing Qlik Sense apps.

Accessing error messages

There are native error messages in the Excel add-in. To assist in error reporting when contacting Qlik, check the error messages in your browser’s developer tools, in the JavaScript console and Network tabs.

Best practices for effective object naming in Qlik Sense app development

When it comes to naming objects in Qlik Sense apps, it is important to follow certain best practices to ensure clarity, consistency, and maintainability. Object names are the chart and table tags that appear in your report template. Here are some recommendations for naming objects like tables, charts, and other elements in Qlik Sense:

• Use a unique name for each object. Avoid duplications that could generate confusion and cause you to add the wrong object.

• Use clear and descriptive names. Choose names that accurately reflect the purpose and content of the object. Avoid ambiguous or generic names that may confuse users.

• Be concise but informative. Keep the names concise while providing enough information to convey the object's function or data. Long and convoluted names can be cumbersome to work with.

• Use consistent naming conventions. Establish and follow a consistent naming convention across all objects in your app. This helps maintain a logical structure and makes it easier to search, identify, and manage objects.

• Avoid using special characters. Stick to alphanumeric characters and underscores in object names. Special characters can cause issues in scripting or expressions.

• Use camel case or underscores instead of spaces: Choose either camel case (myTable) or underscores (my_table) to separate words in object names. This improves readability and makes the names more understandable.

• Avoid using reserved keywords. Qlik Sense has reserved keywords that should not be used as object names. These keywords are used in expressions, scripts, or the Qlik Sense environment. Examples include "if," "and," "or," "load", and so on.

• Use meaningful and intuitive names for dimensions and measures. When creating dimensions and measures within charts, use names that clearly describe the underlying data or calculations they represent. This enhances understanding and collaboration among developers and end-users.

• Document naming conventions. Maintain documentation that outlines the naming conventions used in your Qlik Sense apps. This helps new developers understand the naming conventions and ensures consistency when multiple developers are working on the same app.

• Regularly review and update object names. As your app evolves or requirements change, periodically review and update the object names to ensure they align with the current structure and functionality of the app.