SharePoint Connector: Online Document Connection

Office 365 Account Page

Enter the Office 365 domain account details.

Setting Name	Description
Office 365 domain name	Enter the Office 365 domain name
Office 360 domain description	Enter a description for the Office 365 credential source. This is what will appear to users when they are prompted for their credentials from the web client search results page.
Azure Application Client ID	Enter the Azure Application Client ID you obtained during an earlier step when setting up the Windows Azure Graph API for Locator.
Azure Application Secret Key	Enter the Azure Application Secret Key you obtained during an earlier step when setting up the Windows Azure Graph API for Locator.
Office 365 account synchronized	Check the box if your Office 365 account is synchronized with your on-premises Active Directory
Enable Mixed Mode	Check this box if you wish to provide Forms Login for users that have failed to login using SSO.
Use security cache service	Check this box if you want to use background service that will query SharePoint to cache user tokens. Using this service can decrease the time used by security plugins.
Server Address	Address to the security cache service. Default value is recommended. You can change the security cache server address in the Via.SharePoint.SecurityService.exe.config.
Pause interval	Sets the time security cache service will wait before next run.

Single Sign-On Configuration Page

On this page you can configure Single Sign-On that allows users to get search hits from SharePoint Online connections without providing Office 365 credentials. Currently available options are:

E-mail mapping where authentication is based on matching user's primary SMTP address with E-mail address in Office 365.
ADFS with WS-Federation Protocol

Setting Name	Description
ADFS endpoint address	Address to WS-Federation endpoint. Default https://fs.[tenant].com/adfs/services/trust/13/usernamemixed
Relying Party ID	Default urn:federation:MicrosoftOnline
Name of attribute mapped to email	Default are UPN or Email

More details about WS-Federation settings can be found here.

Server Page

Address for SharePoint Online and the index user credentials.

Setting Name	Description
SharePoint Online URL	Enter the SharePoint Online URL
Connection Name	Enter the display name for the connection
Use application instead of index user	Check this box if you want use Azure AD Application to index documents Important Note: Using this option requires Azure AD connector installed with connection configured to the same tenant.
SharePoint Online Index User or Application Client ID	Enter the index user account name using format user@domain.com. Enter the Azure Application Client ID you obtained during an earlier step when Adding Permissions to the Azure AD Application for SharePoint Online indexing.
Password or Application Secret Key	The password of the index user. Enter the Azure Application Secret Key you obtained during an earlier step when Adding Permissions to the Azure AD Application for SharePoint Online indexing.
Set up separate user/application for authentication and identification	Check this box if you want to use different index user/application for Authentication and Identification.
SharePoint Online Security User or Application Client ID	Enter the security user account name using format user@domain.com. Enter the Azure Application Client ID.
Password or Application Secret Key	The password of the security user. Enter the Azure Application Secret Key

Multiple Index Users Configuration

This page allows you to set up additional users/applications to index data from SharePoint. You can use them in serial or parallel configuration. You should use serial configuration if you want to spread the total resource usage. Parallel configuration speeds up the discovery by crawling multiple site collections at the same time.

Important Note: Every additional index user should have the same permissions as the primary index user.

Connection Configuration Page

Setting Name	Description
SharePoint ChangeSets	Use SiteData web service to index by change sets (Document connections only) This option provides for a more efficient method for Locator to obtain changes to documents within SharePoint. Important Note For SharePoint Connector versions older than 2.9.0.0: In order to use this feature the index user is required to access the SiteData web service, thus the index user must be a site collection administrator. Since SharePoint Connector version 2.9.0.0 SiteData web service is no longer used to retrieve changes and index user no longer has to be site collection administrator to use ChangeSet functionality.
Use Incremental Mode	This option will cause the full scan to index only new site collections. Change Set will handle document additions, updates and deletes in already indexed site collections. This will decrease the number of requests to SharePoint after the initial full scan.
Azure Security	Use Azure to obtain security group information for index security
Include Office 365 Personal Blogs	Include Office 365 Personal Blogs
Include Office 365 Group Sites	Include Office 365 Group Sites
Include Office 365 Communication Sites	Include Office 365 Communication Sites
Include other site templates	Adds option to include other, unlisted site templates. It will be possible on SubSites Page.

Site Collection Page

Setting Name	Description
Index all 'Site Collections' on this server	If you enable this option the SharePoint connector will get the list of site collections from the SharePoint Admin Center. Important Note: In order to use this feature the index user is required to access the admin site, thus the index user must be a site collection administrator.
SharePoint admin center URL	The Url of the Admin Center
Custom property name	Select or provide property name that all included site collections should have. All site collections without this property will be excluded. You can press Auto Discover Properties button to perform lookup for available properties*.
Custom property value	Select or provide value for the custom property. All site collections that don't contain property with configured name and value will be excluded. You can press Auto Discover Properties button to perform lookup for available properties*.

* If your tenant contains a lot of site collections this action can take a while. In that cases there has been added feature that lets you pause the lookup at any time after first site collection has been processed and work with limited data.

Important Note: Auto Discover Properties action takes into account state of Index all 'Site Collections' on this server, so you should decide if you want to index all site collecions before performing lookup, because every time you select/deselect it you have to perform new lookup.

Site Collection Sets Page

This window allows you to divide site collection into sets. Each set can be created with different index user to help with SharePoint throttling.

Setting Name	Description
Index set of 'Site Collection'	If you enable this option the SharePoint connector will index only one set of site collection.
Total number of sets	Number of sets. Each of the set must be created in new connection.
Current set number	Set for which current connection is being created. Important Note: Each set should get connection even if it would be currently empty. When new site is created it has a chance to be assigned to the empty set.
Details	Informations that help determine optimal number of sets/index users.

SubSites Page

In this window, Locator will automatically discover the SharePoint sites .

By default, all sub-sites will be indexed. You can choose to exclude sites if you wish. Simply check the box to the left of the site name for those sites you wish to exclude from the index.

Setting Name	Description
Subsites	By default, all sub-sites will be indexed. You can choose to exclude sites by checking the box to the left of the site name.
Exclude items marked as NoCrawl	You can choose to exclude items marked as NoCrawl in SharePoint. The NoCrawl flag is controlled in the "Search and Offline Availability" settings for the SharePoint List. If "Allow this site to appear in search results" is set to No, the list will have the NoCrawl flag.
Exclude items from Hidden lists	You can choose to exclude items from hidden lists. A list is hidden when the "Hide from Browser" flag is checked in SharePoint Designer.
Include SharePoint Web Sites	The default setting is not to include the SharePoint Web Sites.
Include only selected sites with their subsites	Changes the default indexing behaviour for new SubSites, that were created after this connection was established. If this is checked new site won't be indexed by the connector.

Site Templates Page

The link “There are some additional site templates not shown on this page.” allows you to choose which additional site templates to index. This page also provides list of sites that are using those templates.

Important Note: Once site template is included it cannot be later excluded when editing connection. If you don't want to index sites that are using previously included template you have to exclude them from SubSites Page.

To identify the meaning of the different template IDs displayed there, please refer to the following lists:

Modern SharePoint Sites:

Template ID	Title
STS#3	Team site (no Office 365 group)
SITEPAGEPUBLISHING#0	Communication site
GROUP#0	Office 365 Group associated Team Site
POINTPUBLISHINGPERSONAL#0	Delve Blog
SPSPERS#10	OneDrive for Business personal Site
RedirectSite#0	Redirect Site
TEAMCHANNEL#0	Teams Private Channel Site

Classic SharePoint Sites:

Template ID	Title
STS#0	Classic Team Site
APPCATALOG#0	App Catalog Site
BDR#0	Document Center
BICenterSite#0	Business Intelligence Center
BLANKINTERNETCONTAINER#0	Publishing Portal
BLOG#0	Blog
COMMUNITY#0	Community Site
COMMUNITYPORTAL#0	Community Portal
DEV#0	Developer Site
ENTERWIKI#0	Enterprise Wiki
OFFILE#1	Records Center
PRODUCTCATALOG#0	Product Catalog
PROJECTSITE#0	Project Site
SRCHCEN#0	Enterprise Search Center
SRCHCENTERLITE#0	Basic Search Center
visprus#0	Visio Process Repository

Content Type Page

This window allows you to choose to exclude specific data content types from being indexed. Just as you can with sites, simply check the box to the left of the content type name for those content types you wish to exclude from the index.

Setting Name	Description
Content Type	You can also choose to exclude specific data content types from being indexed. Just as you can with sites, simply check the box to the left of the content type name for those content types you wish to exclude from the index.

Content Type Advanced Configuration Page

The link “Advanced configuration” allows you to exclude and include items that are of specific content type. More specific content types have always higher priority. More specific content types can be recognized by the length of the ID. Content type with ID 0x010201 is more specific that 0x0102. For example if exclude Item (0x01) content type and include Event (0x0102) content type then this connection will index only Event items.
After confirming new configuration Content Type Page will be updated and it won't show excluded content types.

FileTypeExcludeListPage

The link “Select file types to include or exclude for the different libraries” allows you to choose which file extensions to index. Only the most common file types are included by default.

Setting Name

Description

File Type to index

Select file types Only the most common file types are included by default.

The file extension to index. The options are:

Index all file types
- This one will by default index ALL files, regardless of the file format
- For file types associated with the built-in DocFilter content filter, all text content available will be indexed
- For other file types, only available metadata (like file name and path) will be indexed

Index selected file types only (default)
- Will only index the file types listed in the dialog

Exclude selected file types
- Will index everything - except the file types defined in the list

Finalize Page

Setting Name	Description
Include SharePoint Lists	The default setting is to include the SharePoint Lists.
Include SharePoint Comments	Check this option if you want to index comments under pages in SharePoint. Default setting is to exclude comments.
Perform single full scan	Option available only when you are editing connection with enabled Incremental Mode. This forces the connector to perform a single full scan on all connectors after which it will continue with the incremental mode. You should check this option if you want to remove from index some subset of documents that still exist in the source system.

Upon completion of the Locator SharePoint Connection, the Locator Server will be ready for scheduling the SharePoint connection for indexing. As soon as the connection wizard is finished, you will return to the SharePoint connections overview in the Management Console. You can click the "Schedule" option to configure the schedule for the connection.