Modifying Hidden Microsoft SharePoint Source Parameters

TheAdd SourceandSource: ... Generalpages of the Administration Tool present the parameters with which you can configure the connector for most Microsoft SharePoint setups. More advanced and more rarely used

parameters are hidden. You can choose to make one or more of these parameters appear in theAdd Sourceand Source: ... Generalpages of the Administration Tool so that you can change their default value.

The following list describes the available advanced hidden parameters for Microsoft SharePoint sources. The parameter type (integer, string…) appears between parentheses following the parameter name.

13.1.1 ADFS Related Parameters

The following ADFS related parameters are only required when the sourceAuthentication Typeparameter is eitherAdfsUnderClaimsorSpOnlineFederated:

Note:CES 7.0.6684+ (May 2014)The SharePoint connector supports indexing SharePoint online configured withOkta(see"SharePoint Online (Okta SSO) [Claims] Source Quick Setup" on page 19).

In this case, you must add theAdfsServerUrlhidden parameter to the source and set the value to the full path to your SharePoint OnlineActiveClientSignInUrlthat should be in the form: 

https://acme.okta.com/app/office365/abcdefghGWUMNWLWYGXF/sso/wsfed/active

You can find your SharePoint OnlineActiveClientSignInUrlin Okta, in the sign on instructions of the Microsoft Office 365 application:

1. With an administrator account, log in into Okta. 2. In the top menu, clickAdmin.

3. In the administration panel, selectApplications>Applications. 4. In theApplicationspage, clickMicrosoft Office 365.

5. In theMicrosoft Office 365page, select theSign Ontab.

6. In theSign Ontab, underSign On Methodssection, clickView Setup Instructions. 7. TheActiveClientSignInUrlis the value next toActiveLogOnUri.

Ensure that you also set thisActiveClientSignInUrlfor the Claims Security provider and the SharePoint source (seeCreating a Claims Security Provider for SharePoint OnlineandCreating a SharePoint Security Provider).

SharePointTrustIdentifier (String)

The Relying Party Trust identifier for the SharePoint ADFS server (see"Finding the Relying Party Trust Identifier for a SharePoint ADFS server" on page 88).

The following parameters are required only when multiple ADFS servers are used to authenticate users in SharePoint:

IdentityProviderServerUrl (String)

The URL of the ADFS server which is used as an Identity Provider for the ADFS server trusted by SharePoint. AdfsServerTrustIdentifier (String)

Trust Identifier for the SharePoint AD FS Server. Enter the Relying Party Trust identifier for the SharePoint web application (see"Finding the Relying Party Trust Identifier for a SharePoint Web Application" on page 87).

13.1.2 Other Parameters

AllowBasicAuthentication (Boolean)

Select theAllowBasicAuthenticationoption only when basic authentication is enabled on the web application to index and specifically want to use this authentication mode. The default value isfalse.

It is recommended to use this authentication method only with a secured connection (HTTPS) because the user name and password are passed in clear text in the URL.

AuthenticationRealmUrl (String)

Add this hidden parameter only when your SharePoint environment includes an online authentication service on a separate server, in which case you enter the authentication server URL in the form

https://domain.sharepoint.com.

LoadAllOnlineSiteCollections (Boolean)CES 7.0.6830+ (July 2014)

Whether to extract the SharePoint Online site collections. The default value isfalse. LoadUserProfiles (Boolean)

Whether to extract the SharePoint user profiles. The default value istrue. Set this parameter tofalsewhen you do not want to index the SharePoint users.

Notes:Indexing user profiles can take a significant time depending on their number. Moreover, indexing user profiles more than once, creates as many duplicates in your index. It is thus recommended to only index your user profiles once for all your SharePoint sources:

l When you configure your first SharePoint source, you do not need to add this parameter. For all you other

SharePoint sources, add theLoadUserProfilesparameter and set the value tofalse.

l When you already have other configured SharePoint source(s), look for your smallest Web Application in

size, and add theLoadUserProfilesparameter and set the value tofalsein all your other SharePoint sources.

LoadSocialTags (Boolean)CES 7.0.7022+ (September 2014)

Whether to retrieve the social tags for each document or not. When set totrue, documents corresponding to items with social tags have the fieldssyssptagnamesandsyssptagguidsset with the social tag content.

The parameter works for SharePoint On-Premises, but not for SharePoint Online. An incremental refresh should pick social tag changes. However, the SharePoint API does not report social tags accurately for all item types and the SharePoint web service cache can delay or cause multiple pick ups of a tag change by an incremental refresh.

The default value isfalse. Setting this parameter totruecan have a significant impact on crawling performance because one call is required to retrieve each item.

EnableOfficeIntegration (Boolean)CES 7.0.7022+ (September 2014)

Whether to enable the office integration in the .NET UI or not. This will change the clickable URI to open documents directly in Office. The default value istrue.

OverrideSharePointAuthor(Boolean)CES 7.0.7711+ (June 2015)

Whether to override the author saved in SharePoint for a document by the author extracted from the metadata of the document.

what is indexed and include or not potentially secured dynamic content to prevent a security hole. The following table lists the possibleWebPartsOptionsparameter values.

Value Description

SelectiveWebParts The default value. Only indexes the content of Web Parts listed in the

IncludedWebPartTypesparameter.

By default, only fixed content is indexed, not dynamic content for which permissions cannot be indexed and could potentially allow users to find content to which they do not normally have access.

AllContent Indexes the whole Web Part Page, including menus and dynamic web parts that can contain secured content that will be searchable.

WebPartsContent Indexes only the content of all the Web Parts of the Web Part Page, including dynamic web parts that can contain secured content that will be searchable.

NoContent Do not download and index the Web Part Page at all (indexed by reference).

Your mapping file should contain the following tags to ensure that thesyssearchablemetafield gets set: 

<Mapping type="File"> <Fields>

<Field name="syssearchablemeta">%[coveo_AllMetaData]</Field> </Fields>

</Mapping>

IncludedWebPartTypes (String)CES 7.0.7022+ (September 2014)

A semi-colon list of web part types to crawl for Web Part Pages when theWebPartsOptionsparameter is set to

SelectiveWebParts. By default only content editors are crawled

(Microsoft.SharePoint.WebPartPages.ContentEditorWebPart;).

IndexListFolders (Boolean)CES 7.0.7104+ (October 2014)

Whether to index List Folders or not. The default value isfalse, because Web folders are not accessible via the browser, only from Windows Explorer. Set totruewhen you want to see the List Folders in search results.

ServerNameAlias (String)CES 7.0.7711+ (June 2015)

Specifies a server name that overrides the one from which documents are downloaded in the index. This parameter is useful to have query results point to a server other than the one used for indexing.

Example:Three network load balanced (NLB) SharePoint front-end servers handle the end-users requests and your source crawls a fourth mirror server to not impact performance for users. In this case, you add the

ServerNameAliasparameter and set the value to the NLB URL to replace the IP address in the index.

LoadPersonalSites (Boolean)CES 7.0.8047+ (December 2015)

When the Crawling Scope source parameter is set to WebApplication, whether to include personal sites. The default value istrue.