Upgrading to 2022.3

Owned by Emilie Nucci
Last updated: Apr 15, 2022 by Guillaume LEPICARD
3 min read

 

 

Default NAR changes

Created structures

wxmanalyticsalerting

This structure needs to be created to enable the “Alerting” feature in the analytics screen.

Other NAR changes

The portal team is preparing some changes to the default DAM application. Those changes are not released in 2022.3. Nevertheless, some changes to the default NAR have been committed, and are listed below.

Those changes are not required for upgrading to 2022.3

Added structures

pkgroletemplate

Update structures

aicelebrity

Structure changes

  • objectfamily 0 --> 14

aicolor

Structure changes

  • objectfamily 0 --> 14

ailandmark

Structure changes

  • objectfamily 0 --> 14

asset

Structure changes

  • objectfamily 0 --> 11

assetauthor

Structure changes

  • objectfamily 0 --> 12

assetchannel

Structure changes

  • objectfamily 0 --> 13

assetcolorspace

Structure changes

  • objectfamily 0 --> 15

assetcoverage

Structure changes

  • objectfamily 0 --> 12

assetformat

Structure changes

  • objectfamily 0 --> 15

assetgeography

Structure changes

  • objectfamily 0 --> 12

assetiaconcept

Structure changes

  • objectfamily 0 --> 14

assetkeyword

Structure changes

  • objectfamily 13 --> 12

assetlanguage

Structure changes

  • objectfamily 0 --> 12

assetnature

Structure changes

  • objectfamily 0 --> 15

assetrighttype

Structure changes

  • objectfamily 0 --> 18

contentcomments

Structure changes

  • objectfamily 0 --> 19

contentcommentsfile

Structure changes

  • objectfamily 0 --> 19

country

Structure changes

  • objectfamily 0 --> 18

damimport

Structure changes

  • objectfamily 0 --> 17

folder

Structure changes

  • objectfamily 0 --> 12

lang

Structure changes

  • objectfamily 0 --> 18

massimportitem

Structure changes

  • objectfamily 0 --> 17

massimportjob

Structure changes

  • objectfamily 0 --> 17

organization

Structure changes

  • objectfamily 0 --> 13

pimasset

Structure changes

  • objectfamily 0 --> 11

pimassettype

Structure changes

  • objectfamily 0 --> 13

pkgsecugroup

Fields changes

  • roles (updated)

    • Tags

      • Added tags

        • pkg/integrity/ignore

product

Structure changes

  • objectfamily 0 --> 13

productcategory

Structure changes

  • objectfamily 0 --> 13

resolution

Structure changes

  • Tags

    • Added tags

      • rest_api_include/appsettings

role

Structure changes

  • Tags

    • Added tags

      • not_delete_if_used

      • pkg/integrity/keep

      • pkg/security/secugroup/all

      • rest_api_create_not_required

      • rest_api_dam_create

      • rest_api_dam_delete

      • rest_api_dam_update

      • rest_api_dam_workflow

      • rest_api_include/appsettings

    • Removed tags

      • pkg/security/secugroup/view

Fields changes

  • infosde (added)

user

Structure changes

  • Tags

    • Added tags

      • rest_api_gen_aggs/appsettings

      • rest_api_include/appsettings

Fields changes

  • pkgroletemplate (added)

userregistration

Structure changes

  • objectfamily 0 --> 20

videoratio

Structure changes

  • objectfamily 0 --> 15

vueapphomevisual

Structure changes

  • objectfamily 0 --> 16

vueapphomewidget

Structure changes

  • objectfamily 0 --> 16

wkfasset

Structure changes

  • objectfamily 0 --> 21

wkfpkgskmetadata

Structure changes

  • objectfamily 0 --> 21

Important change in the REST API contribution plugins

It is mandatory to update the plugins that contribute to the API by API Business Services.

REST API contribution plugins are those that provide extension components that modify the behavior of the REST API (also called API Business Services). These components extend classes provided by the restapibs.jar library (see API Business Services (Extensions) ).

Changes to be made in these plugins

  1. It is imperative first to update the restapibs.jar library of these plugins with the one that will be delivered in the WXM_RESTAPI plugin of the release 2022.3

  2. In the config.xml file of the plugin, add the following entry in the services section:

    <service provides="com.noheto.extensions.interfaces.services.InstallableService"> com.noheto.restapi.startup.ApiBusinessServiceStartup </service>

Check that your components are taken into account and operational

At the moment it is necessary to go to the Java-Coded Business Services section to check the status of the detected extension components :

See The Java-Coded Business Services section of the API Designer

Changes in operation

Operation / invocation of components

An extension component is no longer executable if the plugin that defines it is not completely started. In some cases, components will be ignored or associated services will be disabled. In other cases, an exception will be thrown.
It is always considered in the general case that if a component is explicitly referenced (i.e. with a plugin name and a class name) in a configuration, it is essential to the operation. In previous releases, the absence of the component threw an exception and an alert was raised to the plugin status when WXM_RESTAPI was started, which is no longer possible. The error will at worst be detected at execution. Special cases are managed:

  • OAuth2 API configurations that use an extension component (e.g. com.noheto.restapi.OAuth2UserBindingAdapter) are disabled if it is not started, or cannot be started (because of a problem with the implementation class)

(cf https://crossmedia.atlassian.net/browse/WXM-12786 )

Normally the changes made have no impact on the execution itself, only on the loading, starting and detection of the component. However, it is recommended to perform a test of the functions that use these components after migration to check that everything is working properly.

Status

Temporarily, alerts on components in error or missing at the start of the WXM_RESTAPI plugin are no longer reported in the status of the plugin, and therefore the engine. It is therefore necessary to check that everything is going well by consulting the status of the REST API (see REST API plug-in status ) and the status of each extension component (see The Java-Coded Business Services section of the API Designer).

Components that are no longer supported as of 2022.3

  • Swagger Contributions (Components that extend com.noheto.restapi.SwaggerContributionAdapter)

  • Configuration Contributions (Components that extend com.noheto.restapi.ConfigContributionAdapter)

  • DXM JWT claims (Components that extend com.noheto.restapi.DXMJWTClaimsAdapter)