Custom Properties

Custom properties are user-defined labels you apply to entities Things deployed in the customer environment that are needed to run the business, such as applications, devices, interfaces, and locations. (applications An entity type representing software applications deployed in the customer environment that are monitored for performance and anomalies., devices An entity type representing network devices or hardware components deployed in the customer environment that are monitored for performance and anomalies., interfaces An entity type representing network interfaces on devices that are monitored for performance metrics and anomalies., locations An entity type representing physical or logical locations in the customer environment where entities are deployed and monitored., and user devices) so you can find and act on the ones that matter. Without them, you can only filter and branch on built-in attributes. With custom properties you can tag entities by role, owner, criticality, or any value you define, then use those tags in incident A collection of one or more related triggers. Relationships that cause triggers to be combined into incidents include application, location, operating system, or a trigger by itself. search, runbooks An automated workflow that executes a series of steps or tasks in response to a triggered event, such as the detection of anomalous behavior generating an incident, a lifecycle event, or a manually executed runbook., and automations Automated procedures that are executed as the result of a trigger. Automations consist of a single entry point and a sequence of connected nodes that define the processing logic.. This topic explains how to define and manage custom properties and where they appear in the platform.

What custom properties are

Each custom property has a name, an optional description, one or more entity types it applies to (Application, Device, Interface, Location, or User Device), and a fixed list of values you define. You choose values from that list when you assign the property to an entity. You manage definitions on the Custom Properties page and assign values to entities from the Explorer pages for each entity type. Some custom properties are system-defined (for example for muting or rollup); you can create, edit, and delete only user-defined properties.

Where to manage custom properties

To open the Custom Properties page:

1. Click the Launchpad button ⁝⁝⁝.

2. Click AI Ops > Management.

3. Click Explorer - Custom Properties.

The page lists each property with its name, description, how many entities of each type use it, and who last updated it and when. From the toolbar you can import or export properties (and their values) via CSV (comma-separated values), create a new property with New, or delete selected properties. You can delete a property that is in use in runbooks. The system prompts you to confirm. For an overview of the Explorer and its entity pages, see Explorer Overview.

Page columns

The Custom Properties table shows: Name, Description, counts of entities tagged with that property (Locations, Devices, Interfaces, Applications, User Devices), Last Updated By (the user who last changed the property definition or an assignment), and Last Updated (date and time of that change).

Defining a new custom property

Click New to open the New Custom Property dialog. Enter a name and optional description, select one or more entity types (Application, Device, Interface, Location, User Device), and add one or more values that the property can have. Those values form the only allowed set when you assign the property to an entity. If you later change the entity types for a property and an entity that already has that property no longer matches the new types, the UI User Interface. The visual components and controls that users interact with to access features and manage the system. (user interface) shows an error until you fix the assignment or the property definition.

Import and export

Use Import to add custom properties (and their names and values) from a CSV file. Use Export to export the current custom properties to CSV. Import and export are useful for backing up definitions or moving them between tenants.

Searching by custom property

In global search, results can include a Custom Properties category and a Locations category. Each result can link to related incidents A collection of one or more related triggers. Relationships that cause triggers to be combined into incidents include application, location, operating system, or a trigger by itself. and to the custom property details. In incident search, each custom property is available as a filter. Fuzzy search does not apply to custom property filters. The incident search table does not show custom properties as columns, but you can filter on them. You can customize which filters appear on Explorer and search pages.

Assigning custom properties to entities

To set a custom property value on one or more entities, go to the Explorer page for that entity type (for example Devices or Applications), select the row or open the Details blade, and click Set Custom Property. In the dialog, choose the property and value and whether to apply it to the selected entities only or to all entities in the current search results. For step-by-step examples, see the Explorer topics for each entity type and Muting applications and locations for incidents, which uses custom properties to mute apps and locations.

Custom properties in runbooks and automations

In the Runbook Editor and at runtime, custom properties for an entity type appear the same way as built-in properties. You can use them in visualization A runbook node category that gets data about the trigger and forwards it to other nodes in the runbook for further processing. nodes Individual components that make up a runbook automation, each performing a specific function such as data queries, transformations, logic, integrations, or visualizations., data source nodes, and other nodes that reference entity fields. In decision branches, some node types may show only the custom property ID (not the display name). For more on building runbooks, see Runbook Editor and Using the Runbook Editor.

Related information

Explorer Overview describes all Explorer pages and the Details blade. Muting applications and locations for incidents explains how to use the Mute App and Mute Apps at Location custom properties. Incidents page and incident search are where custom property filters apply when searching for incidents.