Using custom fields

Use the custom fields associated with alerts in IBM Cloud Pak for AIOps.

Alerts in Cloud Pak for AIOps contain a set of predefined attributes that cover the general use cases. For more information about predefined attributes, see Alert and Event schemas.

In some cases you might want to add custom fields to alert properties, which are specific to your processes. For example, a retail store might want to keep track of a store id, or a communication service provider might want to track the location of a cell tower. These custom fields can be used for mapping incoming data, determining which policies to execute, or as part of automation actions. You can view custom fields alongside the predefined fields in Alert Viewer.

You can use custom fields in integrations that allow JSON mapping. These integrations include IBM Netcool Operations Insight ObjectServer and Webhook.

For more information about IBM Netcool Operations Insight ObjectServer integration, see Creating IBM Netcool Operations Insight ObjectServer integrations.

For more information about Webhook integration, see Creating Generic Webhook integrations.

If you want to use custom fields when you map incoming data (within an integration), then you need to define details field in the JSON. Add key and value pairs for your custom fields within the details object.

Use the following format for the custom fields:

{
 "details": {
   "myCustomField": "value"
 },
}

Following sample example shows the usage of custom fields within IBM Netcool Operations Insight ObjectServer integration:

For more information about displaying custom fields in Alert Viewer, see Columns from custom properties section in Creating views.

For more information about usage of custom fields when you create or customize a policy, see Policy editor.