Quark Publishing Platform v5.x Migration Guide

Migration of QPP from v5.7.0 to v5.8.0

Snapshot and Artifactory Upgrades

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

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

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

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

Web Components and Services

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

Web Components

List of newly added components
  • qpp-custom-date-picker.component: QppCustomDatePickerComponent

  • qpp-report-view.component: QppReportViewComponent

  • qpp-report.component: QppReportComponent

List of modified components
  • qpp-background-tasks.component: QppBackgroundTasksComponent 

  • qpp-asset-export-dialog.component: QppAssetExportDialogComponent 

  • qpp-new-document-list-ui.component: QppNewDocumentListUiComponent 

Services

List of newly added service
  • qpp-report.service: QppReportService

List of modified services
  • background-tasks.service: BackgroundTasksService

  • background-task: BackgroundTask

  • conversion-task: ConversionTask

  • background-task-type: BackgroundTaskType

  • background-task-status: BackgroundTaskStatus

  • qpp-entity-action.service: QppEntityActionService

  • favourites.service: FavouritesService

  • extensibility.service: ExtensibilityService

  • workflow.service: WorkflowService

Application Service Models

List of newly added application service models
  • duration: Duration

  • report-filter-config: ReportFilterConfig

  • report-sort-config: ReportSortConfig

  • content-type-prefilter: ContentTypePrefilter

  • report-data-request: ReportDataRequest

  • report-data-response: ReportDataResponse

  • export-report-data-request: ExportReportDataRequest

  • export-report-data-response: ExportReportDataResponse

  • file-format: FileFormat

  • export-report-status: ExportReportStatus

  • report-column-sort-dir: ReportColumnSortDir

List of modified application service models
  • analytics-contexts: AnalyticsContexts

  • analytics-reports: AnalyticsReports

  • meta-definition: MetaDefinition

  • element-definition: ElementDefinition

  • model-definition: ModelDefinition 

  • content-model: ContentModel

  • meta-type: MetaType

  • element-type: ElementType

  • type-name: TypeName

  • occurance-type: OccuranceType

  • default-elements: DefaultElements

  • meta-category: MetaCategory

  • meta-prefix-id: MetaPrefixId

  • selectors: Selectors

  • element-meta-keys: ElementMetaKeys

  • system-defined-prefix: SystemDefinedPrefix

Modules

Newly added modules
  • control-components.module: ControlComponentsModule

  • report-components.module: ReportComponentsModule

APIs

In the v5.8.0 release, no new APIs have been introduced, and there are no changes to the existing APIs. 

Breaking Impact

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

Configuration Details

Upgrade Impact: Native Reporting Migration

If your extensibility.json file has not been overridden (file not available at this path: applicationservice/conf), then no further action is required; the new reports will be available automatically with OTB deployment. 

Action Required: Update extensibility.json for Native Reporting

If you've previously customized the extensibility.json file, you must manually merge your changes with the new Out-of-the-Box (OTB) file (sample attached below) available at the path: applicationservice/conf, to enable the new reporting dashboards. 

Below is the default OTB extensibility.json. 

Look for the Content Delivery, Content Audit, and Asset Audit Report (newly added). You need to add these three JSON objects under Content Operations key available in the extensibility.json file. 
    "content-operations": [
        {
            "id": "qpp-production-trends-tab",
            "displayText": "Production Trends",
            "hidden": false
        },
        {
            "id": "qpp-content-delivery-tab",
            "displayText": "Content Delivery",
            "hidden": false,
            "report": {
                "configFile": "content-delivery-config.json"
            }
        },
        {
            "id": "qpp-content-audit-tab",
            "displayText": "Content Audit",
            "hidden": false,
            "report": {
                "configFile": "content-audit-config.json"
            }
        }
    ],
    "asset-audit": [
        {
            "id": "qpp-asset-audit-tab",
            "displayText": "Asset Audit Report",
            "hidden": false,
            "report": {
                "configFile": "asset-audit-config.json"
            }
        }
    ]
}

Download extensibility.json sample.

Licensing and Privileges Updates

This release doesn't introduce new privileges; however, the functional scope of the "Check In New" privilege has been modified to enforce stricter content governance.

Updated Privilege Logic 

Privilege Name

Change Type

Description of Behavioral Change

Check In New

Functional Update

This privilege now governs the visibility of content types in the "Create New" menu (Home screen and Author page). Previously, users might have seen all content types regardless of this privilege.