Untitled :: DOCS

configuration of the monitor data export :keywords: monitor

Activation of automatic downloads required.

For the monitor export to work correctly under the corresponding URL, automatic downloads for the BPC must be explicitly activated in the Google Chrome browser. The setting can be found at Einstellungen → Datenschutz und Sicherheit → Website-Einstellungen → [BPC website] → Automatische Downloads. Chrome blocks several consecutive downloads by default if the URL of the BPC has not been classified as trustworthy.

The data of the displayed monitor can currently be exported in CSV, XLSX (Excel) and JSON format.

Options

The export settings are made in the 'Process Monitoring' settings of each individual monitor component. The column formatting options (numbers/date) differ depending on the format.

Custom renderers that have been defined in the monitor are also applied in the export (see Customrenderer)

The monitor columns support the following formatters

Lowercase formatter .Uppercase formatter .Translate formatter

Formatter deviating from this are not evaluated.

Export dialog

The default setting of the export dialog can be controlled via the option function_exportDialogDefaults.

Example:

{
  "exportChildrenDisable": "true",  (1)
  "title": {                        (2)
	"de": "Export Daten",
	"en": "Export data"
  },
  "exportChildren": false,          (3)
  "currentView": true,              (4)
  "format": "csv",                  (5)
}

1	Deactivate/activate export of history data. If it is not configured, it is automatically deactivated if there is no "Data index" history and vice versa.
2	Title of the export window in different languages
3	Default value of the exportChildren field
4	Default value of the currentView field
5	Default value of the format field

CSV

The size of the export should not play a role, as the data is sent to the client in packets (stream). The 'Limit' can be set to the value '0' to export all existing records.

Setting (Key) Type Description

Setting (Key)	Type	Description
Function_ProcessExportCSV (`function_exportConfigCsv`)	boolean	Defines whether the CSV export should appear in the export dialog or not. Default: true
Function_ProcessExportCSVCustomHeader (`function_exportConfigCsvUseCustomColumnHeaders`)	boolean	Defines whether the column names from the database or the customized monitor column names (monitor instance → column_config → text) should be used. Default: true
function_exportConfigCsvInclHidden	boolean	Defines whether the fields marked as 'hidden' in the 'column_config' are to be taken into account during export or not. Default: false
Function_ProcessExportCSVSeperator (`function_exportConfigCsvSeparator`)	string	Defines the CSV column separator. Default: ;

Function_ProcessExportCSV
(function_exportConfigCsv)

boolean

Defines whether the CSV export should appear in the export dialog or not.
Default: true

Function_ProcessExportCSVCustomHeader
(function_exportConfigCsvUseCustomColumnHeaders)

boolean

Defines whether the column names from the database or the customized monitor column names (monitor instance → column_config → text) should be used.
Default: true

function_exportConfigCsvInclHidden

boolean

Defines whether the fields marked as 'hidden' in the 'column_config' are to be taken into account during export or not.
Default: false

Function_ProcessExportCSVSeperator
(function_exportConfigCsvSeparator)

string

Defines the CSV column separator.
Default: ;

XLSX

In contrast to CSV and JSON export, the data cannot be streamed to the client, as a workbook object with all data must first be created on the server side. It must therefore be ensured on the server side that the memory is not overloaded.

Internally, the Apache POI project is used to generate the XLSX file.

Setting (Key) Type Description

Setting (Key)	Type	Description
Function_ProcessExportXLSX (`function_exportConfigXlsx`)	boolean	Defines whether the JSON export should appear in the export dialog or not. Default: true
Function_ProcessExportXLSXAutoResize (`function_exportConfigXlsxAutoResizeColumns`)	boolean	Determine column width automatically. See monitor:admin/configuration_monitor_export.adoc.
Function_ProcessExportXLSXCustomHeader (`function_exportConfigXlsxUseCustomColumnHeaders`)	boolean	Defines whether the column names from the database or the customized monitor column names (monitor instance → column_config → text) are to be used as element names. Default: true
Function_ProcessExportXLSXHiddenColumns (`function_exportConfigXlsxInclHidden`)	boolean	Include hidden columns in Excel export. See monitor:admin/configuration_monitor_export.adoc.
Data set limit (`function_maxExportLimit`)	number	Maximum number of data sets included in the export. This value can be changed in the export dialog. A high value can have a negative impact on the server’s RAM consumption with large data sets. Default: 10,000

Function_ProcessExportXLSX
(function_exportConfigXlsx)

boolean

Defines whether the JSON export should appear in the export dialog or not.
Default: true

Function_ProcessExportXLSXAutoResize
(function_exportConfigXlsxAutoResizeColumns)

boolean

Determine column width automatically. See monitor:admin/configuration_monitor_export.adoc.

Function_ProcessExportXLSXCustomHeader
(function_exportConfigXlsxUseCustomColumnHeaders)

boolean

Defines whether the column names from the database or the customized monitor column names (monitor instance → column_config → text) are to be used as element names.
Default: true

Function_ProcessExportXLSXHiddenColumns
(function_exportConfigXlsxInclHidden)

boolean

Include hidden columns in Excel export. See monitor:admin/configuration_monitor_export.adoc.

Data set limit
(function_maxExportLimit)

number

Maximum number of data sets included in the export. This value can be changed in the export dialog. A high value can have a negative impact on the server’s RAM consumption with large data sets. Default: 10,000

If JSON is not available for selection in the export window, this must be set separately in the configurations as shown in the table above. The configuration parameter responsible for this is function_exportConfigJson.

JSON

Setting (Key) Type Description

Setting (Key)	Type	Description
Function_ProcessExportJSON (`function_exportConfigJson`)	bool
Function_ProcessExportJSONCustomHeader (`function_exportConfigJsonUseCustomColumnHeaders`)	boolean
Function_ProcessExportJSONHiddenColumns (`function_exportConfigJsonInclHidden`)	boolean	Defines, whether or not the fields marked as 'hidden' in the 'column_config' should be included in the export. Default: false
Function_ProcessExportJSONUseUTCDateFormat (`function_exportConfigJsonUseUTCDateFormat`)	boolean	Defines whether the date fields are to be output in JSON/UTC format or in the format "yyyy-MM-dd HH:mm:ss" and the time zone of the user/browser. Default: true

Function_ProcessExportJSON
(function_exportConfigJson)

bool

Function_ProcessExportJSONCustomHeader
(function_exportConfigJsonUseCustomColumnHeaders)

boolean

Function_ProcessExportJSONHiddenColumns
(function_exportConfigJsonInclHidden)

boolean

Defines, whether or not the fields marked as 'hidden' in the 'column_config' should be included in the export.
Default: false

Function_ProcessExportJSONUseUTCDateFormat
(function_exportConfigJsonUseUTCDateFormat)

boolean

Defines whether the date fields are to be output in JSON/UTC format or in the format "yyyy-MM-dd HH:mm:ss" and the time zone of the user/browser.
Default: true