Install Outlook Hub

How to Set Up Outlook Hub

  1. Navigate to the SmartHub root directory.
  2. Open the file web.config.

  3. Remove the X-Frame-Options and Content-Security-Policy headers.


  4. Navigate to the SmartHub directory<SmartHub_Installation_Root>\integrations\office\
  5. Edit the configuration file: BAInsight.OfficeAddIn.OutlookManifest.xml.
  6. Replace all occurrences of the URL https://smarthub.contoso.com with your SmartHub instance address.

  7. Go to line 145 and modify the parameter SmartHubAddressEncoded with your index page of your SmartHub.

    Example:
    Copy 
     <bt:Url id="functionFile" DefaultValue="https://smarthub.contoso.com/integrations/office/Functions/FunctionFile.html?SmartHubAddressEncoded=https%3A%2F%2Fsmarthub.contoso.com%2Findex.html%23pn%3Doffice" />

    • The decoded default value is https://smarthub.contoso.com/integrations/office/Functions/FunctionFile.html?SmartHubAddressEncoded=https://smarthub.contoso.com/index.html#pn=office .

  8. Go to line 146 and modify the parameter redirectUri with your results page of your SmartHub.

    Example:
    Copy 
     <bt:Url id="outlookEnterpriseSearch" DefaultValue="https://smarthub.contoso.com/integrations/office/Login.html?redirectUri=https%3A%2F%2Fsmarthub.contoso.com%2FResults.html%23pn%3Doffice" />
  9. Navigate to the SmartHub directory: <SmartHub_Installation_Root>\integrations\office\officeCustomSettings.js.
  10. Search for SH.AuthDialog.CustomSettings and replace the occurrence of the URL https://smarthub.contoso.com with the SmartHub address:
    Copy
    SH.AuthDialog.CustomSettings = {
        Action: "return window.location = 'https://smarthub.contoso.com/integrations/office/Login.html?redirectUri=https%3A%2F%2Fsmarthub.contoso.com%2FResults.html%23pn%3Doffice'",
    };

URLs can be encoded by opening Console and applying encodeURIComponent function to desired URL.

How to Install Outlook Hub (Organization)

Note: The Hub can be deployed personally by each user or the Exchange Administrator can deploy the Hub to make it available at the company level. You must have access to the Admin Portal home page: https://admin.microsoft.com/AdminPortal/Home#/homepage

The following steps describe how to install the Outlook Hub at an organizational level:

  1. Access the Integrated apps page as an Administrator: https://admin.microsoft.com/AdminPortal/Home?#/Settings/IntegratedApps


  2. Click the Upload custom apps.
  3. On the Upload apps to deploy page, do the following:
    1. In the App type field, select Office Add-in from the drop-down list.
    2. In the Choose how to upload app field, select Upload manifest file (.xml) from device.
    3. Click Choose File and select the .manifest file that was delivered with the SmartHub package.
  4. Click Next.
  5. On the Add users page, do the following:
    1. In the Is this a test deployment? field, use the toggle to select yes or no.
    2. In the Assign users section, specify the users who will have access to SmartHub. The possible values are:
      • Just me
      • Entire Organization
      • Specific users/groups


  6. Click Next.
  7. Review the Deployment section.
  8. Click Finish deployment.
  9. SmartHub is now available to the users you assigned it to.

How Users Enable Hub in Outlook

Users can enable SmartHub in their Outlook instances by using the following steps:

  1. Navigate to https://aka.ms/olksideload to open the Add-Ins for Outlook dialog.
  2. Click Admin-managed.
  3. Locate the SmartHub - Enterprise search app, and click Add.

How to Install Outlook Hub (Independent)

Use the following steps to install Outlook Hub:

  1. Navigate to https://aka.ms/olksideload to open the Add-Ins for Outlook dialog.
  2. Click My add-ins.
  3. In the Custom Addins section, click Add a custom add-in > Add from file.
  4. When prompted to provide the manifest file, load the SmartHub Outlook manifest file that was provided in the SmartHub package.
  5. Install the add-in

How to access SmartHub within Outlook

  1. Click on one of your available mails.

  2. From the actions panel, click on the Apps or More actions button > Apps.

  3. On the newly opened modal window, click on the SmartHub - Enterprise search app.

  4. Select the SmartHub action that you want to perform.