Installation and Configuration

SharePoint Online Connector

Installation and Configuration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.

These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes or other protected rights. The dissemination, publication or reproduction hereof is prohibited.

For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.

InstallationPermanent link for this heading

Before you install the SharePoint Online Connector, ensure that the Mindbreeze server is installed and that the SharePoint Online Connector is included in the license. To install or update the connector, please use the Mindbreeze Management Center.

Plugin installation via Mindbreeze Management CenterPermanent link for this heading

To install the plug-in, open the Mindbreeze Management Center. Select "Configuration" from the menu pane on the left-hand side. Then navigate to the "Plugins" tab. In the "Plugin Management" section, select the appropriate zip file and upload it by clicking the "Upload" button. This automatically installs or updates the connector, as the case may be. In this process, the Mindbreeze services are restarted.

Configuring MindbreezePermanent link for this heading

Select the installation method "Advanced" for configuration.

Configuring the index and crawlerPermanent link for this heading

Navigate to the "Indices" tab and click on the "Add new index" icon in the upper right corner to create a new index.

Enter the path to the index and change the display name as neccessary.

Add a new data source by clicking the "Add new custom source" icon at the top right. Select the category "Microsoft SharePoint Online" and configure the data source according to your needs.

In the “SharePoint Online” area, you can define which Microsoft SharePoint Online installation should be indexed. "Server URL" and "Site Relative URL" define your Microsoft SharePoint Online installation and are mandatory.

Using "Included URL (regex)" or "Excluded Sites URL (regex)", you can define which subsites of your Microsoft SharePoint Online installation should be included in the index or excluded from indexing. If no settings are made here, all subsites are indexed.

By setting the "Crawl hidden lists" option, lists that are defined as hidden are also indexed. The same applies to the "Crawl lists with property, NoCrawl" option. If this option is set, the lists that have the "NoCrawl" property in Microsoft SharePoint Online are also indexed.

Select "Advanced Settings" to adjust the following settings.

Enable the “Enforce ACL Evaluation” options.

In the "Services" section, click on "add new service" to add a new service.
Select "SharepointOnlinePrincipalCache" and assign a display name.

In the “SharePoint Settings section”, enter the information about your Microsoft SharePoint Online installation. "Server URL" and "Site Relative URL" must correspond to the settings in the "Data Source" area. "Included URL (regex)" and "Excluded Sites URL (regex)" are not yet taken into consideration. Under "Regex for your organization", you can enter a regular expression that defines whether a user belongs to your organization or not. The regular expression can refer to the e-mail address, the ObjectSID, or the ObjectGUID from LDAP.

If you do not have the “AD Connect” feature set up in Azure Active Directory, select “AD Connect is NOT configured” and fill in the “Tenant Context ID”, “Application ID”, “Generated Key”, and “Protected Resource Hostname” fields. The corresponding values can be found in the Azure Portal.

If AD Connect is set up in your Azure Active Directory, do not enable the "AD Connect is NOT configured" option.



An LDAP cache is required to terminate users from Active Directory. How to set up a Caching Principal Resolution Service is described at the following link:

The following values should be entered in the LDAP cache under "User Alias Name LDAP Attributes" or "User Alias Name LDAP Attributes":





Save the information about the LDAP cache in the “LDAP Settings” area. Enable the "Use LDAP Principals Cache Service" option and enter the corresponding port for your LDAP Principal Cache.

In the "Cache Settings" area, configure the database location for the cache and set the desired interval for the updates.

In the "Service Settings" area, enter a free port to be used for the principal cache, and enable the “Lowercase Principals” option so that the SharePoint groups can be resolved correctly.

Navigate to the "Network" tab and add a new credential for Microsoft SharePoint Online by clicking on "Add Credential" in the "Credentials" area.

Enter the user’s access data with which the indexing is to take place, and assign a name for the credential. Select a user with sufficient rights to be able to read all relevant pages and the permissions.

Then, in the "Endpoints" section, click "Add Endpoint" to add a new endpoint for the newly created credential. As location, enter the server URL of your Microsoft SharePoint Online installation and select the previously created credential.