Task Factory SharePoint

Connection Manager

SharePoint Connection Manager

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.

Connection Settings

Task Factory Sharepoint Connection Connection Settings

OptionDescription
Server URLURL of the SharePoint server.
DeploymentYou have two options for the deployment:

  • Premise
  • Online
User NameThe user name of the SharePoint server.
PasswordPassword for the server.
TimeoutTime in seconds before the connection times out if the connection fails.

Proxy Settings

Task Factory Sharepoint Connection Proxy Settings

OptionDescription
Use ProxySelecting 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

SharePoint Documents Task

Task IconTask Description
Task Factory Sharepoint Documents Task IconThe 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.

Task Factory Sharepoint Documents Task

OptionDescription
ConnectionSelect an existing or create a new SharePoint Documents Connection Manager.
Task ModeThere are four modes in which you can use the SharePoint Documents Task:

  • Upload File - Upload a single file to the documents list.
  • Download File - Download a single file to the documents list.
  • Upload Directory - Upload a directory of files from the local machine to a SharePoint documents lists.
  • Download Directory - Download a list of documents from a SharePoint documents list.
Check out / Check in fileWhen 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 ListThe SharePoint list that is used in this task. Must be a documents list.
SP Document PathThis 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 DirectoryThe local directory or path in which to download or upload files from or to.
SharePoint Source

SharePoint Source

Source IconSource Description
Task Factory Sharepoint Source IconThe 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.

Task Factory Sharepoint Source

OptionDescription
Select ConnectionSelect an existing SharePoint Connection Manager or choose to create a new one.
Select ListOnce 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 AttachmentsEnabling 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 SubfoldersChoosing this option shows the subfolders that are part of a documents list in the result set.
Include Hidden ColumnsChoosing this option retrieves data from all of the columns of a list / view.
Remove ID's from ResultsChoosing this option removes identifier data from columns that contain both the identifier and text data of a column.
Step
  • Choose Columns - This tab is used to choose which columns from the source are part of the output from the SharePoint Source.
  • Filter & Preview Rows - The filter control allows the user to create custom filters on the data returned from the server.

Filter

Task Factory Sharepoint Source FilterUsers 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.

Task Factory Sharepoint Source Filter Use Advanced Caml Editor

OptionDescription
Query CAMLThe Sharepoint Source allows users to configure Collaborative Application Marchup Language. CAML is similar to XML and used to perform query operations on lists.

Note:  : Users must surround their queries with <Query></Query> tags.
Query Options CAMLUsers can add options to their CAML queries.

Note:  : Users 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 .

SharePoint Destination

SharePoint Destination

Destination IconDestination Description
Task Factory Sharepoint Destination IconThe 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.

Task Factory Sharepoint Destination

OptionDescription
ConnectionSelect an existing connection manager or choose to create a new one.
Destination ListChoose the destination list from the drop down menu, this is where the data is sent.
ActionOnce a list is chosen, you may select from three actions:

  • Create - This action creates rows in the selected list
  • Update - This action updates rows in the selected list.
  • Delete - This action deletes rows in the selected list.
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.