Migration notes 3.0.0
This page explains the changes required to migrate to the stated version of the Bookmark Tool.
Migrate to 3.0.0
Upgrading from version 2.2.0, see Bookmark Tool 3.0.0 Release Notes.
Overview
The 3.0.0 version of the Bookmark Tool is released as:
| Version | Details |
|---|---|
| 3.0.0-AP5.10 | Built using ActivePivot 5.10.4. |
| 3.0.0-AP5.11 | Built using ActivePivot 5.11.3. |
| 3.0.0-AP6.0 | Built using ActivePivot 6.0.0. |
All versions are compatible with the bookmarks structure of ActiveUI 5.0.3+.
Version 3.0.0 also represents an extensive refactoring of the API; migrating packages, renaming classes and reducing reliance on static methods.
API changes
The following is a list of all the API changes made for version 3.0.0. Projects upgrading from version 2.2.0 are likely to only be affected by the package change of the BookmarkTool class.
Modified classes
| Class | Details |
|---|---|
BookmarkTool |
Moved package from com.activeviam.tools.bookmark.impl to com.activeviam.tools.bookmark. |
CSConstants |
Removed from com.activeviam.tools.bookmark.constant.impl and split into the following sets of constants: |
* com.activeviam.tools.bookmark.constants.Paths - Filesystem and content server path. |
|
* com.activeviam.tools.bookmark.constants.Role - Content server role. |
|
* com.activeviam.tools.bookmark.constants.Tree - Content server bookmark tree. |
|
ContentServerToJsonUI |
Renamed to Exporter. |
Moved package from com.activeviam.tools.bookmark.impl to com.activeviam.tools.bookmark. |
|
| Converted from a collection of static methods to a standard Java object. | |
| Updated expected content server structure to ActiveUI 5. | |
JsonUIToContentServer |
Renamed to Importer. |
Moved package from com.activeviam.tools.bookmark.impl to com.activeviam.tools.bookmark. |
|
| Converted from a collection of static methods to a standard Java object. | |
| Updated expected content server structure to ActiveUI 5. |
Added classes
| Class | Details |
|---|---|
BookmarksDTO |
Simplified object representation of a content server bookmark tree. |
MetadataDTO |
Simplified object representation of content server metadata. |
Removed classes
| Class | Details |
|---|---|
SnapshotNode |
Removed to reduce reliance on representing bookmarks as JSON objects internally. |
Format changes
note
Please migrate your bookmarks to ActiveUI 5 before attempting to use this tool. For any ActiveUI 4 projects, version 2.2.0-AP5.9 is forwards-compatible with ActivePivot 5.10.
Version 3.0.0 contains extensive format changes of the exported bookmarks, in order to be compatible with the ActiveUI 5 content server structure. The export and import of empty folders is now supported.
Changed
| Directory | File | Details |
|---|---|---|
| Any | bookmark-name.json |
Updated format to match ActiveUI 5 bookmarks. |
| Any | bookmark-name_metadata.json |
Updated format to match ActiveUI 5 bookmarks. No longer optional. |
Removed
| Directory | File | Details |
|---|---|---|
| ./ | i18n.json |
Removed by migration to ActiveUI 5. |
| ./ | settings.json |
Removed by migration to ActiveUI 5. |
| ./ | version.json |
Removed by migration to ActiveUI 5. |
./bookmarks-listing |
Any | Replaced by directories matching the ActiveUI 5 content server structure. |
Added
| Directory | File | Details |
|---|---|---|
| ./ | calculated_measures.json |
Direct content server export of any saved calculated measures. |
| ./ | users.json |
Direct content server export of user details and settings. |
| Any | bookmark-name_thumbnail.json |
File representing the UI thumbnail of a bookmark. |
./dashboards |
Any | Directory for ActiveUI 5 dashboards. |
./filters |
Any | Directory for ActiveUI 5 filters. |
./widgets |
Any | Directory for ActiveUI 5 widgets. |