updateDBFieldValue Step
Description:
The Update Record Value workflow step updates a specified field in a database table for a record identified by a WHERE clause that matches the specified field and value.
Unlike workflow steps that update FlowWright variables or globals, this step targets a database record directly. It requires a database connection, a table name, a field name, a new field value, and the field/value used to identify the record to be updated.
The step supports:
- Updating a database field from a workflow
- Selecting a configured database connection
- Optionally connecting to a different database
- Specifying the target table
- Specifying the field to update
- Providing the new field value
- Identifying the target record using a WHERE field and value
- True and False return paths
Inputs
- connectionString – Required database connection used by the step.
- Connect to different database – Optional value for connecting to a different database.
- Name of the table – Required name of the database table containing the record to update.
- Name of the field – Required name of the field whose value should be updated.
- Field value – Required new value to assign to the specified field.
- Name of the where field – Required field used to identify the database record to update.
- Value of the where field – Required value used with the WHERE field to identify the target record.
Returns
- True – True return path from the Update Record Value step.
- False – False return path from the Update Record Value step.
Usage:
The Update Record Value step is typically used when a workflow needs to modify information stored in an external database as part of a business process.
The workflow provides the target table, field, new value, and record-selection criteria.
For example, a workflow can:
- Update the status of a database record after an approval.
- Mark a record as processed after a workflow completes an operation.
- Update a customer or order field.
- Change a processing flag used by an external application.
- Update a database record after a human task is completed.
- Modify information in a database that is separate from the workflow's own variable data.
The record to be updated is identified using the Name of the where field and Value of the where field properties.
When the workflow reaches the Update Record Value step, the configured database record is targeted using the WHERE clause, and the specified field is updated with the supplied value.
Typical Workflow Suggestions
Update Status After Approval
Use the step to update the status of a database record after a workflow approval.
Example:
Submit Request → Approval → Update Record Value → Complete
For example, the workflow could update an order's status after the approval task is completed.
Mark a Record as Processed
Use Update Record Value to mark a database record as processed after a workflow operation.
Example:
Read Record → Process Record → Update Record Value → Complete
A processing field or status field can be updated to indicate that the workflow has completed its operation.
Update Customer Information
Use the step when workflow processing results in a change to customer information stored in an external database.
Example:
Capture Customer Update → Validate → Update Record Value → Notify Customer
Update Order Status
Use the step to synchronize an order's database status with the result of workflow processing.
Example:
Process Order → Update Record Value → Send Confirmation
The workflow can update the order record after the business process has completed.
External Application Synchronization
Use Update Record Value when FlowWright needs to communicate a status change to another application through a shared database.
Example:
Complete Workflow Activity → Update Record Value → External Application Processes Record
This can be useful when another application reads the updated database field as part of its own processing.
Update Processing Flags
Use the step to change a database flag that controls subsequent processing.
Example:
Validate Data → Update Record Value → External Process
The workflow can set a field indicating that the record is ready for another process.
Database-Based Workflow Completion
Use the step at the end of a workflow to persist the workflow outcome in an external database.
Example:
Complete Business Process → Update Record Value → End
This can provide an external system with the final processing status.
Example:
Let’s build and execute the “updateDBFieldValueDef” example.
- Create a new process definition called “updateDBFieldValueDef” and open the definition in designer mode.
- Drag an “updateDBFieldValue” step to the canvas.
- Connect the dots between the “Start” and “updateDBFieldValue” 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 “updateDBFieldValue” step to configure its “Required” properties. Provide a name for the step. Select the connection string from the drop-down list. Provide the table name. Provide the field name and the new value. Define the SQL search condition by referencing the field name and the corresponding criteria. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description.
- Click the “updateDBFieldValue” step to configure its “Optional” properties. If required, provide a different DB name (other than FlowWright) that matches the connection string. By default, the step connects to the FlowWright database. 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. Click the process step to view its properties. The step should update the DB field.
- For reference, the DB field value (External User Email) before the change is included here.
- For reference, the DB field value (External User Email) after the change is included here.
Tips:
- Select the correct Connection string before configuring the database operation.
- Verify the table name and field name carefully before executing the workflow.
- Make sure the WHERE field and WHERE value uniquely identify the intended record.
- Avoid using a WHERE criterion that could unintentionally identify multiple records.
- Use workflow variables or mapped values when the table, field, or values need to be determined dynamically.
- Test the update against representative data before deploying the workflow to production.
- Use meaningful step names such as “Update Order Status”, “Mark Record Processed”, or “Update Customer Status” to make the workflow easier to understand.
- Verify database permissions for the connection used by the step.
- Use Connect to different database when the operation needs to target a database other than the one represented by the selected connection configuration.
- Use the True and False return paths to handle successful and unsuccessful execution as appropriate.
Notes:
The UpdateDBFieldValue step is defined in the Database category with the internal name updatedbfieldvalue and display name Update record value.
The workflow step is implemented by the FlowWright.Workflow.UpdateDBFieldValue namespace in FlowWright.Workflow.dll and is defined as a Process step. It supports 2 incoming connections and 2 outgoing connections.
The step has seven configurable properties. Six are required: Connection string, Name of the table, Name of the field, Field value, Name of the where field, and Value of the where field. Connecting to a different database is optional.
The XML defines the database connection property using selectConnectString, described as “Get connection strings list.” The other properties use the string data type, described as “Get textbox.”
The XML does not expose properties for updating multiple fields in a single step. The configuration identifies one Name of the field and one Field value.
The XML also does not define an explicit expression property for this step. The available inputs are the connection, database, table, field, value, and WHERE-field criteria shown in the definition.
Feature comparison:
| Feature | UpdateVariable | UpdateGlobals | UpdateDBFieldValue |
|---|---|---|---|
| Category | Engine | Engine | Database |
| Display name | Update Variables | Update Globals | Update record value |
| Primary purpose | Update one or more workflow variables | Update one or more global values | Update a database field in a record |
| Scope of data | Process/workflow variables | Global values | External/database record |
| Multiple values in one step | Yes | Yes | No — one field per step |
| Variable/global selection | Update multiple variables |
Update multiple globals |
Not applicable |
| Single value name/value inputs | Yes | No separate name/value properties in XML | Yes — field name/value |
| Expression support | Yes | Yes | No explicit expression property |
| Database connection required | No | No | Yes |
| Table required | No | No | Yes |
| Field required | No | No | Yes |
| Record selection | Not applicable | Not applicable | Yes, using WHERE field/value |
| Different database support | Not applicable | Not applicable | Yes, via connection/database properties |
| Return paths | True / False | True / False | True / False |
| Incoming connections | 2 | 2 | 2 |
| Outgoing connections | 2 | 2 | 2 |
Definition Sample:
You may download a sample definition when provided and import it into your FlowWright Process Definition.
Note: Verify and complete any missing configuration after importing a sample, including:
- Connection string
- Database selection
- Table name
- Field name
- Field value
- WHERE field name
- WHERE field value
- Outgoing workflow connections
- Environment-specific database settings
After verifying the configuration, save the Process Definition before execution.
Click here to download the sample file.