Release Notes 5.5
What’s New
map.apps SDI 5.5.0 provides the new app state and some bugfixes and small changes.
The new app state
The new version of map.apps SDI app state management includes a lot of improvements. It allows an app state to be loaded at runtime without having to restart the app. This optimizes the user experience and offers developers more options.
Furthermore, it is possible to use the app state management simultaneously with the map.apps bundles parameter-manager
and parameter-url
without issues.
The new app state management is backward compatible with app states that were created in the past.
However, if you implemented a custom ParameterResolver
, you will have to adapt this component to the new EncoderDecoder
interface to make it work in the current version.
Update Notes
If you skip several versions during the update, please also follow all update notes of the intervening versions. |
App state management bundles
You can use the older versions without taking any action now. But these bundles are now deprecated and will be removed in the future.
Do not use the new and the old versions at the same time. Please make sure to remove the old bundles when migrating as described below. |
For a default map.apps SDI installation follow these steps:
-
Remove all deprecated bundles from your app(s)
-
sdi_appstatemanagement
-
sdi_appstatemanagementshared
-
sdi_appstatemanagerintegration
-
sdi_appstatestore
-
sdi_share-link
-
-
Add new bundles to your app(s)
-
sdi_appstate-ui
-
sdi_appstate-share
-
sdi_appstate-map
-
sdi_appstate-layout
-
-
Configure the new map.apps Manager integration
-
Open the map.apps
application.properties
file. -
From the property
manager.config.viewbundles
replace the entrysdi_appstatemanagerintegration
withsdi_appstate-manager-integration
.
-
Components that provides Parametrizable
interface
The deprecated version of the map.apps SDI app state implementation used the map.apps Parametrizable
interface to harvest the data for an app state.
Therefore, all components that provided this interface were considered.
However, this caused conflicts and the app state management could not be used simultaneously with the map.apps bundles parametermanager
and parameter-url
.
To get over these issues, the interface sdi_appstate-api.EncoderDecoder
was introduced which only slightly differs from the Parametrizable
interface.
If you implemented a custom Parametrizable
component for saving and restoring a certain aspect of your app, you will need to migrate it to the new sdi_appstate-api.EncoderDecoder
interface.
For further information see the bundle documentation of the bundle sdi_appstate-api.
New data structure for app states
The internal JSON structure of an app state has changed.
In the past version all URL parameters were located at the root level of the JSON object.
In the current version, an enclosing property layer was introduced that wraps up all properties belonging to a single EncoderDecoder
.
For backward compatibility the new implementation automatically converts legacy app states to the new data structure.
For this reason, a mapping from the parameter name to the corresponding EncoderDecoder
is required.
For the EncoderDecoders
shipped with map.apps SDI, no configuration is necessary.
However, if you implemented a custom EncoderDecoder
, you will have to add an entry to the customDecoderMap
of the LegacyStateConversionConfig
component in the sdi_appstate-api
bundle.
For further information refer to the documentation of the sdi_appstate-api bundle.
Known Limitations
Issue | Description |
---|---|
|
[ToC] [SceneService] Warnings regarding unsupported SRS aren’t shown properly |
|
CopyrightViewer: The copyright of enabled (instead of visible) services is shown in the copyright viewer |
|
After changing the SLD of a WMS layer, the legend doesn’t update |
|
Additionally loaded services are pushed over the sketching layer |
Changelog
5.5.0
New features
|
[LoadService] Support of WEBTILE services |
|
[LoadService] Accessibility improvements |
|
New App State |
Fixed issues
|
[LoadService] Invalid replacement of WMTS url |
|
[LoadService] Search for favorites: Groups with results don’t open automatically |
|
[LoadService] Metadata request for WMTS without KVP support doesn’t work |
|
[LoadService] Filtering of child nodes is missing |
|
[LoadService] Dynamic loading of certain WMTS fails |
|
[LoadService] Dynamic loading of certain WFS fails |