Configurations v2

Reads and writes Site Configuration values for the active Site and Environment of a Workflow.

Revision History

0.0.0.1 - Initial release.
0.0.0.2 - Uses the Workflow activation's Site and Environment for configuration access.

Setup Notes

You can add this Node to a Workflow without configuring a Connection, authentication, or external access. The Node runs on Flowgear Cloud and Local Clusters.

Each Site Configuration is scoped to the Site and Environment of the current Workflow activation. Configuration keys are case-sensitive. When setting a key, do not include /, \, #, ?, commas, tabs, carriage returns, or line breaks.

Stored strings are limited to 32,768 characters. Binary values are limited to 65,536 bytes.

Methods

This Node provides methods for retrieving several Site Configuration values at once and for creating or updating one value.

Get

Retrieves the Site Configuration keys declared as returns on the Step. Select one of these templates to define the return surface:

  • No Site Configurations starts with no returns so you can add exact keys manually.
  • All Site Configurations adds one object return for every Site Configuration in the active Environment. The return names are sorted in ordinal order, and the template does not include the stored values.

This Method has no Workflow Parameters. Add a Return for each exact key you want to read. The All Site Configurations template is a snapshot; configurations added later do not appear in the Step automatically.

Return Type Description
{Site Configuration key} Object The value stored under the exact Site Configuration key.

Set

Creates a Site Configuration or replaces the value of an existing key in the active Site and Environment.

Parameter Type Description
Key String The case-sensitive Site Configuration key to create or update.
Value Object The value to store. This value can be null.

This Method does not return a value. Set the complete intended value; it is not a partial update of nested fields.

Usage Notes

  • Keys are matched exactly. Case and case identify different Site Configurations.
  • Get returns null for both a missing Site Configuration and a Site Configuration whose stored value is null.
  • Get returns stored values unchanged. The return type configured on the Step does not convert the value.
  • Dots remain part of the exact key. Use a quoted reference to access a dotted return in a later Step, for example {getConfiguration."apple.banana"}.
  • Workflow execution can read and write Site Configurations in its active Site and Environment. Site Configuration permissions used for management outside Workflows do not filter the available templates or these methods.

Site Configuration is useful for settings shared by Workflows in one Environment. Use Connections for connector credentials. For record correlations, duplicate-prevention markers, or business lookup records, see Key-Value and Correlate Records Across Systems.

Control access to Workflows that expose configuration changes. An invoker's Site Configuration management permissions do not make a configured Workflow read-only.

The Workflow's discoverable configuration usage includes Get Return names and literal Set keys, including those in nested Steps. An Expression-derived Set key cannot be resolved statically. See Relationships and Last Used before relying on usage metadata to change or remove a key.

Examples

Add a Get Step with a Return named IntegrationSettings, then define its child Properties to match your stored configuration. If that object contains a String field named Region, reference it downstream with:

{getConfiguration.IntegrationSettings.Region}

For a configuration whose exact key is sales.settings, quote that path segment:

{getConfiguration."sales.settings"}

Both examples assume the Step is named getConfiguration. Use the exact stored key and an appropriate authored Return type for your value.

See also