Skip to main content
Version: 4.61.0

SharePoint On-Premise (2013, 2016, 2019) source connector

The SharePoint On-Premise source connector enables you to export content from a SharePoint On-Premise environment. The connector uses the SharePoint REST API to export the content.

Features​

  • Exporting content structure
  • Exporting custom fields
  • Exporting versions
  • Exporting binary content
  • Exporting access control lists (limited to 5000 per object)
  • Exporting users and groups (on tenant level)
note

This connector does not calculate source.ancestors. If this accelerator is used with the Transformation Accelerator, be sure to run the Calculate Ancestors flow before transformation.

Settings​

mongoConnection​

The Mongo connection string including the database name to connect to.

pageSize​

Specifies the page size number that is used when paginating.

Example: 500

suppressUnsupportedTypesWarnings​

Enables warnings being written to the console when the type of the folder is not supported. Can either be true or false.

retrieveVersions​

Enables retrieving all versions of an SharePoint document. When set to false only the current version is retrieved.

retrieveBinaries​

Enables downloading the binaries into the Content Store. Can either be true or false.

retrieveACLs​

Enables retrieving the ACLs of the SharePoint objects. Can either be true or false.

spUrl​

The base tenant URL to the SharePoint On-Premise environment.

Example: http://sp13.xillio.com

spUsername​

The SharePoint account used to export the content. This account should have site administrator access.

spPassword​

The password belongs to the used SharePoint account.

rootSites​

A list of root sites. It can be left empty if the entire tenant should be crawled.

Example: ["site1","site2/subSite"]

discardMetadata​

Cleans the source.properties object for all stored objects by removing default extracted metadata and unused properties.

Only a minimal set of metadata fields required by schemas and processing logic is retained.

Retained metadata per object type
Containers​

The default properties from the result stored in source.properties is reduced to:

const retainedNestedProperties = [
    // ACL-related
    "__metadata.id", // Required for ACL extraction on files/folders
    "ListItemAllFields.RoleAssignments", // Required for ACL extraction on files/folders
    "Properties.vti_x005f_listtitle", // Required to identify the parent list for ACL extraction
    "RoleAssignments.__deferred.uri", // Required to resolve ACLs

    // Hierarchy traversal
    "Files.__deferred.uri", // Required to traverse child files
    "Folders.__deferred.uri", // Required to traverse child folders
    "Webs.__deferred.uri", // Required to traverse child webs

    // Context-related
    "Properties.vti_x005f_listtitle", // Required to identify the parent list
];
Records​

The objectProperties object in source.properties is reduced to:

const retainedNestedRecordProperties = [
    // ACL-related
    "__metadata.id", // Required for ACL extraction on files/folders
    "ListItemAllFields.RoleAssignments", // Required for ACL extraction
    "Properties.vti_x005f_listtitle", // Required to identify the parent list for ACL extraction

    // Versioning
    "Versions.__deferred.uri", // Required to retrieve file versions
];
principals​

No metadata properties are retained.

ACLs​

No metadata properties are retained.

All non-default (custom) metadata is retained.

origin​

Specifies the origin of the document in the Content Store.