1. Home
  2. Adapters
  3. SharePoint On-Premises (2007, 2010, 2013, 2016)

SharePoint On-Premises (2007, 2010, 2013, 2016)

DESCRIPTION:  SharePoint is a Microsoft framework that manages and integrates intranet, content, documents and other data in a multi-user environment.  Find out more about SharePoint at www.sharepoint.com.  SharePoint 2007, 2010, 2013 and 2016 are supported; the different SharePoint versions each have their own adapter that you select from the Type dropdown when you create a SharePoint system.  For SharePoint 2016, use the 2013 adapter.

This SharePoint adapter is for on-premise SharePoint only; for SharePoint online, use one of the SPO adapters.

The SharePoint adapter can be used for both account mapping and non account mapping jobs; there is no separate Administrator Account version of the SharePoint adapter that must be used for account mapping.  ACLs are supported for SP 2010 and above; APM jobs may be run for older versions of SharePoint, but will only report and apply ownership.

SharePoint is available as a source only.

PREPARING YOUR SHAREPOINT ADAPTER:  The SharePoint adapter is not installed on the Windows app by default. To install it:

  1. Click on the Windows app POP in your dashboard. Select View.
  2. Click the Add Sharepoint button.

Many OneNote notebooks, and the associated items such as Notebook packages, may not transfer from Sharepoint due to the facts that they are highly dependent on the ecosystem in which they were created, and they do not always have well defined properties as files. If they do transfer, they may not open in the same state as on the source, for reasons independent of CFP. Please make other provisions to transfer these items.

SUPPORTED POP:  Windows.

Fields:

The fields below are for the SharePoint 2013 system. Some of these fields will not be available on the SharePoint 2007 and 2010 systems.

SHAREPOINT SITE URL:  The name of the SharePoint host-named site collection you want to access, such as a server name or IP address on the network.  To access a server called serverName in the domain companyName.com, enter http://sharePointDomain.com or https://sharePointDomain.com.  Example: http://company-sp.net.  To access a subsite, you can enter http://company-sp.net/SubSite1/, where ‘SubSite1’ is the name of your subsite.  Every SharePoint system is set up a little differently, and it is helpful to look at the URLs on your SharePoint site for the data you want to transfer, and then experiment with these in the Site URL field to access the data via CFP.

USE WINDOWS INTEGRATED AUTHENTICATION:  Select this checkbox if you plan to use Windows Integrated Authentication.  Windows App must be running under the same logged in user as is desired for the SharePoint login.

FORCE NTLM:  Most users will leave this setting blank.

Advanced Settings

ADFS CLAIMS REALM:  Claims realm for adfs. Leave blank unless your SharePoint site supports claims based authentication.  Example: urn:SP13APPS.sharepoint.

ADFS CLAIMS HOST:  authenticate using adfs with claims based authentication.  Leave blank unless your SharePoint site supports claims based authentication.  Example:  adfs.contoso.com.

Disable ssl certificate validation:  Accept self-signed or expired certificates from the SharePoint server.

Include Metadata: Include SharePoint List view metadata and enterprise keywords.

KERBEROS SPN:   Enter the Kerberos SPN (Service Principal Name, or domain alias) to be used for authentication. This field defaults to HTTP/ unless otherwise specified. An alternative to NTLM.

MYSITE ROOT:  Select this checkbox if the site entered in the SharePoint Site URL field is a MySite root.

Multi Site Collection Mode: Multi Site Collection Mode will append the list of source paths selected in the job configuration (source_filedirs) to the SharePoint Site URL (site_url) defined in the SharePoint system to get a list of multiple site collections to use for the job. Without Multi Site Collection Mode, if the SharePoint Site URL is https://tenant.com and the first source path is /sites/subsite1, the adapter will treat subsite1 as a folder (as opposed to a subsite) within the root site collection https://tenant.com. If Multi Site Collection Mode is selected, the adapter appends /sites/subsite1 to https://tenant.com to get the actual site collection to migrate from: https://tenant.com/sites/subsite1.

NOTE: Do not select this option until after Source Directories have been selected, or it will generate an error.

SHAREPOINT DOMAIN:  SharePoint domain used for NTLM authentication requests.  Leave blank unless the domain for NTLM authentication is different from your SharePoint site.

SHAREPOINT USERNAME:  Getting your SharePoint site connected is generally the biggest challenge that customers encounter in a SharePoint migration.  For best results, enter a username in this format if it is valid for your site:  username@domain.com.  If this is not valid, try username@domain.

SHAREPOINT PASSWORD:  Enter the password you use to log into the network.

Sub-site Root Directory: Sub-site root directory is a way to add an extra directory in the virtual file system tree that comes out of SharePoint. Its default (empty string) is to not add a spacer path component. If you enter a string such as subsites in this field, and you have a subsite subsite1 and a document library Documents selected on the source, the resulting source paths reported on analysis will be /subsites/subsite1 and /Documents. So essentially, this option will prepend the designated string to the reported source paths for selected subsites, but not to selected document libraries.

Updated on January 21, 2021

Related Articles