Slot facets

Indicates that the slot will be treated as mandatory while sending events.

By default, msg and source_identifier are considered as mandatory slots. Custom slots can also be defined as mandatory.

Example of a class definition with the mandatory facet:

{
  "name": "pn_thresh_id",
  "dataType": "INTEGER",
  "default": "0",
  "enum": false,
  "allFacet": [
    {
      "name": "mandatory",
      "value": "true"
    }
  ]
}

Indicates whether the slot is protected against modification by REST APIs or event policies.

A slot with the read_only facet set to true / True / TRUE cannot be modified by a command or a rule. However, the system can modify this slot.

Example of a class definition with the read_only facet:

{
  "name": "pn_thresh_id",
  "dataType": "INTEGER",
  "default": "0",
  "enum": false,
  "allFacet": [
    {
      "name": "read_only",
      "value": "true"
    }
  ]
}

Indicates whether the slot is displayed in the product console.

Example of a class definition with the hidden facet:

{
  "name": "pn_thresh_id",
  "dataType": "INTEGER",
  "default": "0",
  "enum": false,
  "allFacet": [
    {
      "name": "hidden",
      "value": "true"
    }
  ]
}

Indicates whether the slot is used to determine duplicate events.

For events to be considered duplicates, the following must be true:

• Events belong to the same class
• All event slots whose dup_detect facet is set to true / True / TRUE have equal values

The following out-of-the-box slots are defined to determine duplicate events:

• Alarm event class: al_alarm_id
• Patrol event class: source_address, p_origin, p_origin_key
• Anomaly event class: an_anomaly_id

Example of a class definition with the dup_detect facet:

{
  "name": "pn_thresh_id",
  "dataType": "INTEGER",
  "default": "0",
  "enum": false,
  "allFacet": [
    {
      "name": "dup_detect",
      "value": "true"
    }
  ]
}

Indicates that the slot value holds the equivalent slot name that is used to look up topology information in BMC Helix Dynamic Service Modeling . While creating custom slots, you need to specify this facet for only those slots that are meant to be used for looking up topology information.

Some out-of-the-box slots are already defined with this facet type. For example, source_hostname and source_address under the base Event class. The value of these slots is used for retrieving the service IDs and node IDs from BMC Helix Dynamic Service Modeling . These slots are used for displaying service models in BMC Helix AIOps . For more information, see _node_id, _service_id, and _node_service_mapping slots under the base Event class.

If no facet slots are defined for a custom event class, the out-of-the-box facet slots are used for looking up the topology information.

Example of a class definition with the topology_lookup facet:

{
  "name": "NAGIOS_EV",
  "attributes": [
    {
      "name": "custom_slot_1",
      "dataType": "STRING",
      "allFacet": [
        {
          "name": "topology_lookup",
          "value": "custom_slot_1_field_in_SmartGraph"
        }
      ]
    },
    {
      "name": "custom_slot_2",
      "dataType": "INTEGER"
    }
  ]
}