Quark Publishing Platform v5.x Migration Guide

Migration of QPP from v5.6.0 to v5.7.0

Snapshot and Artifactory Upgrades

Include the snapshot version 5.7.0 or replace version 5.6.0 with 5.7.0 –

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

Include web component artifacts' version 5.7.0 or replace version 5.6.0 with 5.7.0 –

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

Web Components and Services

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

Web Components

List of modified web components
  • qpp-attribute-list-ui.component: QppAttributeListUiComponent

  • qpp-attribute-list.component: QppAttributeListComponent

Services

List of modified service
  • attribute.service: AttributeService

Application Service Model

List of modified application service model
  • attribute: Attribute

Utilities

List of modified utility
  • error-message-utility: ErrorMessageUtility

APIs

Content Structure Service API Updates

The latest version introduces granular control over version-based indexing. These changes allow you to manage how content versions are indexed at both the individual and global levels. 

Modified API

POST /createContentType

A new parameter has been added to control indexing behavior upon creation.

  • New Parameter: indexAllVersions 

  • Default Value: false

  • Description: Determines whether all versions of the content type should be indexed.

Newly added APIs 

API

Description

Triggered Event

updateContentTypeIndexing

Enables or disables version-based indexing for a specific content type. 

Object Change Type: CONTENT TYPE INDEXING CHANGED

updateAllContentTypeIndexing

Enables or disables version-based indexing globally for all content types. 

Object Change Type: ALL CONTENT TYPE INDEXING CHANGED

getIndexAllVersionsContentTypes

Retrieves a list of all content types where the indexAllVersions flag is currently enabled. 

 

Enhanced Indexing Controls and Reindexing Events

We have introduced updates to our indexing APIs to provide more control over how data is refreshed in Elasticsearch. These changes are designed to help resolve "ghost" search results or stale data issues without requiring backend API intervention. 

The ASSET_REINDEXING_TRIGGERED event will now be fired whenever a user initiates a reindex operation. Additionally, we have introduced a new parameter, deleteExisting, in the following APIs:

  • generateTextIndexesOfAssetIds

  • generateTextIndexesOfQueryAssets

When this parameter is set to true, the existing index will be deleted from Elasticsearch before reindexing the new data. The default value is false. 

Breakage Impact

There are no breaking changes introduced in this release, ensuring a seamless transition to v5.7.0 without any impact on existing functionality. 

Configuration Details/Setup Requirement

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

Licensing and Privileges Update

  • No new privileges have been introduced in v5.7.0. 

  • No changes have been made to any existing privileges in v5.7.0.