Pre-configuring the Outlook add-in


With the Zoom Outlook add-in, administrators can deploy the add-in with the single sign-on (SSO) URL preconfigured. With the URL preconfigured, users will automatically use SSO to authenticate when they interact with the add-in, such as click the Add a Zoom Meeting or Settings options in the add-in.

Note: When using custom manifest files, the add-in will not receive automatic updates. Thus, whatever version is downloaded and installed, will continue using that version until it is manually updated. Admins should pay close attention to Outlook add-in release notes for important new features and bug fixes, and deploy the latest when needed. 

This article covers:

Prerequisites for managing SSO domains for the Outlook add-in

How to configure the manifest file

  1. Download the manifest file for the Outlook add-in. 
  2. Open the manifest file in a text editor.
  3. Replace the current value in <Id>%value%</Id> with c7740fe1-f1ea-4869-9bec-fc827930b38f.
    For example if your manifest file lists the ID as <Id>a7ca6c74-33fb-43a4-a3e4-781078f0eff5</Id>, change the line to <Id>c7740fe1-f1ea-4869-9bec-fc827930b38f</Id>.
  4. Find the following lines in the Manifest (they will appear two times):
    <bt:Url id="messageReadTaskPaneUrl" DefaultValue="https://zoom.us/office365/schedule"/>
    <bt:Url id="functionFile" DefaultValue="https://zoom.us/office365/addzoom"/>
    <bt:Url id="phoneTaskpaneReadUrl" DefaultValue="https://zoom.us/office365/phoneread"/>
  5. Replace those lines with above, with the following lines respectively:
    <bt:Url id="messageReadTaskPaneUrl" DefaultValue="https://zoom.us/office365/schedule?login=sso&amp;domain=%ssodomain%"/>
    <bt:Url id="functionFile" DefaultValue="https://zoom.us/office365/addzoom?login=sso&amp;domain=%ssodomain%"/>
    <bt:Url id="phoneTaskpaneReadUrl" DefaultValue="https://zoom.us/office365/phoneread?login=sso&amp;domain=%ssodomain%"/>
  6. Modify the newly added lines by replacing "%ssodomain%" with your domain. For example, if your Vanity URL is mycompany.zoom.us, replace "%ssodomain%" with "mycompany".
  7. Save the file. 

Adding Send auto-sync option to the Outlook add-in

When deploying the manifest package provided here, the Send auto-sync option is not enabled by default. To include this option for your users, follow the steps outlined below to add Send auto-sync to the manifest:

  1. Open the modified manifest file created in the previous section.
  2. Locate the second instance of <Host xsi:type="MailHost"> within the file.
  3. Insert the following lines just after this instance:
    <Runtimes>
  <Runtime resid="WebViewRuntimeUrl">
        <Override type="javascript" resid="JSRuntimeUrl"/>
      </Runtime>
    </Runtimes>
  4. Find the second instances of </ExtensionPoint> and insert the following lines just after this instance:
    <ExtensionPoint xsi:type="LaunchEvent">
      <LaunchEvents>
        <LaunchEvent Type="OnAppointmentSend" FunctionName="OnAppointmentSendFunc" SendMode="PromptUser"/>
        <LaunchEvent Type="OnAppointmentOrganizer" FunctionName="OnAppointmentOrganizerFunc"/>
      </LaunchEvents>
      <SourceLocation resid="WebViewRuntimeUrl"/>
    </ExtensionPoint>
  5. Save the file.

Adding Zoom Phone option to the Outlook add-in

If deploying the manifest package provided here, the Zoom Phone option is not provided by default, even if you do have Zoom Phone for your account. To add this option for your users, refer to the following steps on how to add Zoom Phone to the manifest:

  1. Open your modified manifest file created in the section above. 
  2. Find the 2 instances of <ExtensionPoint xsi:type="AppointmentOrganizerCommandSurface"> and insert the following lines just before each instance:
    <ExtensionPoint xsi:type="MessageReadCommandSurface">
    <OfficeTab id="TabDefault">
    <Group id="msgReadTabMessage.grp1">
    <Label resid="groupLabel" />
    <Control xsi:type="Button" id="phoneRead">
    <Label resid="phoneReadButtonLabel" />
    <Supertip>
    <Title resid="phoneReadButtonLabel" />
    <Description resid="phoneReadButtonLabelLong" />
    </Supertip>
    <Icon>
    <bt:Image size="16" resid="zoom16" />
    <bt:Image size="32" resid="zoom32" />
    <bt:Image size="80" resid="zoom80" />
    </Icon>
    <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="phoneTaskpaneReadUrl" />
    </Action>
    </Control>
    </Group>
    </OfficeTab>
    </ExtensionPoint>
  3. Save the file.

Adding Workspace Reservation option to the Outlook add-in

If deploying the manifest package provided here, the Workspace Reservation option is not provided by default, even if you do have Workspace Reservation for your account. This is exclusively available for users with a Workspace license.To add this option for your users, refer to the following steps on how to add Workspace Reservation to the manifest:

  1. Open your modified manifest file created in the section above.
  2. Find the 2 instances of <Control xsi:type="Button" id="addZoomButton">…</Control> and insert the following lines just after each instance:  
    <Control xsi:type="Button" id="roomListButton">
    <Label resid="roomListButtonLabel" />
    <Supertip>
    <Title resid="workspaceSuperTipTitle" />
    <Description resid="workspaceSuperTipDescription" />
    </Supertip>
    <Icon>
    <bt:Image size="16" resid="openworkspace16" />
    <bt:Image size="32" resid="openworkspace32" />
    <bt:Image size="80" resid="openworkspace80" />
    </Icon>
    <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="roomTaskpaneTaskPaneUrl" />
    </Action>
    </Control>
  3.  Save the file.

How to deploy the manifest file

  1. Log in to the Office 365 Admin Portal.
  2. Click Settings to expand that section and then click Services & add-ins.
  3. Click Deploy Add-in.
  4. Click Next.
  5. Click Upload custom apps.
  6. Click I have the manifest file (.xml) on this device.
  7. Click Choose File, and select the file manifest file. 
  8. Click Upload.
  9. Choose the user assignments and deployment method, then click Deploy. 
  10. Once the deployment is finalized, click Close. 

How to update the manifest file

If you are using a custom manifest file and need to update it, you will need to download the latest version of the manifest and update the configuration. Once that is complete, to update the add-in, follow these steps:

  1. Go the Services & add-ins section of your Office 365 admin center. 
  2. Click Zoom.
  3. Click Update add-in.
  4. Choose the location of the new manifest file.
  5. Click Update.