Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Composite Value Syntax

Looking at the JSON configuration syntax from the technical point of view, the values of some properties are treated as elementary values, but they consist of several parts at the application level.

These values are syntactically always string values composed of comma-separated scalar values; however, they can also be interpreted as a different data type.

For example, such a property could be defined in JSON format as follows:

"Property_X": "Value_1, Value_2, Value_3"

If you only list the individual values, always follow the sequence of the values as described in this documentation. It is the only way for the correct meaning to be assigned to them.

For example, if the second value is optional and should be omitted, specify a blank value in order to maintain the sequence:

"Property_X": "Value_1, , Value_3"

As a rule, this documentation also lists a parameter name for the values, which can be specified as an option. Uniqueness is established via the parameter name. This allows values to be omitted and their sequence to be changed, e.g.:

"Property_X": "Param_3: Value_3, Param_1: Value_1"

The program first searches for a value by name. If the value is not found by name, it is searched for by position. No other named value may then be located at the position. The spaces inserted in the value listings are not syntactically necessary, but are only used here for better readability.

If commas do not serve as delimiters between values, but are part of a value, this must be considered a syntactic peculiarity. In practice, this particularly applies to macro expressions (e.g., commas in the parameter list of a macro function). For this reason, commas within single and double quotes as well as within round, square, and curly brackets are implicitly ignored in the macro context. Thus, no special syntax must be observed for such an expression. If a comma is used within an elementary value that does not represent a macro, this comma must be preceded by a \ as a masking character.