Skip to main content

Dictionaries

Dictionaries let you manage variables that are configurable per environment.

What is a dictionary?​

A dictionary is a container of variables:

  • Stores key–value pairs (entries)
  • Values configurable according to the execution environment
  • Reusable in workflows
  • Sensitive values can be masked in the interface

Use cases​

Dictionaries are notably used to:

  • Configuration: URLs, endpoints, parameters
  • Secrets as per-environment variables: API keys, tokens, passwords — sensitive values can be masked in the interface and are consumed in node fields as well as in the fields of authentication methods
  • Business variables: parameters changeable without republishing the workflow
  • Separate environments: same keys, different values in dev, staging, production

Structure​

ElementRole
NameIdentifies the dictionary in Ecosystem and in references
EntriesKey–value pairs (conceptually the entries in the interface)
EnvironmentsSet of values per environment for each key

Usage syntax​

A value is expressed in the format {{dictionaries.nomDuDico.cleDuDico}} in node fields (headers, URLs, parameters, etc.):

{{dictionaries.api.baseUrl}}

Example: {{dictionaries.api.baseUrl}} returns the value of the baseUrl key of the api dictionary for the active environment.

Values per environment​

The same key can have a different value per environment (development, staging, production). When creating or editing an entry — see Manage entries — you select the environments concerned and define a value for each one.

Dictionary api, key baseUrl:

EnvironmentValue
Developmenthttps://api-dev.example.com
Productionhttps://api.example.com

In a workflow, {{dictionaries.api.baseUrl}} is resolved automatically according to the execution environment: the development value in dev, the production one in production, without any change to the workflow.

Next steps​