XML Configuration Files

The XML configuration file documentation is interactive and you can generate your own configuration code sample:

  1. Fill in the desired values (here my-value-here)

  2. Click the blue bar at the left that matches the code block you want to generate (here client).

  3. This will bring up the popup with the example configuration, ready to be copied.

xml snippets guide

Hints

  • Elements that are documented with DEPRECATED are no longer read and supported by Cadenza and should be removed from your configuration

  • Elements that are documented with required are needed to start and use Cadenza

  • The format of the particular configuration option is usually described inline, but some common conventions are:

    • Durations must use the ISO 8601 duration format, for example PT1M for one minute

    • Colors must be given in hexadecimal format: #RRGGBB (e.g. #184e7b)

    • File sizes that are of type "string" accept an integer (e.g. 1000) with an optional, case-insensitive suffix for the order of magnitude (e.g. 1000k or 1000K). Supported suffixes are:

      Suffix Meaning

      K

      Kilo (1k = 1.000)

      M

      Mega (1M = 1.000.000)

      G

      Giga (1G = 1.000.000.000)

      T

      Tera (1T = 1.000.000.000.000)

      P

      Peta (1P = 1.000.000.000.000.000)

      E

      Exa (1E = 1.000.000.000.000.000.000)