Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

tia Viewer Core settings parameter names may be specified either by environment variables in the container context or by providing a YAML configuration file:

  • configuration by environment variables is only viable for minimal configurations

  • configuration by YAML configuration file is required when requiring configuring of instances and more. Here only one environment variable to point to the YAML file is required (SPRING_CONFIG_ADDITIONALLOCATION).

tia Viewer Core settings parameter names are ordered hierarchically: Except of top-level settings, each setting has one direct superior, also called parent: . A . (dot) separates parent name from parameter name.

When configuring using environment variables, a prefix string provides the exact location in the hierarchy from top-level to setting.

When configuring using YAML file, the setting must be placed below its parent with other siblings, each with an line intend increased by the same number of space characters, while no shorter intend may be appear between the setting and its parent.

...

TIA_DESTINATIONS_SAPHTTP_HOST

Info

While tia Viewer Core parameter names are case-sensitive and use the . (dot) character. Depending of the environment like cloud provider or package manager, environment variables must be all uppercase, use _ (underscore) character instead of ., and remove all - . Case-conversion required in this cases may cause undesired resultNot all environments allow the parameter name scheme for environment variables.

To convert a parameter name to an environment variable name follow these rules:

  • Replace dots (.) with underscores (_).

  • Remove any dashes (-).

  • Convert to uppercase.

Example for a docker-compose file with configuration using environment variables:

...