Tivoli Enterprise Console event mapping
Generic event mapping provides useful event class and attribute information for situations that do not have specific event mapping defined. Each event class corresponds to an attribute group in the monitoring agent. For a description of the event slots for each event class, see the tables described in this appendix. For more information about mapping attribute groups to event classes, see the Tivoli Enterprise Console product documentation.
Configuring the Tivoli Enterprise Console
- Ensure sure that the TEC IF is configured to point to the correct Tivoli Enterprise Console server with the correct host port information.
- Install the om_tec.baroc and kt<n>.baroc files
into a rule base for Tivoli Enterprise Console and activate
it.Note: When you install Tivoli Enterprise Monitoring Server support, the installation places the baroc files into one of the following directories, depending on your operating system:
- On Windows systems: %CANDLE_HOME%\CMS\teclib
- On UNIX systems: $CANDLE_HOME/tables/TEMS_NAME/TECLIB
The following ktn.baroc files are available:- kt3.baroc, for the Application Management Console event classes.
- kt5.baroc, for the Web Response Time event classes.
- kt6.baroc, for the Robotic Response Time event classes.
- In this same directory, edit the tecserver.txt file
to add the situations for which you want to see events, using the
following format:
SituationName=*,SEVERITY=CRITICAL|WARNING|UNKNOWN
- Restart the Tivoli Enterprise Monitoring Server.
Specifying attributes to include in events
- Baroc files
- Event Mapping files
TEC_CLASS: class_name ISA super_class_name
DEFINES {
attribute_definitions;
};
END
- STRING - A string value
- REAL - A real value
- ENUM - A value of an enumeration
- INT32 - A 32-bit integer value
- INTEGER - A 29-bit integer value
Detailed information regarding Event Classes and Attributes can be found in the Rule Developers Guide, located at the following website:http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/index.jsp?topic=/com.ibm.itecruledev.doc/ecodmst.htm
- kt3.map, for the Application Management Console event classes.
- kt5.map, for the Web Response Time event classes.
- kt6.map, for the Robotic Response Time event classes.
<itmEventMapping:agent>
<id>xx</id>
<version>n.n</version>
<event_mapping>
<attributeTable>
<class/>
<slot>
<mappedAttribute/>
or
<mappedAttributeEnum/>
</slot>
:.......... one or more slot tags
</attributeTable>
:.......... one or more attributeTable tags
</event_mapping>
</itmeventMapping:agent>
- <attributeTable>
- Syntax: <attributeTable name="attribute_table_name"
[freeSpace="nnnn"]>, where nnnn is an integer
value.
Usage: The freeSpace="nnnn" parameter is the maximum free space available in the TEC event buffer for additional slots after all of the slots that are defined in this event map are built.
- <slot>
- Syntax: <slot name="slot_name">
Usage: Defines a slot in the TEC event. The name of the slot is slot_name.
- <mappedAttribute>
- Syntax: <mappedAttribute name="attribute_name"
[multiplier="nnn"]>
Usage: Specifies the attribute name that is mapped to the slot being defined. If attribute_name is not included in the event data, a null value is used. If the optional multiplier= parameter is specified and the value of the attribute is numeric, the value assigned for the slot is the attribute value multiplied by the number specified in the multiplier= parameter.
- <mappedAttributeEnum>
- Syntax: <mappedAttributeEnum name="attribute_name">
Usage: similar to the <mappedAttribute> tag, except if the attribute is defined as an enumerated value in the attribute file, the external enumerated string is used as the slot value instead of the attribute value. If there is no external enumerated string defined that matches the attribute value, the attribute value is used instead.
By default, not every attribute is included in events that are sent to Tivoli Enterprise Console. See the Attribute Groups section of the Response Time chapter in the User's Guide for an indication of which attributes in each group are preselected to be forwarded in events to Netcool/OMNIbus or Tivoli Enterprise Console.
Example: Forwarding additional Robotic Response Time attributes in events
You can modify the baroc and event mapping files to specify additional attributes to forward in events. The following example procedure illustrates how to modify the kt6.baroc and kt6.map files to create additional event slots for attributes that are not already being forwarded in events. This example will use attributes in the Robotic Response Time agent attribute group, RRT_Robotic_Playback_Events. You can use this same basic procedure to modify the baroc and event mapping files for any of the ITCAM for Transaction agents.
- Determine the amount of free space available in the event mapping file.
- Collect details about the name and size of the attributes to be added to the baroc and event mapping files.
- Edit the baroc and event mapping files to create slots for the additional attributes.
- Apply the baroc and event mapping file changes.
- Open the following file in the Tivoli Enterprise Monitoring Server file
system:
- On Windows systems: %CANDLE_HOME%\CMS\teclib\kt6.map
- On UNIX systems: $CANDLE_HOME/tables/<TEMS_NAME>/TECLIB/kt6.map
- Search for the string: RRT_Robotic_Playback_Events.
- Make note of the freeSpace value, similar to the following
example:
<attributeTable freeSpace="398" name="RRT_Robotic_Playback_Events"> <class name="ITM_RRT_Robotic_Playback_Events"/> <slot slotName="application_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Application_Name"/> </slot> <slot slotName="transaction_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Transaction_Name"/> </slot> <slot slotName="kt6_situation_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Situation_Name"/> </slot> <slot slotName="command_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Command_Name"/> </slot> <slot slotName="violation_data"> <mappedAttribute name="RRT_Robotic_Playback_Events.Violation_Data"/> </slot> <slot slotName="expected_data"> <mappedAttribute name="RRT_Robotic_Playback_Events.Expected_Data"/> </slot> <slot slotName="additional_details"> <mappedAttribute name="RRT_Robotic_Playback_Events.Additional_Details"/> </slot> <slot slotName="captured_content_location"> <mappedAttribute name="RRT_Robotic_Playback_Events.Captured_Content_Location"/> </slot> </attributeTable>
In this example, the attribute table has 398 bytes of available free space.
- In the User's Guide,
look up the RRT Robotic Playback Events attribute
group.In the far right column of the table, note that there are a number of attributes that are not, by default, forwarded in events. Suppose for this example that you want to begin forwarding data for the following attributes in events:
- Event_Type
- Script_Name
- Script_Type
- In the table, note the Tivoli Data Warehouse term and the column
size in bytes value for the attributes you want to add to the
existing event. The total size of the attributes to be added must
not be greater than the freeSpace value noted in the kt6.map
file.
For this example, the amount of free space is 398 bytes. From the above table, each of the attributes being added is 128 bytes, for a total of 384 bytes.
- To add new entries to the kt6.map and kt6.baroc files, you need
the mappedAttribute name and the slotName. The full mappedAttribute name
is constructed from the Attribute Group Name (RRT_Robotic_Playback_Events)
and the Attribute name from the Tivoli Data Warehouse term for
historical reporting column of the above Attribute Group table.
For our example these will be:
- RRT_Robotic_Playback_Events.Event_Type
- RRT_Robotic_Playback_Events.Script_Name
- RRT_Robotic_Playback_Events.Script_Type
The value for slotName is obtained from the Robotic Response Time Event classes table later in this appendix:Table 1. Robotic Response Time event slots to event classes Event class Event slot ITM_RRT_Robotic_Playback_Events ISA KT6_Base RRT_Robotic_Playback_Events attribute group origin_node: STRING; sample_timestamp: STRING; event_timestamp: STRING; script_name: STRING; script_type: STRING; script_type_enum: STRING; event_type: STRING; event_type_enum: STRING; kt6_situation_name: STRING; command_name: STRING; violation_data: STRING; expected_data: STRING; additional_details: STRING; application_name: STRING; transaction_name: STRING; captured_content_location: STRING;
The values for slotName in baroc and map files are the same as the corresponding entry in the Attribute Group table, but all lower-case. For example, Application_Name from the Attribute Group table is application_name in the baroc file, and is the value for slotName in the map file. For our example, the following entries are present:- event_type: STRING;
- script_name: STRING;
- script_type: STRING;
- Make backup copies of the following files:
- On Windows systems:
- %CANDLE_HOME%\CMS\teclib\kt6.baroc
- %CANDLE_HOME%\CMS\teclib\kt6.map
- On UNIX and Linux systems:
- $CANDLE_HOME/tables/tems_name/TECLIB/kt6.baroc
- $CANDLE_HOME/tables/tems_name/TECLIB/kt6.map
- On Windows systems:
- Edit the kt6.baroc file to add the new attributes
to the RRT_Robotic_Playback_Events Event Class.The resulting event class should look similar to the following example:
TEC_CLASS : ITM_RRT_Robotic_Playback_Events ISA KT6_Base DEFINES { # # RRT_Robotic_Playback_Events attribute group # kt6_situation_name: STRING; command_name: STRING; violation_data: STRING; expected_data: STRING; additional_details: STRING; application_name: STRING; transaction_name: STRING; captured_content_location: STRING; event_type: STRING; script_name: STRING; script_type: STRING; }; END
- Edit the kt6.map file and for each of these three
new attributes, add the following lines:
<slot slotName="xxxxxx"> <mappedAttribute name="yyyyyy.zzzzzz"/> </slot>
- xxxxxx
- The Event Slot name from the appropriate TEC Event Mapping table or the lower-case version of the Attribute name from the appropriate Attribute Group table.
- yyyyyy
- Attribute Group name
- zzzzzz
- Attribute name
In addition, update the value of the freeSpace parameter to account for the new attributes added. In this example, the original value of 398 bytes is reduced by 384 bytes, to a resulting freeSpace value of 14 bytes.
The resulting kt6.map entry should look similar to the following example:<attributeTable freeSpace="14" name="RRT_Robotic_Playback_Events"> <class name="ITM_RRT_Robotic_Playback_Events"/> <slot slotName="application_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Application_Name"/> </slot> <slot slotName="transaction_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Transaction_Name"/> </slot> <slot slotName="kt6_situation_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Situation_Name"/> </slot> <slot slotName="command_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Command_Name"/> </slot> <slot slotName="violation_data"> <mappedAttribute name="RRT_Robotic_Playback_Events.Violation_Data"/> </slot> <slot slotName="expected_data"> <mappedAttribute name="RRT_Robotic_Playback_Events.Expected_Data"/> </slot> <slot slotName="additional_details"> <mappedAttribute name="RRT_Robotic_Playback_Events.Additional_Details"/> </slot> <slot slotName="captured_content_location"> <mappedAttribute name="RRT_Robotic_Playback_Events.Captured_Content_Location"/> </slot> <slot slotName="event_type"> <mappedAttribute name="RRT_Robotic_Playback_Events.Event_Type"/> </slot> <slot slotName="script_name"> <mappedAttribute name="RRT_Robotic_Playback_Events.Script_Name"/> </slot> <slot slotName="script_type"> <mappedAttribute name="RRT_Robotic_Playback_Events.Script_Type"/> </slot></attributeTable>
Step 4: Apply the baroc and event mapping file changes
- Restart Tivoli Enterprise Monitoring Server. This ensures that the newly added attributes are included in events being forwarded.
- To ensure the new attributes are recognized by the receiving event
server, update the ITCAM for Transactions rule base on the TEC Server.
For example:
wrb -delrbclass kt6.baroc -force ITCAMfT_RB Copy the new baroc file from the TEMS file system to the TEC Server wrb -imprbclass kt6.baroc ITCAMfT_RB wrb -comprules ITCAMfT_RB wrb -loadrb ITCAMfT_RB wstopesvr wstartesvr
Application Management Console Event classes
Event class | Event slot |
---|---|
ITM_DB_Agent_Details ISA KT3_Base | DB_Agent_Details attribute group
|
ITM_ERT_Agent_Messages ISA KT3_Base | ERT_Agent_Messages attribute group
|
ITM_DB_Application_Summary ISA KT3_Base | DB_Application_Summary attribute
group
|
ITM_DB_Client_Summary ISA KT3_Base | DB_Client_Summary attribute group
|
ITM_DB_Depot_Status ISA KT3_Base | DB_Depot_Status attribute group
|
ITM_DB_File_Depot ISA KT3_Base | DB_File_Depot attribute group
|
ITM_T3_File_Transfer ISA KT3_Base | T3_File_Transfer attribute group
|
ITM_AMC_Internet_Service ISA KT3_Base | AMC_Internet_Service attribute
group
|
ITM_AMC_Internet_Service_Element ISA KT3_Base | AMC_Internet_Service_Element attribute
group
|
ITM_AMC_Internet_Service_Agent ISA KT3_Base | AMC_Internet_Service_Agent attribute
group
|
ITM_AMC_Internet_Services_Profiles ISA KT3_Base | AMC_Internet_Services_Profiles attribute
group
|
ITM_AMC_ISM ISA KT3_Base | AMC_ISM attribute group
|
ITM_AMC_Robotic_Playback_Status ISA KT3_Base | AMC_Robotic_Playback_Status attribute
group
|
ITM_DB_Sub_Node_App_Client_Summary ISA KT3_Base | DB_Sub_Node_App_Client_Summary attribute
group
|
ITM_AMC_Agent ISA KT3_Base | AMC_Agent attribute group
|
ITM_AMC_Application ISA KT3_Base | AMC_Application attribute group
|
ITM_DB_Sub_Node_Application_OverTime ISA KT3_Base | DB_Sub_Node_Application_OverTime attribute
group
|
ITM_DB_Sub_Node_Application_Summary ISA KT3_Base | DB_Sub_Node_Application_Summary attribute
group
|
ITM_DB_Sub_Node_App_Server_Summary ISA KT3_Base | DB_Sub_Node_App_Server_Summary attribute
group
|
ITM_AMC_Client ISA KT3_Base | AMC_Client attribute group
|
ITM_DB_Sub_Node_Client_Over_Time ISA KT3_Base | DB_Sub_Node_Client_Over_Time attribute
group
|
ITM_DB_Sub_Node_Client_Summary ISA KT3_Base | DB_Sub_Node_Client_Summary attribute
group
|
ITM_AMC_Client_Agents ISA KT3_Base | AMC_Client_Agents attribute group
|
ITM_DB_Sub_Node_Client_Server_Summary ISA KT3_Base | DB_Sub_Node_Client_Server_Summary attribute
group
|
ITM_AMC_Server ISA KT3_Base | AMC_Server attribute group
|
ITM_DB_Sub_Node_Server_Over_Time ISA KT3_Base | DB_Sub_Node_Server_Over_Time attribute
group
|
ITM_DB_Sub_Node_Server_Summary ISA KT3_Base | DB_Sub_Node_Server_Summary attribute
group
|
ITM_AMC_Server_Agents ISA KT3_Base | AMC_Server_Agents attribute group
|
ITM_AMC_Transaction ISA KT3_Base | AMC_Transaction attribute group
|
ITM_DB_Sub_Node_Transaction_Summary ISA KT3_Base | DB_Sub_Node_Transaction_Summary attribute
group
|
ITM_DB_Sub_Node_Transaction_OverTime ISA KT3_Base | DB_Sub_Node_Transaction_OverTime attribute
group
|
Web Response Time Event classes
Event class | Event slot |
---|---|
ITM_WRT_Agent_Details ISA KT5_Base | WRT_Agent_Details attribute group
|
ITM_WRT_Agent_Messages ISA KT5_Base | WRT_Agent_Messages attribute group
|
ITM_WRT_Application_Status ISA KT5_Base | WRT_Application_Status attribute
group
(continued in next row) |
ITM_WRT_Application_Status ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Application_Over_Time ISA KT5_Base | WRT_Application_Over_Time attribute
group
(continued in next row) |
ITM_WRT_Application_Over_Time ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Application_Summary ISA KT5_Base | WRT_Application_Summary attribute
group
(continued in next row) |
ITM_WRT_Application_Summary ISA KT5_Base (continued) | (continued from previous row)
|
ITM_WRT_Client_Application ISA KT5_Base | WRT_Client_Application attribute
group
(continued in next row) |
ITM_WRT_Client_Application ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Client_Status ISA KT5_Base | WRT_Client_Status attribute group
(continued in next row) |
ITM_WRT_Client_Status ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Client_Over_Time ISA KT5_Base | WRT_Client_Over_Time attribute
group
(continued on next row) |
ITM_WRT_Client_Over_Time ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Client_Patterns ISA KT5_Base | WRT_Client_Patterns attribute
group
|
ITM_WRT_Client_Summary ISA KT5_Base | WRT_Client_Summary attribute group
(continued on next row) |
ITM_WRT_Client_Summary ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Client_Server ISA KT5_Base | WRT_Client_Server attribute group
|
ITM_WRT_Depot_Status ISA KT5_Base | WRT_Depot_Status attribute group
|
ITM_WRT_Profile_Configuration ISA KT5_Base | WRT_Profile_Configuration attribute
group
|
ITM_WRT_Server_Application ISA KT5_Base | WRT_Server_Application attribute
group
|
ITM_WRT_Server_Status ISA KT5_Base | WRT_Server_Status attribute group
(continued on next row) |
ITM_WRT_Server_Status ISA KT5_Base (continued) | (continued from previous row)
|
ITM_WRT_Server_Over_Time ISA KT5_Base | WRT_Server_Over_Time attribute
group
(continued on next row) |
ITM_WRT_Server_Over_Time ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Server_Summary ISA KT5_Base | WRT_Server_Summary attribute group
(continued on next row) |
ITM_WRT_Server_Summary ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_SubTransaction_Status ISA KT5_Base | WRT_SubTransaction_Status attribute
group
(continued on next row) |
ITM_WRT_SubTransaction_Status ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_SubTransaction_Instance ISA KT5_Base | WRT_SubTransaction_Instance attribute
group
|
ITM_WRT_SubTransaction_Over_Time ISA KT5_Base | WRT_SubTransaction_Over_Time attribute
group
|
ITM_WRT_SubTransaction_Summary ISA KT5_Base | WRT_SubTransaction_Summary attribute
group
|
ITM_WRT_Transaction_Status ISA KT5_Base | WRT_Transaction_Status attribute
group
(continued on next row) |
ITM_WRT_Transaction_Status ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Transaction_Instance ISA KT5_Base | WRT_Transaction_Instance attribute
group
(continued on next row) |
ITM_WRT_Transaction_Instance ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Transaction_Over_Time ISA KT5_Base | WRT_Transaction_Over_Time attribute
group
(continued on next row) |
ITM_WRT_Transaction_Over_Time ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_Transactions_Patterns ISA KT5_Base | WRT_Transactions_Patterns attribute
group
|
ITM_WRT_Transaction_Summary ISA KT5_Base | WRT_Transaction_Summary attribute
group
(continued on next row) |
ITM_WRT_Transaction_Summary ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_User_Sessions ISA KT5_Base | WRT_User_Sessions attribute group
(continued on next row) |
ITM_WRT_User_Sessions ISA KT5_Base (Continued) | (continued from previous row)
|
ITM_WRT_SSL_Alert_Current_Status ISA KT5_Base | WRT_SSL_Alert_Current_Status attribute
group
|
Robotic Response Time Event classes
Event class | Event slot |
---|---|
ITM_RRT_Agent_Details ISA KT6_Base | RRT_Agent_Details attribute group
|
ITM_RRT_Agent_Messages ISA KT6_Base | RRT_Agent_Messages attribute group
|
ITM_RRT_Application_Status ISA KT6_Base | RRT_Application_Status attribute
group
|
ITM_RRT_Application_Over_Time ISA KT6_Base | RRT_Application_Over_Time attribute
group
|
ITM_RRT_Application_Summary ISA KT6_Base | RRT_Application_Summary attribute
group
|
ITM_RRT_Client_Application ISA KT6_Base | RRT_Client_Application attribute
group
|
ITM_RRT_Client_Over_Time ISA KT6_Base | RRT_Client_Over_Time attribute
group
|
ITM_RRT_Client_Patterns ISA KT6_Base | RRT_Client_Patterns attribute
group
|
ITM_RRT_Client_Summary ISA KT6_Base | RRT_Client_Summary attribute group
|
ITM_RRT_Depot_Status ISA KT6_Base | RRT_Depot_Status attribute group
|
ITM_RRT_Robotic_Playback_Events_Sampled ISA KT6_Base | RRT_Robotic_Playback_Events_Sampled attribute
group
|
ITM_RRT_Robotic_Playback_Configuration ISA KT6_Base | RRT_Robotic_Playback_Configuration attribute
group
|
ITM_RRT_Robotic_Playback_Events ISA KT6_Base | RRT_Robotic_Playback_Events attribute
group
|
ITM_RRT_Robotic_Playback_Status ISA KT6_Base | RRT_Robotic_Playback_Status attribute
group
|
ITM_RRT_Profile_Configuration ISA KT6_Base | RRT_Profile_Configuration attribute
group
|
ITM_RRT_Realms ISA KT6_Base | RRT_Realms attribute group
|
ITM_RRT_SubTransaction_Status ISA KT6_Base | RRT_SubTransaction_Status attribute
group
|
ITM_RRT_SubTransaction_Instance ISA KT6_Base | RRT_SubTransaction_Instance attribute
group
|
ITM_RRT_SubTransaction_Over_Time ISA KT6_Base | RRT_SubTransaction_Over_Time attribute
group
|
ITM_RRT_SubTransaction_Summary ISA KT6_Base | RRT_SubTransaction_Summary attribute
group
|
ITM_RRT_Transaction_Status ISA KT6_Base | RRT_Transaction_Status attribute
group
|
ITM_RRT_Transaction_Instance ISA KT6_Base | RRT_Transaction_Instance attribute
group
|
ITM_RRT_Transaction_Over_Time ISA KT6_Base | RRT_Transaction_Over_Time attribute
group
|
ITM_RRT_Transactions_Patterns ISA KT6_Base | RRT_Transactions_Patterns attribute
group
|
ITM_RRT_Transaction_Summary ISA KT6_Base | RRT_Transaction_Summary attribute
group
|