> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/quality-rules.md).

# Quality Rules

A quality rule detects one kind of issue, such as a hard-coded secret or a missing error handler, and raises a finding with a severity and category. Rules are supplied with IZ Suite for each technology, and your team can add custom rules. Use this tab to find a rule, see which applications and open issues it affects, and maintain your custom rules.

Open it from **Operations** → **Quality Control** → **Quality rules** in the sidebar.

{% hint style="warning" %}
You need a role that can view quality rules. Creating, editing, cloning, deleting and activating rules in profiles need the matching quality rule permissions.
{% endhint %}

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FvTmIdzVr2P2UR3UGU1AW%2Fv2-qc-rules.png?alt=media&amp;token=9df3ea05-3588-40a5-aa9c-023565a74d86" alt="Quality rules tab with filters and the rule table"><figcaption></figcaption></figure>

## Filters

| Filter                             | Description                                                                      |
| ---------------------------------- | -------------------------------------------------------------------------------- |
| **Technology**                     | The technology the rule applies to.                                              |
| **Severity**                       | The rule severity, for example **Critical**, **Major**, **Minor** or **Info**.   |
| **Category**                       | The rule category, for example **Bugs**, **Vulnerabilities** or **Code smells**. |
| **Origin**                         | **Supplied** or **Custom**.                                                      |
| **Implementation language**        | The language the rule's detection logic is written in.                           |
| **Search name, identifier or tag** | Finds rules by name, identifier or tag.                                          |

**Saved filters** and **Save filters** keep a combination of filters for later.

## Rule Table

**Refresh** reloads the table, **Columns** shows or hides columns (**Rule id** and **Tags** start hidden) and **Export** downloads the table.

| Column           | Description                                                                                                                          |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Rule**         | The rule name and its tags. Click it to open the rule.                                                                               |
| **Technology**   | The technology the rule applies to.                                                                                                  |
| **Severity**     | The severity of the findings it raises.                                                                                              |
| **Category**     | The category of the findings it raises.                                                                                              |
| **Origin**       | **Supplied** or **Custom**.                                                                                                          |
| **Last updated** | When the rule last changed. The list shows the most recently changed rules first; click **Last updated** or the name column to sort. |
| **Manage**       | The row actions below. Actions that do not fit open from **More actions**.                                                           |

| Action                  | What it does                                                         |
| ----------------------- | -------------------------------------------------------------------- |
| **Edit rule**           | Opens the rule in the definition editor.                             |
| **Clone rule**          | Creates a custom copy and opens it in the definition editor.         |
| **Find violations**     | Opens **Rule impact investigation** for the rule.                    |
| **Activate in profile** | Adds the rule to one or more quality profiles.                       |
| **Delete rule**         | Permanently deletes a custom rule. Supplied rules cannot be deleted. |

{% hint style="danger" %}
Deleting a custom rule cannot be undone.
{% endhint %}

## Investigate a Rule's Impact

1. Click **Find violations** on the rule's row.
2. In **Rule impact investigation**, review the applications affected by the rule and their open issues.
3. To investigate several rules together, add or remove rules with the tags at the top of the drawer.

## Create a Quality Rule

1. Click **Create rule**.
2. Fill in the fields on **Purpose & classification**, **Customer guidance** and **Implementation**.
3. Click **Create rule**. **Back to rules** leaves without saving.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FcBSXWRkY7AdpaOGIN7Fu%2Fv2-qc-rule-editor.png?alt=media&amp;token=b649f8c3-0031-4ba8-aa54-929f093d9f72" alt="Create quality rule with the Purpose and classification tab"><figcaption></figcaption></figure>

### Purpose & Classification

| Field                               | Description                                                                                                                                                                  |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Rule name**                       | Required. A descriptive name, up to 100 characters.                                                                                                                          |
| **Technology**                      | Required. The technology the rule applies to.                                                                                                                                |
| **Severity**                        | Required. The severity of the findings it raises.                                                                                                                            |
| **Category**                        | Required. The category of the findings it raises.                                                                                                                            |
| **Estimated remediation (minutes)** | Required. How long a fix usually takes.                                                                                                                                      |
| **Tags**                            | Type a tag and press Enter or a comma, or pick an existing tag. Consistent tags help you find related rules.                                                                 |
| **Security standards**              | The CWE weaknesses, OWASP Top 10 categories and AWS Foundational Security Best Practices controls the rule detects. OWASP categories follow from a mapped CWE automatically. |

### Customer Guidance

**Guidance (Markdown)** explains what the finding means, why it matters and what the application owner should do. **Guidance preview** shows how it renders.

### Implementation

**Implementation language** (required) and the rule implementation (required) define how the assessment detects the issue. Saving updates the definition; adding it to profiles is a separate step.

## Open or Edit a Rule

Click a rule's name to open it. The header shows whether it is a **Supplied definition** or a **Custom definition**, and offers:

* **Edit definition**: change the fields, then click **Save definition**, or **Cancel**.
* **Find applications and issues**: open the rule impact investigation.
* **Activate in profile**: add the rule to quality profiles.

Supplied rules have no **Implementation** tab. When your role cannot edit a rule, the page shows it as a **Read-only definition**; clone it to make a custom version you can change.

## Next Steps

* [Quality Profiles](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/quality-profiles.md): choose which rules run for a technology.
* [Security Standards](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/security-standards.md): see which rules detect each CWE or OWASP category.
* [Metric Rules](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/metric-rules.md): review the metrics that count findings for quality gates.
* [Quality Control](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control.md): return to the Quality Control overview.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/quality-rules.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
