Set Up SharePoint Server Client

This manual is relevant only for on premises SharePoint Server. If you want to configure SharePoint Online please refer to Set Up SharePoint Online and OneDrive.

In the context of this connector you need to make sure that amberSearch has access to the SharePoint Server network-wise. The APIs are called in the context of service account. In the following you can see how to create the service account and grant the required permissions. amberSearch needs to navigate through the folders and files, pages and read them. Furthermore amberSearch should be able to read the permissions structure in order to ensure that the users can search through the contents that they are permitted to.

  1. Create a new user (we refer to it as service account in this manual). If SharePoint Server is relying on a local Active Directory, then you can create the user in AD as well

  2. Grant the user at least the following permissions

Permission

Explanation

View Items

View items in lists and documents from a document library

Open Items

View the source of documents with server-side file handlers

View Versions

View past versions of a list item or document

Browse Directories

Enumerate files and folders in a website by using SharePoint Designer 2013 and Web DAV interfaces (Web DAV being an HTTP extension which allows for namespace management and remote authoring, more specifically for nested file systems)

View Pages

View pages in a website

Enumerate Permissions

Enumerate permissions on the website, list, folder, document, or list item

Browse User Information

View information about users of the website

Open

Enables users to open a website, list, or folder to access items inside that container

Hint: You can create a new permission level that complies with our requirements, if you do not have existing ones that fit with the requirements above. Below you see an example of permission level that matches amberSearch needs.

By default, amberSearch will integrate the root / site collection. If you have multiple sites collections, make sure that the service account has the respective rights/permissions in all relevant site collections.

Check List

Make sure to transfer the following information to amberSearch

  • SharePoint Server URL and IP

  • Access details of the Service Account

  • Grant the required permissions to the service account

  • If there are multiple sites collections give amberSearch the list of them

  • Make sure that the service account has the respective permissions in all relevant sites collections