Skip to main content

Microsoft SharePoint Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

The Microsoft SharePoint Reader is a data integration tool that enables seamless extraction and interaction with data from Microsoft SharePoint, including documents, lists, and libraries. It provides easy access to SharePoint content for integration, reporting, and analytics, streamlining workflows and enhancing data connectivity.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

✓

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication method

The Microsoft SharePoint Reader supports connecting to SharePoint using basic authentication. To connect, you must obtain the SharePoint URL, which may be a site collection URL or an individual (subsite) URL, and the Windows user and password credentials.

Obtaining the SharePoint URL

The SharePoint URL is the web address of your SharePoint site or site collection. There are two types of URLs you may need:

  • Site Collection URL: This URL provides access to the entire site collection, including all sub-sites (if available). To find this URL open the SharePoint Admin Center (or ask your administrator if you don't have access). The Site Collection URL will be listed in the Site Collections section. It's often something like https://<company-name>.sharepoint.com, or you may have a custom domain, like https://teams.<company-name>.com.

  • Individual Site URL: If you are connecting to a specific site within the SharePoint site collection, use the URL of that site. Navigate to the specific site you need to access within SharePoint. Copy the URL from the browser's address bar. It will look like https://<company-name>.sharepoint.com/sites/<site-name> or similar.

Obtaining the Windows credentials

Windows authentication requires a Windows user and password associated with your domain credentials.

  • Windows user (domain username): when logged into a Windows machine, open Command Prompt and type the command whoami. This command returns your current logged-in user in the format DOMAIN\username.

  • Windows password: The password associated with your Windows domain account. Used to log into your computer or access corporate resources.

Supported objects

The Microsoft SharePoint Reader can read the following supported objects from SharePoint:

  • Attachments

  • Comments

  • Files

  • Groups

  • Lists

  • ListItems

  • RoleAssignmentMember

  • RoleAssignments

  • RoleDefinitionBindings

  • Roles

  • Subsites

  • Users

Microsoft SharePoint Reader properties

Property

Type

Default value

Notes

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.

URL

String

The URL for the SharePoint service you are connecting to.

Username

String

The SharePoint user's account name.

Password

Password

The password for the SharePoint user.