Rules and rulesets

Rules

Rules are standards with which the software product should comply with.

The rules for quality checks in Quality Clouds are based on the following elements:

Compliance or its lack impacts several areas such as security, performance or reliability differently, depending on the recommendation. 

Rulesets

Rulesets are sets of rules that are applied to a platform scan. You can manage and customize your rulesets from the Rulesets section in the portal.

Ruleset types

The following ruleset types are now available:

Baseline rulesets

Set of default best practices provided by Quality Clouds. The main quality metrics are always calculated against the default ruleset, so that they can serve us as a baseline.

This is especially useful when, for example, you run scans using different sets of customized best practices. In this case, comparing baseline values gives you a better view of the global quality trends.

Custom rulesets

Set of best practices defined by you, which ignores or overrides specific rules of the default set of best practices provided by Quality Clouds. The quality metrics obtained by applying this set of rules, are labeled as Custom Ruleset Metrics, and are displayed in a prominent place in the dashboards.

Custom rulesets without extensions

Metrics obtained by applying the custom ruleset only to the code developed by you on the instance. It dismisses all issues encountered in third party vendor code or applications. Although vendor issues do affect the overall instance quality, you normally cannot address them directly as you do with your own code.

Managing rulesets

As you customize your rules - ignore or overwrite them - you are going to see updated values for your top-level KPIs, such as the Quality of Cloud, technical debt, etc. as well as for the total number of issues. You are always be able to compare the values to the baseline ones in the dashboards and in the summary emails you receive. 

Ignoring rules

You can remove specific rules from a ruleset that is applied to a scan.

→ To ignore an individual rule

  1. In the Quality Clouds portal, go to Rulesets section. 
  2. Search for the rule you want to exclude, and click on the  Ignore rule icon.

The rule will now be excluded from the ruleset applied to your scan. 


Customizing rules

You can customize individual rules by changing their severity and time to fix. This will change the overall calculation of your instance profile. 

→ To customize a rule

  1. In the Quality Clouds portal, go to Rulesets section. 
  2. Search for the rule you want to exclude, and click on the  Rewrite rule icon. 
  3. Choose the new desired severity, and/or modify the time to fix for the rule.
  4. Click Save.

The rule has now been changed, and will be taken into account in the next scan. 


Restoring rules

→ To restore a rule to default setting

  1. In the Quality Clouds portal, go to Rulesets section. 
  2. Search for the rule you want to restore. You can filter on the rule status by selecting rewritten  or ignored value.
  3. Once you located the rule you want to restore, click on the  Restore to default icon to restore a rewritten rule, or on the  Enable rule to enable an ignored rule. 

The rule has now been restored.

What's here


Related content

KPIs and basic terms

Severity of issues