# Custom Tests

This page will display any custom tests that you have previously created for use in the [CIPP Dashboard](/user-documentation/dashboard.md) or [Custom Reports](/user-documentation/tenant/standards/bpa-report/builder.md).

## Feature Walkthrough

{% @storylane/embed subdomain="app" linkValue="qevotii3ats1" url="<https://app.storylane.io/share/qevotii3ats1>" %}

## Table Details

| Column                | Description                                                                                                                                                                                  |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Script Name           | The display name of the script.                                                                                                                                                              |
| Description           | The description set on the script.                                                                                                                                                           |
| Enabled               | Whether the test runs with the rest of the tests on schedule.                                                                                                                                |
| Alert On Failure      | Whether CIPP sends an alert when there is a failure.                                                                                                                                         |
| **Return Type**       | `JSON` or `Markdown`                                                                                                                                                                         |
| Category              | Existing Options: `License Management`, `Security`, `Compliance`, `User Management`, `Group Management`, `Device Management`, `Guest Management`, `General`, or any custom created category. |
| Pillar                | Classifies which test category this belongs to. One of `Identity`, `Devices`, `Data`                                                                                                         |
| Risk                  | The risk label associated with the script. One of `Low`, `Medium`, `High`, `Critical`                                                                                                        |
| User Impact           | Classifies the impact to the end user. One of `Low`, `Medium`, or `High`                                                                                                                     |
| Implementation Effort | Classifies the effort to remediate a failed test. One of `Low`, `Medium`, or `High`                                                                                                          |
| Version               | The version of the script. Latest is shown by default.                                                                                                                                       |
| Created By            | The UPN of the user that created the script.                                                                                                                                                 |
| Created Date          | Relative time since the script was created                                                                                                                                                   |

## Table Actions

<table><thead><tr><th>Action</th><th>Description</th><th data-type="checkbox">Bulk Action Available</th></tr></thead><tbody><tr><td>Edit Test</td><td>Opens the <a data-mention href="/pages/8SRaAR9n2LIXCodpNWXt">/pages/8SRaAR9n2LIXCodpNWXt</a> page with the selected test populated</td><td>false</td></tr><tr><td>View Versions</td><td>Opens <a data-mention href="/pages/RFUBgPJzakt6UGt1Wp8S">/pages/RFUBgPJzakt6UGt1Wp8S</a> for the selected test script</td><td>false</td></tr><tr><td>Enable Test</td><td>Enables the selected test(s) to run with the rest of the test suite.</td><td>true</td></tr><tr><td>Disable Test</td><td>Disables the selected test(s) from running</td><td>true</td></tr><tr><td>Enable Alerts</td><td>Enables alerts for failed test runs of the selected test(s)</td><td>true</td></tr><tr><td>Disable Alerts</td><td>Disables alerts for failed test runs of the selected test(s)</td><td>true</td></tr><tr><td>Delete Test</td><td>Permanently deletes all versions of the selected test(s)</td><td>true</td></tr><tr><td>Save to GitHub</td><td>Saves the selected test(s) to your chosen GitHub repository.</td><td>true</td></tr></tbody></table>

***

## Feature Requests / Ideas

We value your feedback and ideas. Please raise any [feature requests](https://github.com/KelvinTegelaar/CIPP/issues/new?template=feature.yml) on GitHub.


---

# Agent Instructions: 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:

```
GET https://docs.cipp.app/user-documentation/tools/custom-tests.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
