Custom Tests

This page lists the custom tests you have created, which run alongside CIPP's built-in tests and can be surfaced in the CIPP Dashboardor the Report Builder.

Feature Walkthrough

Action Buttons

Add Test opens the test editor with a blank test:

Add/Edit Custom Test

Import from GitHub

Opens the Browse Custom Test Catalog flyout, listing custom tests published in the community-repos registered with your instance. Search for a test, preview it, then select Import to add it to your own tests.

There is no option to import from one of your tenants, as custom tests are not tenant objects.

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 the test produces a result matching its configured alert statuses.
Result Mode	How the test's pass or fail state is decided. Auto lets the script's own output determine the outcome, while Always Pass, Always Info and Always Investigate force that result regardless of what the script returns.
Return Type	JSON or Markdown.
Category	Existing options: License Management, Security, Compliance, User Management, Group Management, Device Management, Guest Management, General, or any custom category you create.
Pillar	Classifies which area the test 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

Bulk Action Available

Action	Description	Bulk Action Available
Edit Test	Opens Add/Edit Custom Test with the selected test populated.
View Versions	Opens View Versions for the selected test script.
Enable Test	Enables the selected test to run with the rest of the test suite. Only shown on tests that are currently disabled.
Disable Test	Stops the selected test from running. Only shown on tests that are currently enabled.
Enable Alerts	Enables alerting for the selected test. Only shown where alerts are currently off.
Disable Alerts	Turns off alerting for the selected test. Only shown where alerts are currently on.
Delete Test	Permanently deletes the selected test, including every version of it.
Save to GitHub	Publishes the selected test to a community repository, so it can be shared or reused elsewhere. You choose the repository and supply a commit message. Only shown when the GitHub integration is enabled.

Deleting a test removes all of its versions and cannot be undone. Where you only want the test to stop running, disable it instead.

Only repositories you have write access to are offered when saving to GitHub. Where the list is empty, the repositories registered with your instance are all read-only, which includes the built-in CyberDrain ones.

---

Feature Requests / Ideas

We value your feedback and ideas. Please raise any feature requests on GitHub.