Rules | Discovery | Create#

Create a discovery rule to add matched entities to the Discovery overview.

Start creating a rule:

  1. From the left sidebar, select + Create > Rules > Discovery rule.

Configure the rule#

In the Create discovery rule view, fill out the following fields:

Rule name*

Name of the discovery rule.

Description

Short description. Should contain context and information on what this rule does.

Run on new data#

Under Run on new data, select Enable discovery for new Entities to control whether the rule automatically runs against new entities.

When selected, the rule executes automatically each time an entity is ingested or created. Any entity matching the rule’s criteria is added to the Discovery overview immediately, without manual intervention.

When left unselected, the rule does not run on new data. This is useful when you want to apply a rule only retroactively to existing entities — for example, to discover entities ingested before the rule was created. You can trigger a retroactive run from the rule’s details page; see Rules | Discovery | Manage.

Matching type#

Under Matching type, select how entities should be matched for this discovery rule:

  • Keyword match criteria — match entities by terms in their Title, Description, or Tags. Supports inline keywords and references to keyword lists.

  • Search query — build precise, advanced logic across any entity field using full query syntax.

The remaining options on the page depend on which matching type you select.

Keyword match criteria#

  1. Under Matching type, select Keyword match criteria.

  2. Configure the keyword criteria. See Keyword criteria for details on entity fields, the Keywords or lists field, and keyword sets.

  3. (Optional) Under Filters, narrow the entities the rule applies to:

    • Entity Types — select one or more entity types that this rule runs against.

    • Include sources — select one or more sources. The rule runs only against entities from these sources.

Search query#

  1. Under Matching type, select Search query.

  2. Craft a search query. Type @ at any point in the query to reference a keyword list from the picker. You can combine multiple keyword list references and inline syntax in the same query.

  3. (Optional) Select one or more Correlated Project spaces or one or more Correlated Project space types. The rule then only matches entities that have direct or indirect relations to objects in a selected Project space or in a Project space of a selected type.

Select Save to create the rule.