Custom Properties

Custom properties are user-defined properties that you can apply to one or more entityClosed Things deployed in the customer environment that are needed to run the business, such as applications, devices, interfaces, and locations. types (ApplicationClosed An entity type representing software applications deployed in the customer environment that are monitored for performance and anomalies., DeviceClosed An entity type representing network devices or hardware components deployed in the customer environment that are monitored for performance and anomalies., InterfaceClosed An entity type representing network interfaces on devices that are monitored for performance metrics and anomalies., and LocationClosed An entity type representing physical or logical locations in the customer environment where entities are deployed and monitored.) to make it easier to find entitiesClosed Things deployed in the customer environment that are needed to run the business, such as applications, devices, interfaces, and locations. of special interest via incidentClosed 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, runbooksClosed 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 automationsClosed 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..

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.

  • Interface: 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 is possible for the custom property to have. These values are 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 two links: to incidents and custom property details

  • Locations: result will show name, description, and two 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 runbooksClosed 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 the Runbook Editor the same as built-in properties. This includes VisualizationClosed A runbook node category that gets data about the trigger and forwards it to other nodes in the runbook for further processing. nodesClosed Individual components that make up a runbook automation, each performing a specific function such as data queries, transformations, logic, integrations, or visualizations..

Custom Properties in Automations

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