Set

A task used to set data to the workflow's state.

warning

A Temporal workflow MUST be deterministic.

You are strongly advised to use the Set task when setting data, especially generated data (such as ${ uuid }), rather than invoking it in a task. For example, the following CallHTTP task would return a Non-Determinism Error (NDE) if it was replayed:

# Bad ❌
- updateUser:
    call: http
    with:
      method: put
      endpoint: https://echo.free.beeceptor.com
      body:
        id: ${ uuid } # This value is different every time this task is run

However, as this one generates the UUID in a Set task, this is wrapped in such a way that it's saved to the Temporal state and is safe to replay.

# Good ✅
- set:
    set:
      id: ${ uuid }
- updateUser:
    call: http
    with:
      method: put
      endpoint: https://echo.free.beeceptor.com
      body:
        id: ${ .data.id }

With great power comes great responsibility

Properties

Name	Type	Required	Description
set	map	yes	The data to set.

Example

The data is saved to a state object and can be retrieved in a later task by calling ${ .data.<key> }. Once set, it remains in the state and can be overidden by a later Set task.

document:
  dsl: 1.0.0
  namespace: zigflow
  name: example
  version: 0.0.1
do:
  - baseData:
      set:
        # This value will be overidden later
        progress: 0
        # Set a variable from an envvar
        envvar: ${ .env.EXAMPLE_ENVVAR }
        # Generate a UUID
        uuid: ${ uuid }
        # Insert something from the input
        inputUserId: ${ .input.userId }
        # Maps can be used
        object:
          hello: world
          uuid: ${ uuid }
        # As can arrays
        array:
          - ${ uuid }
          - hello: world
  - updateProgress:
      set:
        # Overidden from above. Everything else remains the same
        progress: 100