Upgrade notes (2.5 to 2.6)
Heads Up!
To upgrade Optimize to version 2.6.0 please perform the following steps first: Migration & Upgrade Instructions.
Here you will find information about:
- limitations,
- known issues,
- changes in the supported environments,
- any unexpected behvavior of Optimize (e.g due to a new feature)
New behavior of Optimize
With the introduction of the new collection and permission concept you might find the behavior Optimize startling and thus the subsequent sections will guide you thorugh the changes.
Collection Permissions & Private Reports
With Optimize 2.6.0 a resource permission system is introduced. This system provides private reports/dashboard entities in the Home section as well as the possibility to manage permissions on the level of a collection entity in order to share it with other Optimize users.
This ultimately means that after the migration to Optimize 2.6.0 each user only sees the entities he originally created. This includes reports, dashboards as well as collections. In order for other users to be able to access those entities they need to be copied into a collection and the others users being granted at least view access to those collection.
Grant access to a private report
Given the scenario that the user john
owns a report John's Report
that user mary
was used to access in Optimize 2.5.0 the
user john
can share this report in Optimize 2.6.0 with mary
following these steps:
- User
john
creates a collection named e.g.John's Share
- User
john
grants usermary
the viewer role on the collectionJohn's Share
- User
john
copies & moves theJohn's Report
report to theJohn's Share
collection - User
mary
will now see the CollectionJohn's Share
in her Home section of Optimize
Grant access to an existing collection
Given the scenario that the user john
owns a collection John's Collection
that user mary
was used to access in Optimize 2.5.0, the user john
can share this collection with mary
in Optimize 2.6.0 granting user mary
a permission role on that collection. Please refer to step 2 in Grant access to a private report.
Super User Role
In case entities are owned by a user that is not available anymore or in the case that the required collections and permissions shall be created by one user to save the communication overhead to ask for permission between users in the course of migration there is the possibility to grant a user Super User
permission. This means that user bypasses the owner/collection permissions and can access all available entities.
In order to grant a user Super User permissions see the Authentication & Security Section
Known issues
Rebuild your Optimize plugin
With Optimize 2.6.0 the plugin system got overhauled. In order for your plugins to continue to work you have to rebuilt them with the latest optimize plugin artifact as an uber jar. Please refer to the updated plugin setup guide
Misinterpreted cron expressions
The configuration of Optimize allows you to define when the history cleanup is triggered. For that, the Cron expression notation is used. However, the values are incorrectly interpreted in Optimize. For example, the historyCleanup.cronTrigger
configuration has the default value 0 1 * * *
, which should be 1am every day. Unfortunately, a bug causes this to be interpreted as every hour.
To fix this just use the spring cron expression notation. For instance, the default value for historyCleanup.cronTrigger
would then be 0 0 1 * * *
.