General Configuration Properties
This section documents the value specifications and object structures of configuration properties that can be used in various different places in configuration.
The following conventions apply to all configuration properties listed in this documentation:
If a concrete data type such as "Boolean value" or "numeric value" is not explicitly listed in the description text, then specify string values for the properties. This also applies to enumeration values from a fixed set of alphanumeric value specifications.
The values of some properties are composed of multiple individual comma-separated parameters. In the descriptions of the properties, these parameters are described in exactly the order in which they are to be specified. In addition, an optional name is listed for each one. An asterisk (*) in the parameter name indicates that this parameter is mandatory.
The following symbols are used to indicate the characteristics of properties:
Icon
Description
*
(*)
Star
For values that are mandatory, the property is marked with a final *.
The property is marked with an (*) if the obligation is only conditionally valid (e.g., if it is dependent on another property). For subordinate properties, the obligatory information is only relevant if the superordinate property is set at all.
Notice
Most of the properties that require a value are predefined with a default value. The description states the default value. For these kinds of properties, explicit indication that they are mandatory is omitted.
(§)
Paragraph sign
A (§) appended to a property indicates that the property supports the use of an encoded or partial value in the syntax
<§>...</§>.(#)
Hash mark
A (#) appended to a property indicates that the property supports the use of a hexadecimal string in the syntax
<#>...</#>.(%)
Percentage sign
Some properties in scenario configurations allow the use of dynamic values or dynamic partial values in the form of variables with the placeholder
%VariableName%. The placeholder is replaced at runtime by the value of the variable in question.The percentage sign (%) appended to a property indicates that variables can be used for this property.For property values representing a macro expression executed in the context of a document, the use of document-related variables is already provided by default. Therefore, an explicit indication is omitted there.
.
Dot
The path of a configuration property is not always named in full. In some cases, only the trailing part of the path is named. In such a case, the path is preceded by a dot to indicate that it is a sub-path that still needs to be preceded by a parent-path segment.
This occurs when describing general properties that may be used in different contexts with different names of parent properties. It is also used as an abbreviated notation when the context indicates the parent property referred to by a child.
{}
Curly brackets
Curly brackets containing an expression or a partial expression in the syntax description of a configuration value (i.e., in the form
{value}) indicate a value that varies depending on context.Do not include the curly brackets as part of the concrete configuration value.
""
Quotation marks
Double quotation marks that are part of the syntax of a value are always written in the form
"...". Also use double quotes (decimal code 34 or hexadecimal 22) in the configuration data.