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

SharePoint Onsite Connector

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

The SharePoint Onsite Connector is an onsite Connector, which you install on your own system.

SharePoint Onsite Connector Configuration

This section outlines the configuration options that you can set for the sharepoint_onsite 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 (the default value), you must also set the 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 (the default value).
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 (the default value).
  • You set online to true, and you set url_type to PersonalSiteCollection.

Optional Parameters

Parameter Type Description Default
max_task_duration String If specified, the maximum duration of a task in the format H[H][:MM][:SS]. If the maximum duration is exceeded, the task stops.
service_port Integer The configured service port for the connector. This value is set in the connector configuration file, and the connector uses this port to listen for service control requests, such as stopping the connector.
This port must be available on the machine where the connector is installed, and the connector will open it. If port 7932 is not available on your connector host machine, you must reconfigure it. If you have more than one instance of the connector on your host machine, you must change this value for all but one of the connectors.
7932
aci_port Integer The configured action port for the connector. This value is set in the connector configuration file, and the connector uses this port to listen for actions, such as requesting a connector run.
This port must be available on the machine where the connector is installed, and the connector will open it. If port 7930 is not available on your connector host machine, you must reconfigure it. If you have more than one instance of the connector on your host machine, you must change this value for all but one of the connectors.
7930
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
mapped_security Boolean Set this parameter to false if you do not want to index security information for each document. true
index_user_profiles Boolean Set this parameter to false if you do not want to index information from user profiles.
Note: If index_user_profiles is set to true (the default), you must set the admin_url parameter (listed as a required parameter).
true
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

Example Configuration

{
	"service_port": 1111,
	"aci_port": 1112,
	"online": true,
	"url_type": "SiteCollection",
	"url": "http://testsite.com",
	"admin_url": "http://testsite.com",
	"mysite_url": "http://testsite.com",
	"version_indexing_mode": "All",
	"index_sites": true,
	"index_lists": true,
	"index_folders": true,
	"mapped_security": true,
	"index_user_profiles": true,
	"index_attachments": true,
	"index_catalogs": true,
	"index_file_versions": true,
	"index_hidden": true
}

SharePoint Onsite 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 Onsite 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.
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.
start_time String The time of day to start the connector, in one of the following date formats:
  • HH:mm:ss Z
  • HH:mm:ss ZZ
  • HH:mm:ss
If you add a schedule, and set start_time, the connector runs at the start time, and then after every interval elapses.
If you add a schedule, but do not set start_time, the connector runs each time the service starts, and then after every interval elapses.
If you do not add a schedule, and you do not set start_time, the connector runs each time the service starts.

Example Configuration

{
	"occurrences": 5,
	"start_time": "11:55:00",
	"frequency": {
		"frequency_type": "seconds",
		"interval": 21600
	}
}

SharePoint Onsite 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_onsite 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.

Example Connector Credentials

{
	"username": "username",
	"password": "password",
	"domain": "domain"
}

SharePoint Onsite 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 credential decryption for managing the credentials that the connector uses to access the repository. When you start the onsite connector, it retrieves the connector configuration, including any credentials it requires, from Haven OnDemand. You can use the credentials_policy to determine how long the connector can use these credentials for. 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
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

Important: When you use the key_expiration field, if the credentials policy expires, the connector fails to retrieve the configuration necessary to run the connector. In this case, you must renew the credentials by using the Update Connector API to update the connector with your credentials, and then restarting the connector.

Example Credentials Policy

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

SharePoint Onsite Connector Limits

The sharepoint_onsite 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_onsite flavor connector.