Report Output Format

Last modified 03 Apr 2024 16:14 +02:00

Table of Contents

Description
File Format
HTML
CSV

Description

In the report definition you have a couple of possibilities for the export format of a report file. Currently, the CSV and HTML format is supported other formats such as XSLX are planned to be supported in the future.

File Format

With a report you can specify what kind of export file format should be used. If nothing is specified then there are defaults which are used based on the source of data used in the export.

The default for dashboard based reports is HTML. For object collection based reports it is CSV.

Show Configuration Attributes:

Name	Type	Description
type	FileFormatTypeType	Report data type. Possible values: csv and html.
csv	CsvFileFormatType	Configuration attribute for CSV export.
html	HtmlFileFormatType	Configuration attribute for html export.

Name

Type

Description

type

FileFormatTypeType

Report data type. Possible values: csv and html.

csv

CsvFileFormatType

Configuration attribute for CSV export.

html

HtmlFileFormatType

Configuration attribute for html export.

HTML

Configuration for HTML file format doesn’t contain any other format specific attributes.

CSV

Configuration for CSV file format contains the following attributes specific for the used format:

Name	Type	Description	Default
multivalueDelimiter	string	Multi-value delimiter.	,
fieldDelimiter	string	Field delimiter.	;
escape	string	The escape character of the format.	\
quote	string	Character for the quote.	"
quoteMode	QuoteModeType	Quote Mode for records. Possible values is all, allNonNull, minimal, nonNumeric and none.	nonNumeric
recordSeparator	string	Separator of line of record.	\r\n
trailingDelimiter	boolean	Define, whether to add a trailing delimiter.	false
trim	boolean	Define, whether to trim leading and trailing blanks.	false
createHeader	boolean	Create header in CSV output file.	true
encoding	string	Encoding of CSV file. Most common encodings (UTF-8, windows-125x, ISO-8859-x) are supported. See IANA list of charsets for proper values - generally, both IANA and MIME names are supported as well as many aliases. Details of supported character sets depend on the concrete JDK used to run midPoint, but it is unlikely that your charset is not supported.	UTF-8

Name

Type

Description

Default

multivalueDelimiter

string

Multi-value delimiter.

fieldDelimiter

string

Field delimiter.

;

escape

string

The escape character of the format.

quote

string

Character for the quote.

quoteMode

QuoteModeType

Quote Mode for records. Possible values is all, allNonNull, minimal, nonNumeric and none.

nonNumeric

recordSeparator

string

Separator of line of record.

\r\n

trailingDelimiter

boolean

Define, whether to add a trailing delimiter.

false

trim

boolean

Define, whether to trim leading and trailing blanks.

false

createHeader

boolean

Create header in CSV output file.

true

encoding

string

Encoding of CSV file. Most common encodings (UTF-8, windows-125x, ISO-8859-x) are supported.

See IANA list of charsets for proper values - generally, both IANA and MIME names are supported as well as many aliases. Details of supported character sets depend on the concrete JDK used to run midPoint, but it is unlikely that your charset is not supported.

UTF-8

QuoteModeType

all - Quotes all fields.
allNonNull - Quotes all non-null fields.
minimal - Quotes fields which contain special characters such as the field delimiter, quotes character or any of the characters in the line separator string.
nonNumeric - Quotes all non-numeric fields.
none - Never quotes fields. When the delimiter occurs in data, the printer prefixes it with the escape character. If the escape character is not set, format validation throws an exception.

Was this page helpful?

YES NO

Thanks for your feedback