Update Entity Record – setting fields of the current record¶
The command "Update Entity Record" sets fields of the current record, as if a user had typed the values. This page is for administrators who build actions that change records.
1. At a glance¶
| Purpose | Change fields of the current record |
| Typical use | Set a status, stamp a date, fill fields of a record just created |
| Where in the editor | Toolbar menu "Data" → "Update Entity Record" |
| Needs a user interface | No |
| Needs a current record | Yes |
| Related | Update Related Record, Save, Create Entity Record |
2. Settings¶
Like every command, the command has "Display Name", "Description" and "Execution Condition" on the tab "General" (see Actions). The tab also has:
| Setting | Meaning | Default / Required |
|---|---|---|
| "Save" | Saves the record right after the fields were set | Off |
The fields are on the tab "Set Fields". Each entry ("Value Templates") sets one field:
| Part | Meaning |
|---|---|
| "Field" | A field of the entity the command works on – the entity the editor shows for the command |
| "Clear Value" / "Set Value" | Empty the field, or set it to the value |
| "Value" | Expression for the value, evaluated against the current record. For fields with a list of valid values, the editor offers them as quick values. |
| "Append" | Adds the value to the end of what the field already holds, as text, instead of replacing it |
The command always works on the entity of the current record at its place in the action – after a Create Entity Record "Invoice", the fields of the invoice are offered.
3. Behaviour¶
- Without a current record, or if the entity of the command is unknown, the action ends (without an error).
- All value expressions are evaluated first, against the current record before any field is set. A value that reads another field of the same record sees its old value.
- The fields are set in the order of the entries. Business rules that react on changed fields (calculations, validations, rules that start actions in the user interface) run as for a user typing. Fields that do not belong to the entity are skipped.
- Open forms are drawn again.
- With "Save", the record is saved. If the save is rejected, the user sees the reasons and the action ends with an error (see Save).
Without "Save", the values stay unsaved until a later save. In a background run they are lost if nothing saves them.
4. Examples¶
Close a ticket.
| "Field" | Mode | "Value" |
|---|---|---|
| Status | "Set Value" | "Closed" |
| Closed on | "Set Value" | today |
| Closed by | "Set Value" | current user |
| Reopen reason | "Clear Value" | – |
"Save" on.
Add a line to a log field. "History" with "Set Value", "Append" on and a value that starts with a line break, followed by the date and "Escalated to level 2". Each run adds a line.
5. Limitations¶
- "Append" joins texts. For numbers, compute the sum in the value expression instead.
- Edit limits of the user's roles are not checked for values set by an action (see Actions – permissions).
- Values computed from the same record use the state before the command. To use a value the command sets, use a second Update Entity Record.