Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

General Output Properties

The following output formats and output systems are configured in separate arrays, but can be executed mixed in freely definable order one after another.

The order in which these two object types is commonly sorted is determined by the numeric property .Order. This property is used to sort across both object types to determine the order of execution. If the number assigned is the same, an output format will take precedence over an output system.

The following properties apply to output formats and output systems:

Property

Description

OutputFormat[].Order

OutputSystem[].Order

Numerical indication of the order of execution

Counting starts at 1.

The default value is the order of listing within the OutputFormat[] and OutputSystem[] arrays.

OutputFormat[].ConditionMacro

OutputSystem[].ConditionMacro

Field macro expression if processing of an output format or output system is to be executed only under certain conditions (optional)

The field macro expression must return a corresponding Boolean value. If the property value is missing, the condition will implicitly be considered satisfied.

OutputFormat[].MultiValueSep

OutputSystem[].MultiValueSep

Delimiter for the case that multiple field contents (array values or table fields) that it separates are to be transferred as a composite string into a single output field (optional)

By default, the delimiter is not defined. If the target system does not explicitly support the transfer of multiple values, then, by default, only the first value from a multiple field will be used.

Furthermore, this property only takes effect if the field content is output as a string. In other words, it will only take effect if 1) the field content type is "string," 2) the field content type is converted to "string" via OutputFormat, or 3) the output format / output system only supports the type "string," which always results in an implicit conversion.

OutputFormat[].Field[].Name*

OutputFormat[].Field[].OutputName

OutputFormat[].Field[].OutputFormat

OutputSystem[].Field[].Name*

OutputSystem[].Field[].OutputName

OutputSystem[].Field[].OutputFormat

Definition of the assignment of source fields from the field catalog to the target fields, which will be included in an output format or transferred to an output system

Under .Name, specify the name of the source field analogous to the property of the same name in the field catalog. Under .OutputName, specify the definition of the respective target field from the output data. The syntax to be used varies. (For more information on the syntax, see the respective index data reader.)

If the name of the source field in the field catalog is identical to the name of the target field, you can omit the .OutputName. In that case, the name of the source field will be used as the default value. Note, however, that the value can only be omitted if the output format /output system does not require the .OutputName to have any special syntax (i.e., if it requires only a simple field name).

Notice

If condition-dependent alternative field catalogs with different field definitions are used, but only one assignment list can be defined for their output fields in the output format or output system, this is considered a special circumstance.

One of two alternative procedures can be used for this:

  1. A condition-dependent definition of 2 variants of the output format / output system, each of which only includes the assignments for the fields contained in the active field catalog

  2. A definition of all output fields across all catalogs in just one output format / output system

Fields that are not present in the catalog used do not lead to an error in the output; rather, they are simply skipped. Therefore, in most use cases, you can use the second procedure.

The OutputFormat property only applies if there is a typed value in the source field, but it is to be transferred to the target field as a string value. The property defines the syntax for formatting the target value. If the source value is already a string, no new formatting will take place.

The syntax for the .OutputFormat property depends on the target data type. If no output format is specified, but a string value is mandatory for the target field (because of output format/output system support) a default formatting is used. This formatting is either system-specific (e.g., yyyyMMdd for an SAP date format) or corresponds to the internal text representation of typed values (i.e., yyy-MM-dd HH:mm:ss for dates and a dot as decimal separator for numeric values). Depending on the target data type, use the following syntax:

  • Number: the following characters can be used in the formatting pattern:

    • . (decimal separator)

    • , (comma separator)

    • 0 (fixed position)

    • # (variable position)

    Notice

    If only one delimiter is included in the pattern, this delimiter is considered to be a decimal separator. If two different separators are included, the first of the two characters is interpreted as a thousands separator.

    For examples, see Examples of Use.

  • Date: specify a pattern for the structure of the date format (e.g., yyyy-MM-dd for a date of the form "2021-12-31") (see also property ProcessReadIndex[].Field[].InputFormat at General Properties).

  • Bool: this data type is not configurable. The output is always TRUE or FALSE.

Examples of Use

The following table shows examples of formatting numeric values.

Notice

Rounding to a specified number of digits applies only to decimal places; digits before the decimal point are always output in full.

Numeric value

Formatting pattern

Output value

123,45

0

123

1,2

000.00

001.20

1,2

0.##

1.2

0

#.##

(Blank)

0,123

0.00

0.12

0,123

#.##

.12

1234,5

#,##0.00

1,234.50

In this section: