SharePoint Connector

The SharePoint Connector lets you upload, download, move, and delete files on a SharePoint server.

Note: This topic is valid for versions 1.0.0.0, 1.0.0.1, and 1.0.0.2 of the SharePoint Connector.

Prerequisites

Version 9.2.9 or later.
Connection component 1.0.0.2 or later. Note that the Connections component will be installed or updated automatically if necessary when you install this extension.
Privileges Required to Use Azure Connections.
Privileges Required to Use SharePoint.
A Process Server with the RedwoodScript ScriptService service.

Object Type	Name
Application	`GLOBAL.Redwood.REDWOOD.SharePointUtilities`
Constraint Definition	`REDWOOD.Redwood_SharePointConnectionConstraint`
Constraint Definition	`REDWOOD.Redwood_SharePointDriveConstraint`
Extension Point	`REDWOOD.Redwood_SharePointUI`
Job Definition	`REDWOOD.Redwood_Sharepoint_Delete_Item`
Job Definition	`REDWOOD.Redwood_Sharepoint_Download_File`
Job Definition	`REDWOOD.Redwood_Sharepoint_Move_Item`
Job Definition	`REDWOOD.Redwood_Sharepoint_Upload_File`
Library	`REDWOOD.Redwood_SharePoint`

Upload a file to a SharePoint server.

Name	Description	Documentation	Values
`SHAREPOINT_CONNECTION`	SharePoint Site Connection	Connection created with the Connections.
`FROM_FILE`	File to Upload	File type parameter with file Browser.
`DRIVE`	Document Library	SharePoint library to upload the file into.
`TO_DIRECTORY_PATH`	Target Folder	Target path in SharePoint.
`TO_FILENAME`	Uploaded File Name	Target file name in SharePoint.
`OVERWRITE`	Overwrite Existing File	If a file exists, do you want to overwrite the file? Note that with SharePoint history, you can restore files.	`true` - overwrite file `false` - raise an error if the file already exists
`CREATE_MISSING_DIRECTORIES`	Create Missing Directories	If the path does not exist in SharePoint, would you like to create the missing folders in the path?	`true` - creates the missing folders `false` - raise an error if a folder is missing
`OUT_URL`	URL of the uploaded file	The URL to the uploaded file (Out parameter).

Download a file from a SharePoint server.

Name	Description	Documentation
`SHAREPOINT_CONNECTION`	SharePoint Site Connection	Connection created with the Connections.
`DRIVE`	Document Library	SharePoint library to download the file from.
`FROM_PATH`	Folder Path	Source folder to download the file from.
`FROM_FILENAME`	File Name	File name on the SharePoint server.
`TO_FILENAME`	Downloaded File Name	File name of the downloaded file.
`DOWNLOADED_FILE`	Downloaded File	The downloaded file (Out parameter).

Delete a file on a SharePoint server.

Name	Description	Documentation
`SHAREPOINT_CONNECTION`	SharePoint Site Connection	Connection created with the Connections.
`DRIVE`	Document Library	SharePoint library to download the file from.
`DIR_PATH_TO_DELETE`	Folder Path	Folder to download the file from.
`FILE_NAME_TO_DELETE`	File Name	File name on the SharePoint server.
`RECURSIVE`	Recursive	Delete files recursively

Move a file on a SharePoint server.

Name	Description	Documentation	Values
`SHAREPOINT_CONNECTION`	SharePoint Site Connection	Connection created with the Connections.
`DRIVE`	Source Document Library	SharePoint library to download the file from.
`SOURCE_FOLDER`	Source Folder	Source path in SharePoint.
`FILE_NAME`	File Name	Source file name in SharePoint.
`TARGET_DRIVE`	Target Document Library	Target SharePoint library to copy the file to.
`TARGET_FOLDER`	Target Folder	Target path in SharePoint to copy the file to.
`OVERWRITE`	Overwrite	If the path does not exist in SharePoint, would you like to create the missing folders in the path?	`true` - creates the missing folders `false` - raise an error if a folder is missing
`CREATE_MISSING_DIRECTORIES`	Create Missing Directories	If the path does not exist in SharePoint, would you like to create the missing folders in the path?	`true` - creates the missing folders `false` - raise an error if a folder is missing
`OUT_URL`	URL of the destination file/directory	The URL to the moved file (Out parameter).

To install the SharePoint Connector and create a connection to SharePoint:

Locate the SharePoint Connector in the Catalog and install it. All dependencies will be installed automatically.
Navigate to Custom > Connections and click .
Choose SharePoint Connection under Select a Connection Type.
Choose Next or Basic Properties and create a Queue and Process Server for the Connection. All required settings will be configured automatically.
Choose Next or Security, then specify which roles can access the connection information.
Choose Next or SharePoint Connection Propertiesand enter the site URL in the Site URL field.
Do one of the following things.
- (Recommended) Select SharePoint App-Only from the Connection Type dropdown list and enter values in the Client ID, Tenant ID, and Client Secret fields.
- Select SAML in Connection Type and enter values in the Username and Password fields.
- Create an Azure AD Connection that uses certificate authentication. Then, select Azure AD Connection and choose the Azure AD Connection from the Azure AD Application dropdown list.
Click Save & Close.