Configuring the Hyperfish Office 365 Connector

Justin Tung -

Note: Applies to Hyperfish Premium hybrid (on-premises AD) deployments only

The Hyperfish Office 365 connector provides connectivity options for Office 365 applications.

Primary uses include:

Photo Sync for Exchange Online and SharePoint Online - When users upload a profile photo to Hyperfish, the photo will be committed to Active Directory, resized to optimal resolutions, and uploaded to Exchange Online and SharePoint Online simultaneously. 

Using Office 365 Attributes in Hyperfish - Allowing end-users to update SharePoint Online (most Delve attributes) through the Hyperfish Profile page. 

Before you start, make sure you are using a supported version of the Hyperfish Agent (3.15.1 or higher). You can always find out which agent version you have installed, and download the latest agent from Settings -> General in the Hyperfish web application.

Upgrade instructions can be found here

You will also need:

  • Access to the server hosting the Hyperfish Agent
  • Office 365 Global Administrator credentials 
  • Hyperfish Service account credentials

Configuration

1   Enabling the O365 Connector

  • Stop the Hyperfish Service from the services.msc snap-in console
  • Using a text editor of your choice, open servicesettings.json from "C:\Users\<hyperfishsvc>\AppData\Local\Hyperfish"
  • Under the "Connectors" section, find the "o365" connector setting and change the "Enabled" value from false to true.

  • Start the Hyperfish Service from the services.msc snap-in console

  • Confirm that the file "SPOConnectorSettings.json" exists in "C:\User\<hyperfishsvc>\AppData\Local\Hyperfish\connectors" folder. If it isn't there, make sure that all of Step 1 was completed properly.

2   Configuring Office 365 Connector Settings

  • A configuration utility, O365Config.exe is bundled with the Hyperfish Agent; to locate it, navigate to "C:\Users\hyperfishadmin\AppData\Local\Hyperfish\versions" 

  • Open the latest version folder within, and open the agent folder to find O365Config.exe
    Note: If the Hyperfish Agent has never been updated, the version folder may be 0.0.0

  • Stop the Hyperfish Service from the services.msc snap-in console

  • Run O365Config.exe as the Hyperfish service account (Run a CMD session as the service account and change directory to the O365Config.exe location if you need to)

  • Select option 1 to set up standard username/password authentication

  • When prompted to do so, enter the full name and password of the O365 administrator account, e.g. admin@contoso.onmicrosoft.com


    Accounts requiring multi-factor authentication will not work.

  • When prompted for Tenant Name, enter the name of your Office 365 tenant. For example, if your Office 365 tenancy is contoso.onmicrosoft.com, enter 'contoso'

  • After doing so, the configuration utility will attempt to lookup the user specified in SharePoint Online User Profiles using the credentials provided:

    If the test is unsuccessful, press any key to return to the main menu and perform select option 1 to perform the configuration steps again

    If the test is successful, press any key to return to the main menu and make sure to exit O365Config.exe as its running state will prevent the Hyperfish service from starting later 


3   Validate the O365 Connector Settings 

  • In an explorer window, navigate to the C:\Users\<hyperfishsvcaccount>\AppData\Local\Hyperfish\connectors folder and open SPOConnectorSettings.json using your text editor of choice
  • Verify that the following sections have your tenant name populated:
    TenantName
    SpoConfig: AdminUri, TenantName, MySiteHost, RootSiteHost


    Optionally, if you are using a different language pack, the MySiteHostPhotoLocationPath will be different. Make sure you change this appropriately for photo upload to work correctly.

  • At the bottom of the SPOConnectorSettings.json make sure that the username is correct and that the password is populated as an encrypted string:


    If you're unsure about the formatting of the contents of the .json file, you can use a JSON validator to make sure it's formatted correctly.

  • After you've validated the contents of SPOConnectorSettings.json, save any changes if needed, and close it

  • Start the Hyperfish Service from the services.msc snap-in console

4   Testing Connector Functionality

  • Test Photo Sync - From your Hyperfish Profile page, upload a new profile photo (you may also need to approve it from the Hyperfish 'Approve' page)

    Sign-in to Outlook Web Access and make sure your profile photo is updated there.

    Navigate to your Delve profile (SPO is the photo store for Delve) and make sure your profile photo is updated there.

  • Test Office 365 Attributes - From the Hyperfish Web Application, navigate to Settings -> Attributes. Click on '+ Add Attribute' and search for "o365" in 'Field' to make sure SharePoint Online User Profile properties show up:

If any of these tests fail, please contact support@hyperfish.com 


5   Additional Configuration (Optional)

If there are custom SharePoint Online user profile properties you would like to add to Hyperfish, an entry must be made for that property in SPOConnectorSettings.json

  • Stop the Hyperfish Service from the services.msc snap-in console

  • Edit SPOConnectorSettings.json with a text editor

  • Under the "Attributes" section, create a new section for each custom attribute you wish to add (you can copy another section to make sure you don't miss any properties)

  • For each custom attribute, enter the display name of the attribute for "Name", and 'true' or 'false' for the "IsMultiValued" parameter:



  • Start the Hyperfish Service from the services.msc snap-in console

Your custom attributes should appear when adding attributes from Settings -> Attributes.

NOTE: Again, if you're unsure about the formatting of the contents of the .json file, you can use a JSON validator to make sure it's formatted correctly.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.