spRenameDocument Step
Description:
This step renames a SharePoint document.
Inputs
- BaseURL – BaseURL for ur Sharepoint site
- selOAuthProvider - select OAuth Provider
- documentPath –Path of the document to be renamed
- renamedTo – rename the document to
- resultJson – store result in Variable or Global
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “spRenameDocumentDef” example.
- Create a new definition called “spRenameDocumentDef.”
- Select the definition and click the “design” button
- Drag a “spRenameDocument” step to the canvas
- Connect the dots between the start and “spRenameDocument” step
- Define a variable/global to store the file path and the result after execution
- Click the "spRenameDocument" step to configure its "Settings" properties. Provide a name to the step. Provide a description. Provide a base URL for the SharePoint site. Select SharePoint provider from the dropdown list. Select the document with the folder path to be renamed.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the process definition, create a new process instance, and execute. Render the process instance. Click on the process step to view its properties. The step should rename the document as configured.