workbook

This configuration is required when using the plugin Workbook.

Documentation
YAML Format
XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.

<workbookConfiguration

required

<restrictions

<rowCountLimit

optionalint

Maximum number of data records that are loaded for a data view by default

Authorized users of a workbook can increase this limit for individual data views (see maxRowCountLimit).

Note: Depending on the visualization type, lower limits may apply within Cadenza; e.g. a maximum of 2,000 data records can be loaded for a bar chart. These limits cannot be adjusted.

Default: 100000

</rowCountLimit>

<maxRowCountLimit

optionalint

Maximum number of data records that can be loaded for a data view

Authorized users of a workbook can increase the maximum number of data records loaded by default (rowCountLimit) for individual data views up to this limit in the advanced data view settings. This limit must be greater than or equal to rowCountLimit. The default value is 1.5 * rowCountLimit.

</maxRowCountLimit>

<selectionLimit

optionalint

Maximum number of data records that can be selected in a data view

Default: 100

</selectionLimit>

<spatialConditionVertexLimit

optionalint

Maximum number of vertices that is possible for the filter geometries of a spatial filter

Default: 100000

</spatialConditionVertexLimit>

<queryResultGeometryVertexLimit

optionalint

Maximum number of vertices that is possible by default for displaying the geometries of a layer

This limit controls the number of features sent to the client. Once the limit is reached, no more features are loaded. The features loaded are displayed, and the user gets a warning. Authorized users can increase the limit for layers (see maxQueryResultGeometryVertexLimit). Increasing this limit means more data is transferred to the client, which can slow map rendering. Instead of increasing the limit, try a different map configuration with fewer features on higher zoom levels.

Default: 300000

</queryResultGeometryVertexLimit>

<maxQueryResultGeometryVertexLimit

optionalint

Maximum number of vertices that is possible for displaying the geometries of a layer

Authorized users of a workbook can increase the maximum number of vertices (queryResultGeometryVertexLimit) for individual layers up to this limit in the advanced data view settings. This limit must be greater than or equal to queryResultGeometryVertexLimit. The default value is 1.5 * queryResultGeometryVertexLimit. Increasing this limit means more data is transferred to the client, which can slow map rendering.

</maxQueryResultGeometryVertexLimit>

optional

</restrictions>

<expiresAfter

optionalduration

The idle duration after which unsaved workbook states are discarded. Should be rather high, because unsaved data are lost!

Default: PT60M

</expiresAfter>

<printHeaders

required

optional

boolean

DEPRECATED: define Data protection labels (DPL) and Data confidentiality levels (DCL) via a Data protection context (DPC) in the management center instead.

Default: false

<printHeader

<name

requiredstring

</name>

<printName

requiredstring

DEPRECATED: define Data protection labels (DPL) and Data confidentiality levels (DCL) via a Data protection context (DPC) in the management center instead.

</printName>

<text

requiredstring

DEPRECATED: define Data protection labels (DPL) and Data confidentiality levels (DCL) via a Data protection context (DPC) in the management center instead.

</text>

<alignment

xs:string

left

center

right

required

</alignment>

<font

size

optional

int

color

optional

string

Color of print header text. Value could be a 6 or 8 digit hex value e.g. #caca44 or #ffff0000 or rgba value e.g. rgba(169, 169, 68, 1)

style

optional

string

Value could be e.g. bold or italic bold underline. Extra styles are separated by space. Only italic, bold and underline are allowed. Other values are ignored.

required

</font>

requiredmax. unbounded

</printHeader>

optional

DEPRECATED: define Data protection labels (DPL) and Data confidentiality levels (DCL) via a Data protection context (DPC) in the management center instead.

</printHeaders>

<attributeDescriptionVisibility

xs:string

userConfigurable

alwaysVisible

neverVisible

optional

Visibility of attribute descriptions in workbook views. If not set, the default value 'userConfigurable' is applied.

Default: userConfigurable

</attributeDescriptionVisibility>

<disclaimerForExternalLinks

<title

optionalstring

The title of the disclaimer dialog. The default title is defined internally by Cadenza.

</title>

<message

optionalstring

The message text of the disclaimer dialog. The default message is defined internally by Cadenza. Note: There are no styling options (line breaks, italics, etc.) for the message text.

</message>

<allowedLinks

<url

optionalmax. unboundedstring

Trusted URL. Partial URLs are also supported when specifying the URL. If it matches the beginning of an external link, that external link is exempt from the requirement to show a disclaimer.

</url>

optional

List of URLs for which the disclaimer dialog will not be displayed. Any number of URLs can be excluded (positive list of trusted websites). By default, the disclaimer dialog will be displayed for all URLs that come from URL attributes.

</allowedLinks>

optional

A dialog that will be displayed when the user tries to open an external link that comes from a URL attribute. Trusted URLs can be configured.

For more information see Disclaimer for External Links

</disclaimerForExternalLinks>

<relativeDateFilterSuggestions

optional

<suggestion

from

optional

>=-9999<=+9999xs:integer

optional

>=-9999<=+9999xs:integer

unit

optional

xs:string

DAY

WEEK

MONTH

QUARTER

YEAR

activeByDefault

optional

boolean

requiredmax. unbounded

Configuration of relative date filter suggestions for workbook conditions. If not set, hard-coded defaults defined in RelativeDateIntervalProvider.getStandardRelativeDateIntervals are used. The order of suggestion elements in the configuration file defines the displayed order on the UI.

</suggestion>

</relativeDateFilterSuggestions>

<liveMode

optional

<refreshIntervals

<refreshInterval

isDefault

optional

boolean

<milliseconds

>=1000<=604800000xs:int

required

</milliseconds>

optionalmax. unbounded

</refreshInterval>

optional

The Live Mode feature refreshes workbooks automatically at a user-selected interval. The list of default intervals a user can choose from is defined in LiveModeRefreshIntervalsProvider.getStandardRefreshIntervals. You only need to configure this particular element if you want to override those intervals.

</refreshIntervals>

</liveMode>

</workbookConfiguration>

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:
    workbook:
      restrictions:
        rowCountLimit: 15
        maxRowCountLimit: 15
        selectionLimit: 15
        spatialConditionVertexLimit: 15
        queryResultGeometryVertexLimit: 15
        maxQueryResultGeometryVertexLimit: 15
      expiresAfter: "P2DT3M"
      printHeaders:
        required: true
        printHeader:
        - name: "text"
          printName: "text"
          text: "text"
          alignment: "left"
          font:
            size: 15
            color: "text"
            style: "text"
        - name: "text"
          printName: "text"
          text: "text"
          alignment: "left"
          font:
            size: 15
            color: "text"
            style: "text"
      attributeDescriptionVisibility: "userConfigurable"
      disclaimerForExternalLinks:
        title: "text"
        message: "text"
        allowedLinks:
        - "text"
        - "text"
      relativeDateFilterSuggestions:
      - from: 15
        to: 15
        unit: "DAY"
        activeByDefault: true
      - from: 15
        to: 15
        unit: "DAY"
        activeByDefault: true
      liveMode:
        refreshIntervals:
        - isDefault: true
          milliseconds: 15
        - isDefault: true
          milliseconds: 15

Filename: workbook-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"?>
<workbookConfiguration>
  <restrictions>
    <rowCountLimit>15</rowCountLimit>
    <maxRowCountLimit>15</maxRowCountLimit>
    <selectionLimit>15</selectionLimit>
    <spatialConditionVertexLimit>15</spatialConditionVertexLimit>
    <queryResultGeometryVertexLimit>15</queryResultGeometryVertexLimit>
    <maxQueryResultGeometryVertexLimit>15</maxQueryResultGeometryVertexLimit>
  </restrictions>
  <expiresAfter>P2DT3M</expiresAfter>
  <printHeaders required="true">
    <printHeader>
      <name>text</name>
      <printName>text</printName>
      <text>text</text>
      <alignment>left</alignment>
      <font size="15" color="text" style="text"/>
    </printHeader>
    <printHeader>
      <name>text</name>
      <printName>text</printName>
      <text>text</text>
      <alignment>left</alignment>
      <font size="15" color="text" style="text"/>
    </printHeader>
  </printHeaders>
  <attributeDescriptionVisibility>userConfigurable</attributeDescriptionVisibility>
  <disclaimerForExternalLinks>
    <title>text</title>
    <message>text</message>
    <allowedLinks>
      <url>text</url>
      <url>text</url>
    </allowedLinks>
  </disclaimerForExternalLinks>
  <relativeDateFilterSuggestions>
    <suggestion from="15" to="15" unit="DAY" activeByDefault="true"/>
    <suggestion from="15" to="15" unit="DAY" activeByDefault="true"/>
  </relativeDateFilterSuggestions>
  <liveMode>
    <refreshIntervals>
      <refreshInterval isDefault="true">
        <milliseconds>15</milliseconds>
      </refreshInterval>
      <refreshInterval isDefault="true">
        <milliseconds>15</milliseconds>
      </refreshInterval>
    </refreshIntervals>
  </liveMode>
</workbookConfiguration>