ADFS Related Parameters

The following ADFS related parameters are only required when the source Authentication Type parameter is either AdfsUnderClaims or SpOnlineFederated:

AdfsServerUrl (String)

URL of the AD FS server for which a trust is established with SharePoint.

Note: CES 7.0.6684+ (May 2014) The SharePoint connector supports indexing SharePoint Online configured with Okta (see SharePoint Online (Okta SSO) [Claims] Source Quick Setup).

In this case, you must add the AdfsServerUrl hidden parameter to the source and set the value to the full path to your SharePoint Online ActiveClientSignInUrl that should be in the form: 

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

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

1. With an administrator account, log in to Okta.

2. In the top menu, click Admin.

3. In the administration panel, select Applications > Applications.

4. In the Applications page, click Microsoft Office 365.

5. In the Microsoft Office 365 page, select the Sign On tab.

6. In the Sign On tab, under Sign On Methods section, click View Setup Instructions.

7. The ActiveClientSignInUrl is the value next to ActiveLogOnUri.

Ensure that you also set this ActiveClientSignInUrl for the Claims Security provider and the SharePoint source (see Creating a Claims Security Provider for SharePoint Online and Creating 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).

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

Other Parameters

UsePeopleSearchForUserProfiles (Boolean) CES 7.0.8541+ (September 2016)

Note: User profiles are not available in Microsoft SharePoint Foundation.

Whether to extract the SharePoint user profiles using the SharePoint search service application (see Listing User Profiles With a SharePoint Search Service Application). The default value is false.

When you have created a search service application, set this parameter to true only on the SharePoint source of your smallest web application in size.

You must also set the LoadUserProfiles hidden parameter to true (see LoadUserProfiles). Otherwise, the parameter is ineffective.

AllowBasicAuthentication (Boolean)

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

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.

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 is true.

LoadAllOnlineSiteCollections (Boolean) CES 7.0.6830+ (July 2014)

Whether to extract the SharePoint Online site collections. The default value is false.

LoadUserProfiles (Boolean)

Whether to extract the SharePoint user profiles. The default value is true.

Set this parameter to false when you do not want to index the SharePoint users.

Notes:

• CES 7.0.8541+ (September 2016) Indexing user profiles takes a significantly smaller amount of time using the parameter in combination with the UsePeopleSearchForUserProfiles parameter (see UsePeopleSearchForUserProfiles).

• CES 7.0.8388– (June 2016) 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:

  • When you configure your first SharePoint source, you do not need to add this parameter. For all your other SharePoint sources, add the LoadUserProfiles parameter and set the value to false.

  • When you already have other configured SharePoint source(s), look for your smallest Web Application in size, and add the LoadUserProfiles parameter and set the value to false in all your other SharePoint sources.

• Since SharePoint 2010, 2013 and 2016 do not support ADFS users on Windows with user profile, it is currently impossible when indexing those SharePoint versions to set the LoadUserProfiles parameter to true when the Crawl Scope is WebApplication and the Authentication Type is AdfsUnderClaims (see Configuring and Indexing a Microsoft SharePoint Source).

• User profiles and personal websites are not available in Microsoft SharePoint Foundation.

LoadSocialTags (Boolean) CES 7.0.7022+ (September 2014)

Whether to retrieve the social tags for each document or not. When set to true, documents corresponding to items with social tags have the fields syssptagnames and syssptagguids set 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 is false. Setting this parameter to true can have a significant impact on crawling performance because one call is required to retrieve each item.

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.

RequestTimeout (Integer) CES 7.0.7711+ (June 2015)

The maximum amount of time (in seconds) an HTTP request can be executed before being canceled. The default value is 60.

WebPartsOptions (String) CES 7.0.7022+ (September 2014)

Note: Not all Web parts are available in Microsoft SharePoint Foundation 2010 (see Overview of Web Parts available in SharePoint Foundation 2010).

Determines what to do with Web Part Pages. The content of the web parts is added to the field syssearchablemeta, which is not displayed in search results, but is searchable. Use this parameter to control what is indexed and include or not potentially secured dynamic content to prevent a security hole.

The following table lists the possible WebPartsOptions parameter values.

Value	Description
SelectiveWebParts	The default value. Only indexes the content of Web Parts listed in the IncludedWebPartTypes parameter. 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 the syssearchablemeta field 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 the WebPartsOptions parameter 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 is false, because Web folders are not accessible via the browser, only from Windows Explorer. Set to true when 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 ServerNameAlias parameter and set the value to the NLB URL to replace the IP address in the index.

LoadPersonalSites (Boolean) CES 7.0.8047+ (December 2015)

Note: Personal websites are not available in Microsoft SharePoint Foundation.

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

OktaRealm (String) CES 7.0.9272+ (March 2018)

If your SharePoint instance uses an Okta single sing-on setup, provide the $realm value obtained from Okta (see Retrieve your application parameters).

OktaSingInUrl (String) CES 7.0.9272+ (March 2018)

If your SharePoint instance uses an Okta single sing-on setup, provide the $signInURL value obtained from Okta (see Retrieve your application parameters).