As a plug-in developer, you are responsible for the following steps within customizing Incident Manager:

Figure 10-1 displays the General tab for a selected incident from the Incident Manager page.

The following customizations are supported for this page:

• Adding name-value pairs to the Incident Details region.

  For more information, see Adding Customized Details About the Event.

• Customizing Action and Diagnostic links in the Guided Resolution region.

  For more information, see Providing Content in the Guided Resolution Region.

• Adding recommendations to the Guided Resolution region.

  For more information, see Adding Recommendations using XML.

• Specifying the default search phrase for My Oracle Support Knowledge.

  For more information, see Defining a Search String for My Oracle Support Knowledge.

Each customization specification has two parts:

Oracle provides an event-specific customization XSD so that you can write XML to describe customizations for a specific event for display on the Incident Manager UI.

The event-specific customization XSD defines how the Incident Manager UI supports UI customization.

You can define fine-grained conditions to customize the Event Details or Incident Details pages.

Example: Sample Metadata File

<evt:CustomUI AppliesTo="EVENT" EventClass ="metric_alert" TargetType =host">
    <evt:ConditionDetails>
       <evt:Condition>
         <evt:Attrib Name="metric_name" Value="Load"/>
         <evt:Attrib Name="metricColumn" Value="cpuUtil"/> </evt:Condition>
     </evt:ConditionDetails>
</evt:CustomUI>

Oracle recommends the following naming conventions for your metadata XML:

• event_class_description.xml

  In the preceding file name:

  • event_class represents the name of the event class

    Event customization supports the following event classes:

    • metric_alert

    • target_availability

    • job_status_change

    • cs_rule_violation

    • cs_score

    • sla_alert

    • metric_error

  • description represents a short description of the event customization

  For example, job_status_change_recommendation.xml

• event_class_target_type_description.xml

  In the preceding file name:

  • event_class represents the name of the event class

  • target_type represents the name of the target type for which this event is generated

  • description represents a short description of the event customization

  For example, host_metric_alert_diaglinks.xml

For information about the directory location for the metadata XML, see Registering Customizations.

The Incident Details region shows information about the event. It consists of system attributes (such as the message, target name, and when the event was reported) and the class attributes. You can customize the name-value pairs for the class attributes.

Through the event-specific customization XML, you can choose which attributes to show, such as the labels for the name part, and whether you require a link under the value. For more information, see Creating Event-Specific Customization XML.

Example: Constructing a Name-Value Pair

<evt:DetailUI>
  <evt:UIAttributeList>
    <evt:UIAttrib Name="metric_name">
      <evt:URL PageType="sdkcore-dummy-published-page-id">
      <evt:URLParam Name="target" Value="^TARGET:sys_target_name^"/>
      <evt:URLParam Name="type" Value="^TARGET:sys_target_type^"/>
      <evt:URLParam Name="metric" Value="^metric_name^"/>
      <evt:URLParam Name="metricColumn" Value="^metric_column^"/>
      <evt:URLParam Name="ctxType" Value="Hosts"/>
      </evt:URL>
    </evt:UIAttrib>
  </evt:UIAttributeList>
</evt:DetailUI>

The previous example constructs a name-value pair under the Incident Details region. The name is the translated value of metric_name, which is an event class attribute. The value part is the value of metric_name, with a link to the METRIC_DETAILS page with specified URL parameters.

The URL parameters in the links can be:

• Event attributes: Must be enclosed in carets (^). For example, ^metric_name^.

  For information about event attributes, see About Events.

• Target attributes: Must be prefixed with TARGET. For example, ^TARGET:sys_target_type^.

  Possible target attributes:

  • sys_target_name

  • sys_target_type

  • sys_target_owner

  • sys_target_version

  • sys_target_lifecycle_status

  • sys_target_guid

    For more information about these attributes, see Table 10-2.

• Event context attributes: Must be prefixed with EVENT. For example, ^EVENT:evt_context_attrib_name^.

  Event context attributes enable the event publisher to provide additional event information to event attributes and are defined as name-value pairs.

• Constants: Must be specified as literal strings. For example, byDay.

You can make the following customizations to the Guided Resolution region:

The Guided Resolution region provides links to relevant Enterprise Manager pages to help users debug and resolve issues. These context-sensitive links are grouped into multiple areas based on the nature of content in the destination page of the link. The following areas are displayed only if they have content.

• Diagnose: This area contains links that can help users diagnose the issue. For example, for an event based on a target, the Diagnose area contains a link called View topology that drills down to the Topology Viewer. You can add or remove links in this area using the evt:DiagLinks tag (see the Adding a Link to the Diagnostics Subsection example).

• Repair: This area contains links that can help users resolve the issue. For example, for metric alerts with thresholds, this area might contain a link to Edit Thresholds. You can add or remove links to and from this area using the evt:ActionLinks tag. This area displays for open events only.

• Recommendation: This area contains text content drawn from the metric advisory, if available. You can customize the content of this area using the evt:Recommendation tag (see the Adding Recommendations example in Adding Recommendations using XML).

• Any additional area: This area contains text content drawn from the metric advisory, if available. You can customize the content of this section using the evt:Sections tag (see the Adding Customized Areas example in Customizing Sections).

The following example provides an example of adding a link to the Diagnostics list in the Guided Resolution region using XML:

Example: Adding a Link to the Diagnostics Subsection

<evt:DiagLinks>
  <evt:Add>
    <evt:Link LinkID="diagLink1_example">
      <evt:Label>
      <evt:LocalizedLabel DefaultLabel="Edit Thresholds"
        NLSID="EDIT_METRIC_THRESHOLDS"
        ResourceBundle="oracle.sysman.resources.MntrResourceBundle"/>
      </evt:Label>
      <evt:URL PageType="sdkcore-published-page-id-for-edit-threshold">
      <evt:URLParam Name="target" Value="^TARGET:sys_target_name^"/>
      <evt:URLParam Name="type" Value="^TARGET:sys_target_type^"/>
      <evt:URLParam Name="event" Value="doEditTreshold"/>
      <evt:URLParam Name="metric" Value="^metric_name^"/>
      <evt:URLParam Name="collName" Value="^coll_name^"/>
      <evt:URLParam Name="keyValue" Value="^key_value^"/>
      <evt:URLParam Name="metricColumn" Value="^column^"/>
      </evt:URL>
    </evt:Link>
  </evt:Add>
</evt:DiagLinks>

In the previous example, the link text is derived from the evt:Label specification and the URL is derived from evt:URL.

The URL parameters in the links can be:

• Event attributes: Must be enclosed in carets (^). For example, ^metric_name^.

  For information about event attributes, see About Events.

• Target attributes: Must be prefixed with TARGET. For example, ^TARGET:sys_target_type^.

  Possible target attributes:

  • sys_target_name

  • sys_target_type

  • sys_target_owner

  • sys_target_version

  • sys_target_lifecycle_status

  • sys_target_guid

    For more information about these attributes, see Table 10-2.

• Event context attributes: Must be prefixed with EVENT. For example, ^EVENT:evt_context_attrib_name^.

  Event context attributes enable the event publisher to provide additional event information to event attributes and are defined as name-value pairs.

• Constants: Must be specified as literal strings. For example, byDay.

The customization framework provides a default search phrase in the following order of preference:

The search string can be specified explicitly by using XML as shown in the following example. This search string searches for a metric alert indicating high CPU usage for the plug-in component.

Example: Defining a Search String

<evt:GuidedResolutionDetails>
  <evt:GuidedResolution>
    <evt:SearchPhrase>High CPU Utilization </evt:SearchPhrase>
  </evt:GuidedResolution>
</evt:GuidedResolutionDetails>

To select the events for which customizations are to be applied, you can define conditions using the attributes of an event. To define conditions using attributes from the event payload (for example, system attributes such as target name, target type, or event-class specific attributes such as metric_name for metric alerts, or event-context attributes), use XML.

Conditions can be defined under the evt:ConditionDetails tag. You can specify various event attributes here and they are joined together implicitly using an AND condition.

Example: Defining a Condition

<evt:CustomUI AppliesTo ="EVENT" EventClass ="metric_alert" TargetType =host">
  <evt:ConditionDetails>
    <evt:Condition>
      <evt:Attrib Name="metric_name" Value="Load"/>
      <evt:Attrib Name="metricColumn" Value="cpuUtil"/>

    </evt:Condition>
  </evt:ConditionDetails>
...
</evt:CustomUI>

The following operators are supported to define conditions:

• EQ: Equals. This is the default operator

• NE: Not equals

• ISNULL: Is null

• ISNOTNULL: Is not null

• CONTAINS: Can be contained in the string (as a substring)

• BEGINSWITH: Begins with (for example, the event name begins with Tablespace)

• IN: In a predefined set of values (separated by pre-defined delimiter comma (,))

• NOT_IN: Not in a predefined set of values. Use for exclusion

The event-specific customization XML files are located in the $PLUGIN_ORACLE_HOME/sysman/metadata/events/custmzn directory. In the shipped version of the product, these XMLs are registered as part of the plug-in installation.

If you are creating the XMLs for the first time in a view that is already set up or to test changes, use the Metadata Registration Service (MRS) to register XML for the event class. For more information about the MRS, see Updating Deployed Metadata Files Using the Metadata Registration Service (MRS).

emctl register oms metadata -service eventSpecificCustmzn -file XML filename -pluginId plugin_name -sysman_pwd sysman -debug

For example:

emctl register oms metadata -service eventSpecificCustmzn -file metric_alert_host_load.xml -pluginId test.demo.xyz -sysman_pwd sysman -debug 

You must restart the Oracle Management Service (OMS) after registering the event-specific customization XML, using the emctl command from the OMS home directory (OMS_HOME).

OMS_HOME>emctl stop oms
OMS_HOME>emctl start oms

You might encounter the following errors when you register your event-specific customization XML:

• Syntax error in the XML

  For information about the correct syntax and an example of the XML, see Creating Event-Specific Customization XML.

• Incorrect values for attribute names

  For information about attribute names, see About Events.

• Incorrect credentials

  Incorrect credentials will not allow you to connect to the Management Repository. Ensure that you are using authorized credentials.

Test the Incident Manager UI by publishing an event that matches the condition and then make sure that there is an incident created for it: