Skip to content

Invalidate Relationships – reading related records again

The command "Invalidate Relationships" makes the current record forget the related records it has loaded, so that the following commands and the form read them again. This page is for administrators whose actions change related records in ways the current record does not notice.

1. At a glance
Purpose Read related records of the current record again
Typical use After a called action, a background step or an API call created or changed related records
Where in the editor Toolbar menu "Data" → "Invalidate Relationships"
Needs a user interface No
Needs a current record Yes
Related Refresh, quick action "Invalidate Relationships"

2. Settings

The settings are on the tab "General", below "Display Name", "Description" and "Execution Condition" (see Actions).

Setting Meaning Default / Required
"Relationships" The relationships of the current record's entity whose related records are read again. Several can be selected. Inactive while "Invalidate All" is on. Required unless "Invalidate All"
"Invalidate All" All relationships the current record has loaded Off

3. Behaviour

  1. Without a current record, the command is skipped.
  2. For every selected relationship that the current record has already loaded, the loaded related records are dropped. Relationships that were not loaded yet are left alone – they are read fresh anyway.
  3. The next command, expression or form that needs the related records reads them again.

Related records that were added and not saved yet are kept.

4. Example

Show the documents a sub-action created. A button on "Contract" runs Execute Action "Generate documents", which creates "Document" records through its own queries and saves them. Afterwards Invalidate Relationships with "Relationships" "Contract → Documents" makes the related items grid of the contract show the new documents.

5. Limitations

  • The fields of the current record itself are not read again – use Refresh for that.