Microsoft SharePoint

Version 0.0.1

📘

Check out the API docs here for more information.

Set up


Source

To get set up you will just need your SharePoint username and password. You will also need to make sure this user has access to the files you are looking to ingest.

Extract

The Sharepoint connector has 13 different reports, allowing you to pull CSV and XLSX file types, either from your private OneDrive folders, or your shared sites (Sharepoint). If you are extracting an XLSX file you can either choose an all sheets report which will ingest data from every sheet in the XLSX file or a single sheet report where the name of the sheet must be specified in the 'Sheet Name' input field.

⬇️ Report✏️ Description📄 Link to API endpoint
OneDrive CSV FileRetrieves the specified CSV file from OneDriveGet OneDrive CSV File
OneDrive CSV FolderRetrieves all CSV files from the specified folder within OneDriveGet OneDrive CSV Folder
OneDrive XLSX FileRetrieves any sheet with the specified sheet name from the specified XLSX file within OneDriveGet OneDrive XLSX File
OneDrive XLSX File All SheetsRetrieves all sheets from the specified XLSX file within OneDriveGet OneDrive XLSX File All Sheets
OneDrive XLSX FolderRetrieves any sheet with the specified sheet name from any XLSX file from the specified folder within OneDriveGet OneDrive XLSX Folder
OneDrive XLSX Folder All SheetsRetrieves all sheets from any XLSX file from the specified folder within OneDriveID
Sharepoint CSV FileRetrieves the specified CSV file from SharepointGet Sharepoint CSV File
Sharepoint CSV FolderRetrieves all CSV files from the specified folder within SharepointGet Sharepoint CSV Folder
Sharepoint XLSX FileRetrieves any sheet with the specified sheet name from the specified XLSX file within SharepointGet Sharepoint XLSX File
Sharepoint XLSX File All SheetsRetrieves all sheets from the specified XLSX file within SharepointGet Sharepoint XLSX File All Sheets
Sharepoint XLSX FolderRetrieves any sheet with the specified sheet name from any XLSX file from the specified folder within SharepointGet Sharepoint XLSX Folder
Sharepoint XLSX Folder All SheetsRetrieves any sheet with the specified sheet name from any XLSX file from the specified folder within SharepointGet Sharepoint XLSX Folder All Sheets
Sharepoint XLSX RangeSee detailed explanation belowGet Sharepoint XLSX Range

🚧

All Sheets - Column Structure

If you select an all sheets XLSX report, then the column structure of all sheets must be identical.

If the 'Headers Included' checkbox is ticked the first row of each file will always be considered the column headers. If it is not ticked the column headers will be numbered.

OneDrive

To pull either an entire folder or a single file, you will first need to know the path.

If your file is within 1 folder, then your path will be <folder_name>/<file_name>, if your file is not within a folder, then your path will be <file_name>.

For the example file below (file.csv), the path would be folder/file.csv

317

🚧

Folders - File Structure

If you are extracting multiple files within a folder, then the file structure of each file must be identical.

Sharepoint

To pull individual files from shared sites (SharePoint), you will need the following details. Some of the details you can get from the URL when you are on your shared sites in your browser. E.g. if this is the URL: https://benminorodata.sharepoint.com/sites/Test then your base URL is benminorodata.sharepoint.comand your site is Test.

  • Base URL - As above
  • Site - As above
  • Base Folder - This will be the base folder, in which the file sits, which is usually visible from the left-hand side menu when you are on the site home page. See below. e.g. Documents, or docs
464
  • Path - This would be the path to the file from the base folder. E.g. Book.xlsx or folder_name/file.csv

📘

Ingesting an entire folder

If you are looking to ingest an entire folder, you can just add the path to that folder instead of the file name. When this option is selected, the extract will look for all xlsx or csv files within that folder and will ingest them.

The file structure of each file will have to be the same as everything will go into 1 destination table.

If you file sites within your base folder, and within another folder called January, then the file name is data.csv, then your path would be January/data.csv


Following on from the example given above for SharePoint, consider the same SharePoint space:

https://benminodata.sharepoint.com/sites/Test

Where the base folder will Documents and the path as Example/test_files.

Below is example for the test_files folder containing .xlsx files, as well as how to connect to just one .xlsx file within that same folder. Be sure to select the Report as either SharePoint XLSX Folder or SharePoint XLSX File depending on your use case.


949

The case is nearly identical when working with .csv files, where instead the Report in the extract is selected as either SharePoint CSV folder or SharePoint CSV File.


811

Range report

For the XLSX Range report, you can provide the specific range of cells you are looking to pull from a specified sheet. E.g. for the following range, you will sheet A1:C4 as the range.

536

You can also provide columns to exclude if you have PII in your worksheets. To do this, simply provide a comma-separated list of columns. e.g. Col1,Col2.

Limitations


  • For XLSX files all sheets will either be ingested or the first sheet with the specified sheet name
  • For XLSX all sheet reports the order of the columns is taken from the first sheet so all subsequent sheets must match this order.
  • If any of your column headers surpasses the maximum character threshold for column headers in your warehouse the column headers will be truncated. This threshold is 255 and 157 for Snowflake and Redshift respectively.