Skip to content

What's New Modal

The What's New modal displays release notes to users when a new version of Clarive is available. The modal appears automatically on login or page reload when the version changes.

Permissions

The modal requires the action.user.whatsnew permission to be enabled for user roles.

By default, no roles have this permission assigned. Administrators must manually assign the permission to the desired roles.

To enable the What's New modal

  1. Navigate to Admin - Roles
  2. Select the role to edit (e.g. user or developer)
  3. Open the Available Actions tab
  4. Drag View What's New on Login from the left pane to the right pane
  5. Save the role

Note If no roles have this permission assigned, the modal will not appear for any users.

The modal displays when:

  • A new version is detected (different from the user's last seen version)
  • The user has not disabled the modal for the current version

The modal does not display when:

  • The user lacks the action.user.whatsnew permission
  • The user has already accepted the current version
  • The user has clicked "Don't show this again" (until a new version is released)

User Actions

Users can interact with the modal in three ways:

  • Close (X) - Closes the modal without saving. The modal will appear again on the next reload.
  • Accept - Marks the current version as seen. The modal will not appear again for this version.
  • Accept + "Don't show this again" - Marks the version as seen and disables future notifications until a new version is released.

New Version Behavior

When a new version is released, the modal automatically appears even if users previously clicked "Don't show this again". This ensures important release information reaches all users.

Data Persistence

User preferences for the What's New modal are stored as attributes in the user model:

  • whats_new_last_seen - Stores the version number last viewed by the user
  • whats_new_disabled - Stores whether the user disabled future notifications (0 or 1)

These attributes are stored in MongoDB and are included automatically in database backups. No special export or import procedures are required.

For more information about user model attributes, see the Users documentation.

Troubleshooting

  1. Verify the user's role has the action.user.whatsnew permission
  2. Check that CHANGELOG.txt exists in the Clarive root directory
  3. Verify the CHANGELOG format follows the required structure:
----- 7.16.1 -----
[ENHANCEMENTS]
- #1234 Feature description

[FIXES]
- #5678 Bug fix description

This is expected behavior if the user closes the modal with the X button without clicking Accept. To prevent the modal from appearing, the user must click the Accept button.