The Set Business Object Properties workflow step sets properties on a specified Business Object using a mapped set of property parameters.

The step identifies the Business Object and provides the property mappings to be applied to it.

The step supports:

• Setting properties on a Business Object.
• Mapping multiple Business Object properties.
• Supplying property values through the FlowWright Business Object property mapping interface.
• Updating Business Object information during workflow execution.
• Using workflow data to populate Business Object properties.
• Returning a True or False result.

This step can be used for:

• Updating Business Object records.
• Populating Business Object properties from workflow Variables.
• Updating object information after an approval or decision.
• Synchronizing workflow data with Business Objects.
• Applying calculated workflow results to Business Objects.
• Preparing Business Objects for subsequent workflow processing.
• Maintaining Business Object information as part of an automated workflow.

Usage:

The Set Properties step is typically placed after workflow activities have collected, calculated, or modified information that needs to be applied to a Business Object.

The workflow supplies:

• The name of the Business Object.
• The property mappings to apply.

Typical workflow pattern:

Collect Data → Set Properties → Continue Processing

For example:

Approval Task → Set Properties → Notify Customer

The approval result can be mapped to Business Object properties before the workflow proceeds to notification or subsequent processing.

The step can also be used to synchronize workflow data with an existing Business Object.

Typical Workflow Suggestions:

Update a Customer After Approval

Use the step after an approval task to update the corresponding Customer Business Object.

Example:

Approval Task → Set Properties → Send Notification

Potential mappings:

• Status → Approved
• ApprovalDate → workflow date
• ApprovedBy → approver information

This ensures the workflow result is reflected in the Business Object.

Update an Order Status

Use Set Properties to update an order after it has been processed.

Example:

Process Order → Set Properties → Complete

For example:

Business Object: Order
Status: Processed

Populate Business Object Properties from Form Data

Use form values to populate or update Business Object properties.

Example:

Form Submission → Set Properties → Continue

Potential mappings include:

• Customer name.
• Address.
• Contact information.
• Request type.
• Status.

This pattern allows information captured through a workflow form to be applied to the corresponding Business Object.

Apply Calculated Values

Use the step after performing workflow calculations.

Example:

Calculate Total → Set Properties → Continue

For example:

Order.TotalAmount = CalculatedTotal

This is useful when Business Object information depends on workflow calculations.

Synchronize Workflow and Business Object Data

Use Set Properties to synchronize information generated during workflow execution with a Business Object.

Example:

Retrieve Data → Transform Data → Set Properties → Continue

The workflow can retrieve information from another source, transform it, and then apply the resulting values to the Business Object.

Update Multiple Properties

The BoProps mapping is designed to map Business Object properties, allowing multiple related properties to be supplied through the property-mapping configuration.

Example:

Collect Customer Data → Set Properties → Continue

Potential mappings:

Name       → CustomerName
Email      → EmailAddress
Type       → CustomerType
Status     → CustomerStatus

Update a Business Object After a Decision

Use a decision to determine what values should be applied.

Example:

Evaluate Request → Set Properties → Continue

For example:

If approved:
    Status = Approved

If rejected:
    Status = Rejected

Update a Business Object Before Notification

Use Set Properties before sending a notification so that the Business Object contains the latest workflow information.

Example:

Process Request → Set Properties → Send Notification

This can ensure that downstream activities and users see the updated Business Object information.

Maintain Processing Information

Use Business Object properties to record workflow processing information.

Example:

Process Record → Set Properties → Continue

Potential properties include:

• ProcessingStatus
• ProcessedBy
• ProcessedDate
• ReferenceNumber

This can provide a Business Object record of workflow activity.

Update After External Integration

Use the step after an external integration returns information that needs to be reflected in a Business Object.

Example:

External System → Process Response → Set Properties → Continue

For example:

ExternalStatus Returned by the integration can be mapped to a Business Object status property.

Success and Failure Handling

Use the two return paths to distinguish successful Business Object property updates from unsuccessful execution.

Example:

Set Properties → True → Continue Processing

** ↳ False → Log Failure / Retry / Notify Administrator**

The XML explicitly provides True and False return values.

To use this step, we need business objects configured in FlowWright Business Objects.

We must define the configured Business object in the Process Definition. On the Process Designer page, select Actions > Manage Business Objects > Add.

Example:

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

• Create a new process definition named “setBoPropertiesDef” and open it in designer mode.
• Drag a “setBOProperties” step to the canvas. 
• Connect the dots between the “Start” and “setBOProperties” 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.
• Click the “setBOProperties” step to configure its “Required” properties. Provide a name for the step and the name of the business object defined in the process definition. Click the button to set the business object’s values, then click Save. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

• Click the button to set the values for the business object. Click the Add Row button to insert an empty row. Enter the property name and value. Click the Save button. You may add multiple params to the business object by using the Add Row button.  

• The “Logging” configuration is necessary for documentation and to measure workflow progress and percent complete. This is done 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. When the workflow reaches the Set Properties step, FlowWright uses the specified Business Object and supplied property mappings to set the Business Object properties. The workflow then follows the True or False return path according to the execution result.

• Click the process step to view the properties > Business Objects. The step should set the business object's properties.

Tips:

• Verify the Business Object name before configuring the step.
• Ensure that the specified Business Object exists in the target FlowWright environment.
• Configure all required property mappings before executing the workflow.
• Use meaningful workflow Variable names when supplying property values.
• Make sure the supplied values are appropriate for the corresponding Business Object properties.
• Keep related Business Object property mappings together where practical.
• Verify that required Business Object properties have appropriate values.
• Test the workflow with representative Business Object data.
• Test each property mapping independently when troubleshooting.
• Verify the Business Object after the workflow executes to confirm that the expected properties have been updated.
• Use the True path for successful processing.
• Use the False path for appropriate error handling.
• Consider logging the Business Object and relevant property values when troubleshooting.
• Test the workflow after importing the Process Definition into another environment.
• Verify that the target environment contains the same Business Object configuration.
• Do not assume that a property exists simply because it exists in another environment.
• Confirm the data requirements of individual Business Object properties before mapping workflow values to them.
• Use descriptive property mappings to make the workflow easier to maintain.
• If several properties are updated together, document their relationship and purpose.
• Test behavior when the Business Object cannot be resolved.
• Test behavior when an individual property value is invalid.
• Test the workflow's False path rather than assuming the update will always succeed.
• Avoid relying on undocumented behavior for invalid properties, missing values, or other Business Object errors.

Notes:

• The Set Properties step is defined in the Business Objects category with the internal name setboproperties, label “Set business object properties”, and display name “Set properties.”
• The step is implemented by FlowWright.Workflow.SetBOProperties in FlowWright.Workflow.dll and is a Process step with 2 incoming connections and 2 outgoing connections.
• The XML defines two configurable properties, both of which are required.
• The two properties are:
  • boName – Name of the business object
  • boProps – Parms to the business object 
• The boName property uses the string data type, implemented by FlowWright.DataTypes.ClsTextBox.
• The boProps property uses the BoProps data type, implemented by FlowWright.DataTypes.BoProps, which is described as “Map business object properties.”
• The step provides two predefined return values: False and True.

Feature Comparison:

Both SetBOProperties and SetBODynamicProperties are FlowWright Business Objects process steps used to set properties on a business object. Their XML definitions are almost identical: both accept a business object name and a BoProps property mapping, and both provide True/False return paths. The primary distinction is the nature of the parameter set they pass to the business object: standard properties versus dynamic properties.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes. 

Click here to download the sample file.