Quality gate reports

Display aggregated reports of achieved quality gates of your assets in a quality gate report.

Prerequisites

You must configure a quality gate sequence for the desired scope of assets

Introduction

By default, the quality gate server actions are disabled. To use the quality gate reports in your system, you must enable the desired server actions and update the server configuration. For more information, see the Enable server actions section below.

The censhare dedicated solutions are delivered with manual and automatic server actions to generate reports on the achieved quality gates of the following assets:

Projects - Asset types Project, Campaign, Tactic, Marketing plan
Media - Asset types Image, Audio, 3D model, Video
Products - Asset types Product, Product item, Product category, Product output, Product edition
Content - Asset types Layout, Article, Text

The reports (aggregated assets for each achieved quality gate) is displayed in the Status tab of the overview pages.

In the report, censhare counts and displays all assets with their highest achieved the quality gate in the respective sequence. The quality gate reports can be executed with a manual server action, or triggered with an automatic server action.

The quality gate report also writes the highest achieved quality gate of an asset in the Achieved quality gate property of this asset. The value type is asset key reference. The value is the resource key of the respective quality gate:

XML

<asset id="12345">
 <asset_feature asset_id="12345"
                feature="censhare:quality-gate.achieved"
                timestamp="2021-10-27T11:24:37.193Z"
                value_asset_key_ref="censhare:quality-gate.media.files"/>
</asset>

Enable server actions

The server actions are stored in the censhare Admin Client in the Configuration/Modules/Quality gates directory. censhare dedicated solutions are delivered with server actions (manual and automatic) that correspond to the quality gate reports (see the section above). The manual server actions to calculate the achieved quality gates can only be executed in the censhare Client. The automatic server actions are triggered by an asset changed event.

If you want to use the preconfigured server actions as is, you only need to enable them:

Open the desired server action configuration.
Select the Enabled field.
Click OK to save your changes.
Update the server configuration. If necessary, synchronize the remote servers.

Customize server actions

If you use custom quality gate sequences that do not match the asset types of the preconfigured server actions, you can add custom server actions. Proceed as follows:

Switch to the Admin mode of the censhare Admin Client.
Open the server action that you want to customize.
Enter a name.
Edit the trigger events if necessary (only automatic server actions).
To edit the asset filters, open the Admin menu and select Show/edit XML. The XML editor opens in a new window.

Direct editing of the asset filter is currently not possible!
Go to the <asset-filter/> section and add your custom filters in the <query/> element.

Automatic server actions that are triggered by Asset changed events can create a high server load. To avoid this, do not remove the predefined filters Currversion = "0" , Deletion state = "Not deleted" and state = "Available"!
Click OK to close the editor window.
Click OK to save your changes.
Update the server configuration. If necessary, synchronize the remote servers.

Create custom quality gate reports

Quality gate reports are chart bars that show an aggregated count of assets and their achieved quality gates. Preconfigured quality gate reports are placed in the Status tab of the static pages Projects, Media, Products and Content (see the section above). These reports use the following transformations that are part of the censhare dedicated solutions:

Bar chart of article quality gates (resource key: censhare:chart.article-quality-gates.bar)
Bar chart of campaign quality gates (resource key: censhare:chart.campaign-quality-gates.bar)
Bar chart of media quality gates (resource key: censhare:chart.media-quality-gates.bar)
Bar chart of product quality gates (resource key: censhare:chart.product-quality-gates.bar)

To display a custom quality gate report, you can place a Chart widget with the respective transformation on any asset page.

Custom reports require a corresponding server action (manual or automatic) to calculate the achieved quality gates and add the Achieved quality gate property to the assets in the scope.

To create a custom report proceed as follows:

Create a new transformation asset, or create a resource replace variant of one of the Bar chart transformation above.
In the XSL master file, edit the values of censhare:asset-type-filter and censhare:asset-type.
Save your changes.