Set field value
The Set Field Value can be used to set the value of a document field. In addition to standard fields, the rule can be used to set the system field status if statuses have been defined in the document definition.
The Set Field Value rule updates the document in the database immediately.
Availability
The rule can be added to:
- User actions
- Bulk actions
- Scheduled actions
- Rest actions
Properties
| Property | Required | Description |
|---|---|---|
| Label | No | A brief description of the rule. This description is visible in the list of rules and meant to distinguish similar rules from each other. |
| Description | No | A longer description of the rule. You can use this field to describe the purpose of the rule is. |
| Field | Yes | The field for which the value will be set when the rule is applied. |
| Value | Yes | The new value of the field. If you set the value of the status field, the value should correspond to the name of the new status. |
| Execute Only If | No | The condition that needs to be passed in order for this rule to execute. If this field is empty, the rule will always be executed. |
Note: The condition in the Execute Only If field is evaluated against the document in the database. This implies that changes that the rule makes are not taken into account when determining whether the rule should be executed.