Connection Key Data Type v2

The connectionKey type identifies the Connection that a Node Method must use. Its value is the Connection's stable key, not its name or its protected Environment value.

Select a Connection

In the canvas, a connectionKey Property uses a Connection selector. The list contains Connections compatible with the selected Node and the Workflow's Cluster. It also provides actions to create a Connection or open an existing Connection for editing.

The Cluster specified for a Workflow must match the Cluster chosen on a Connection. If there is a mismatch, the Connection will be shown greyed. Similarly, a Connection that is assigned but no longer exists is shown as missing. Reopen or refresh the selector after creating or changing a Connection in another tab.

Console stores the selected key in Workflow YAML:

Connection:
  Type: connectionKey
  Value: "00000000-0000-0000-0000-000000000000"

Runtime resolution

At validation time, Flowgear confirms that a literal key identifies a compatible Connection and that its Node and Cluster placement match the Workflow Step. At runtime, the key resolves the protected Connection value for the Workflow's Site and Environment and materializes the Connection type required by the exact Node version.

The same key can therefore resolve different endpoints or credentials in different Environments. The protected Connection fields are not embedded in Workflow YAML and are never returned in Workflow Logs.

A Connection Key can be assigned dynamically by injecting it into the Connection property.

See also

See Connection, Site Environment, and Data Types.