Quark Publishing Platform v5.x Migration Guide

Migration of QPP from v5.1.0 to v5.2.0

Snapshot and Artifactory Upgrades

Include the snapshot version 5.2.0 or replace version 5.1.0 with 5.2.0 –

          <dependency> 
                    <groupId>com.quark.qcep.contentservices</groupId> 
                    <artifactId>qcep-contentservices-remoting-stubs</artifactId> 
                    <version>5.2.0</version> 
          </dependency> 
          <dependency> 
                    <groupId>com.quark.qcep.automation</groupId> 
                    <artifactId>qcep-automation-interface</artifactId> 
                    <version>5.2.0</version> 
          </dependency>

Include web component artifacts' version 5.2.0 or replace version 5.1.0 with 5.2.0 –

          "@quark/application-services-model": "5.2.0"
          "@quark/platform-components-ng": "5.2.0"
          "@quark/qwc": "5.2.0"

Web Components and Services

The following changes have been made to the web components, services, and modules in the upgrade from v5.1.0 to v5.2.0. 

List of Modified Web Components

  • qpp-asset-checkin.component: QppAssetCheckinComponent

  • qpp-asset-form.component: QppAssetFormComponent

  • qpp-attribute-picker.component: QppAttributePickerComponent

  • qpp-collection-content.component: QppCollectionContentComponent

  • qpp-collection-columns-picker.component: QppCollectionColumnsPickerComponent

  • qpp-collection-move-confirm.component: QppCollectionMoveConfirmComponent

  • qpp-entity-deck.component: QppEntityDeckComponent

  • qpp-entity-list.component: QppEntityListComponent

  • qpp-meta-attribute.component: QppMetaAttributeComponent

  • qpp-multi-files-asset-form.component: QppMultiFilesAssetFormComponent

  • qpp-multi-files-edit-attributes.component: QppMultiFilesEditAttributesComponent

  • qpp-query-builder.component: QppQueryBuilderComponent

  • collection-browser-tree.component: CollectionBrowserTreeComponent

List of Modified QWC components

  • qwc-data-table-component: QwcDataTableComponent

  • qwc-localization-service: QwcLocalizationService 

  • date-utility: DateUtility

List of Modified Services

  • asset.service: AssetService

  • attribute.service: AttributeService

  • qa.service: QaService

  • qpp-entity-action.service: QppEntityActionService

  • global-dialog.service: GlobalDialogService

  • qpp-query-builder.service: QppQueryBuilderService

  • query.service: QueryService

  • query-quest.service: QueryQuestService

List of Modified Modules

  • collection-components.module: CollectionComponentsModule

List of Modified Application Service Models

  • asset: Asset

  • attribute: Attribute

  • entity: Entity

  • query: Query

APIs

Newly introduced APIs

deleteAssetVersions

The deleteAssetVersions API has been introduced in the assetService. This API is designed to delete specified versions of assets efficiently, with detailed feedback on the operation's outcome. 

Endpoint
  • POST /api/v5/assetService/deleteAssetVersions?AssetId

  • POST /api/v5/assetService/deleteAssetVersions?AssetVersion[]

  • POST /api/v5/assetService/deleteAssetVersions?forceDelete

Description

This API deletes all the specified asset versions for the given asset ID:

  • AssetId: The unique identifier of the asset from which versions are to be deleted.

  • AssetVersion[]: An array of versions to be removed.

  • forceDelete: A boolean parameter (default: false) that determines if the deletion bypasses certain checks. 

Features
  • Deletes all associated relations, blobs, and metadata for the specified asset versions.

  • Returns detailed information for each version regarding the deletion status:

    • Success message for deleted versions. 

    • Reason or error details for any version that was not deleted. 

Events Published
  • After the deletion operation completes, a bulk event ASSET_VERSIONS_DELETED is published containing details of all processed versions. 

  • Each successfully deleted version generates an internal event ASSET_VERSION_DELETED. 

Deletion Conditions
  • If forceDelete is set to false (default):

    • The deletion will not proceed for versions that have a pinned relation or are associated with a branch. 

  • If forceDelete is set to true:

    • The version will be deleted without any checks. 

The latest manually saved version of an asset will not be deleted under any circumstances.

Changes/modification in the APIs

Support for Deleted Users in exportAllUsers API

In this release, the Configuration Manager Service has been enhanced with a new parameter for the exportAllUsers API. The new parameter, includeDeleted, allows you to include deleted users in the export output. When set to true, the API will export all user configurations along with roles and associations for both active and deleted users. This provides greater flexibility when migrating or auditing user data. 

For more details on usage and implementation, please refer to the Developer Portal. 

Breakage/Impact

Uniform Attribute Naming

To ensure clarity and consistency, the attribute previously labeled "Routed To" or "Assigned To" will now be displayed as "Assigned To" throughout the platform—except in the Admin > Attributes pane. 

Configuration Details/Setup Requirement

Canvas View

To enable the new Canvas View option for displaying QPP attributes and metadata:

  1. Default Settings: No initial configuration is required to use this feature.

  2. Customization: Users can modify the appearance of the properties by editing the content.css file located at: S3/qaservice/conf

    Styling example

    Use the following CSS to change the section titles to red and set the cursor to a pointer:

    /* Font Styling of Section Titles */  
    .quark-editor-content .section > div > div.info-toolbar-container {
         color: red;
         cursor: pointer;
    }
  3. Priority Order: The info-toolbar displays metadata in the same order as the meta pane. To adjust the display priority, update the qa-config.json file located at S3/qaservice/conf. 

This configuration option empowers users to tailor the visualization to meet their specific needs. 

Licensing and Privileges Update

Privilege Name

License Type

  • Content Privileges → Structured Content → General

    • Allow Lock/Unlock

Admin & Author

The Allow Lock/Unlock privilege is not available by default for users migrating Quark Publishing Platform from v5.1 to v5.2. To enable this privilege in your environment, please contact your account representative or the Quark Support team to request activation. Once enabled, this privilege can only be assigned to users with Admin and Author license types.