Community

Product DocsMenu

Modifying Hidden Microsoft OneDrive for Business Source Parameters

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the connector for most Microsoft OneDrive for Business setups. More advanced and more rarely used parameters are hidden. You can choose to make one or more of these parameters appear in the Add Source and Source: ... General pages of the Administration Tool so that you can change their default value.

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

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: The Microsoft OneDrive for Business 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 into 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

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)

(For SharePoint Online only) 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)

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.

IndexListFolders (Boolean)

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)

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.

To modify hidden Microsoft OneDrive for Business source parameters

  1. Refer to Adding an Explicit Connector Parameter to add one or more Microsoft OneDrive for Business hidden source parameters.

  2. For a new Microsoft OneDrive for Business source, access the Add Source page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection in which you want to add the source.

    3. Under Sources, click Add.

    4. In the Add Source page, edit the newly added advanced parameter value.

  3. For an existing Microsoft OneDrive for Business source, access the Source: ... General page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection containing the source you want to modify.

    3. Under Sources, click the existing Microsoft OneDrive for Business source in which you want to modify the newly added advanced parameter.

    4. In the Source: ... General page, edit the newly added advanced parameter value.

People who viewed this topic also viewed