Migration of QPP from v5.2.0 to v5.3.0 

Configuration Details/Setup Requirement

Enhanced Document Preview and Publishing Capabilities

This section outlines the configuration steps required to enable the new preview and publishing capabilities in the content management system. This enhancement allows admin users to set up rules that determine which document components appear in previews and are included in the publishing process. 

Configuration Steps

  1. Enable the Feature 

    • Set the Query Service Flag 

      • Flag: qpp.index.all.versions 

        This flag must be enabled in Queryquest Service and Content Service to allow the capability to use previous revisions of component documents.  

    • Add Channel Parameter 

      • Parameter: PARAM: CONTENT_FILTERING_TYPE 

        This parameter allows for configuring dynamic publishing rules. 

    If you are using an OOTB or a copy of an OOTB channel, you don’t need to manually add this parameter—it already exists by default. You should only add it manually if you are working with a custom (non-OOTB) channel. 
    • Enable Content Filtering 

      • Flag: contentFilterEnabled 

        This flag must be set to true in the configuration to activate content filtering capabilities. 

  2. Accessing the Configuration File 

    • Log into the QPP platform and navigate to: 

      Home > sysinternals > automationservice > filterconfig

    • Download the content-filter-config.json file from this location. 

  3. Modifying the Configuration

    • Open the content-filter-config.json file using Notepad++ or any text editor. Update the JSON file to include the desired filter rules and attributes. 

  4. Sample JSON Body

    • The following is a sample structure for the content-filter-config.json: 

{

          "contentFilterEnabled": true, 

          "contentFilterRules": { 

               "filter1": [ 

               { 

               "contentTypeId": 110451, 

               "queryId": 20975, 

               "removeIfNotFound": true, 

               "skipIfNoWorkflowDefined": false 

          }, 

          { 

               "contentTypeId": 110456, 

               "queryId": 20976, 

               "removeIfNotFound": false, 

               "skipIfNoWorkflowDefined": false 

          } 

     ], 

     "filter2": [ 

          {

               "contentTypeId": 110451, 

               "queryId": 20976, 

               "removeIfNotFound": true, 

               "skipIfNoWorkflowDefined": false 

          } 

     ],

          "filter3": [ 

     {

               "contentTypeId": 110451, 

               "queryId": 20977, 

               "removeIfNotFound": true, 

               "skipIfNoWorkflowDefined": true 

          }

     ],

     "filter4: [ 

          { 

               "contentTypeId": 110451, 

               "queryId": 20456, 

               "removeIfNotFound": true, 

               "skipIfNoWorkflowDefined": false 

          }

     ]

     }

}

Important Notes
  • Replace Filter1, Filter2, Filter3, and Filter4 with your desired filters. 

  • Each filter can contain multiple rules; however, a single channel will only contain one filter. For example, Filter1 can include multiple rules under it. 

  • The filter name from this configuration will be the value for the parameter CONTENT_FILTERING_TYPE in channels. 

Uploading the Configuration

After making the necessary changes in the JSON file, upload it back to the same directory to replace the existing configuration file. 

Key JSON Parameters

  • contentTypeId: The unique identifier for the content type of document components included in previews and publishing. 

  • queryId: Represents the ID of the search query used for matching document components. 

Filter Options Explained
  • removeIfNotFound

    • True: Excludes components from the published version if they are not found based on the query results.  

    • False: Includes components in the published version even if they are not found. 

  • skipIfNoWorkflowDefined

    • True: Skips validation for rules if no workflow is defined, allowing the component to be included. 

    • False: Conducts a validation to determine if the component meets the rules for inclusion.