Upgrading to 2021.6

Owned by Guillaume LEPICARD
Last updated: Jan 06, 2022 by Antonin MEUNIER (Unlicensed)
10 min read

 

Breaking changes

PACKAGED_DAM_Utils

The system relies on new structures updates to work properly, please apply these structure updates to you current version to upgrade to 2021.6

Structures updates

lang

Added structure tag pkg/security/secugroup/view in order to enable securing view access on this structure’s instances through PACKAGED_Security plugin.

Instance of ID #4 (German) has been activated.

userregistration

Removed structure tags rest_api_dam_update and rest_api_include.

Added structure tag pkg/security/secugroup/all in order to enable securing all actions on this structure’s instances through PACKAGED_Security plugin.

Removed unicity indexes

Redefined properties of structure

vueapphomewidget

Added structure tag pkg/security/secugroup/all in order to enable securing all actions on this structure’s instances through PACKAGED_Security plugin.

wxmcartshare

Added a property visible who is the list id’s liste of the assets in a board that will be visible when the cart will be shared.

New HTML editor

Until now, Wedia used CKEditor and Quill to edit html text in the content edition, to write comments or to edit print documents. As CKeditor has deprecated the use of the “WebspellChecker” plugin we used for advanced spell checking, we took the opportunity to replace the CKEditor / Quill with a brand new editor : Froala.

Froala is a state of the art text editor, and offer a brand new text editing experience. Notable improvements are :

  • when pasting styled text, a better cleanup of the content is now performed,

  • spell as you type functionality

  • cleaner user interface.

In order to activate Froala, please follow the following steps :

  • Set the defaultEditor parameter in the WXM_Wysiwig_Editor to froala.

  • Set the defaultEditor parameter in the WXM_DTP_MANAGER to froala.

CKEditor is still supported, but if you opt in to use CKEditor, you will only loose the Webspellchecker advanced spell checking.

If you want to stick with CKEditor,

→ In Web-to-Print : there is a parameter called “defaultEditor“ in the WXM_Wysiwyg_Editor and another one in the WXM_DTP_MANAGER, set both to “ckeditor” and CKEditor will be used in the web-to-print editor.

→ In the Back-Office : if you pass the editor=ckeditor parameter in the URL, you will revert from Froala to CKeditor in the dataedit, commenting sections.

 

New Froala design and functions :

  • Dataedit :

When you edit an HTML property of an asset, an HTML editor is displayed to write rich text :

Misspelled words are underlined in orange as you type and you can see on the bottom right the current status of the spell check : no error, or the error count. By clicking on the orange check you may change the language, or other spell checking options.

 

  • Comments :

To write comments, Froala is also used:

 

  • Print :

The editor has been also changed in the print editor :

 

Web-to-Print enhancements

Along with Froala, we added great improvements to text editing in web-to-print:

 

  • Font-family change : it is possible to apply a new typeface in the text edition, restricted to the font list currently used in the edited document.

  • Font-size change : it is possible to apply a new font size in the text edition, either by picking a size from the predefined list or user defined.

Froala also offer typographic correction in multiple languages :

These features are only available in Froala and can be deactivated in the WXM_Wysiwyg_Editor plugin option page. Currently we do not offer them on a document per document, or text box per text box granularity.

 

New Analytics features

Analytics dashboards have been reshaped in order to have more consistency.

The “Audience and Usages” dashboard has been removed. Most of it content have been moved under the “Back-Office” tab.

Additionally, some dashboards have been added to the “Back-Office” tab such as “Views” or “Downloads”, so that it almost fully matches with “Portal” tab.

 

New Boards features

  • The names of the asset displayed in a board are now internationalized , if possible, with the current surfer locale.

  • A size unit ( MB ) has been added to the files size in the mail when sharing a board by zip.

  • Back-office Before, if you would share a board with someone by link, it was only possible to share the totally of it. It’s now possible to share only a part of a board. To achieve such a goal, just select the assets you want to share and process as before.

  • Boards download limits changes :

    Default limits for downloading boards have changed. Now a warning is displayed when estimated download is above 512mo and the hard limit is set to 4Go.

New Imaging API command in the REST API

Clip

The clip command allows you to fill the space delimited by a path (not only clipping path) with a color.

See documentation : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2119860268 .

There is a strong adherence to the implementation of this command and the image processing server environment. The version of ImagingServer and its associated components must be the one that corresponds to the plugin version (i.e. the engine version). It is preferable for a local server to use a docker version of the image processing server environment.

Examples:

Source image with two paths

Example of results

New REST API Security domains and actions

The RESTAPI domain

Controls access to the end point. This domain is delivered disabled as standard, with a blocking rule on the api action that allows you to configure access to all endpoints.

The parameters are:

  • surfer: the surfer

  • request: the request

  • endPoint: the endpoint identifier

  • resourceName: the name of the resource

  • objectName: the name of the object (only for resources associated with a single object)

  • fieldName: the name of the field (only for the concerned services)

  • preset: the name of the preset (only for the concerned services)

It is possible to isolate the processing for an endpoint by adding an action whose name is the endpoint identifier: in this case, the specific action will be used instead of the api action.

See https://crossmedia.atlassian.net/wiki/spaces/WD/pages/11829825 for more details

The restapi_docportal domain

Controls access to the document portal (doc swagger of endpoints and documentation of error messages). This domain is delivered disabled by default, with a rule blocking all access.

See https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1179123738/API+Documentation#Access-to-documentation-by-user-(object-user) for more details.

The RESTAPIDEBUG domain

Controls the ability to use the debug parameter in the endpoints (which is not possible by default in production mode). It is also possible to determine the level of verbosity (two levels: with or without detailed information). This domain is delivered disabled by default, with a rule blocking all access.

Information

The documentation of the plugin configuration has been completed: .

The APIDesigner has been enriched with a new Setup section that displays the configuration values currently and actually used by the plugin (some parameters are evaluated from the value indicated in the plugin configuration – default value, evaluated variables, evaluated enumerated values, composition, configuration recovery from other plugins, replacement values and fallbacks in case of error...):

See

Reminder

It is always better to recompile the plugins that use the restapibs.jar library, with the version of this library provided with the WXM_RESTAPI plugin, and to redeploy them.
For this release, JavaSE 11 support has been added: it is absolutely necessary to update restapibs.jar in all your contribution plugins, recompile and redeploy them.
The restapibs.jar library can now work within a plugin compiled in JavaSE 11 or JavaSE 8.

 

Default expiration date of a shared board link in Portal

You can now configure the default expire date of link when you share a board.

How to use :

// board/behaviors.json { "shareExpireEndOfMode": "week", // can be week, month or nothing if we want J+X days "shareExpirePlusDays": 21, }

Opening direction of inputs in form

In Edit forms (like mass import), you can now force the select inputs to open to the bottom so it doesn’t overlap with the header of the form.

// edit/default/fields/types/array/default.json { "openDirection": "bottom" }

Portal input text pattern checks

New configuration to handle inputs behaviors based on regular expressions :

  • Split user input to make a multi value search from fulltext inputs :

  • Search for ids from fulltext inputs :

How to tune this behavior :

// /dam/explore/full-text-search.json { "regexId": "^#\\d+$", "pattern": { "regexps": ["\\d+"], "separators": ",; ", } }

 

  • Split user input to make a multi value search from advanced search text inputs :

How to tune this behavior :

 

Disabling Send by email and Copy link in the Share asset popup

If configuration needed, add file in : “src/wedia-plugin-template/res/_portal@club-wed/common/named-actions/dam-download/props.json” containing:

Better UX for separating direct login and SSO login

New fine-grained permissions security domain an rules

A new “objectactions” domain is now available (disabled by default) to better fine tune the authorization given to a user.

The new actions can be passed two parameters :

  • surfer

  • objectname

In this domain, the new security rules available are :

  • create: can a new instance of this object be created ?

  • delete: can a instance of this object be deleted ?

  • order: can the instances of this object be ordered ?

  • multiupdate: si the bulk update function available ?

  • datavaluespicker: is it possible to pick some content to past on new instance or during multi-update ?

  • damimport: is it possible to bulk import via damimport ?

  • massimport: is it possible to bulk import directly in the object ?

Enhancements in the home carousel

In previous versions of portal, it was required to create a dummy cursor “home-header-carousel“ to be able to display images in the Home carousel, even if you were providing static assets.

As of 2021.6, you need to remove that cursor if you want to use direct images. Otherwise, the two configurations will mix and you might have two carousels showing