core

This configuration is optional.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<configuration
>
required
<licenseKey
>
optional
base64Binary

Base 64 encoded Cadenza license key. If this setting is configured we will not try to load a license key from the configuration directory.

</licenseKey>
<databaseNetworkTimeout
>
optional
int

Timeout for access to database network resources (through JDBC) in seconds.

Default: 300

</databaseNetworkTimeout>
<httpNetworkTimeout
>
optional
int

Timeout for access to network resources (e.g. WMS servers) in seconds.

Default: 10

</httpNetworkTimeout>
<httpProxy
>
optional

These are the proxy settings that Cadenza uses for http requests. These settings are also used for exporting PDF Reports. Configured proxy username and password are not used for PDF reporting.

Choice: Choose only ONE of the following
<host
>
required
string
</host>
<port
>
required
int
</port>
<userName
>
optional
string
</userName>
<password
>
optional
string
</password>
<excludedHosts
>
optional

Hosts for which the proxy should not be used. This must be either the FQHN or an expression starting with a dot. The expression .example.org will act as a wildcard which matches all hostnames within the domain example.org. An asterisk must not be used as wildcard expression since it is not supported here.

<host
>
optionalmax. unbounded
string
</host>
</excludedHosts>
<useSystemDefaults
>
optional
boolean

If set to true, the system proxy will be used. See https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/doc-files/net-properties.html (Proxies) for a detailed description. The settings for http will be interpreted for both http and https, settings for https will not be respected separately.

Default: false

</useSystemDefaults>
Choice End
</httpProxy>
<secretHandling
<processor
xsd:string
pass-through
decode
>
required

The secret processor to use.

  • pass-through: Interpret all secrets as they are present in the configuration file without further processing.

  • decode: Interpret all secrets as obscured using PasswordEncoder (see also Secrets in Configuration).

Default: decode

</processor>
>
optional

Globally configures how secrets in the configuration file(s) are interpreted.

</secretHandling>
<repositoryListFile
>
optional
string

The filename of the XML file containing the repositories. This should not typically be configured as there is a sensible default.

Default: repositoryList.xml

</repositoryListFile>
<view
>
optional
<nullValueDisplayText
>
optional
string

Alternative text that is displayed for NULL values of an attribute, e.g. the number "0” or the character “-”. For measures, this alternative text can be overridden in the Management Center, in the workbook, or in the data view. All data queries and calculations are based on the actual attribute values; the alternative text is only used for display.

Default: NULL

</nullValueDisplayText>
</view>
<exportSettings
>
optional

There is a corresponding element for each available export format. If an entry for a format is missing the application-specific default settings (if configured) or the Cadenza default values are taken.

<default
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional

Definition of application-specific default settings that will be used for all configured export formats. The application-specific default settings override the Cadenza default values.

  • warningRowCount: Number of rows/features from which a warning should be issued (default value is 30,000)

  • maximumRowCount: Number of rows/features from which an export should be denied (default value is 100,000)

</default>
<xlsx
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
<filterAssignmentTargetSheet
xsd:string
NEW_SHEET
DATA_SHEET
>
optional

Excel export only:

  • NEW_SHEET for writing the filter assignment to a new sheet.

  • DATA_SHEET for putting the filter assignment into the sheet containing the data..

Default: NEW_SHEET

</filterAssignmentTargetSheet>
>
optional
</xlsx>
<csv
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
<delimiter
>
optional
string

Delimiter that separates the values in a row. Control characters, such as tabs, are not supported.

Note: The encoding for CSV export can also be customized in the Management Center. Default: UTF-8

Default: ,

</delimiter>
>
optional
</csv>
<json
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional
</json>
<kml
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional
</kml>
<shapefile
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional
</shapefile>
<geoPackage
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional
</geoPackage>
<gpx
<warningRowCount
>
optional
int
</warningRowCount>
<maximumRowCount
>
optional
int
</maximumRowCount>
>
optional
</gpx>
</exportSettings>
<systemDb
<driverName
>
required
string

Fully qualified name of the JDBC driver

</driverName>
<jdbcURL
>
required
string

JDBC URL of the database

</jdbcURL>
<user
>
required
string

The database user on whose behalf the connection is being made

</user>
<password
>
required
string

Password of the database user, see Secrets in Configuration for information on password encoding modes.

</password>
<minimumIdleConnectionCount
>
optional
int

Minimum number of idle connections in the connection pool.

This setting can be used to reduce the number of connections that Cadenza keeps open for this connection pool.

Default: connectionPoolSize.

</minimumIdleConnectionCount>
<connectionPoolSize
>
optional
int

Maximum number of total connections of the connection pool (idle and active).

Monitoring the available connections helps to find a good value for this parameter (see Database Connection Pools).

Default: 10

</connectionPoolSize>
<properties
<property
xs:string
name
required
=
string
description
optional
=
string
>
optionalmax. unbounded
</property>
>
optional
</properties>
>
optional

Login credentials and additional connection settings for the system database. This database is used to manage jobs, user settings, and additional configurations. Warning: This setting must only be configured if no job management database, user preference database, or configuration database is configured.

</systemDb>
</configuration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    core:
      licenseKey: "dGV4dA=="
      databaseNetworkTimeout: 15
      httpNetworkTimeout: 15
      httpProxy:
        host: "text"
        port: 15
        userName: "text"
        password: "text"
        excludedHosts:
        - "text"
        - "text"
        useSystemDefaults: true
      secretHandling:
        processor: "pass-through"
      repositoryListFile: "text"
      view:
        nullValueDisplayText: "text"
      exportSettings:
        default:
          warningRowCount: 15
          maximumRowCount: 15
        xlsx:
          warningRowCount: 15
          maximumRowCount: 15
          filterAssignmentTargetSheet: "NEW_SHEET"
        csv:
          warningRowCount: 15
          maximumRowCount: 15
          delimiter: "text"
        json:
          warningRowCount: 15
          maximumRowCount: 15
        kml:
          warningRowCount: 15
          maximumRowCount: 15
        shapefile:
          warningRowCount: 15
          maximumRowCount: 15
        geoPackage:
          warningRowCount: 15
          maximumRowCount: 15
        gpx:
          warningRowCount: 15
          maximumRowCount: 15
      systemDb:
        driverName: "text"
        jdbcURL: "text"
        user: "text"
        password: "text"
        minimumIdleConnectionCount: 15
        connectionPoolSize: 15
        properties:
        - name: "text"
          description: "text"
          value: "text"
        - name: "text"
          description: "text"
          value: "text"

Filename: core-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
  <licenseKey>dGV4dA==</licenseKey>
  <databaseNetworkTimeout>15</databaseNetworkTimeout>
  <httpNetworkTimeout>15</httpNetworkTimeout>
  <httpProxy>
    <host>text</host>
    <port>15</port>
    <userName>text</userName>
    <password>text</password>
    <excludedHosts>
      <host>text</host>
      <host>text</host>
    </excludedHosts>
    <useSystemDefaults>true</useSystemDefaults>
  </httpProxy>
  <secretHandling>
    <processor>pass-through</processor>
  </secretHandling>
  <repositoryListFile>text</repositoryListFile>
  <view>
    <nullValueDisplayText>text</nullValueDisplayText>
  </view>
  <exportSettings>
    <default>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </default>
    <xlsx>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
      <filterAssignmentTargetSheet>NEW_SHEET</filterAssignmentTargetSheet>
    </xlsx>
    <csv>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
      <delimiter>text</delimiter>
    </csv>
    <json>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </json>
    <kml>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </kml>
    <shapefile>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </shapefile>
    <geoPackage>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </geoPackage>
    <gpx>
      <warningRowCount>15</warningRowCount>
      <maximumRowCount>15</maximumRowCount>
    </gpx>
  </exportSettings>
  <systemDb>
    <driverName>text</driverName>
    <jdbcURL>text</jdbcURL>
    <user>text</user>
    <password>text</password>
    <minimumIdleConnectionCount>15</minimumIdleConnectionCount>
    <connectionPoolSize>15</connectionPoolSize>
    <properties>
      <property name="text" description="text">text</property>
      <property name="text" description="text">text</property>
    </properties>
  </systemDb>
</configuration>