Quark Publishing Platform v5.x Migration Guide

Migration of QPP from v5.0.0 to v5.1.0

Snapshot and Artifactory Upgrades

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

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

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

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

Web Components and Services

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

List of Modified Components

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

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

  • qpp-picker-searches.component: QppPickerSearchesComponent

  • qpp-asset-picker.component: QppAssetPickerComponent

  • qpp-confirmation-template-dialog.component: QppConfirmationTemplateDialogComponent

  • qpp-content-types.component:  QppContentTypesComponent

  • qwc-search-input.component: QwcSearchInputComponent

  • qwc-app-shell.component: QwcAppShellComponent

  • qwc.module: QwcModule 

List of Modified Services

  • qpp-dialog.service: QppDialogService

  • content-types.service: ContentTypesService

  • qpp-action-entity.service: QppActionEntiryService

  • user-privileges.service: UserPrivilegesService

  • qa-service: QaService

APIs

Changes/modification in the APIs

Unified Access Service APIs

In the previous release (v5.0.0), we introduced new APIs for the Unified Access Service. In this release (v5.1.0), we have made the following updates to those APIs: 

  • exportConfigurations API

    • Added a new parameter to support exporting query-based assets.

  • Service Renaming

    • The service previously referred to as assetservice in v5.0.0 has been renamed to assets in v5.1.0.

  • importConfigurations API

    • Added form-data in the request body. You can attach the ZIP file directly and import options in the form body to deploy configurations to the target environment. 

For detailed information, please refer to the Unified Access Service APIs documentation. 

Breakage/Impact

There are no breaking changes introduced in this release, ensuring a seamless transition to v5.1.0 without any impact on existing functionality. However, you will need to create the new asset index and reindex all existing assets to ensure optimal performance with the updated version.

Configuration Details/Setup Requirement

There are no features introduced in this release that require additional configuration or setup. 

Licensing and Privileges Update

Privilege Name

License Type

  • Content Privileges → Asset → General

    • Check In New

Contributor