---
title: "Set up Outlook integration"
slug: "set-up-outlook-integration"
description: "Follow steps to set up Outlook integration with Zilliant CPQ."
updated: 2025-01-10T23:42:54Z
published: 2025-01-10T23:42:54Z
canonical: "docs.zilliant.com/set-up-outlook-integration"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zilliant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up Outlook integration

## Baseline configuration

### Application properties

To enable Outlook integration, set up the following parameters in the `application.properties` file:

- revenuegrid.url
- revenugrid.secret

For more information about the `application.properties` file, read [General property and ontology files](/v1/docs/general-property-and-ontology-files).

          Note

          

- Parameter values are provided by your Zilliant representative.
- You must restart your instance for changes to the `application.properties` file to take effect.

## Enable Groupware Sync tabs for Activities

In **Administration > Master Data Management > SettingBoolean > Enable Outlook Integration**, set the flag to **YES**. This setting enables the tabs you need to set up Outlook integration and enables you to personalize user settings in **Activities**.

## UI profile configuration

Zilliant recommends you allow only administrators to access the **Groupware Administration** tab. If a respective Outlook synchronization user does not exist for the currently logged in CRM user, selecting this link will create a new admin user. This link should be hidden behind a UI Profile that is assigned only to CRM administrators.

## Create a connected client

In **Administration > Connected Clients**, create a client with the ID **revenuegrid** with the following settings:

| Grant Types | Required for |
| --- | --- |
| authorization_code | SSO |
| password | User / password authorization |
| refresh_token | Application-to-application authorization |

To construct the redirect URL, append the RG tenant URL with the following string:

```
/ui/redirect.html
```

For example, if the tenant URL is `https://acmecorptest--0us4--0hana--0ondemand--0com.inmindcloud.com/`, then the full redirect URL is:

```
https://acmecorptest--0us4--0hana--0ondemand-0com.inmindcloud.com/ui/redirect.html
```

Upon saving or regenerating, the system will prompt to copy the secret. The secret is needed in the next step.

## Connect CRM and Outlook integration tenant

In the CRM, navigate to **Activities** > **Groupware**. Set up the client ID and client secret.

## Optional: Grant access to the mailbox in server-side integration

When a standard user tries to authenticate their Office 365 mailbox into a server-side integration, they may encounter an "Approval required" error.

The error occurs if the **User can consent to apps accessing company data on their behalf** setting (in **Azure Active Directory > Enterprise applications > User settings**) is set to **No**.

To resolve this error, use one of the following options.

- **Option 1: Grant consent for server-side integration**

          Note

          

If no users previously consented to the app, then the application may not appear in the list. In this case, use Option 2 to resolve the error.
  1. Sign on to Azure AD as an administrator.
  2. Navigate to **Enterprise Applications** and locate **IMC, server-side integration** in the list.
  1. Go to the **Permissions** tab and select **Grant Admin consent for [...]**.
  2. In the dialog that appears, sign in with the Office 365 admin account, then select **Accept**. A message appears that indicates successful sign-in. On the **Admin Consent** tab of the application page, a list of consented-to permissions appears.
- **Option 2: Office 365 administrator consent to the application during initial sign-in** To use this option, the Office 365 administrator must be a CPQ user and be provisioned as a server-side integration user.
  1. Sign on to CPQ as Office 365 administrator.
  2. Navigate to **Activities** > **My Sync Settings**, then select the gear icon for **MAIL SERVER CONNECTION STATUS**.
  3. In the Office 365 OAuth log-in dialog, sign in with your Office 365 administrator account.
  4. In the **Permissions Required** dialog, select the **Consent on behalf of your organization** checkbox, then select **Accept**. A **Signed in successfully** message appears.

The application will consent for the organization, and standard users will be able to successfully authenticate.

          Note

          

If the Office 365 administrator does not plan to use server-side integration, a reset mailbox procedure can be executed for the user on the **Groupware Settings** tab. Alternatively, the user can be de-provisioned from server-side integration.

### Related documentation

[Consent experience for applications in Microsoft Entra ID](https://docs.microsoft.com/en-us/azure/active-directory/develop/application-consent-experience)

## User provisioning

To use the add-in or server-side sync as an administrator, you must first provision users as follows:

1. Select the **Provisioning** tab to view the list of all employees.
2. To provision users, select **+** as shown in the following image:

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/MS%20Set%20Up%20User%20Provsioning%201.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

1. To confirm, select the **Provisioning** action as shown in the following image:

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/MS%20Set%20up%20provisioning%202.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

The user appears on the **User** tab. By default, sync is disabled and mailbox status is not initialized as shown in the following image.

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/Microsoft%20Set%20Up%20User%20Provisioning%203.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

When the user has been provisioned, the end-user can install the add-in manually. You can also perform mass provisioning of users by selecting the checkboxes and then by clicking the **Activate Selected** button.

If you want to centrally install the add-in and enable server-side sync use the following steps. The next step needs to be performed by the end user.

1. Sign in to the employee-facing application.
2. Go to **Activities > My Sync Settings** and click on the gear icon for **MAIL SERVER CONNECTION STATUS.**
3. Select Microsoft Office 365 as your e-mail service.
4. In the pop-up window, log in to your Microsoft Office 365 account and allow Zilliant CPQ to access your data. If you don't see the pop-up window, check to see if it is behind the main window in the background.

After a **signed in successfully** message appears and as you click on the dashboard, you will see a checkmark for mail server connection status.
5. Click **Force Sync** to start the initial synchronization. If synchronization is enabled successfully, during the next sync cycle the sync will occur. ## Installation Using Groupware Administration An admin user can also install, uninstall, and check the status of the add-in for users, as outlined in the following figure and table:

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/MS%20Setup%20Groupware%201.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

| Action | Meaning |
| --- | --- |
| Install Revenue Grid... | Allows an admin to install the add-in at the user's Inbox. |
| Check Add-In Status | Checks the add-in status |
| Remove Add-In | Removes the add-in from the user's inbox |

## Manually install the Outlook add-in

To manually install the add-in, follow these steps:

          Note

          

If your add-in was not automatically installed, you will receive an XML file from your IT organization or from Zilliant.

1. Save the XML file in your system.
2. Select **Manage Add-ins** under your Outlook settings as shown in the following image:

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/MS%20General%20Set%20Up%2012.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

1. Go to **Custom add-ins**and on **Add a custom add-in**.
2. Choose **Add from File**, select the XML file that you received from Zilliant and add it.  

This will perform the installation of Zilliant's add-in as part of your Outlook application.

If you have successfully installed the add-in, you will see the Zilliant icon in your Outlook toolbar. You will need to enter the proper URL of the CRM tenant such as the following example:

```
https://XXX.hana.ondemand.com/
```

## Manually uninstall the add-in

Follow these steps to uninstall the Outlook Add-in:

1. Select **Manage Add-ins** under your Outlook settings.
2. In the pop-up window, select **Remove** as shown in the following image:

![image](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/MS%20Add-In%20Uninstall.png?sv=2026-02-06&spr=https&st=2026-11-11T12%3A43%3A00Z&se=2026-11-11T13%3A43%3A00Z&sr=c&sp=r&sig=9D8zYbBSHy768OHbrcPR6cz9QzEv%2FVs1UHZ3dROBuCU%3D)

## Setup for Exchange 2013 and later versions

To enable integration, configure the following:

- **EWS URL** should be opened for connection from outside of their network (this is required for MailApp and synchronization functionality)
- **Metadata URL** should be exposed without password validation; this is required for MailApp functionality.

For additional troubleshooting information, read [Getting Internal Server Error 500 when creating New-CsPartnerApplication for Exchange 2013](https://learn.microsoft.com/en-us/archive/blogs/jenstr/getting-internal-server-error-500-when-creating-new-cspartnerapplication-for-exchange-2013).

Alternatively, admins can whitelist firewall IPs of resources that are used for MailApp and synchronization.