Add custom data to this execution

Where custom execution data is stored

Each run has its own execution. Custom data is a set of keys and values on that record, so you can tell which customer or which order this run was. The json a node outputs is still the data handed to the next node. Do not use one in place of the other.

Filtering the executions list by custom data requires a plan that includes it. Without that, the filter tells you to upgrade. Writing the values happens during the run.

Write it from a Code node

In a JavaScript Code node, use $execution.customData. Pass strings. Name keys after what you will filter on, such as a customer id or an environment.

$execution.customData.set("customerId", String($json.customerId));
$execution.customData.setAll({
  customerId: String($json.customerId),
  source: "form",
});

set writes one key. Writing the same key again replaces the value. setAll writes many keys at once and drops keys that are not in the object you pass. It is not a patch of only those keys.

get reads one key. getAll reads every pair stored on this execution. Use them later in the same run. The executions list does not need a get.

Python

A Python Code node uses _execution.customData. The methods are the same: set, get, setAll, and getAll.

_execution.customData.set("customerId", str(_item["json"]["customerId"]))

Write it with the Execution Data node

If you would rather not write code, use the Execution Data node. Fill in the keys and values. When the run reaches that node, they are stored on the current execution. The node writes. It does not fetch the values back into other nodes. To read them later in code, use get as above.

The keys and values are fixed when that node runs. Later nodes can change the business data without updating custom data, unless something writes it again.