workbook Configuration

This configuration is optional.

No dedicated Cadenza feature requires this configuration.

  • 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
<selectionLimit
>
optional
int

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

Default: 100

</selectionLimit>
<spatialConditionVertexLimit
>
optional
int

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

Default: 100000

</spatialConditionVertexLimit>
<queryResultGeometryVertexLimit
>
optional
int

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
>
optional
int

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

Authorized users of a workbook can increase the 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
>
optional
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

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

Default: PT60M

</expiresAfter>
<attributeDescriptionVisibility
xs:string
userConfigurable
alwaysVisible
neverVisible
>
optional

Visibility of attribute information in the info window, which can be accessed via the view’s toolbar.

The data compilation of a data view contains various attributes. Depending on the use case, it may be useful for a workbook user to view the attribute information for a view.

  • userConfigurable: The creator of a view controls whether or not the attribute information is displayed in the Info window.

    This can be set in the Designer on the “Information” tab.

  • alwaysVisible: The attribute information is always displayed.

  • neverVisible: The attribute information is never displayed.

Default: userConfigurable

</attributeDescriptionVisibility>
<relativeDateFilterSuggestions
>
optional
<suggestion
from
optional
=
>=-9999<=+9999
xs:integer
to
optional
=
>=-9999<=+9999
xs:integer
unit
optional
=
xs:string
DAY
WEEK
MONTH
QUARTER
YEAR
activeByDefault
optional
=
boolean
>
requiredmax. unbounded

A predefined relative time period available in the filter settings of a date and date interval filter. If not set, hard-coded defaults are used. The order of suggestion elements defines the display order.

from, to: time period

A valid range is either:

  • from: [-9999, -1], to: -1 – meaning "previous $from $timeunits"

  • from: [-9999, 0], to: 0 – meaning "previous $from $timeunits including the current $timeunit"

  • from: 0, to: [0, 9999] – meaning "next $to $timeunits including the current $timeunit"

  • from: 1, to: [1, 9999] – meaning "next $to $timeunits"

The validity is checked in code when the configuration is loaded.

The time periods are always expressed in calendar weeks, months, quarters, or years.

activeByDefault: true to make the predefined relative time period initially available as a quick filter selection. Default is false.

</suggestion>
</relativeDateFilterSuggestions>
</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:
        selectionLimit: 15
        spatialConditionVertexLimit: 15
        queryResultGeometryVertexLimit: 15
        maxQueryResultGeometryVertexLimit: 15
      expiresAfter: "P2DT3M"
      attributeDescriptionVisibility: "userConfigurable"
      relativeDateFilterSuggestions:
      - from: 15
        to: 15
        unit: "DAY"
        activeByDefault: true
      - from: 15
        to: 15
        unit: "DAY"
        activeByDefault: true

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>
    <selectionLimit>15</selectionLimit>
    <spatialConditionVertexLimit>15</spatialConditionVertexLimit>
    <queryResultGeometryVertexLimit>15</queryResultGeometryVertexLimit>
    <maxQueryResultGeometryVertexLimit>15</maxQueryResultGeometryVertexLimit>
  </restrictions>
  <expiresAfter>P2DT3M</expiresAfter>
  <attributeDescriptionVisibility>userConfigurable</attributeDescriptionVisibility>
  <relativeDateFilterSuggestions>
    <suggestion from="15" to="15" unit="DAY" activeByDefault="true"/>
    <suggestion from="15" to="15" unit="DAY" activeByDefault="true"/>
  </relativeDateFilterSuggestions>
</workbookConfiguration>