variable_dict_from_file

Define a variable that contains key,value pairs (a dictionary) from a JSON file.

⚙️ Compatible targets: Linux, Windows

Parameters

NameDocumentation
prefixThe prefix of the variable name.

This parameter is required.
nameThe variable to define, the full name will be prefix.name.

This parameter is required.
file_nameThe absolute local file name with JSON content.

This parameter is required.

Outcome conditions

You need to replace ${name} with its actual canonified value.

  • ✅ Ok: variable_dict_from_file_${name}_ok
    • ☑️ Already compliant: variable_dict_from_file_${name}_kept
    • 🟨 Repaired: variable_dict_from_file_${name}_repaired
  • ❌ Error: variable_dict_from_file_${name}_error

Example

method: variable_dict_from_file
params:
  file_name: VALUE
  prefix: VALUE
  name: VALUE

Documentation

To use the generated variable, you must use the form ${prefix.name[key]} with each name replaced with the parameters of this method.

Be careful that using a global variable can lead to unpredictable content in case of multiple definition, which is implicitly the case when a technique has more than one instance (directive). Please note that only global variables are available within templates.

See variable_dict_from_file_type for complete documentation.