Skip to main content

Customizable widgets on the start page of CM/Track V3 (#662012, #662157)

The welcome page of CM/Track V3 can now be customized by adding generic widgets and using more than one news widget. This provides more flexibility when designing the start page and adapting it to the customer's requirements.

The configuration is done for the respective portal configuration in the new Widgets on welcome page section of the Portal configuration page of the Web Admin Suite. The widgets can be added to the grid by clicking the Add widget button. The user needs to select the widget type and provide the required settings.

Three widget types are available:

  • Case list: Shows the newest cases of the user. No configuration options.
  • Generic: Allows to display script-based content. A script of the type Widget visualization is required.
  • News: Allows to display news. A script of the type News publisher is required.

Generic widgets

Generic widgets allow to display totally customized content on the welcome page. You need to create a script of the type Widget visualization which defines the content and returns it in the render() method. The resources() method allows to include additional resources, as stylesheets, images or JavaScript files, which are saved in the ConSol CM data directory.

PrimeReact components

For technical reasons, it is not possible to use additional PrimeReact components in the visualization script.

The template for scripts of the type Widget visualization has been updated to reflect its new usage in CM/Track V3.

A new REST API endpoint called /widget/{scriptName} has been introduced to retrieve the resources needed for the widget.

News widgets

It is now possible to use several news widgets by adding them to the grid. Therefore, the News widget section has been removed from the Portal configurations page and the settings are now available for the individual widgets in the widget details, which can be opened by double-clicking the widget in the grid or clicking the Edit icon.

Update and migration

The existing news configuration in the config.json file is migrated automatically when updating ConSol CM or creating a configuration for CM/Track V3 based on an existing configuration for CM/Track V2.