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.
To use this connector as a connector client, see Connector clients.
For additional operations, see Using connectors.
The following SharePoint Server versions are compatible with the Elastic connector framework:
- SharePoint 2013
- SharePoint 2016
- SharePoint 2019
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:
- The username of the account for SharePoint Server.
- The password of the account to be used for the SharePoint Server.
The server host url where the SharePoint is hosted. Examples:
Comma-separated list of site collections to fetch from SharePoint. Examples:
Whether SSL verification will be enabled.
Default value is
Content of SSL certificate needed for SharePoint Server. Keep this field empty, if
ssl_enabledis set to
-----BEGIN CERTIFICATE----- MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT ... 7RhLQyWn2u00L7/9Omw= -----END CERTIFICATE-----
The number of retry attempts after failed request to the SharePoint. Default value is
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 --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:
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>
elasticsearch.api_key is the recommended authentication method. However, you can also use
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:220.127.116.11 \ /app/bin/elastic-ingest \ -c /config/config.yml
DOCKER.md in the
elastic/connectors repo for more details.
Find all available Docker images in the official registry.
Documents and syncsedit
The connector syncs the following SharePoint object types:
- Sites and Subsites
- 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.
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.
See Content extraction.
Connector client operationsedit
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
make ftest NAME=sharepoint_server DATA_SIZE=small
There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Framework and sourceedit
This connector is included in the Elastic connector framework.
View the source code for this connector (branch 8.11, compatible with Elastic 8.11).