Elements runtime reference / Runtime store

`setVar`

Persist a tenant-shared runtime variable immediately during Element execution.

Terug naar builtin index Signatuur Payloadformaat Voorbeeld Scope-notities

Signatuur

setVar(name, value=None)

Doel

Persist a tenant-shared runtime variable immediately during Element execution.

Aliases and imports

setvar

Payloadformaat

Use these fields as the Python call arguments or keyword payload for this helper.

{
  "name": "sync_cursor",
  "value": 12345
}

Field	Description
`name`	Runtime variable id.
`value`	JSON-serializable value to store.

Return payload

Voorbeeld

def run(params):
    cursor = int(getVar("sync_cursor", 0) or 0)
    next_cursor = cursor + int(params.get("rows", 0))
    setVar("sync_cursor", next_cursor)
    return {"cursor": next_cursor}

Scope-notities

Writes to the runtime store before setVar returns; it is not delayed until the Element finishes.
Only call setVar when a durable state/config mutation is intended.
Values must be JSON-serializable.

setVar