If you need to upload files from SSIS to SharePoint Online, the ZappySys SharePoint Online Connector for SSIS gives you a direct way to configure the connection, authenticate, and send files without building the API calls from scratch.

This guide shows how to upload one file or multiple files to SharePoint Online using SSIS, API Source, and supporting SSIS components.

Upload files to SharePoint Online with SSIS

In this section, you will configure the SharePoint Online Connector in API Source and use it to upload files to SharePoint Online.

1. Begin by opening Visual Studio and creating a new project.
2. Select Integration Service Project and in the new project window set the appropriate name and location for the project. Click OK.
3. In the new SSIS project screen you will find the following:
   1. SSIS ToolBox on the left sidebar
   2. Solution Explorer and Property Window on the right bar
   3. Control flow, data flow, event Handlers, Package Explorer in tab windows
   4. Connection Manager Window at the bottom
   

   SSIS Toolbox – ZappySys Tasks

   NOTE: If you don’t see ZappySys SSIS PowerPack Task or Components in the SSIS Toolbox, please refer to this help link.
4. Drag and drop the SSIS Data Flow Task from the SSIS Toolbox. Double-click on the Data Flow Task to see the Data Flow Designer.
   
5. From the SSIS Toolbox, drag and drop API Source (Predefined Templates) onto the Data Flow Designer surface, then double-click it to edit it:
   
6. Select New Connection to create a new connection:
   

Configuring the SharePoint Online Connector

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

   SSIS ZS API Connection Manager – Select SharePoint Online Connector

2. Select the desired authentication type. Then choose the API Base URL. In most cases, the default value is correct. Fill in the required parameters and add optional parameters only when needed.
3. After configuring the required properties in API Connection Manager, click Test Connection to confirm that the connection works.
   

   Method 1: Connect to SharePoint Online using user credentials [OAuth]

   Use the Steps to Configure link to help set the required parameters.

   

   SSIS ZS API Connection Manager – Generate Token – SharePoint Online with User Credentials

   Method 2: Connect to SharePoint Online using application credentials [OAuth]

   Use the Steps to Configure link to help set the required parameters.

   

   SSIS API Source – Generate Token – SharePoint Online with Application Credentials

How to upload a local file to SharePoint Online

In the API Source Component, we’ve chosen the API Connection Manager. Next, we need to configure the remaining properties of the component to upload a local file to SharePoint Online.

1. Choose the Upload file endpoint from the “Select Table/Endpoint” dropdown menu.
2. Select the desired Drive ID from the DriveId drop-down.
3. Specify the desired source file path for the file being uploaded by setting the DiskFilePath parameter.
4. Specify the desired Target Path by setting the SharePointFilePath parameter.

Please refer to the sample screenshot below.

SSIS API Source – SharePoint Online – Upload Single File

After configuring the properties above, click Preview Data to test the API call. At this point, the SharePoint Online Connector is ready to upload a local file from SSIS.

How to upload multiple files to SharePoint Online

In the API Source Component, we’ve selected the API Connection Manager. Next, we need to configure the remaining properties of the component to upload multiple files to SharePoint Online. Additionally, we should utilize a Foreach Loop Container to iterate through each file one by one in a loop.

1. Create 3 SSIS variables as described below.
   

   Variable Name	Datatype	Value
   varFileLists	Object	System.Object
   varFileName	String	fake.extension
   varFullFilePath	String	C:/fake/fake.extension

2. Go to Control Flow, From the SSIS toolbox drag and drop ZS Advanced File System Task on the control flow designer surface, and double click on it to edit it:
   
3. Select the “Get file list as ADO.NET Data Table” action from the Action drop-down menu. Set the file path in the Path textbox. Choose the variable (Object type) where you want to store the file list, and then click the OK button to save the settings.
   

   SSIS Advanced File System Task – Get file list as ADO.net Data Table

4. Now, drag and drop the “Foreach Loop Container” from the SSIS Toolbox and connect it with the “ZS Advanced File System Task.” Double-click on the “Foreach Loop Container” to edit its properties.
   

   SSIS Foreach Loop Container – Drag & Drop

5. In the Foreach Loop Editor’s “Collection” tab, choose the Enumerator as “Foreach ADO Enumerator.” In the “ADO object source variable” field, select your SSIS object-typed variable. Select the “Rows in the first table” radio option.
   

   SSIS Foreach Loop Editor – Collection – Select Variable & Enumeration mode

6. In the Foreach Loop Editor’s “Variable Mappings” tab, select the variables that you want to map to the values from the collection, and then click the “OK” button to save your selections.
   

   SSIS Foreach Loop Editor – Variable Mappings

7. Inside the Foreach Loop Container, drag and drop the Data Flow Task, and then rename it according to your preference.
   

   SSIS Data Flow Task – Drag & Drop inside Foreach Loop Container

8. Double-click on the Data Flow Task to see the Data Flow Designer, From the SSIS Toolbox, drag and drop API Source (Predefined Templates) onto the Data Flow Designer surface, then double-click it to edit it:
   
9. Double-click on the API Source component to configure it for uploading multiple files to SharePoint Online.
   1. Choose the Upload file endpoint from the “Select Table/Endpoint” dropdown menu.
   2. Set the SharePointFilePath parameter to the SSIS variable that contains the file name, such as varFileName.
   3. Set the DiskFilePath parameter to the SSIS variable that contains the local file path, such as varFullFilePath.
      When configuring the SSIS variable directly in the Raw Edit, JSON may become invalid due to the requirement of slashes within the local file path. To address this, we use a JSONENC Placeholder Function for proper escaping.
      

      <<{{User::varUserFullFilePath}},FUN_JSONENC>>

   4. If you wish to upload the local file to a specific folder in SharePoint Online, please set the folderName in the SharePointFilePath parameter.

   Please refer to the sample screenshot below.

   

   SSIS API Source – SharePoint Online – Upload Multiple files configuration

   To configure dynamic filenames and file paths, you can set variables. Click on “Raw Edit,” and in the “Edit Parameters” popup, you can use SSIS variables, as shown in the above image.

   Once you have configured all the mentioned properties above, please click on the “Preview Data” button to initiate the API call.
   After that, execute the SSIS package and confirm that the files are uploaded to SharePoint Online. The screenshot below shows a sample result.

   

   Multiple files uploaded on SharePoint Online using SSIS

   You have now configured the SharePoint Online Connector to upload multiple files from SSIS.

Conclusion

In this guide, you learned how to connect to SharePoint Online using SSIS API Connection Manager and upload one or many files using the SSIS API Source component, SSIS ZS Advanced File System Task, Foreach Loop Container, and SSIS variables.

Frequently Asked Questions

Can I upload more than one file to SharePoint Online from SSIS

Yes. You can use a Foreach Loop Container with SSIS variables and ZS Advanced File System Task to iterate through a file list and upload files one by one.

What is the easiest way to upload files to SharePoint Online from SSIS

The simplest approach is to use the SharePoint Online Connector for SSIS, because it provides ready-made authentication and upload endpoints inside the ZappySys connector interface.

Which component uploads the files

The upload action is configured in API Source by selecting the Upload file endpoint and setting values such as DriveId, DiskFilePath, and SharePointFilePath.

Next step

If you want to build this workflow in your own SSIS package, download SSIS PowerPack and review the SharePoint Online Connector guide.

The post How to upload files on SharePoint Online using SSIS appeared first on ZappySys Blog.

In today’s data-driven world, the ability to seamlessly integrate and transfer files between different platforms is crucial for efficient business operations. If you’re a user of SQL Server Integration Services (SSIS) and looking to integrate SharePoint Online into your data workflow, you’re in luck. ZappySys SSIS PowerPack offers a powerful SharePoint Online Connector that makes downloading files from SharePoint Online a breeze. In this guide, we’ll walk you through the process of downloading files from SharePoint Online using SSIS and the ZappySys SSIS PowerPack SharePoint Online Connector.

Download files from SharePoint Online with SSIS:

In this section, we will learn how to configure and use SharePoint Online Connector in the API Source & API Destination to download files from SharePoint Online.

1. Begin with opening Visual Studio and Creating a New Project.
2. Select Integration Service Project and in the new project window set the appropriate name and location for the project. Click OK.
3. In the new SSIS project screen you will find the following:
   1. SSIS ToolBox on the left sidebar
   2. Solution Explorer and Property Window on the right bar
   3. Control flow, data flow, event Handlers, Package Explorer in tab windows
   4. Connection Manager Window at the bottom
   

   SSIS Toolbox – ZappySys Tasks

   NOTE: If you don’t see ZappySys SSIS PowerPack Task or Components in the SSIS Toolbox, please refer to this help link.
4. Now, Drag and Drop the SSIS Data Flow Task from the SSIS Toolbox. Double-click on the Data Flow Task to see the 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:
   
6. Select New Connection to create a new connection:
   

Configuring the SharePoint Online Connector

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

   SSIS ZS API Connection Manager – Select SharePoint Online Connector

2. 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.
3. After configuring all the required properties in the API Connection Manager, please click on the “Test Connection” button to confirm that the connection is established successfully.
   

   Method1: Connect to SharePoint Online using User Credentials [OAuth]

   You may press a link Steps to Configure which will help set certain parameters.

   

   SSIS ZS API Connection Manager – Generate Token – SharePoint Online with User Credentials

   Method2: Connect to SharePoint Online using Application Credentials [OAuth]

   You may press a link Steps to Configure which will help set certain parameters.

   

   SSIS API Source – Generate Token – SharePoint Online with Application Credentials

How to download a single file from SharePoint Online

In the API Source Component, we’ve chosen the API Connection Manager. Next, we need to configure the remaining properties of the component to download the single file from SharePoint Online.

1. Choose the Download file endpoint from the “Select Table/Endpoint” dropdown menu.
2. Please choose DriveId from the drop-down menu.
3. Please set the FileId that indicates which file you wish to download. This is an essential parameter for the download process.
4. Please set the local folder’s physical path which indicates the desired file being downloaded by setting the TargetFilePath parameter.
5. If you intend to replace the local file with the one being downloaded, please select the ‘AlwaysOverwrite‘ option from the dropdown menu labeled ‘FileOverwriteMode‘. Alternatively, you can choose ‘FileIfExists’ or ‘SkipIfExists’ based on your specific needs.

Please refer to the sample screenshot below.

SSIS API Source – SharePoint Online – Download Single File

Once you have configured all the mentioned properties above, please click on the “Preview Data” button to initiate the API call. With just a few clicks, we have successfully configured the call to SharePoint Online using the ZappySys SharePoint Online Connector for downloading a Single file from SharePoint Online.

How to download multiple files from SharePoint Online

In the API Destination Component, we have chosen the API Connection Manager. Now, we must proceed to configure the remaining properties of the component to facilitate the download of multiple files from SharePoint Online. Additionally, we should make use of an OLE DB Source and Derived Column component to map the files for the download process.

1. Drag and drop the OLE DB Source Component from the SSIS Toolbox. Double-click on the OLE D B Source Component to initiate its configuration.
   

   OLE DB Source – Drag and Drop

2. Create a new OLE DB Connection Manager and configure your SQL Server settings for the connection. Next, select the Data access mode, specify the name of the table or view, or write an SQL Command. Afterward, click on the ‘Preview’ button to view a preview and check the ‘Columns’ tab for the source columns.
   

   SSIS OLE DB Source – Configure SQL Connection and fetch the table data

3. Next, drag and drop the Derived Column Component from the SSIS Toolbox. Double-click on the Derived Column Component to begin its configuration.
   

   Drag and drop the Derived Column

4. Now, add a new Derived Column by setting the expression to concatenate FilePath and FileName. Click ‘OK’ to save the configuration.
   

   SSIS Derived Column – Add New Column and Set Expression

5. Now, drag and drop the API Destination Component from the SSIS Toolbox. Double-click on the API Destination Component to begin its configuration.
   

   Drag and Drop the SSIS API Destination Component

6. Double-click on the API Destination component to configure it for downloading multiple files from SharePoint Online.
   1. Choose the Download file endpoint from the “Select Table/Endpoint” dropdown menu.
   2. Please specify the ‘FileOverwriteMode’ option as ‘AlwaysOverwrite,’ or you can choose ‘FailIfExists’ or ‘SkipIfExists’ options based on your requirements.
      Please refer to the sample screenshot below.
      

      SSIS API Destination Component – Configure Settings Tab to download Files from SharePoint Online

   3. Now, go to the Mappings tab and specify the source columns with the corresponding target properties.
      Note: Here We’re mapping FileID with $$Id and FileNameWithPath with $$ResponseDataFile. You can create mappings based on your Source columns
      Please refer to the sample screenshot below
      

      SSIS API Destination Component – Configure the Mappings Tab to download multiple files from SharePoint Online

7. Once you have configured all the mentioned properties above, please click on the “Preview Data” button from the Settings tab to initiate the API call. With just a few clicks, we have successfully configured the call to SharePoint Online using the ZappySys SharePoint Online Connector for downloading multiple files from SharePoint Online.
   Please refer to the sample screenshot below.
   

   Download Multiple files from SharePoint Online

Conclusion

In this blog, we learned how to connect with SharePoint Online using SSIS API Connection Manager and download single or multiple files from SharePoint Online using a combination of SSIS components, including the SSIS API Source component, SSIS API Destination component, OLE DB Source component, and Derived Column component.

The post How to download files from SharePoint Online using SSIS appeared first on ZappySys Blog.