spMoveDocument Step
Description:
This step moves a SharePoint document from one location to another.
Inputs
- BaseURL – Base URL for your SharePoint site
- selOAuthProvider - select OAuth Provider
- sourceDocPath – Source Path of the document to be moved
- destinationDocPath - Destination Path of the document to be moved
- 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 “spMoveDocumentDef” example.
- Create a new definition called “spMoveDocumentDef”
- Select the definition and click the “design” button
- Drag a “spMoveDocument” step to the canvas
- Connect the dots between the Start and “spMoveDocument” step
- Define a variable/global to store the file path and the result after execution
- Click the "spMoveDocument" step to configure its "Settings" properties. Provide a name to the step. Provide a description. Provide a base URL to the SharePoint site. Select an oAuth provider from the dropdown list. Select the SharePoint provider dropdown values coming from the connection menu. The oAuth setting must be configured with SharePoint oAuth parameters to get authorization. Provide the source file path of the document to be moved. Provide the destination file path. Provide a variable/global to store the result after execution.
- 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 move a SharePoint document from one location to another.