SSIS SharePoint Online Connector

SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!
You can use this connector to integrate REST API data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Video Tutorial - Read SharePoint Online data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for SharePoint Online integration in SSIS
  • How to configure connection for SharePoint Online
  • How to Read data from SharePoint Online
  • Features about SSIS API Source
  • Using SharePoint Online Connector in SSIS

Step-By-Step: How to read from SharePoint Online in SSIS (Export data)

In this section we will learn how to configure and use SharePoint Online Connector in the API Source to extract data from the SharePoint Online.

  1. Prerequisite: you must have downloaded and installed SSIS PowerPack. Check Getting started section for more information.

  2. Begin with opening Visual Studio and creating new SSIS package Project.

  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox.
    SSIS Data Flow Task - Drag and Drop

  4. Double click on the Data Flow Task to see Data Flow designer.

  5. From the SSIS toolbox drag and drop API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled SharePoint Online Connector from Popular Connector List or press Search Online radio button to download SharePoint Online Connector. Once downloaded simply use it in the configuration:

    SharePoint Online
    SharePoint Online Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Steps to get SharePoint Online Credentials

    Firstly, login into Azure Portal and there create an OAuth application:

    1. Go to Azure Portal and login there.
    2. Then go to Azure Active Directory.
    3. On the left side click menu item App registrations
    4. Then proceed with clicking New registration.
    5. Enter a name for your application.
    6. Select one of Accounts in this organizational directory only as supported account type to access data in your company.
    7. In Redirect URI section leave option selected at Web.
    8. In nearby textbox enter https://login.microsoftonline.com/common/oauth2/nativeclient as Redirect URI or any other valid redirect URL, e.g. https://zappysys.com/oauth
    9. Use this Redirect URI in Redirect URL grid row.
    10. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
    11. Then click on Endpoints link and copy first URL to Authorization URL and second one to Token URL in configuration grid. Usually they look similar to these:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
      • https://login.microsoftonline.com/common/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/common/oauth2/v2.0/token
    12. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
    13. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
    14. Use these scopes in Scopes field: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All openid profile Sites.Read.All Sites.ReadWrite.All User.Read email
    15. Click Generate Token to generate tokens.
    16. That's it!
    For more information you can read this link https://docs.microsoft.com/en-us/graph/auth-register-app-v2 Also https://docs.microsoft.com/en-us/graph/auth-register-app-v2

    API Reference (External Site)

    SharePoint Online
    User Credentials [OAuth]
    https://graph.microsoft.com/v1.0
    Required Parameters
    Authorization URL Fill in the parameter...
    Token URL Fill in the parameter...
    Client ID Fill in the parameter...
    Scope Fill in the parameter...
    SiteId (Select after Generate Token) Fill in the parameter...
    Optional Parameters
    Client Secret Fill in the parameter...
    ReturnUrl Fill in the parameter...
    Login Prompt Option Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - SharePoint Online
    SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!
    API Source - Select Endpoint

  10. That's it; we are done. In a few clicks we configured the call to SharePoint Online API using ZappySys SharePoint Online Connector

Video Tutorial - Write or lookup data to SharePoint Online using SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for SharePoint Online integration in SSIS
  • How to configure connection for SharePoint Online
  • How to Write or lookup data to SharePoint Online
  • Features about SSIS API Destination
  • Using SharePoint Online Connector in SSIS

Step-By-Step: How to write or lookup to SharePoint Online in SSIS (Import data)

In upper section we learned how to read data, now in this section we will learn how to configure SharePoint Online in the API Source to Post data to the SharePoint Online.

  1. Prerequisite: you must have downloaded and installed SSIS PowerPack. Check Getting started section for more information.

  2. Firstly, open Visual Studio and create a new SSIS Package Project.

  3. Now, drag and drop SSIS Data Flow Task from SSIS Toolbox.
    SSIS Data Flow Task - Drag and Drop

  4. Double click on the Data Flow Task to see Data Flow Designer view.

  5. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  6. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  7. Select New Connection to create a new connection:

    API Destination - SharePoint Online
    SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!
    API Destination - New Connection

  8. Use a preinstalled SharePoint Online Connector from Popular Connector List or press Search Online radio button to download SharePoint Online Connector. Once downloaded simply use it in the configuration:

    SharePoint Online
    SharePoint Online Connector Selection

  9. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Steps to get SharePoint Online Credentials

    Firstly, login into Azure Portal and there create an OAuth application:

    1. Go to Azure Portal and login there.
    2. Then go to Azure Active Directory.
    3. On the left side click menu item App registrations
    4. Then proceed with clicking New registration.
    5. Enter a name for your application.
    6. Select one of Accounts in this organizational directory only as supported account type to access data in your company.
    7. In Redirect URI section leave option selected at Web.
    8. In nearby textbox enter https://login.microsoftonline.com/common/oauth2/nativeclient as Redirect URI or any other valid redirect URL, e.g. https://zappysys.com/oauth
    9. Use this Redirect URI in Redirect URL grid row.
    10. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
    11. Then click on Endpoints link and copy first URL to Authorization URL and second one to Token URL in configuration grid. Usually they look similar to these:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
      • https://login.microsoftonline.com/common/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/common/oauth2/v2.0/token
    12. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
    13. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
    14. Use these scopes in Scopes field: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All openid profile Sites.Read.All Sites.ReadWrite.All User.Read email
    15. Click Generate Token to generate tokens.
    16. That's it!
    For more information you can read this link https://docs.microsoft.com/en-us/graph/auth-register-app-v2 Also https://docs.microsoft.com/en-us/graph/auth-register-app-v2

    API Reference (External Site)

    SharePoint Online
    User Credentials [OAuth]
    https://graph.microsoft.com/v1.0
    Required Parameters
    Authorization URL Fill in the parameter...
    Token URL Fill in the parameter...
    Client ID Fill in the parameter...
    Scope Fill in the parameter...
    SiteId (Select after Generate Token) Fill in the parameter...
    Optional Parameters
    Client Secret Fill in the parameter...
    ReturnUrl Fill in the parameter...
    Login Prompt Option Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  10. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - SharePoint Online
    SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!
    API Destination - Select Endpoint

  11. Finally, map the the desired columns:

    API Destination - SharePoint Online
    SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!
    API Destination - Columns Mapping

  12. That's it; we successfully configured the POST API Call. In a few clicks we configured the SharePoint Online API call using ZappySys SharePoint Online Connector

Conclusion

In this article we discussed how to connect to SharePoint Online in SSIS and integrate data without any coding. Click here to Download SharePoint Online Connector for SSIS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Documentation 

Actions supported by SharePoint Online Connector

SharePoint Online Connectors support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Read Main Site
 List Sites
 List Drives
Parameter Description
SiteId Specify a site
 Read Drive
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Folders
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Files
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List Excel Files
Parameter Description
SiteId Specify a site
DriveId Specify a drive
 List SharePoint Lists
Parameter Description
SiteId Specify a site
 List SharePoint System Lists
Parameter Description
SiteId Specify a site
 Read List Fields
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
Expand
 Read List
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Read List Items
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Read List Items (Dynamic Columns)
Use this endpoint if you face issue with NULl values in some columns. This endpoint scans metadata from few sample rows and decides datatypes. Use this if other endpoing showing null values for Complex datatypes (e.g. Lookup, Location, Person)
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Read List Item (By ID)
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id (Record ID)
 Create List Item
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
 Update List Item
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id
 Delete List Item
Parameter Description
SiteId Specify a site
ListId Specify a list id to search items for
ListItemId Specify a list item id
 List Excel Worksheets
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id to search items in
FileId Specify a drive Id to search items in
 Read Excel Worksheet
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
SheetId Specify a sheet name
Range
 Download File as a column field
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Download File to disk
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Delete File from Sharepoint Site
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
FileId Specify a file id
 Upload File
Parameter Description
SiteId Specify a site
DriveId Specify a drive Id
DiskFilePath Specify a disk file path
SharePointFilePath Specify target file path
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for SharePoint Online

Other API Connectors for SSIS


Documentation 

  • How to connect SharePoint Online in SSIS?

  • How to get SharePoint Online data in SSIS?

  • How to read SharePoint Online data in SSIS?

  • How to load SharePoint Online data in SSIS?

  • How to import SharePoint Online data in SSIS?

  • How to pull SharePoint Online data in SSIS?

  • How to push data to SharePoint Online in SSIS?

  • How to write data to SharePoint Online in SSIS?

  • How to POST data to SharePoint Online in SSIS?

  • Call SharePoint Online API in SSIS

  • Consume SharePoint Online API in SSIS

  • SharePoint Online SSIS Automate

  • SharePoint Online SSIS Integration

  • Integration SharePoint Online in SSIS

  • Consume real-time SharePoint Online data in SSIS

  • Consume realtime SharePoint Online API data in SSIS

  • SharePoint Online ODBC Driver | ODBC Driver for SharePoint Online | ODBC SharePoint Online Driver | SSIS SharePoint Online Source | SSIS SharePoint Online Destination

  • Connect SharePoint Online in SSIS

  • Load SharePoint Online in SSIS

  • Load SharePoint Online data in SSIS

  • Read SharePoint Online data in SSIS

  • SharePoint Online API Call in SSIS