Backoffice - Widgets and menus

This documentation applies to version 2023.3.0 and upper.

For previous versions, please refer to BO Configuration checklist (prior to 2023.3)archived

Dashboard widgets

Starter-kit provides a set of default widgets for the BO dashboard as well as a mechanism to assign default widgets to users based on their role (or role-type).

Those widgets are provided through plugins. You might need to adapt plugin parameters based on the setup of the platform.

Remaining of this documentation is technical. In a nutshell, as a Project manager, you must know that

The 2 widgets Latest assets and Assets about to expire are listing latest assets and assets about to expire in all dam collections, based on user’s permissions.
Simple widgets providing “Todo lists” for your users are likely to be easily configured by a technical consultant.
The Assets access widget has been deprecated in 2023.3.0 though it is still available for users who have added it to their dashboard. This behaviour can be changed (keep reading)

PACKAGED_DAM_DashboardWidgets

This plugin provides 2 widgets:

Latest assets
Provides for each DAM collection on which user has read permissions the 5 last created assets. A link to access the full list of assets ordered by creation date
Assets about to expire:
Provides for each DAM collection on which user has read permissions the 5 first assets that will expire within 21 days. Duration can be configured in the plugin.

Those 2 widgets can be configured in PACKAGED_DAM_DashboardWidgets:

parameter name	default value	description	comments

parameter name	default value	description	comments
wedia_packaged_dam_dashboard_asset_objectname	#damobject	Name of the asset library to build widgets with
wedia_packaged_dam_dashboard_asset_expirancy_property	dteendrights	property used to find assets about to expire.
wedia_packaged_dam_dashboard_asset_expirancy_others_property	binary	add coma separated list of properties to include in the widget. binary is required to display a thumbnail of the asset.	deprecated in 2023.3.0 ; was used in previous version to select properties to display
wedia_packaged_dam_dashboard_asset_expirancy_days_countdown	21	Max number of days before archiving for filtering assets about to expire

PACKAGED_BOV3_DashboardWidgets

This plugin provides the ability

to define simple data list widgets
to filter widgets available for a user
to define default widgets for a user based on his role
to define default widgets for a user based on his role type

Define simple list widgets

Use configured_widgets parameter to define widgets.

Don’t get afraid by the following definition, have a look to plugin’s default configuration to get some working examples on how to configure new widgets.

This parameter is a JSON Object. Each key is concatenated to “PACKAGED_BOV3_DashboardWidgets_“ and will define the widget code. Each associated value is a JSON object following this type definition:

interface ConfiguredBloc {
  object: string // the object for which we want to create a widget 
  fields: Array<string> // fields to display in the widget - default: ["name"]
  orderBy: string // the order by to use for retrieving objects - default: "pid desc"
  filters: Record<string, Record<string, any> // filters to apply. same syntax as /bov3/datalist/preload.jsp
  query: QueryConstraint // deprecated see archive page for more information
  bases: Array<string> // bases from which the PreparedWhere will be used - default: null
  actionsPosition: string // position of actions in list - default: "after"
}

Remove widgets

Use remove_widgets parameter to filter out widgets you don’t want to provide to users. The parameter is a JSON Object. Each key refers to a widget key. Each value is either a boolean (which value should be true) to remove the widget for all users or, a string containing an expression language that should evaluate to a boolean. Example: "${surfer.properties.roleid ne '4'}"

Define default widgets for a user

You can define default widgets to automatically assign to a user when he has been created. This will ensure the user will not get an empty dashboard first time he connects.

Prior to 2022.5 , roles were entirely managed by the project team. Starting from 2022.5 as roles can be created by the customer, it is recommended to use the role type default widgets configuration.

Default widgets assigned to a user are defined based on their role ID and fallbacks on their role type.

Default widgets defined for a role are configured in the default_widgets parameter. This parameter is a JSON object. each key denotes a role ID. It contains an object with a bloc property (Array). Each item in the array is a JSON object with the following interface:

interface DefaultBloc {
  code: string // the widget code 
  title: string // the i18n key that will be used for the widget title
  path: string // the JSP page displaying the widget
  open: boolean // is the widget opened by default
  img: string | null // the image of the widget
  nbr: string // number of items to display for a list
  params: string
  col: string // target column
}

Back Office menu

Default Back Office menu is auto generated based on user permissions:

For all DAM collections: For each collection a user has view grants, an access to the collection will be provided.
Administration menu will provide links to users, roles, portal widgets… based on user permissions.

It is still possible to contribute and assign menu using the rubrique object. Entries assigned to a role will be added after automatically generated entries.