Skip to content

Home

Jump to bottom
Stefano Castelluccio edited this page May 28, 2026 · 1 revision

DISCLAIMER

The extension is delivered as-is and is published under the GNU LGPL v3 open source license.

1. Description

This Extension adds a Golden Rules Indicator to the CAST AIP Assessment Model. It is intended for organizations that need to define and track a curated set of software quality rules — called Golden Rules — grouped into custom Business Criteria (BC) and Technical Criteria (TC), visible in CAST Enlighten and CAST Imaging dashboards.

The Extension does not introduce new analyzers or object types. It works entirely at the assessment model level, by mapping existing CAST quality rules to newly defined BC/TC indicators.

1.1 Version

Version Date Key Notes
1.0.0 30/03/2026 Initial release — ACEA Golden Rules Indicator (BC: 2112000, TC: 2112100)

1.2 Use Cases

  • Extension of the Quality Model: groups a selected set of existing CAST quality rules under a dedicated Business Criteria (Golden Rules Indicator) and its companion Technical Criteria (Golden Rules Technical Criteria).
  • Custom KPI per customer/programme: each deployment can define its own set of Golden Rules by editing the MetricRegister.xlsx file and regenerating the metrics via the provided toolchain.

2. Compatibility

2.1 CAST AIP Compatibility

CAST AIP Release Supported Notes
8.3.x Yes Minimum required version
Below 8.3.x No —

2.2 Other Technology Compatibility

No additional technology dependency is required. The extension operates on the CAST Central schema only.

3. Prerequisites & Installation

3.1 Prerequisites

  • CAST AIP 8.3.0 or above installed and configured
  • CAST Server Manager or AIPConsole available to manage schema extensions
  • PowerShell 7.x (pwsh.exe) available in the system PATH — required only when regenerating metrics

3.2 Installation Instructions

Install via AIPConsole

  1. Download the extension package from CAST Extend or select it in AIPConsole.
  2. In AIPConsole, navigate to the application settings and select Manage Extensions.
  3. Find com.castsoftware.uc.goldenrules and choose the desired version.
  4. Apply and run a new snapshot to activate the new Business Criteria.

Install via CAST Server Manager

  1. Launch CAST Server Manager and connect to the CAST Storage Service hosting your schemas.
  2. Right-click the target schema group and select Manage Extensions.
  3. Locate Golden Rules Business Criteria and select the version to install.
  4. Click Next and then Proceed to complete the installation.
  5. The custom metrics will be injected into the Central schema (DSS_METRIC_TYPES, DSS_METRIC_TYPE_TREES, DSS_METRIC_DESCRIPTIONS, etc.).

WARNING: All XML and SQL files must be encoded in UTF-8, otherwise the installation may fail.

4. How to Use

4.1 Features

After installation and snapshot generation, the following items are available in CAST Enlighten / CAST Imaging:

Metric ID Type Description
ACEA Golden Rules Indicator 2112000 Business Criteria Top-level indicator grouping all selected Golden Rules
ACEA Golden Rules Technical Criteria 2112100 Technical Criteria TC aggregating the mapped quality rules

4.2 Customising the Golden Rules Set

The set of quality rules and their mapping to TC/BC is fully configurable:

  1. Edit Tools/MetricGenerator/MetricRegister.xlsx — fill in:
    • QR tab: quality rule IDs to include, with weights
    • TC tab: Technical Criteria name(s) and descriptions
    • BC tab: Business Criteria name(s) and descriptions
    • TREE tab: hierarchy mapping (QR → TC → BC)
  2. Run the generation script: 
    pwsh Tools\GenerateMetrics.ps1
    The script will prompt for the reserved ID range (RangeStart / RangeEnd).
  3. The following files are regenerated automatically:
    • InstallScripts\common\ADG\GOLDENRULES_CustomMetrics.xml
    • InstallScripts\common\assessment_model_tables.xml
    • InstallScripts\CastStorageService\DIAG\UninstallerGOLDENRULES-local.SQL
  4. Bump the version in plugin.nuspec and re-install the extension.

4.3 Running a New Snapshot

After the extension is installed (or updated), run a new snapshot in AIPConsole or CAST Management Studio. The Golden Rules Indicator will appear in the quality model results.

4.4 Documentation History

Version Date Notes
1.0 30/03/2026 Initial documentation

5. What Results Can Be Expected

5.1 Outputs

Once the snapshot has been generated, the following are available:

  • A new Business Criteria — Golden Rules Indicator — visible in the quality model dashboards.
  • A new Technical Criteria — Golden Rules Technical Criteria — listing all contributing quality rules with their grades and violations.
  • Standard CAST Enlighten / CAST Imaging compatibility: the BC/TC are accessible through all standard reporting and dashboard features.

5.2 Dashboards

The extension ships with pre-built dashboard configurations in the Dashboards/ folder:

File Purpose
app-ISO.json Application-level ISO dashboard
cmp-ISO.json Component-level ISO dashboard
ed.json Executive dashboard

5.3 Quality Rules

The exact list of quality rules included in the Golden Rules set is defined in Tools/MetricGenerator/MetricRegister.xlsx. The generated mapping is stored in InstallScripts/common/ADG/GOLDENRULES_CustomMetrics.xml.

6. Uninstalling

To remove the extension metrics from the Central schema, execute the uninstaller SQL script against the target local schema:

InstallScripts\CastStorageService\DIAG\UninstallerGOLDENRULES-local.SQL

Replace the {Start Range} and {End Range} placeholders with the actual metric ID range used during installation (e.g., 2112000 and 2112100).

7. Components Present in the Package

Path Description
plugin.nuspec NuGet extension manifest (ID, version, metadata)
InstallScripts/common/ADG/GOLDENRULES_CustomMetrics.xml Generated XML with BC/TC/QR metric definitions
InstallScripts/common/ADG/CUST_METRIC_TREE_GOLDENRULES.pck CAST package descriptor for schema installation
InstallScripts/common/assessment_model_tables.xml Assessment model table schema definition
InstallScripts/CastStorageService/DIAG/UninstallerGOLDENRULES-local.SQL SQL script to remove installed metrics
Dashboards/app-ISO.json Application ISO dashboard configuration
Dashboards/cmp-ISO.json Component ISO dashboard configuration
Dashboards/ed.json Executive dashboard configuration
Tools/GenerateMetrics.ps1 PowerShell script to regenerate metric files
Tools/HowToReGenerateMetrics.md Step-by-step guide to regenerate metrics
Tools/MetricGenerator/CASTMetricsGenerator.exe Metric generator executable
Tools/MetricGenerator/MetricRegister.xlsx Excel input defining QR/TC/BC and their mapping
Tools/MetricGenerator/CLI-Usage.md CLI reference for CASTMetricsGenerator.exe
Tools/MetricGenerator/assessment_model_tables_template.xml Template for assessment model generation
Tools/MetricGenerator/Uninstaller-local.SQL Template for uninstaller SQL generation
license/COPYING.LESSER.TXT GNU LGPL v3 license text

8. Version of Documentation Used

Version 1.0 of the "Golden Rules Business Criteria – Extension Wiki" is used for this document.

Clone this wiki locally