> 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-analyzer/manage-rules/custom-rules.md).
# Custom Rules
## Manage Custom Rules
{% hint style="warning" %}
In case of an On-Premises or Hybrid installation model:
* Navigate to your organization-specific service URL instead of [https://analyzer.integralzone.com](https://analyzer.integralzone.com/)
* Choosing an organization will not be required after login
{% endhint %}
{% hint style="warning" %}
Before creating a custom rule, make sure you have:
* Created a custom Quality Profile from the default Profile. Refer to [Create Custom Quality Profile](/product-guides/integral-zone/iz-analyzer/manage-rules/activate-rules.md) for more information
* In case of an On-Premises or Hybrid installation model, navigate to your organization-specific service URL instead of [https://analyzer.integralzone.com](https://analyzer.integralzone.com/)
{% endhint %}
### Create Custom Rule:
1. Click on **`Rules`** -> **`Show Templates Only`** -> **`Create Custom Mule Rule`**
2. **`Registry Keywords`** details the list of all available variables that can be used in the groovy script, while defining a custom rule
3. Click on **`Create`** to start defining a custom rule\
4. Fill in all the required attributes. Refer to Custom Rule Attributes for more information
5. Click on **`Create`** to create the custom rule
Rules should be activated in at least one of the custom **`Quality Profiles`** for it to be applied on the projects being scanned (usually the default Quality Profile). Follow the below steps to activate the rule:
1. Select the custom rule created earlier
2. Click on **`Activate`**
3. Select the **`Quality Profile`** in which the rule should be activated and click on **`Activate`**
### Custom Rule Attributes:
1. **`Name`** - Name of the new custom rule
2. **`Key`** - Unique key for the custom rule. The key will be auto populated, which can be changed if there are any conflicts
3. **`Type`** - Select the type of rule, which can be one of
1. Code Smell
2. Bug
3. Vulnerability
4. Security Hotspot
4. **`Severity`** - Select the rule severity, which can be one of
1. Blocker
2. Critical
3. Major
4. Minor
5. Info
5. **`Implementation`** - Actual groovy script for the rule definition
6. **`Description`** - Description of the rule. Markdown syntax can be used to describe the rule. Few examples include
| Write | To Display |
| -------------------------------------------------- | ------------------------------------------------ |
| +**this text is bold**+ | **this text is bold** |
| + | |
| +[IZ Analyzer](https://analyzer.integralzone.com)+ | [IZ Analyzer](https://analyzer.integralzone.com) |
### Edit Custom Rule:
1. Click on **`Rules`** -> Select language **`Mule`** -> **`Search for rule name`**
2. Select a rule to edit
3. Update the required fields and click on **`Save`**. Refer to Custom Rule Attributes for more information
### See Also
* For Activating custom rules - [Activate Rules](/product-guides/integral-zone/iz-analyzer/manage-rules/activate-rules.md)
* For Deactivating custom rules - [Deactivate Rules](/product-guides/integral-zone/iz-analyzer/manage-rules/deactivate-rules.md)
---
# 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 dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-analyzer/manage-rules/custom-rules.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.