workbook

<workbookConfiguration
>
required
<restrictions
<rowCountLimit
>
optional
int

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

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

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

This limit controls how many features are sent to the client for rendering. As soon as the limit is reached, no more new features are loaded. The features loaded up to this point are displayed and the user receives a warning. Authorized users of a workbook can increase the limit for individual layers (see maxQueryResultGeometryVertexLimit).

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 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.

</maxQueryResultGeometryVertexLimit>
>
optional
</restrictions>
<expiresAfter
>
optional
duration

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
>
required
string
</name>
<printName
>
required
string

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

</printName>
<text
>
required
string

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

The title of the disclaimer dialog. Empty content is treated as title not present.

</title>
<message
>
optional
string

The message body of the disclaimer dialog. Empty content is treated as message not present.

</message>
<allowedLinks
<url
>
optionalmax. unbounded
string

One allowed link, matched as prefix: if it matches the beginning of an external link, that external link is exempt from the requirement to show a disclaimer.

</url>
>
optional

A list of links for which no disclaimer shall be shown.

</allowedLinks>
>
optional

Configuration of a disclaimer to show for links pointing outside Cadenza. If the disclaimer config present and the title and message are both absent or empty, a fallback for title and message is used.

</disclaimerForExternalLinks>
<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

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<=604800000
xs: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>