Custom Properties

Custom properties are user-defined properties that you can apply to one or more entity types (Application, Device, Interface, Location) to make it easier to find entities of special interest via incident search, runbooks, and automations.

Click Explorer > Custom Properties to display the Custom Properties page, which lists all of the existing custom properties in your configuration.

Custom Properties Page

The Custom Properties page shows these columns for each custom property:

  • Name — The user-assigned name of the custom property.

  • Description — The user-defined description of the custom property.

  • Locations — The count of location entities that use this custom property.

  • Devices — The count of device entities that use this custom property.

  • Interfaces — The count of interface entities that use this custom property.

  • Applications — The count of application entities that use this custom property.

  • Last Updated By — The ID of the user who changed this custom property's definition or assignment most recently.

  • Last Updated — The most recent time at which this custom property's definition or assignment was changed.

Defining a Custom Property

Click New at the upper right corner of the Custom Properties page to open the Set Custom Property dialog and define a new custom property. Type a name and a description for the custom property, then, select one or more entity types to which the custom property can be applied: Application, Device, Interface, or Location. Add one or more values that it's possible for the custom property to have. This is a list of possible valid values that you define explicitly.

An error message will appear if a custom property is assigned to an entity and you make the entity type invalid for the custom property.

Importing and Exporting Custom Properties

Custom properties, names, and values, can be exported and imported via CSV file.

Searching By Custom Property

Global Search

Global search results include two categories:

  • Custom Properties — result will show name, description and 2 links: to incidents and custom property details

  • Locations — result will show name, description and 2 links: to incidents and custom property details

Incident Search

Incident search includes filters for each custom property category. Fuzzy search should not be applied on custom property. Custom properties are not shown as columns for the table.

Custom Properties in Runbooks

Custom properties for an entity type are shown in runbooks and the Runbook Editor the same as built-in properties. This includes Visualization nodes.

Custom Properties in Automations

Custom properties for an entity type are shown in automations the same as built-in properties.