Description:

The Set Document Properties workflow step updates a document's properties in a SharePoint site using the specified SharePoint site URL, OAuth provider, document path, and payload.

The step supports:

• Specifying the BaseURL for the SharePoint site.
• Selecting an OAuth provider for authentication.
• Specifying the path to the document whose properties are being accessed or updated.
• Providing raw payload data containing the document property information.
• Storing the result returned by the operation in a FlowWright Variable or Global.
• Routing the workflow through True or False return paths based on the step result.

The step is categorized as a SharePoint process step. It is implemented by FlowWright.Workflow.dll and uses the FlowWright.Workflow.SpSetDocProperties namespace.

Usage:

The Set Document Properties step is typically used when a FlowWright workflow needs to update or set properties associated with a document stored in SharePoint.

A typical workflow pattern is:

The step requires the SharePoint BaseURL, OAuth provider, document path, and result destination. Payload data can be supplied when required.

The result can then be stored in a FlowWright Variable or global variable and used by later workflow activities.

The step uses the configured SharePoint site and OAuth provider to perform the operation against the specified document path. The operation result is stored in the configured Variable or Global.

To use this step, SharePoint should be configured with Flowwright OAuth connections.

A sample SharePoint OAuth configuration is provided here for reference.

Typical Workflow Suggestions.

Update Document Properties After Upload

Use the step after a document has been uploaded to SharePoint when additional document properties need to be set.

This pattern can be useful when document creation and property assignment are separate operations in the workflow.

Set Metadata After Document Classification

Use Set Document Properties after a workflow has determined information that should be associated with a SharePoint document.

The workflow can prepare the property payload based on information obtained during earlier processing.

Update Properties After Approval

A document workflow can update SharePoint properties after an approval activity completes.

For example, the workflow can perform its SharePoint property operation after an approval stage.

Document Lifecycle Processing

Use the step as part of a document lifecycle workflow.

This provides a defined point in the workflow where SharePoint document properties can be updated.

Set Properties Based on Workflow Data

Use workflow Variables or Globals to prepare information that is incorporated into the payload before the Set Document Properties step executes.

This approach keeps data preparation separate from SharePoint operations.

Handle SharePoint Operation Results

Use the True and False paths to provide different processing for successful and unsuccessful operations.

The step's XML explicitly defines the two return values.

Store and Use the Operation Result

Store the result in a Variable or Global and use it in subsequent workflow processing.

The resultJson property is specifically provided for storing the result in a Variable or Global.

Example:

Let’s build and execute the “spSetDocPropertiesDef” example.          

• Create a new process definition called “spSetDocPropertiesDef” and open the definition in designer mode. 
• Drag a “spSetDocProperties” step to the canvas.
• Connect the dots between the “Start” and “spSetDocProperties” steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, additional values are available for configuration. 
• Define a variable or a global variable to store the result. 
• Click the "spSetDocProperties" 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 list. Provide the path to retrieve file properties on the SharePoint site. 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. 

• Click the "spSetDocProperties" step to configure its "Optional" properties. Enter the raw JSON payload. Click the Save button. 

• 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, and execute it. Render the process instance. The process step should set the document properties on the SharePoint site to the configured values.

Tips:

• Provide the correct BaseURL for the SharePoint site.
• Select the appropriate OAuth provider configured for the SharePoint integration.
• Verify the document file path before executing the workflow.
• Use Define Payload raw data when the operation requires property information to be supplied in the payload.
• Do not assume a payload schema from the XML definition; use the schema supported by the FlowWright SharePoint integration.
• Store the operation result in a meaningful FlowWright Variable or Global.
• Use the True and False return paths to provide explicit success and failure handling.
• Test the configured SharePoint authentication before using the step in a production workflow.
• Verify that the configured document path identifies the intended SharePoint document.
• Keep payload preparation separate from the SharePoint operation when the property data is assembled dynamically during the workflow.
• Use meaningful Variable and Global names for stored results to make downstream workflow activities easier to understand.

Notes:

• The step belongs to the SharePoint category. 
• The display name is Set Document Properties. 
• The step name is spsetdocproperties.
• The step uses the FlowWright.Workflow.SpSetDocProperties namespace.
• The step is implemented by FlowWright.Workflow.dll. 
• The step is defined as a Process step.
• The definition specifies two input connections and two output connections. 
• BaseURL is required.
• Select OAuth provider is required.
• Document file path is required.
• Payload raw data is optional.
• Storing the result in a Variable/Global is required. 
• The OAuth provider property uses the SelOAuthProvider data type. 
• The payload property uses the multilineTextBox data type. 
• The step provides True and False return values. 
• The XML does not define the exact payload schema.
• The XML does not define the exact SharePoint URL or document-path syntax.
• The XML does not specify the runtime conditions that produce the True or False result.
• The XML does not document handling of authentication failures, SharePoint API errors, retries, timeouts, or other runtime behavior. Such behavior should be verified against the applicable FlowWright implementation/documentation.

Recommended Workflow Pattern:

A useful pattern for the Set Document Properties step is to separate document identification, property preparation, SharePoint property updating, and subsequent workflow processing.

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: When importing or adapting the definition, verify the SharePoint configuration and workflow connections before execution.

Click here to download the sample file.