Task Factory users running version 2020.1.4 or older (released prior to May 27, 2020): There's an important Task Factory update. Please visit here for more details.
Note: Task Factory supports SharePoint versions 2010 through 2019.
The SharePoint Connection Manager is used to set up a connection to a SharePoint server. Used with SharePoint Source and SharePoint Destination. The SharePoint Documents Task requires the similar SharePoint Documentation Connection Manager.
|Server URL||URL of the SharePoint server.|
|Deployment||You have two options for the deployment:|
|User Name||The user name of the SharePoint server.|
|Password||Password for the server.|
|Timeout||Time in seconds before the connection times out if the connection fails.|
|Use Proxy||Selecting this allows you to connect through a proxy.|
Note: If checked you must fill in the proxy information located below the check box.
SharePoint Documents Task
|Task Icon||Task Description|
|The SharePoint Documents Task gives you the ability to upload and download documents from a SharePoint documents list in SSIS. See the SharePoint Connection Manager to learn more about setting up the connection manager.|
|Connection||Select an existing or create a new SharePoint Documents Connection Manager.|
|Task Mode||There are four modes in which you can use the SharePoint Documents Task:|
|Check out / Check in file||When selected, the file(s) are marked as Checked Out when downloaded from or Checked In when uploaded to Sharepoint to the account executing the package.|
|Documents List||The SharePoint list that is used in this task. Must be a documents list.|
|SP Document Path||This is the document subfolder in which to upload / download documents from, or the full path in which to download a file from. Selecting the ellipsis (...) opens the SharePoint Documents Browser.|
|Local File Path / Local Directory||The local directory or path in which to download or upload files from or to.|
|Source Icon||Source Description|
|The SharePoint Source is used to retrieve data from a SharePoint object within an SSIS package. See the SharePoint Connection Manager to learn more about setting up the connection manager.|
|Select Connection||Select an existing SharePoint Connection Manager or choose to create a new one.|
|Select List||Once your connection manager is set, choose a list from your SharePoint server.|
|Select View (optional)||Choose the view to use for the chosen list.|
|Download Attachments||Enabling this option allows users to download files as attachments within lists. Select the ellipsis in its corresponding window to define the destination path for the file.|
|Include Subfolders||Choosing this option shows the subfolders that are part of a documents list in the result set.|
|Include Hidden Columns||Choosing this option retrieves data from all of the columns of a list / view.|
|Remove ID's from Results||Choosing this option removes identifier data from columns that contain both the identifier and text data of a column.|
Users can begin configuring filters by selecting the + beside the word And. Column filters are configured by selecting the blue hyperlink column name (e.g. [Start Time].) Operators are configured by selecting the green operator selector (e.g. Is greater than or equal to.)
Use Advanced Caml Editor
Selecting the Use Advanced Caml Editor option enables the Query CAML and Query Options CAML windows.
|Query CAML||The Sharepoint Source allows users to configure Collaborative Application Marchup Language. CAML is similar to XML and used to perform query operations on lists.|
Note: You must surround queries with <Query></Query> tags.
|Query Options CAML||Users can add options to their CAML queries.|
Note: You do not need to add the opening and closing query options tag in the query options editor.
Additional Information: For more information about using CAML, please see this Query schema MSDN article .
|Destination Icon||Destination Description|
|The SharePoint destination is used to send data to a SharePoint object within an SSIS package. See the SharePoint Connection Manager to learn more about setting up the connection manager.|
|Connection||Select an existing connection manager or choose to create a new one.|
|Destination List||Choose the destination list from the drop down menu, this is where the data is sent.|
|Action||Once a list is chosen, you may select from three actions:|
|Batch Size||Set the batch size, limited to 200.|
| Map SharePoint Destination Columns||Once your destination is selected you can map the Input and Destination columns.|
Additional Information: See the Task Factory Error Row Handling article for more information about this functionality.