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:
To use this step, configure SharePoint with Flowwright OAuth connections.
A sample SharePoint OAuth configuration is included here for reference.
Example:
Let’s build and execute the “spRenameDocumentDef” example.
- Create a new definition called “spRenameDocumentDef" and open the definition in designer mode.
- Drag a “spRenameDocument” step to the canvas.
- Connect the dots between the “Start” and “spRenameDocument” steps, as shown above.
- Define a variable or a global to store the file path and the result.
- Click the "spRenameDocument" step to configure its "Required" properties. Provide a name for the step. Provide the base URL for your SharePoint site. Select the SharePoint OAuth provider from the dropdown. Provide the document folder path to rename and the new name. Provide a variable or a global reference to store the result. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 instance, execute it, and then render the process instance. The process step should rename the document on the SharePoint site as configured.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the import process steps for any missing configurations, such as file path references and database connections. Then, save the definition to confirm the changes.
Click here to download the sample file.