SharePoint Connector 1.0.0.3
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 through 1.0.0.3 of the SharePoint Connector.
Changes in Version 1.0.0.3
-
Uploading large files with the Redwood_SharePoint_Upload_File Job Definition no longer results in an out-of-memory error.
-
Uploading and downloading empty files is now possible using an Microsoft Entra (Azure AD) Connection.
-
If you have an Microsoft Entra (Azure AD) Connection, and you try using the Redwood_SharePoint_Move_Item Job Definition to move a file to a folder that already contains a file with the same name, the Overwrite option is now respected.
Prerequisites
- RunMyJobs 9.2.9 or later.
- Connection Management Extension 1.0.0.2 or later. Note that the Connection Management Extension will be installed or updated automatically if necessary when you install this Connector.
- A SharePoint Connection.
- Azure Connections 1.0.0.2 or later.
- Privileges Required to Use Azure Connections.
- Privileges Required to Use SharePoint.
- A Job Server with the RedwoodScript ScriptService service.
Contents
| Object Type | Name |
|---|---|
| Folder | 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
|
Setup
To install the SharePoint Connector and create a connection to SharePoint:
-
To install the SharePoint Connector, click its tile in the Catalog, select the version you want, and then click Install <version number>.
-
Create a SharePoint Connection.
Process Definitions
Redwood_Sharepoint_Delete_Item
Lets you delete a file or folder from a SharePoint site.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | SHAREPOINT_CONNECTION
|
SharePoint Site Connection | The SharePoint Connection object that contains the authentication information for the desired SharePoint site. | String | In |
|
|
| Parameters | DRIVE
|
Document Library | The Document Library containing the item that will be deleted. Available document libraries will be enumerated in the dropdown list if an Azure AD connection is selected. For remaining connection types, you must type the document library name. | String | In |
|
|
| Parameters | DIR_PATH_TO_DELETE
|
Folder Path | The path, relative to the selected source document library, to the directory that will be deleted (if file name is not specified) or contains the file to be deleted (if file name is specified). | String | In |
|
|
| Parameters | FILE_NAME_TO_DELETE
|
File Name | The name of the file to delete. This will be appended to the Folder Path parameter to construct the relative path to the file. If this field is omitted, the entire directory will be deleted. |
String | In |
|
|
| Parameters | RECURSIVE
|
Recursive | Recursive directory deletion. If set to true, deleting of non-empty directories is allowed. If set to false and a non-empty directory is specified, the deletion will fail with an error. | String | In | false | true, false |
Redwood_Sharepoint_Download_File
Download a file from a SharePoint site.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | SHAREPOINT_CONNECTION
|
SharePoint Site Connection | The SharePoint Connection object that contains the authentication information for the desired SharePoint site. | String | In |
|
|
| Parameters | DRIVE
|
Document Library | The Document Library containing the file that will be downloaded. Available document libraries will be enumerated in the dropdown list if an Azure AD connection is selected. For remaining connection types, you must type the document library name. | String | In |
|
|
| Parameters | FROM_PATH
|
Folder Path | The relative path, inside the selected document library, of the folder containing the file that will be downloaded. | String | In |
|
|
| Parameters | FROM_FILENAME
|
File Name | The name of the file that will be downloaded. | String | In |
|
|
| Parameters | TO_FILENAME
|
Downloaded File Name | Optional filename for the downloaded file. If not set, the original filename will be kept. | String | In |
|
|
| Parameters | DOWNLOADED_FILE
|
Downloaded File | The downloaded file. | File | Out |
|
|
Redwood_Sharepoint_Move_Item
Lets you move a file or folder to a different location on a SharePoint site.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | SHAREPOINT_CONNECTION
|
SharePoint Site Connection | The SharePoint Connection object that contains the authentication information for the desired SharePoint site. | String | In |
|
|
| Parameters | SOURCE_DRIVE
|
Source Document Library | The Document Library containing the file that will be moved. Available document libraries will be enumerated in the dropdown list if an Azure AD connection is selected. For remaining connection types, you must type the document library name. | String | In |
|
|
| Parameters | SOURCE_FOLDER
|
Source Folder | The source path, relative to the selected source document library, of the file or directory that will be moved. | String | In |
|
|
| Parameters | FILE_NAME
|
File Name | The name of the file to move. If left empty, then the folder specified in the Source Folder parameter will be moved. | String | In |
|
|
| Parameters | TARGET_DRIVE
|
Target Document Library | The Document Library the file or folder will be moved to. Available document libraries will be enumerated in the dropdown list if an Azure AD connection is selected. For remaining connection types, you must type the document library name. | String | In |
|
|
| Parameters | TARGET_FOLDER
|
Target Folder | The path, relative to the selected target document library, of the Target folder to move the specified file or folder to. | String | In |
|
|
| Parameters | OVERWRITE
|
Overwrite | Specifies whether an existing file with the same name at the destination be overwritten. Folders cannot be overwritten. The process will fail if a folder is being moved and one with the same name already exists in the target directory. | String | In | false | true, false |
| Parameters | CREATE_MISSING_DIRECTORIES
|
Create Missing Directories | If this is set to true and the destination path does not yet exist, all missing directories in the path will be created. Otherwise the move process will fail with an error. | String | In | false | true, false |
| Parameters | OUT_URL
|
URL of the destination file/directory | The URL of the destination file/directory. | String | Out |
|
|
Redwood_Sharepoint_Upload_File
Lets you upload a file to a SharePoint site.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | SHAREPOINT_CONNECTION
|
SharePoint Site Connection | The SharePoint Connection object that contains the authentication information for the desired SharePoint site. | String | In |
|
|
| Parameters | FROM_FILE
|
File to Upload | File to upload to SharePoint server. | File | In |
|
|
| Parameters | DRIVE
|
Document Library | The Document Library where the file will get uploaded. Available document libraries will be enumerated in the dropdown list if an Azure AD connection is selected. For remaining connection types, you must type the document library name. | String | In |
|
|
| Parameters | TO_DIRECTORY_PATH
|
Target Folder | Destination path, relative to the selected document library, of the directory the file gets uploaded to. | String | In |
|
|
| Parameters | TO_FILENAME
|
Uploaded File Name | Optional filename for the uploaded file. If not set, the original filename will be kept. | String | In |
|
|
| Parameters | OVERWRITE
|
Overwrite Existing File | If set to true, any existing file with the same name in the target directory will be overwritten by this upload. If set to false, the upload will fail if a file with the same name already exists in the target directory. | String | In | `false` | true,false |
| Parameters | CREATE_MISSING_DIRECTORIES
|
Create Missing Directories | If this is set to true and a file should be uploaded to a directory that does not yet exist, then all missing directories in the path will be created. Otherwise the upload will fail with an error if any part of the path is missing. | String | In | `false` | true,false |
| Parameters | OUT_URL
|
URL of the uploaded file | The URL of the uploaded file. | String | Out |
|
|