Outlook Hub

SmartHub Outlook Hub enables SmartHub search integration across desktop and web Outlook platforms.

How to Set Up Outlook Hub

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

  4. 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.

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

When upgrading from an older version to SmartHub 5.6.6 or later, you must reinstall the Outlook Hub integration.

How to Install Outlook Hub (Organization)

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 (Settings > Integrated apps) as an Administrator: https://admin.microsoft.com/AdminPortal/Home?#/Settings/IntegratedApps


  2. Click Upload custom apps.
  3. On the Upload apps to deploy page, specify the following:
    1. App type: Select Office Add-in from the drop-down list.
    2. Choose how to upload app: 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, specify the following:
    1. In the SmartHub - Enterprise search section, enable or disable the Is this a test deployment? toggle according to your installation mode.
    2. In the Assign users section, specify the users that you want to have access to SmartHub.

  6. Click Next.
  7. Review the Deployment section.
  8. Click Finish deployment.
  9. The SmartHub Outlook Hub is now available to your specified users.
    It can take up to six hours for the app to appear in Outlook.

How Users Enable Hub in Outlook

  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 add-in and click Add.

    You can also enable the SmartHub app by default from the Exchange admin center.

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 delivered with the SmartHub package.
  5. Install the add-in.

How to access SmartHub within Outlook

  1. In Outlook, click on an available message.

  2. From the actions panel, click on the Apps button.

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

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