Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

General Properties

The following properties are valid for all output formats.

The specific properties of the formats are described in the respective sections on the individual formats. These sections also explain the individual syntax of the OutputName property. This property can be used to define the target field for a value to be output.

Notice

The technical property OutputFormat is used in 2 places in a configuration:

  1. As the format of an artificially created file attachment, which is then output via an output system ( OutputFormat[]property)

  2. As a formatting pattern for a single output field if a typed field value is to be transferred as a string (properties OutputFormat[].Field[].OutputFormat and OutputSystem[].Field[].OutputFormat)

When the term "output format" is used in this documentation, it generally refers to the first variant.

Property

Description

OutputFormat[].Type*

Type of output format:

  • Custom: user-defined output format

  • InternalJson: internal document object in JSON format

  • Json: JSON file

  • MsExcel: Microsoft Excel file

  • MsWord: Microsoft Word file

  • Text: simple text file ("plain text")

  • Xml: XML file

OutputFormat[].FileName*(%)

Name of the file attachment to be created in the defined output format

OutputFormat[].AttachFileFilter(%)

Name filter to select existing file attachments (optional)

The file attachments can be embedded in the new attachment that will be created, provided that the output format supports this functionality.

Default value: * (all attachments)

In this section: