SharePoint Item Actions (Beta)

Configuration Notes

1. File Upload

The component supports direct and chunked uploads. The upload method is selected based on the configured Small Upload Limit (MB).

a. Files within the limit use a single-request upload.
b. Files exceeding the limit use a chunked upload session.
c. The Chunk Size (MB) value must be a multiple of 320 KB.

2. Folder Downloads

Folder downloads are subject to the following limits:

a. Maximum Total Size: 10 MB.
b. Maximum File Count: Controlled by the Max Folder Download File Count parameter. Set it to 0 to remove the file-count restriction.

3. Handling Existing Items

The Rename on Conflict setting determines how the component handles an item with the same name at the destination.

Enabled: Renames the incoming item to avoid a name conflict.
Disabled: Allows the existing item to be overwritten.

For Move and Copy operations, New Name specifies the name of the destination item.

4. Location Resolution

The Input Location and Destination Location parameters accept a supported SharePoint path or full SharePoint URL to identify the source or destination item.

Supported path formats may include:

a. Full SharePoint URL: The complete URL of a file or folder.
b. Site-relative path: For example, /sites/Finance/Shared Documents/report.pdf.
c. Short or relative path: For example, /Shared Documents/, where supported.

The Default Drive ID identifies the SharePoint document library when required. The component can resolve the drive automatically for supported full URLs and site-relative paths. If the component cannot resolve a short or relative path, provide the Drive ID associated with the intended document library.

Examples

Example 1: Upload a File

1. Select UploadFile as the operation.
2. Configure the Authentication Token.
3. Specify the file to upload using File Paths (Data/DataFrame), File Paths (Select Files), File Path, or Content (Base64), as applicable.
4. Enter the destination folder in Destination Location.
5. Configure Rename on Conflict and other applicable upload parameters.
6. Execute the component and verify the result.

Example 2: Download a File

1. Select Download as the operation.
2. Configure the Authentication Token.
3. Enter the SharePoint file path or full URL in Input Location.
4. Configure Default Drive ID if required to resolve the location.
5. Execute the component and verify the returned result.

How to Retrieve the SharePoint Drive ID

Follow these steps to retrieve the Drive ID of a SharePoint document library.

Steps

1. Open the required SharePoint site in a web browser and sign in if prompted. https://<your-tenant>.sharepoint.com/sites/<your-site-name>

2. Enter the following URL in the browser’s address bar, replacing the tenant and site name with the appropriate values: https://<your-tenant>.sharepoint.com/sites/<your-site-name>/_api/v2.0/drives

Press Enter to retrieve the JSON response containing the available document libraries.

3. Locate the required document library by checking its name property.

4. Identify the corresponding id property. This value represents the Drive ID of the document library.

5. Copy the Drive ID and use it in the relevant SharePoint operations.

Example

The JSON response may contain the following details:

{
“id”: “b!xYZ123abc…456DEF”,
“name”: “Documents”,
“driveType”: “documentLibrary”
}

In this example, b!xYZ123abc…456DEF is the Drive ID for the Documents library.

Note: A SharePoint site can contain multiple document libraries. Ensure that you copy the ID associated with the required library.

Tool Mode

Tool Mode enables the SharePoint Item Actions component to expose its supported SharePoint file and folder operations as tools for an Agent. Based on the task requirements, the Agent can select and invoke one or more available actions during execution.