Oracle® Enterprise Manager Installation and Configuration Guide for IBM Tivoli Enterprise Console Connector Release 1.0.4.1.0 Part Number E14038-05 |
|
|
PDF · Mobi · ePub |
This appendix describes the default mappings between the Enterprise Manager alert data fields and the IBM TEC event slots. The data is formatted in XML, and the XSLT files transform the data from one format to another.
For information on customizing the field mappings, see Section 4.1, "Customizing Mappings".
This appendix discusses the following topics:
Data Translation Files
createEvent Operation
updateEvent Operation
getNewAlerts and getUpdatedAlerts Operations
XML Style Sheet (XSL) files contain the mappings between the two systems. These files are located in the following directory:
$ORACLE_HOME/sysman/connector/TEC_Connector
Table A–1 lists the XSL files that perform the mappings and provides a summary of each.
Table A-1 XSL Files that Perform Mappings
File | Description |
---|---|
createEvent_request.xsl |
Transforms the Oracle Enterprise Manager alert data to the IBM TEC event format for the createEvent operation. |
updateEvent_request.xsl |
Transforms the Oracle Enterprise Manager alert data to the IBM TEC event format for the updateEvent operation. |
getNewAlerts_response.xsl |
Transforms data in the IBM TEC event format to the Oracle Enterprise Manager alert format. This file is invoked to transform the response for the getNewAlerts poll operation. |
getUpdatedAlerts_response.xsl |
Transforms data in the IBM TEC event format to the Oracle Enterprise Manager alert format. This file is invoked to transform the response for the getUpdatedAlerts poll operation. |
The following sections provide details about the default mappings in each of the files.
The Oracle Enterprise Manager Connector Framework invokes the createEvent operation whenever an alert is generated in Oracle Enterprise Manager and there is a notification rule configured to invoke the TEC connector. createEvent_request.xsl is invoked during the process to transform the data from Oracle Enterprise Manager format to TEC event format. Table A–2 lists the default field mappings between the IBM TEC event and the Oracle Enterprise Manager alert.
Table A-2 createEvent Operation Mappings
TEC Slot | TEC Attribute Type | Req'd? | Oracle Enterprise Manager Alert Attributes | Value |
---|---|---|---|---|
Class Name |
String |
Yes |
Conditional based on the TargetType |
Set to Database if Oracle Enterprise Manager target type is database instance or cluster database. Set to Listener if Oracle Enterprise Manager target type is database listener. Set to Host if Oracle Enterprise Manager target type is host. Set to ApplicationServer if Oracle Enterprise Manager target type is Oracle application server. Set to OracleEnterpriseManager for all other target types. |
msg |
String |
Yes |
Values from the alert context are listed in angle brackets in the Value column. |
Received alert reported by Oracle Enterprise Manager: Collection Time — <Collection Time>Target Type — <TargetType>Target Name — <TargetName>Metric Name — <MetricName>Metric Column — <MetricColumn>* Key Values — <KeyValues>Severity — <Severity>* Notification Rule — <NotificationRuleName>* URL — <EventPageURL>Message — <Message> Fields preceded with an asterisk ( * ) are only present if the corresponding Enterprise Manager alert field has data. |
status |
String |
Yes |
Value defaulted |
OPEN |
severity |
String |
Yes |
Conditional based on the Oracle Enterprise Manager severity. |
Set to UNKNOWN if Oracle Enterprise Manager Severity is Unknown. Set to HARMLESS if Oracle Enterprise Manager Severity is Information. Set to CRITICAL if Oracle Enterprise Manager Severity is Critical. Set to WARNING for all other Oracle Enterprise Manager severity values. |
repeat_count |
String |
No |
Value defaulted. |
0 |
date |
String |
No |
Set to the Collection Time |
<CollectionTime> |
fqhostname |
String |
No |
Set to the Target Host |
<TargetHost> |
hostname |
String |
No |
Set to the Target Host |
<TargetHost> |
source |
String |
Yes |
Value defaulted |
OracleEnterpriseManager |
origin |
String |
No |
Set to the Target Type |
<TargetType> |
action_flag |
String |
No |
Value defaulted |
CREATE |
ext_id |
String |
Yes |
Set to the unique identifier for the Oracle Enterprise Manager Alert |
<EventGuid> |
sub_source |
String |
Yes |
Value defaulted |
OracleEnterpriseManager |
sub_origin |
String |
No |
Set to the Target Name |
<TargetName> |
The Oracle Enterprise Manager Connector Framework invokes the updateEvent operation whenever an alert is generated in Oracle Enterprise Manager and there is a notification rule configured to invoke the TEC connector. updateEvent_request.xsl is invoked during the process to transform the data from Oracle Enterprise Manager format to TEC event format. Table A–3 lists the default field mappings between the IBM TEC event and the Oracle Enterprise Manager alert.
Table A-3 updateEvent Operation Mappings
TEC Slot | TEC Attribute Type | Req'd? | Oracle Enterprise Manager Alert Attributes | Value |
---|---|---|---|---|
Class Name |
String |
Yes |
Conditional based on the TargetType |
Set to Database if Oracle Enterprise Manager target type is database instance or cluster database. Set to Listener if Oracle Enterprise Manager target type is database listener. Set to Host if Oracle Enterprise Manager target type is host. Set to ApplicationServer if Oracle Enterprise Manager target type is Oracle application server. Set to OracleEnterpriseManager for all other target types. |
msg |
String |
Yes |
Values from the alert context are listed in angle brackets in the Value column. |
Received alert reported by Oracle Enterprise Manager: Collection Time — <Collection Time>Target Type — <TargetType>Target Name — <TargetName>Metric Name — <MetricName>Metric Column — <MetricColumn>* Key Values — <KeyValues>Severity — <Severity>* Notification Rule — <NotificationRuleName>* URL — <EventPageURL>Message — <Message> Fields preceded with an asterisk ( * ) are only present if the corresponding Enterprise Manager alert field has data. |
status |
String |
Yes |
Value defaulted |
OPEN |
severity |
String |
Yes |
Conditional based on the Oracle Enterprise Manager severity. |
Set to UNKNOWN if Oracle Enterprise Manager Severity is Unknown. Set to HARMLESS if Oracle Enterprise Manager Severity is Information. Set to CRITICAL if Oracle Enterprise Manager Severity is Critical. Set to WARNING for all other Oracle Enterprise Manager severity values. |
repeat_count |
String |
No |
Value defaulted. |
0 |
date |
String |
No |
Set to the Collection Time |
<CollectionTime> |
fqhostname |
String |
No |
Set to the Target Host |
<TargetHost> |
hostname |
String |
No |
Set to the Target Host |
<TargetHost> |
source |
String |
Yes |
Value defaulted |
OracleEnterpriseManager |
origin |
String |
No |
Set to the Target Type |
<TargetType> |
action_flag |
String |
No |
Conditional based on the Oracle Enterprise Manager severity. |
Set to CLOSE if Oracle Enterprise Manager severity is Clear, Unreachable End, Blackout End, or Metric Error End. Set to UPDATE for all other Oracle Enterprise Manager severity values. |
ext_id |
String |
Yes |
Set to the unique identifier for the Oracle Enterprise Manager Alert |
<EventGuid> |
sub_source |
String |
Yes |
Value defaulted |
OracleEnterpriseManager |
sub_origin |
String |
No |
Set to the Target Name |
<TargetName> |
The Oracle Enterprise Manager Connector Framework invokes the getNewAlerts operation on the poll cycle interval configured for the TEC connector. One step in the operation is to send a request to the IBM TEC web service for new alerts in IBM TEC. When the response comes back, the getNewAlerts_response.xsl file is invoked to transform the IBM TEC event data to the format required to create new alerts in Oracle Enterprise Manager.
After the getNewAlerts operation is complete, the Enterprise Manager Connector Framework performs the getUpdatedAlerts operation. Like the getNewAlerts operation, it sends a request to the IBM TEC web service for updated alerts. When the response comes back, the getUpdatedAlerts_response.xsl file is invoked to transform the IBM TEC event data to the format required to update the alerts in Oracle Enterprise Manager.
Table A–4 lists the default field mappings between the IBM TEC event and the Oracle Enterprise Manager alert. These mappings are applicable to new and updated alerts, and must always be the same.
Table A-4 getNewAlerts and getUpdatedAlerts Operation Mappings
Oracle Enterprise Manager Event Attribute | Attribute Type | Req'd? | Oracle Enterprise Manager Alert Attributes | Value |
---|---|---|---|---|
key1 |
String |
Yes |
Set to the IBM TEC event identifier. |
<Identifier> |
message |
String |
Yes |
Values from the event slot are listed in angle brackets in the Value column. |
Identifier — <Identifier>Hostname — <hostname>Source — <source>Object — <Object>* Origin — <origin>Date — <date> Fields precede with an asterisk ( * ) are only present if the corresponding TEC event slot has data. |
comment |
String |
Yes |
Set to message text. |
Severity Identifier — <severity>Status — <status>Repeat Count — <repeat_count>Message — <msg> |
producerID |
String |
No |
Value defaulted. |
TEC |
targetName |
String |
Yes |
Set to the host that reported the problem. |
<hostname> |
TargetType |
String |
No |
Value defaulted. |
tec_host |
username |
String |
No |
Value defaulted to no value. |
|
password |
String |
No |
Value default to no value. |
|
metricName |
String |
Yes |
Set to the event class name. |
<Class Name> |
category |
String |
Yes |
Set to the event class name. |
<Class Name> |
value |
String |
Yes |
Set to the transaction identifier. This is not part of the event data. It is provided by the web service for tracking transactions. |
<transactionID> |
severity |
String |
Yes |
Conditional based on the IBM TEC status and severity. |
Set to Clear if the TEC status is set to CLOSED. Set to Informational if the TEC status is not set to CLOSED and the TEC severity is HARMLESS. Set to Critical if the TEC status is not set to CLOSED and the IBM TEC severity is CRITICAL or FATAL. Set to Warning if the TEC status is not set to CLOSED and any other TEC severity value is specified. |