Breaking changes

https://crossmedia.atlassian.net/browse/WXM-16812

Rewriting changes

Inbound changes

New Rules

WXM-RESTAPI

Important changes in debug mode

As a reminder, the debug mode of the REST API allowed you to

• debug information for each request

• on the other hand, to provide information in error messages where applicable

In a request, the debug=true parameter activated the display of debug information. On a server in development mode, the value of this parameter was true if omitted. It was possible to enable the use of this parameter on a server in production mode, either through a plugin parameter (allowDebugInProduction) or through security (RESTAPIDEBUG domain). This security domain could also be used to control the information accessible in errors.

Starting with version 2024.4.0

• the debug parameter always has the same function

• this parameter has no default value (which is equivalent to default=false)

  • you can set it to a default value of true on a development environment using the requestDebugDefaultValue plugin parameter.

  • the allowDebugInProduction plugin parameter has been removed

• the RESTAPIDEBUG security domain has not changed

• it is possible to run your own session in debug mode (which means as if you passed the debug=true parameter in the query) via the _plugins/WXM_RESTAPI/page/admin/debug/allowdebug.jspz page. You'll need a developer role to access this page (role 4).

• it is possible to enable access to debug mode, including for integrators in production environments, via the _plugins/WXM_RESTAPI/page/uadm/surferdebug.jspz page. You'll need a developer role to access this page (role 4).
  in this interface, you can

  • authorize a user to use the debug parameter in their requests

  • indicate the value of this parameter if it is not passed in the request

  • configure the level of information available in errors, from among

    • none

    • contextual information (object identifiers, structure and field names, internal information…)

    • stack trace ( very sensitive information: a stack trace can give precise clues to the application's inner workings)

  • indicate an expiry date for these rights

  • temporarily suspend these rights

See more information on https://crossmedia.atlassian.net/browse/WXM-16883

Customer intégration

Please inform customers and integration teams that they must consult Code integration (REST API invocation) before writing customer code that will use the API.

Plugin startup controls

wkfmassimportjobaction

wkfmassimportjobaction/9 (ADDED)

• activated: 1

• child:

• condition:

• created: 02/09/2024 15:40:31

• forward: 0

• icon:

• id: 9

• modified: 02/09/2024 15:40:31

• name: reset

• ontransition:

• owner: 3

• parent:

• position: 0

• roles:

• state_in: 9

• state_out: 2

• status: 2

wkfmassimportjobaction/10 (ADDED)

• activated: 1

• child:

• condition:

• created: 02/09/2024 15:46:06

• forward: 0

• icon:

• id: 10

• modified: 02/09/2024 15:46:06

• name: reset

• ontransition:

• owner: 1

• parent:

• position: 0

• roles:

• state_in: 11

• state_out: 2

PACKAGED_Portal

/portal to /dam/wedia

Starting from 2024.4, by default the front-end’s main entry point is changed from /portal/ to /dam/wedia/
(URL rewritting rules are present to redirect from /portal to /dam/wedia)

Therefore the app’s default vue_apps_base_url.portal has been updated in tools\wediaportal-cli\api\constants\defaultConfig.mjs

If you haven’t configured a specific vue_apps_base_url.portal in your project, on the next front-end build, the app will be configured for /dam/wedia/

New configuration point

Portals

A new configuration domain has been added to portal’s json configuration. It is mainly used by the new components added for the Portals. The new domain (folder) is placed at the same level as the dam, product, spaces or dam-import domain, and it is called : portals

This domain is necessary if you want to use the new feature on your front-end.

Starter-kit’s common config has been updated too, new named actions and named displays have been added.

More details about the configuration possibilites can be found here : Portals installation guide | 4/ Configuration possibilites

Changes Information

Structures changes

asset

Fields changes

• portals (added)

  • Type: childmultilngdb

  • Nature: portal

  • Label:

  • Default value:

  • Order: 7300

  • Remote name:

  • Max size: 0

  • Attachment:

  • In list:

  • Editable: false

  • Viewable: false

  • Mandatory: false

  • Null if empty: false

  • Auto carriage return: false

  • Index: Not indexed

  • i18n: false

  • i18n for:

  • Tags: rest_api_include

Tags

Removed

• exportxls

user

Fields changes

• activated

  • Tags:

    • Added: datalist_search_simple

• pkgroletemplate

  • Tags:

    • Added: datalist_search_simple

assetgeography, assetkeyword, assetauthor, assetiaconcept, folder, pimasset

Portals feature new structures

Front widgets structures update

Instances changes

pkgroletemplate

assetnature

country

resolution (In preparation for MCV2)

vueapphomewidgettype, homewidgetelttype

wkfpkgportal, wkfpkgportalaction

Plugins changes

PACKAGED_CreativeWorkflow

plugin.xml

• Parameters:

  • UPDATED portal_base_url:

    • default value:

      • Old:

      portal

      • New:

      dam/wedia

  • UPDATED batch_periodicity:

    • description: Defines the periodicity (in seconds) of batch processing and delay of last modifiction batch files to process. --> Defines the periodicity (in seconds) of batch processing and delay of last modification batch files to process.

PACKAGED_Portals

plugin.xml

• Services:

  • ADDED com.wedia.packaged.portals.extensions.AssetsTrigger (com.noheto.extensions.interfaces.services.IObjectTriggerBusinessService)

• Parameters:

  • ADDED portal_base_url:

    • type: string

    • mandatory: true

    • description: Portal Base URL

    • default value: dam/wedia

  • ADDED max_portals:

    • type: int

    • mandatory: true

    • description: Defines the maximum number of portals available. Enter a negative number to disable limits.

    • default value: 10

  • ADDED portal_download_expiration:

    • type: int

    • mandatory: true

    • description: Number of days before deletion of portaldownload instances

    • default value: 7

  • UPDATED max_assets_async:

    • description: Defines the maximum number of assets to submit in order to automatically switch to asynchronous treatment for assignation/removal
      of assets to/from portals. --> Defines the maximum number of assets to submit in order to automatically switch to asynchronous treatment for assignation/removal of assets to/from portals.

    • default value:

      • Old:

      50

      • New:

PACKAGED_RegistrationEmails

plugin.xml

• Parameters:

  • UPDATED portal_entry:

    • default value:

      • Old:

      • New:

  • UPDATED success_redirect:

    • default value:

      • Old:

      • New:

  • UPDATED timeout_redirect:

    • default value:

      • Old:

      • New:

  • UPDATED error_redirect:

    • default value:

      • Old:

      • New:

PACKAGED_DAM_Utils

More information about the modifications can be found here : Resolving automatic asset publication in 2024.1, 2024.2 and 2024.3

plugin.xml

• Parameters:

  • UPDATED dam_denormalization_config:

    • default value:

      • Open

        

         

      • Open

        

• UPDATED dam_denormalization_force_update:

  • description: force triggers on update --> Force triggers on every update. This should never be set to true unless for debug purposes

WXM_MEDIACLOUD_V2

plugin.xml

• Services:

  • ADDED com.wedia.mediacloud.cloudApi.Trigger (com.noheto.extensions.interfaces.services.IObjectTriggerBusinessService)

WXM_VARIATIONS_API

plugin.xml

• Services:

  • ADDED com.wedia.dam.transform.providers.ImagingTransformationsProvider (com.noheto.extensions.interfaces.services.InstallableService)

PACKAGED_Security

plugin.xml

• Parameters:

  • UPDATED role_template_default_permissions:

    • default value:

      • Update: content below added after l688

      •  

security.xml

UPDATED pkgV1ObjectActions(action)

UPDATED pkgV1Objectdata(action)

Old expression

Plugins Config changes

WXM_CONFIG_RESOLVER

• Parameters:

  • UPDATED config_settings:

    • New value :

WXM_FulltextSandbox

Overview

• Activated:

  • false -> true

• Parameters:

  • UPDATED fieldsBoosts:

    • New value : { "*.#boost40": 40 }

Overview

These updates are linked to the tag boost40 set on the fields portal.name, portal.namefr, and portal.namede.

This configuration enhances the search relevance of these fields by a factor of 40 during full-text searches on portals. For instance, it affects how portals are displayed in the DAM Search (see 1. Access and search for a portal | Searching for a Portal through the DAM for more details about this functionnality).

For more information about the configuration possibilities for this plugin’s parameter, please refer to the following documentation : Setting up Full Text Search | Enhancing Full Text Search with Property Boosting.

PACKAGED_Portals

• Activated:

  • true