This connector is used to communicate with Microsoft SharePoint document libraries. SharePoint allows users to share files easily with each other via document libraries, also known as drives. A single site can contain multiple drives that can each contain both files and folders. The Cleo SharePoint connector supports creating directories and uploading and downloading files.
The SharePoint connector only supports Application Client authentication. For this, the user must configure an application that has the ability to access the SharePoint site in Azure AD. For more information, see Configuring an Azure application for Sharepoint Connector. During setup the 'TenantId', 'ApplicationId', and 'ApplicationSecret' properties must be obtained and set in the connector.
The path to files and folders must be in the format
hostname:siteName/driveName/fileOrFolder. Please note that root sites will have only the hostname and not an additional site name. In this case, the path would be
The hostname and site name can be found in two different ways:
- If a Directory Listing is performed without specifying
hostname:site, available sites are listed and the path of the desired site can be used.
- This information can be found in the web URL for the SharePoint site itself. If the URL for my SharePoint site is
https://test.sharepoint.com/sites/MySite, the hostname is
test.sharepoint.com, and the site name is
MySite. If the URL looks like
https://test.sharepoint.com/, it is the root site and no site name should be supplied.
If a Root Path is configured in the SharePoint properties tab, only resources located below this path are available to traverse. All paths in actions should be a continuation of the Root Path. For example, if the root path is set to
hostname:siteName, all actions must include the
driveName in the path, for example,
driveName/myFile.txt. This allows the user to traverse multiple drives within the same connector host.
If the Root Path is not configured, the full path must always be specified in actions. This allows the user to traverse multiple different sites and drives in actions.
- Directory Listings are the only operations that can be performed without specifying
- Performing a listing without specifying
hostname:siteNamewill list available sites.
- Performing a listing where 'hostname:siteName' is specified but drive name is not will list available drives in that site.
- Renaming can be used to move files into different folders and even to different drives and sites as long as the Root Path property allows access to those resources.
- SharePoint allows deletion of folders that are not empty. Please be careful when deleting directories to avoid unintended deletions.
SharePoint Connector Properties
|TenantId||The ID of the tenant||Yes|
|ApplicationId||The Application ID of the registered application|
|ApplicationSecret||The secret for the registered application||Yes|
|RootPath||The root path to use. This should be in the format
|Command Retries||The number of times the command should be retried when an error or exception occurs.
Valid range: [0-5].
|Command Retry Delay||The number of seconds to wait between retries.
Valid range: [0-120].
|Do Not Send Zero Length Fies||For PUT, a switch that indicates to not send a fife if it is zero-length.|
|Delete Received Zero Length Fies||For GET, a switch that indicates to remove a received file that is zero-length.|
|Retrieve Directory Sort||For PUT, the sorting options for the list of outbound files.|
|Enable Debug||A switch that indicates whether to perform debug logging.|
Please sign in to leave a comment.