SharePoint Connector
Configuration settings for adjusting the Haven OnDemand Cloud SharePoint Connector.

SharePoint Cloud Connector

The SharePoint Connector retrieves documents from a Microsoft SharePoint server or a SharePoint Online account, and indexes them into Haven OnDemand.

This connector is a cloud connector that runs entirely in the Haven OnDemand environment.

SharePoint Cloud Connector Configuration

This section outlines the configuration options that you can set for the sharepoint_cloud connector flavor. You can use these in the JSON object that you pass to the config parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
online Boolean Set this parameter to true to retrieve data from SharePoint Online. Set it to false to retrieve data from SharePoint Server.
If you set this parameter to true, and you set the optional parameter index_user_profiles to true, you must also set admin_url and mysite_url.
url_type Enum The type of URL specified by url. You can use one of the following values:
  • SiteCollection. A SharePoint site collection URL. The connector retrieves only one site collection, specified by url.
  • PersonalSiteCollection. A SharePoint personal site collection URL. The connector retrieves a personal site collection, specified by url. You can use this option only if you set online to true. If you set this option, you must also set mysite_url.
  • WebApplication. A Sharepoint Web application URL. The connector retrieves all content databases and site collections from the Web application specified by url. You can use this option only if you set online to false.
url String The starting point for the connector to crawl.
The following parameters are required for certain configurations:
admin_url String When you are retrieving data from SharePoint Online, user profiles can be retrieved only through the admin site collection. Set this parameter to the URL of the admin site collection.
Note: This parameter is required only if you set online to true, and you set the optional parameter index_user_profiles to true.
mysite_url String To index user profiles from SharePoint online, you must set this parameter to the URL of the MySites site collection.
Note: This parameter is required only if you are using one of the following configurations:
  • You set online to true, and you set the optional parameter index_user_profiles to true.
  • You set online to true, and you set url_type to PersonalSiteCollection.

Optional Parameters

Parameter Type Description Default
version_indexing_mode Enum A string that specifies which versions of a document the connector retrieves for indexing. You can use one of the following values:
  • LatestMajor. Index only the latest major version.
  • AllMajor. Index all major versions.
  • All. Index all versions (major and minor).
LatestMajor
index_sites Boolean Set this parameter to false if you do not want to index sites. In this case, the connector still crawls the sites for lists and list items. true
index_lists Boolean Set this parameter to false if you do not want to index lists. In this case, the connector still indexes list items. true
index_folders Boolean Set this parameter to false if you do not want to index folders that are contained within a list or document library. In this case, the connector still indexes all the list items and files that they contain. true
index_user_profiles Boolean Set this parameter to true if you want to index information from user profiles.
Note: If index_user_profiles is set to true, you must set the admin_url parameter (listed as a required parameter).
false
index_attachments Boolean Set this parameter to false if you do not want to index attachments. true
index_catalogs Boolean Set this parameter to true if you want to index catalogs. false
index_file_versions Boolean This parameter specifies how the connector indexes versions of files in the document libraries. Set this parameter to true to index the file versions specified by version_indexing_mode. When you set this parameter to false, the connector indexes only the latest version of a file, whether the latest version is a major version or minor version. false
index_hidden Boolean A Boolean that specifies whether the connector indexes hidden items. false
index_site_assets Boolean Set this parameter to true to index site assets. A site assets library stores rich media assets such as video, audio, and images. false
site_collection_url_must_have_regex String If you set this parameter, the absolute URL of a site collection must match the specified regular expression for the connector to index the site collection.
site_collection_url_cant_have_regex String If you set this parameter, the absolute URL of a site collection must not match the regular expression for the connector to index site collection.
site_url_must_have_regex String If you set this parameter, the absolute URL of a site must match the regular expression for the connector to index the site.
site_url_cant_have_regex String If you set this parameter, the absolute URL of a site must not match the regular expression for the connector to index the site.
list_url_must_have_regex String If you set this parameter, the absolute URL of a list must match the regular expression for the connector to index the list.
list_url_cant_have_regex String If you set this parameter, the absolute URL of a list must not match the regular expression for the connector to index the list.
list_item_url_must_have_regex String If you set this parameter, the absolute URL of a list item must match the regular expression for the connector to index the list item.
list_item_url_cant_have_regex String If you set this parameter, the absolute URL of a list item must not match the regular expression for the connector to index the list item.
file_extension_must_have_csv String A comma-separated list of file extensions to restrict the content retrieved by the connector. A file must have one of the specified extensions, otherwise it is not retrieved. The values of this parameter are case-sensitive
file_extension_cant_have_csv String A comma-separated list of file extensions to restrict the content retrieved by the connector. If a file has one of the specified extensions, it is not retrieved. The values of this parameter are case-sensitive.
ignore_no_crawl Boolean Set this parameter to true to ignore the NoCrawl setting for lists and document libraries false
ignore_wiki_aspx Boolean Set this parameter to true to ignore ASPX wiki pages. In this case, the Connector indexes the plain text content of the page instead. true
ignore_publishing_pages_aspx Boolean Set this parameter to true to ignore ASPX publishing pages. In this case, the Connector indexes the plain text content of the page instead. true

Example Configuration

{
	"online": true,
	"url_type": "SiteCollection",
	"url": "http://testsite.com",
	"admin_url": "http://testsite-admin.com",
	"mysite_url": "http://testsite-my.com",
	"version_indexing_mode": "LatestMajor",
	"index_sites": true,
	"index_lists": true,
	"index_folders": true,
	"index_user_profiles": true,
	"index_attachments": true,
	"index_catalogs": false,
	"index_file_versions": false,
	"index_hidden": false
}

SharePoint Cloud Connector Destination

This section outlines the options that you can set for the destination that the connector indexes into. You can use these in the JSON object that you pass to the destination parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
action Enum The action to take when indexing documents. You can use the following options:
  • addtotextindex. Add documents directly to a Haven OnDemand text index.

Parameters for Add to Text Index Action

The following parameters are required in the destination JSON object when action is set to addtotextindex

Parameter Type Description
index String The name of the text index that you want to index documents into. This index must already exist in Haven OnDemand (created by the Create Text Index API).

Example Destination

{
	"action": "addtotextindex",
	"index": "testindex"
}

SharePoint Cloud Connector Schedule

This section outlines the options that you can set for the schedule that the connector runs on. You can use these in the JSON object that you pass to the schedule parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
frequency Object The frequency configuration that describes how often to run the connector.

The frequency object must contain the following parameter:

Parameter Type Description
frequency_type Enum The type of frequency configuration to use. This setting affects the other parameters that you must set in the frequency object. You can use one of the following values:
  • seconds. The connector frequency is set in seconds. You must also specify the interval parameter.

When you have set the frequency_type parameter to seconds, you must also set the following parameters:

Parameter Type Description
interval Integer The number of seconds between each connector run. This interval measures from the start of one connector run to the start of the next. The maximum interval is 31536000.
Note: The exact interval that the connector uses might vary by up to 30 minutes, depending on load on the system and the scheduler.

Optional Parameters

Parameter Type Description
occurrences Integer The number of times to attempt to schedule a connector run. If you do not set occurrences, the number of runs is unlimited. The schedule stops either after this number of runs, or when it reaches the configured end_date, whichever occurs first.
start_date String The date to start scheduling the connector. For a list of available date formats, see Date Formats for Parameters. If you do not set a start_date, the connector runs after the first interval elapses.
end_date String The date to stop scheduling the connector. For a list of available date formats, see Date Formats for Parameters. The schedule stops either after this date, or when it has run the number of times configured in occurrences, whichever occurs first.

Example Configuration

{
	"occurrences": 5,
	"start_date": "1",
	"end_date": "29/06/2015 12:00:00 -0600",
	"frequency": {
		"frequency_type": "seconds",
		"interval": 21600
	}
}

Schedule Errors

If an attempt to run a connector fails, for example because an error occurred on the system, the Connector Status and Connector History APIs return an error status in the response for the schedule. In this case, Haven OnDemand attempts to retry the connctor schedule up to three times. When a schedule fails, Haven OnDemand attempts to retry it the next time it scans the connector schedules (every minute).

If the schedule fails three times, Haven OnDemand stops the connector schedule. In this case, you must either use the Update Connector API to set a new schedule, or manually start the connector with the Start Connector API.

SharePoint Cloud Connector Credentials

This section outlines the options that you can use to set credentials for the connector. You can use these in the JSON object that you pass to the credentials parameter in the Create Connector API. The credentials parameter is required for sharepoint_cloud flavor connectors.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
username String A user name to use for authentication with SharePoint Web Services and Client API.
password String A password to use for authentication with SharePoint Web Services and Client API.

Optional Parameters

Parameter Type Description Default
domain String The domain of the specified user name. You can use this option only if you set online to false.

Example Connector Credentials

{
	"username": "username@testsite.com",
	"password": "password"
}

SharePoint Cloud Connector Credentials Policy

This section outlines the options that you can use to set the credentials policy for the connector. The credentials policy options define when the system can decrypt credentials. You can use these parameters in the JSON object that you pass to the credentials_policy parameter in the Create Connector API. The credentials_policy parameter is required if you have set credentials.

The credentials policy controls how Haven OnDemand manages decryption tokens for storing and decrypting the credentials that the connector uses to access the repository. You can obtain a decryption token from the Start Connector and Retrieve Config APIs, which require the decryption of the connector credentials. Haven OnDemand sends the decryption token to an email address that you specify in the credentials policy.

The credentials policy also specifies how long the decryption token is valid for. If you send an invalid token to one of the APIs that requires it, the API automatically generates and sends a new token to the email.

The credentials policy has its own expiration date. After this time, you must renew the policy with the Update Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
notification_email String The email address to which to send information about connector activity.

Optional Parameters

Parameter Type Description Default
token_expiration Integer The number of seconds that a generated token remains valid. The expiration time is counted from the moment the token was generated. Every generated token is valid for the specified duration, and can be used for decryption a number of times specified by token_occurrences. After the token_expiration time, the token cannot be used, even if it has not had token_occurrences uses. When the token expires, a new token is generated, resetting the token_expiration time and token_occurrences. The minimum value is 1. 1800
token_occurrences Integer The number of times that a generated token can be used for decryption. Every generated token is valid for this number of uses, and can be used for a duration specified by token_expiration. After it has been used token_occurrences times, the token cannot be used, even if the token_expiration time has not been reached. When the number of uses are exhausted, a new token is generated, resetting the token_expiration time and token_occurrences. The minimum value is 1. 1
key_expiration String The duration that the credentials policy is valid for. When the key expires, the Haven OnDemand key management service returns an error stating that the policy has expired. For a list of available date formats, see Date Formats for Parameters. 3 months
notification_email_frequency Enum The frequency to use to send information about connector activity to the notification_email address. You can use the following values:
  • always. Always send email notifications for all connector activity.
  • on_decrypt. Send email notifications only when an attempt to decrypt connector credentials occurs.
  • on_failure. Send email notifications only when a failure occurs when using connector credentials.
  • never. Never send email notifications.
on_decrypt

Example Credentials Policy

{
	"notification_email": "test@example.com",
	"notification_email_frequency": "always",
	"key_expiration": "19/06/2015 11:25:00",
	"token_expiration": 3600,
	"token_occurrences": 10
}

SharePoint Cloud Connector Limits

The sharepoint_cloud flavor Connector has the following limits:

Schedule

Property Max Limit
interval 31536000

Static_resource_unit_cost

It costs 1 static resource unit to create a sharepoint_cloud flavor connector.

Start_connector_unit_cost

It costs 5 start connector units to start a sharepoint_cloud flavor connector.