Elastic SharePoint Server connector reference | Enterprise Search documentation [master]

You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.

› ›

« Elastic SharePoint Online connector reference Elastic Slack connector reference »

Elastic SharePoint Server connector referenceedit

The Elastic SharePoint Server connector is a connector for Microsoft SharePoint Server.

Looking for the SharePoint Online connector? See the SharePoint Online reference.

Availability and prerequisitesedit

This connector is available as a self-managed connector client. This connector client is compatible with Elastic versions 8.9.0+. To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. Beta features are subject to change and are not covered by the support SLA of generally available (GA) features. Elastic plans to promote this feature to GA in a future release.

Create a SharePoint Server connectoredit

Use the UIedit

To create a new SharePoint Server connector:

Navigate to the Search → Connectors page in the Kibana UI.
Follow the instructions to create a new SharePoint Server connector client.

For additional operations, see Using connectors.

Use the APIedit

You can use the Elasticsearch Create connector API to create a new self-managed SharePoint Server connector client.

For example:

PUT _connector/my-sharepoint_server-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from SharePoint Server",
  "service_type": "sharepoint_server"
}

You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

Run the following command, replacing values where indicated. Note the encoded return values from the response:

POST /_security/api_key
{
  "name": "<connector_name>-connector-api-key",
  "role_descriptors": {
    "<connector_name>-connector-role": {
      "cluster": [
        "monitor"
      ],
      "indices": [
        {
          "names": [
            "<index_name>",
            ".search-acl-filter-<index_name>",
            ".elastic-connectors-v1*"
          ],
          "privileges": [
            "all"
          ],
          "allow_restricted_indices": false
        }
      ]
    }
  }
}

Update your config.yml file with the API key encoded value.

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usageedit

To use this connector as a connector client, see Connector clients (self-managed).

For additional operations, see Using connectors.

Compatibilityedit

The following SharePoint Server versions are compatible with the Elastic connector framework:

SharePoint 2013
SharePoint 2016
SharePoint 2019

Configurationedit

When using the connector client workflow, initially these fields will use the default configuration set in the connector source code. These are set in the get_default_configuration function definition.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

username

The username of the account for SharePoint Server.

password

The password of the account to be used for the SharePoint Server.

host_url

The server host url where the SharePoint is hosted. Examples:

https://192.158.1.38:8080
https://<tenant_name>.sharepoint.com

site_collections

Comma-separated list of site collections to fetch from SharePoint. Examples:

collection1
collection1, collection2

ssl_enabled

Whether SSL verification will be enabled. Default value is False.

ssl_ca

Content of SSL certificate needed for SharePoint Server. Keep this field empty, if ssl_enabled is set to False.

Example certificate:

-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----

retry_count

The number of retry attempts after failed request to the SharePoint. Default value is 3.

Deployment using Dockeredit

You can deploy the SharePoint Server connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

elasticsearch.host
elasticsearch.api_key
connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: sharepoint_server
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.14.0.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.

Documents and syncsedit

The connector syncs the following SharePoint object types:

Sites and Subsites
Lists
List Items and its attachment content
Document Libraries and its attachment content(include Web Pages)

Content of files bigger than 10 MB won’t be extracted.
Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elasticsearch Index.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version. Currently filtering is controlled via ingest pipelines.

Content Extractionedit

See Content extraction.

Connector client operationsedit

End-to-end testingedit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the sharepoint connector, run the following command:

$ make ftest NAME=sharepoint_server

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=sharepoint_server DATA_SIZE=small

Known issuesedit

There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Framework and sourceedit

This connector is included in the Elastic connector framework.

View the source code for this connector (branch main, compatible with Elastic 8.14).

« Elastic SharePoint Online connector reference Elastic Slack connector reference »