Upgrading 10.5 to 11.0

When migrating to a new Cadenza version:

  1. Check and update database schemas using the Database Migration Tool.

    • Backup your database before running the tool, as schema structures may change.

  2. Check and update the Cadenza API. The recommended version of Cadenza JS for use with this Cadenza version is v11.0.2 (see the release notes).

  3. If you use workbook reports with your own binaries of Chromium and ChromeDriver, check and update ChromeDriver. The version of ChromeDriver for use with this Cadenza version is v150 (see System Requirements).

Applying updates in sequence is strongly recommended, as skipping versions may lead to increased update effort.

Licensing and Feature Availability

New Licensing System

Cadenza 11.0 introduces a new licensing system. To start Cadenza 11.0, you need a license in the new format.

If you have not yet received a new license, contact Disy before upgrading.

The new license is configured as described in core Configuration.

Removed Plugin Configuration

The previous plugin system has been removed from Cadenza. Functionality is no longer enabled by explicitly listing plugins in a plugins.xml file or in a plugins configuration section.

Instead, Cadenza now makes functionality available automatically when all of the following conditions are met:

  • the functionality is included in your licensed Cadenza edition,

  • the required configuration is present,

  • the functionality has not been explicitly disabled.

Remove any existing plugins.xml files and any plugins: configuration sections before starting Cadenza 11.0 (otherwise Cadenza will not start).

This upgrade supports the new licensing model in Cadenza 11.0. Cadenza is now available in several editions, each of which enables a different set of features. Features are enabled by default whenever possible, so administrators do not need to explicitly configure newly available functionality after a license or edition change.

Existing configuration for previously used functionality should generally continue to work, subject to the additional migration notes described later in this document.

The available Cadenza editions and their features are described in Cadenza Editions and Features.

The conditions that determine whether a feature is visible or usable are described in Understanding Cadenza Feature Availability.

Edition-Based Feature Availability

With the removal of the plugin system, Cadenza now uses editions to control which features are available. After upgrading to Cadenza 11.0, the license file must contain a valid Cadenza edition. Cadenza will not start without one.

How feature availability is determined

A feature is available when all of the following conditions are met:

  • The feature is included in the licensed Cadenza edition.

  • The required configuration is present (if any).

  • The feature has not been explicitly disabled.

If an optional configuration is missing (for example, the mail client configuration required for subscriptions), the corresponding feature is disabled even if the edition includes it. Cadenza continues to start normally.

Startup prevention

Cadenza will refuse to start in the following cases:

  • The license file does not contain a valid edition.

  • A repository contains projects, but the edition does not include the projects feature.

  • A repository contains data protection configuration, but the edition does not include the data protection feature.

  • A purpose-of-request configuration is present, but the edition does not include the purpose-of-request feature.

Before upgrading, verify that your Cadenza edition supports all features currently used in your repositories.

New system privilege: Management API

A new system privilege named "Use Management API" has been introduced. Access to Management API endpoints now requires both the Management API feature and this system privilege. After upgrading, verify that the relevant user roles include this privilege.

The available Cadenza editions and their features are described in Cadenza Editions and Features.

New Mandatory Configuration datasources Configuration

In the new mandatory datasources Configuration at least one cross-repository data source must be defined: the central CDS data source which will be used to store all self-service data of all repositorys (with the exception of enrichments on existing workbook-internal data which is stored in repository-based CDS data sources).

Repository-based data sources ("repository data sources") can still be used unless they are based on templates or are linked as a CDS to a repository: If such data sources or the objecttypes based on them are to continue to be used, they must be replaced by cross-repository data sources. So corresponding data sources (accessing the same physical data source or a clone) must be defined in datasources Configuration. After that, the migration function in the Management Center can be used on the original data source so all the references will point to the new data source.

Changes to Access Manager Configuration Behavior

Authenticators are now enabled via their specific configuration. If necessary, each authenticator can be disabled using the new flag (enable settings).

An authenticator is enabled if the authenticators block is configured explicitly and the used authenticators are not disabled by the new flag.

The general access manager configuration is now optional.

Changes to Repository Database Schema Configuration

The repositoryList.xml file is no longer supported by Cadenza and must be removed. Additionally, the repositoryListFile setting must be removed from the core Configuration.

The settings to specify repository database schemas that were formerly configured in the repositoryList.xml file must be moved to the databaserepository Configuration.

The databaserepository Configuration is now mandatory and must contain at least one repository database schema.

Configuration Changes

visualizercore Configuration

These settings are no longer supported by Cadenza and should be removed from your configuration.

gistermweb Configuration

The following elements are no longer supported by Cadenza and should be removed from your configuration:

  • defaultCoordinateVisualizationSrs

  • In mapConfig the following elements should be removed:

    • controls

    • print

shapefileexport Configuration

The following elements are no longer supported by Cadenza and should be removed from your configuration:

  • columnNamesFrom

  • shapefileExportWhiteList

  • shapefileExportBlackList

  • exportAllowList

  • exportDenyList

  • exportAllObjectsDenyList

sdo Configuration

The following elements are no longer supported by Cadenza and should be removed from your configuration:

  • datasourceDescription

  • connectionDescription

workbook Configuration

The following settings must be removed from your XML/YAML configuration (otherwise Cadenza will not start):

  • PrintHeaders(no longer supported by Cadenza)

  • disclaimerForExternalLinks(moved to the Management Center)

  • liveMode(moved to the Management Center)

  • rowCountLimit(moved to the Management Center)

  • maxRowCountLimit(moved to the Management Center)

Settings moved to the Management Center require manual migration. Values previously configured in XML/YAML must be re-entered via the Management Center UI.

accessmanager Configuration

The configuration is now optional.

repositorydatasourcetemplates Configuration

The repositorydatasourcetemplates configuration is no longer supported by Cadenza and should be removed. Use datasources Configuration instead.

Anonymous Access (Guest Login) Configuration Changes

The attributes guestsAllowed and disableLoginButton from the authenticators setting are no longer supported and must be removed if configured. Instead, the guests setting is now available. Anonymous access is disabled by default. When enabled, the additional login option via the login button is now enabled by default and must be disabled if necessary.

Authenticators Configuration Changes

The authenticators setting is no longer used to enable the authenticators. An authenticator is enabled if a specific configuration exists, and is not disabled in that configuration. All specific authenticator settings now have an enabled setting; the default value is true.

accessmanagerldap Configuration

The following settings are no longer supported by Cadenza and should be removed from your configuration:

  • one-step-authentication

core Configuration

The following settings must be removed from your configuration (otherwise Cadenza will not start):

  • repositoryListFile (no longer supported by Cadenza)

  • view(no longer supported by Cadenza)

  • nullValueDisplayText(moved to the Management Center)

  • exportSettings(moved to the Management Center)

Settings moved to the Management Center require manual migration. Values previously configured in XML/YAML must be re-entered via the Management Center UI.

workbooktable Configuration

The following settings must be removed from your configuration (otherwise Cadenza will not start):

  • pivotTable(moved to the Management Center)

Settings moved to the Management Center require manual migration. Values previously configured in XML/YAML must be re-entered via the Management Center UI.

repositoryweb Configuration

The repositoryweb Configuration is no longer supported by Cadenza and should be removed. Its former settings were moved to the Management Center:

  • restrictions > attributeValueClassification

  • restrictions > intervalClassesLimit

Settings moved to the Management Center require manual migration. Values previously configured in XML/YAML must be re-entered via the Management Center UI.

referencingconfiguration Configuration

The following setting is no longer supported by Cadenza and should be removed from your configuration:

  • maximumExtents

For all built-in coordinate systems, the maximum extent is now specified by Cadenza.

postgis Configuration

The following settings are no longer supported by Cadenza and should be removed from your configuration:

  • Under raster the following settings must be removed:

    • cache