Oem Users Guide

OEM Users Guide
Abstract
This manual describes the OEM Server and Enterprise Management Adapter components of the Open Enterprise Management (OEM) Gateway product. It tells how to install, configure, and customize the OEM Server to monitor OEM objects, and it documents the application programmatic interfaces (APIs) for both client applications and enterprise management framework adapters as a reference for developers planning to use the OEM Server in their own development efforts.
Product Version
Open Enterprise Management (OEM) Version 3.0 (T8486)
Part Number
520330-001
Published
April 2001
Document History
Part Number 520330-001 Product Version OEM Version 3.0 Published April, 2001
Ordering Information
For manual ordering information: domestic U.S. customers, call 1-800-243-6886; international customers, contact your local sales representative.
Document Disclaimer
Information contained in a manual is subject to change without notice. Please check with your authorized representative to make sure you have the most recent information.
Export Statement
Export of the information contained in this manual may require authorization from the U.S. Department of Commerce.
Examples
Examples and sample programs are for illustration only and may not be suited for your particular purpose. The inclusion of examples and sample programs in the documentation does not warrant, guarantee, or make any representations regarding the use or the results of the use of any examples or sample programs in any documentation. You should verify the applicability of any example or sample program before placing the software into productive use.
U.S. Government Customers

FOR U.S. GOVERNMENT CUSTOMERS REGARDING THIS DOCUMENTATION AND THE ASSOCIATED SOFTWARE: These notices shall be marked on any reproduction of this data, in whole or in part. NOTICE: Notwithstanding any other lease or license that may pertain to, or accompany the delivery of, this computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in Section 52.227-19 of the FARS Computer SoftwareRestricted Rights clause. RESTRICTED RIGHTS NOTICE: Use, duplication, or disclosure by the Government is subject to the restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227-7013. RESTRICTED RIGHTS LEGEND: Use, duplication or disclosure by the Government is subject to restrictions as set forth in paragraph (b)(3)(B) of the rights in Technical Data and Computer Software clause in DAR 7-104.9(a). This computer software is submitted with restricted rights. Use, duplication or disclosure is subject to the restrictions as set forth in NASA FAR SUP 18-52 227-79 (April 1985) Commercial Computer SoftwareRestricted Rights (April 1985). If the contract contains the Clause at 18-52 227-74 Rights in Data General then the Alternate III clause applies. U.S. Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract. Unpublished All rights reserved under the Copyright Laws of the United States.
OEM Users Guide
Glossary
Index
Figures
Whats New in This Manual xi Manual Information xi New and Changed Information About This Manual xiii Audience xiii Organization xiii Your Comments Invited xiii Notation Conventions xiv xi
1. Introducing the Open Enterprise Management Server

OEM Architecture 1-1 1-2 1-3 Features of the OEM Server Version 3.0 Hardware and Software Requirements Hardware Requirements Obtaining Support 1-3 1-3 Software Requirements 1-3
2. Installing the Open Enterprise Management Server

Setup 2-1 Files Installed 2-1 Registry Changes 2-2 Uninstalling the OEM 2-2
Compaq Computer Corporation 520330-001 i
Contents
3. Configuring the Open Enterprise Management Server
3. Configuring the Open Enterprise Management Server

General Options 3-1 Opening the OEM General Options Dialog Box Specifying the Number of Reporting Levels 3-2 3-2
Including Intermediate-Level State Values in Frameworks and Display Windows 3-2 Example 3-3 3-3 3-4 3-4 3-5 3-6 Reusing Display Windows
Keeping Display Windows on Top
Automatically Closing Max Alerts Windows as They Are Used Using Custom View Windows for Alerts and Max Alerts Automatically Saving Custom View Definitions 3-5 Synchronizing the OEM Alerts Window and Client Applications Setting the Icon Size 3-7 3-8 Choosing a New Icon Set 3-7 Choosing the Default Tiling Scheme Adapter Options 3-8 Viewing the Adapter List 3-9 Adding an Adapter Entry Updating an Adapter Entry Deleting an Adapter Entry Adjusting Adapter Priority 3-9 3-10 3-10 3-11 3-11
Configuring a Framework Adapter 3-10 Restoring Default Adapter Settings Logging Options 3-12 Opening the OEM Logging Dialog Box Setting the Size of the Log 3-13 Enabling API and Error Tracing Enabling OEM Timer Tracing Font Options 3-14 Advanced Options 3-15 Opening the OEM Advanced Options Dialog Box 3-15
OEM Users Guide520330-001 ii
Using the Add/Update Adapter Dialog 3-12 3-13
3-13 3-14
Contents
3. Configuring the Open Enterprise Management Server (continued)
3. Configuring the Open Enterprise Management Server (continued)

Limiting the Number of Icons Used 3-15 Supplementary Display Windows 3-16
4. OEM Windows
The Alerts Window 4-1 4-2 4-2 4-3 Opening an Alerts Window Alerts Window Fields Alerts Window Menus View Menu 4-3 Help Menu 4-3 4-3 Sorting Alerts Window Items Aligning Alerts Windows Locking the Alerts Window 4-4 4-4 4-5
Sizing Alerts Window Columns 4-4
Keeping the Alerts Window on Top 4-5 Refreshing Alerts Window Contents Creating a New Alerts Window Closing the Alerts Window The Max Alerts Window 4-6 4-6 4-7 4-7 4-6 4-5
Navigating to Client Applications 4-6
Opening a Max Alerts Window Max Alerts Window Fields Max Alerts Window Menus View Menu 4-7 Help Menu 4-8
Sorting Max Alerts Window Items Aligning Max Alerts Windows Locking the Max Alerts Window 4-9
4-8 4-8
Sizing Max Alerts Window Columns 4-9
Keeping the Max Alerts Window on Top 4-10 Refreshing Max Alerts Window Contents Creating a New Max Alerts Window 4-10 Navigating to Client Applications 4-10
OEM Users Guide520330-001 iii
4-10
Contents
4. OEM Windows (continued)

Closing the Max Alerts Window The Clients Window 4-11 4-11 Opening a Clients Window 4-11
Clients Window Fields 4-11 Clients Window Menus 4-12 View Menu 4-12 Help Menu 4-13 4-13 Sorting Clients Window Items 4-13 Sizing Clients Window Columns Aligning Clients Windows 4-13 Locking the Clients Window 4-14 4-14 4-15 Keeping the Clients Window on Top Refreshing Clients Window Contents Closing the Clients Window The Objects Window 4-15 4-15 Opening an Objects Window Objects Window Fields 4-16 Objects Window Menus 4-17 View Menu Help Menu 4-18 4-18 4-18 4-15
Sorting Objects Window Items Aligning Objects Windows Locking the Objects Window
Sizing Objects Window Columns 4-19 4-19 4-19 4-20
Keeping the Objects Window on Top 4-20 Refreshing Objects Window Contents Closing the Objects Window The Popups Window 4-21 Opening a Popups Window 4-21 Popups Window Fields 4-21 Popups Window Menus 4-22 View Menu 4-22
OEM Users Guide520330-001 iv
4-20
Contents

Help Menu 4-23 4-23 Sorting Popups Window Items 4-23 Sizing Popups Window Columns Aligning Popups Windows 4-24 Locking the Popups Window 4-24 4-25 4-25 Keeping the Popups Window on Top Refreshing Popups Window Contents Closing the Popups Window The Popup Navigation Window 4-25 4-26 4-26 4-26
Popup Navigation Window Fields Popup Navigation Window Menus View Menu 4-26 Help Menu 4-27
Sorting Popup Navigation Window Items 4-27 Sizing Popup Navigation Window Columns Aligning Popup Navigation Windows Locking the Popup Navigation Window 4-27 4-28 4-28 4-29 4-27
Keeping the Popup Navigation Window on Top Refreshing Popup Navigation Window Contents Navigating to Client Applications 4-29 Closing the Popup Navigation Window 4-29 The Log Window 4-29 4-29 Opening a Log Window
Log Window Fields 4-29 Log Window Menus 4-30 View Menu 4-30 Help Menu 4-31 4-31 Sorting Log Window Items
Sizing Log Window Columns 4-31 Aligning Log Windows 4-31 Locking the Log Window 4-32 Keeping the Log Window on Top 4-32
OEM Users Guide520330-001 v
Contents

Refreshing Log Window Contents Closing the Log Window OEM Server Log Messages The Statistics Window 4-34 4-34 Opening a Statistics Window 4-33 4-33 4-33
Statistics Window Fields 4-34 Statistics Window Menus 4-34 View Menu 4-35 Help Menu 4-35 4-35 4-35 4-36 Sorting Statistics Window Items 4-35 Sizing Statistics Window Columns Automatically Refreshing Displayed Statistics Manually Refreshing Displayed Statistics Closing the Statistics Window 4-36 OEM Server Statistics The Icons Window 4-38 4-38 4-39 4-39 4-39 4-40 4-40 4-36
Opening the Icons Window Closing the Icons Window The Trace Window 4-39 Opening the Trace Window Closing the Trace Window The About Window 4-40 Opening the About Window Closing the About Window
5. Custom Views
Custom Grouping of Objects State Filtering 5-1 Independent State Propagation and Arbitration for Each View Hierarchical and Object-based Display of Data Alerts and Max Alerts Custom Views Custom View Window Layout 5-3 5-3 5-2 Display of All Clients or Max Client Modes 5-2 5-1 5-1
OEM Users Guide520330-001 vi
Contents
5. Custom Views (continued)

Custom View Object List Custom View Links Bar File Menu 5-5 5-5 5-3 5-4 Custom View Window Fields 5-4 Custom View Menus 5-4 Items in the File menu control the Custom View window. View Menu 5-5 Help Menu The Toolbar 5-6 5-6 5-7 5-7
The MinState Field 5-7 The Status Bar Configuring Custom View Properties 5-7 Setting Object Specifiers and State Filters Viewing Existing Specifiers Adding a New Specifier 5-9 Updating an Existing Specifier Deleting an Existing Specifier Clearing All Existing Specifiers Choosing the Display Mode 5-12 Selecting the View Format Altering the Window Layout Working With Custom Views Creating a New Custom View 5-13 5-14 5-16 Selecting the Client State Reporting Option 5-14 5-15 5-9 5-10 5-11 5-12 5-8
The Add/Update Specifier Dialog Box
Opening an Existing Custom View 5-16 Saving a Custom View Configuration 5-17 Sorting Custom View Window Items 5-17 Sizing Custom View Window Columns 5-17 5-18 5-19 Locking the Custom View Window 5-18 Keeping the Custom View Window on Top Refreshing Custom View Window Contents
OEM Users Guide520330-001 vii
Contents

Navigating to Client Applications 5-19 Closing a Custom View Window 5-19
A. OEM External Specification

Component Terminology A-1 Interface Terminology A-1 Architectural Overview A-2 A-4 A-4 A-5 Open Enterprise Management Server
Architecture and Design Considerations for the OEM Server OEM Request API (Client Application to OEM) ReportingLevels Popup.Add A-6 Popup.Delete A-9 Popup.Cleanup A-10 Object.Add A-11 Object.Delete Object.Cleanup LogMessage SetIcons A-16 DebugDisplayPopups DebugTraceDisable DebugQueuePause DebugQueueResume Command A-23 A-25 A-27 A-17 A-20 A-21 A-22 A-23 DebugDisplayObjects A-18 A-13 A-14 A-15 A-5
Client Callback API (OEM to Client Application) ClientMessage Move A-28
WindowManagementEnabled Height A-30 Width A-31 WindowCaption A-32 WindowState A-33
OEM Users Guide520330-001 viii
Contents
A. OEM External Specification (continued)

SetIcons A-35 Framework Adapter A-36 A-36 A-36 Architecture and Design Considerations for Framework Adapters Adapter Request API (OEM to Adapter) Popup.Add A-37 Popup.Delete Popup.Clear Object.Delete AdapterName SetCallback IncludeContext IsConfigurable Configure A-49 A-39 A-40 A-43 A-45 A-46 A-47 A-48
Object.Add A-41 Object.Clear A-44
FrameworkWindowPosition A-50 SetIcons A-51 CloseAdapter Command A-52 A-53 OEM Callback API (Adapter to OEM) A-53 A-55 A-57 A-58 ClientMessage RefreshObjects RefreshPopups Tile A-59 A-61 A-62 A-63 A-64 A-66 A-66 A-67
OEM Users Guide520330-001 ix
Cascade RestoreAll
MinimizeAll LogMessage
SetIcons A-65 DebugTraceEnable DebugTraceDisable DebugQueuePause
Contents

DebugQueueResume API Summary A-68 OEM Request API Adapter Request API OEM Callback API Client Callback API Class Name Standards Object Name Standards A-68 A-69 A-70 A-71 A-71 A-72 A-73 A-73 A-73 A-67 A-68 Adapter Callback API (Framework to Adapter)
Rule #1 - Hierarchical Name Space Rule #2 - Path Delimiter Rule #3 - Null Classes and Objects Rule #4 - Case Sensitivity A-73 Rule #5 - Class Names State Conventions A-74 A-73
Glossary Index Figures

Figure A-1. OEM Information Path Example A-2
OEM Users Guide520330-001 x
Whats New in This Manual

Manual Information
OEM Users Guide
Abstract This manual describes the OEM Server and Enterprise Management Adapter components of the Open Enterprise Management (OEM) Gateway product. It tells how to install, configure, and customize the OEM Server to monitor OEM objects, and it documents the application programmatic interfaces (APIs) for both client applications and enterprise management framework adapters as a reference for developers planning to use the OEM Server in their own development efforts. Product Version Open Enterprise Management (OEM) Version 3.0 (T8486)
Part Number 520330-001 Published April 2001
Document History
Part Number 520330-001 Product Version OEM Version 3.0 Published April, 2001
New and Changed Information

This manual is new.
OEM Users Guide520330-001 xi
Whats New in This Manual
New and Changed Information
OEM Users Guide520330-001 xii
About This Manual

The OEM Gateway consists of a Server component and one or more Adapter components that provide client applications such as Compaq state monitoring, performance monitoring, and command and control graphical user interfaces (GUIs) with a simplified, encapsulated layer to operations management frameworks. This manual describes how to install, configure, and customize the OEM Server to monitor OEM objects, and it documents the application programmatic interfaces (APIs) for both client applications and enterprise management framework adapters.
Audience
This manual addresses two audiences:
System managers, network managers, and operators who install, configure, and customize the OEM Server to monitor OEM objects Developers planning to use the OEM Server in their own development efforts
Organization
This manual consists of five sections and an appendix, as follows:
Section 1, Introducing the Open Enterprise Management Server, provides an overview of the OEM product and lists hardware and software requirements. Section 2, Installing the Open Enterprise Management Server, provides information about setup, files installed, and system registry changes. Section 3, Configuring the Open Enterprise Management Server, describes how to customize the behavior of the OEM Server and the appearance of OEM windows. Section 4, OEM Windows, describes the OEM Server windows that are created either in response to direct user requests from OEM menus or as a result of callbacks from framework adapters. Section 5, Custom Views, describes how to create your own logical groupings of OEM objects based on any criteria you choose and including only objects whose states fall within the range you specify. Appendix A, OEM External Specification, serves as a reference detailing the OEM architecture and providing descriptions of the APIs for both client applications and enterprise management framework adapters for developers wanting to use the OEM Server in their own development efforts.
Your Comments Invited

After using this manual, please take a moment to send us your comments. You can do this by returning a Reader Comment Card or by sending an Internet mail message.
OEM Users Guide520330-001 xiii
About This Manual
Notation Conventions
A Reader Comment Card is located at the back of printed manuals and as a separate file on the User Documentation disc. You can either fax or mail the card to us. The fax number and mailing address are provided on the card. Also provided on the Reader Comment Card is an Internet mail address. When you send an Internet mail message to us, we immediately acknowledge receipt of your message. A detailed response to your message is sent as soon as possible. Be sure to include your name, company name, address, and phone number in your message. If your comments are specific to a particular manual, also include the part number and title of the manual. Many of the improvements you see in manuals are a result of suggestions from our customers. Please take this opportunity to help us improve future manuals.
Notation Conventions
Hypertext Links
Blue underline is used to indicate a hypertext link within text. By clicking a passage of text with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2.
General Syntax Notation

The following list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS. Uppercase letters indicate keywords and reserved words; enter these items exactly as shown. Items not enclosed in brackets are required. For example:
MAXATTACH
lowercase italic letters. Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required. For example:
file-name
[ ] Brackets. Brackets enclose optional syntax items. For example:

TERM [\system-name.]$terminal-name INT[ERRUPTS]
A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list may be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example:
FC [ num ] [ -num] [ text] K [ X | D ] address-1
OEM Users Guide520330-001 xiv
About This Manual
General Syntax Notation
{ } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list may be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example:
LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF }
| Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example:
INSPECT { OFF | ON | SAVEABEND }
Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example:
M address-1 [ , new-value ]... [ - ] {0|1|2|3|4|5|6|7|8|9}...
An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example:
"s-char..."
Punctuation. Parentheses, commas, semicolons, and other symbols not previously described must be entered as shown. For example:
error := NEXTFILENAME ( file-name ) ; LISTOPENS SU $process-name.#su-name
Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must enter as shown. For example:
"[" repetition-constant-list "]"
Item Spacing. Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. For example:
CALL STEPMOM ( process-id ) ;
If there is no space between two items, spaces are not permitted. In the following example, there are no spaces permitted between the period and any other items:
$process-name.#su-name
Line Spacing. If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example:
ALTER [ / OUT file-spec / ] LINE [ , attribute-spec ]...
OEM Users Guide520330-001 xv
About This Manual
Notation for Messages
!i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data to the called procedure); the !o notation follows an output parameter (one that returns data to the calling program). For example:
CALL CHECKRESIZESEGMENT ( segment-id , error ) ; !i !o
!i,o. In procedure calls, the !i,o notation follows an input/output parameter (one that both passes data to the called procedure and returns data to the calling program). For example:
error := COMPRESSEDIT ( filenum ) ; !i,o
!i:i. In procedure calls, the !i:i notation follows an input string parameter that has a corresponding parameter specifying the length of the string in bytes. For example:
error := FILENAME_COMPARE_ ( filename1:length , filename2:length ) ; !i:i !i:i
!o:i. In procedure calls, the !o:i notation follows an output buffer parameter that has a corresponding input parameter specifying the maximum length of the output buffer in bytes. For example:
error := FILE_GETINFO_ ( filenum , [ filename:maxlen ] ) ; !i !o:i
Notation for Messages

The following list summarizes the notation conventions for the presentation of displayed messages in this manual. Bold Text. Bold text in an example indicates user input entered at the terminal. For example:
ENTER RUN CODE ?123 CODE RECEIVED: 123.00
The user must press the Return key after typing the input. Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown. For example:
Backup Up.
lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example:
p-register process-name
OEM Users Guide520330-001 xvi
About This Manual
Notation for Management Programming Interfaces
[ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For example:
Event number = number [ Subject = first-subject-value ]
A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed. The items in the list might be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example:
proc-name trapped [ in SQL | in SQL file system ]
{ } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list might be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example:
obj-type obj-name state changed to state, caused by { Object | Operator | Service } process-name State changed from old-objstate to objstate { Operator Request. } { Unknown. }
| Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example:
Transfer status: { OK | Failed }
% Percent Sign. A percent sign precedes a number that is not in decimal notation. The % notation precedes an octal number. The %B notation precedes a binary number. The %H notation precedes a hexadecimal number. For example:
%005400 P=%p-register E=%e-register
Notation for Management Programming Interfaces

The following list summarizes the notation conventions used in the boxed descriptions of programmatic commands, event messages, and error lists in this manual. UPPERCASE LETTERS. Uppercase letters indicate names from definition files; enter these names exactly as shown. For example:
ZCOM-TKN-SUBJ-SERV
lowercase letters. Words in lowercase letters are words that are part of the notation, including Data Definition Language (DDL) keywords. For example:
token-type
OEM Users Guide520330-001 xvii
About This Manual
Change Bar Notation
!r.
The !r notation following a token or field name indicates that the token or field is required. For example:
ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. !r
!o.
The !o notation following a token or field name indicates that the token or field is optional. For example:
ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. !o
Change Bar Notation

Change bars are used to indicate substantive differences between this edition of the manual and the preceding edition. Change bars are vertical rules placed in the right margin of changed portions of text, figures, tables, examples, and so on. Change bars highlight new or revised information. For example: The message types specified in the REPORT clause are different in the COBOL85 environment and the Common Run-Time Environment (CRE). The CRE has many new message types and some new message type codes for old message types. In the CRE, the message type SYSTEM includes all messages except LOGICAL-CLOSE and LOGICAL-OPEN.
OEM Users Guide520330-001 xviii
1
Introducing the Open Enterprise Management Server
The OEM Gateway (OEM) provides client applications with an encapsulated interface layer to enterprise management frameworks. The OEM consists of a Server component and one or more Adapter components. Client applications communicate with the Server component. The Server communicates with the Adapter or Adapters on behalf of the clients, while the Adapters handle communication to and from the enterprise management framework. Interfaces are implemented as ActiveX OLE servers/components. ActiveX minimizes the impact and effort required to integrate existing clients. The interface provides clients such as Compaq state monitoring, performance monitoring, and command and control graphical user interfaces (GUIs) with a simplified, encapsulated layer to operations management frameworks. The OEM layer handles all details of the interface to enterprise management frameworks. As a result, clients effectively communicate information in a uniform and consistent manner with minimal impact to existing code.
OEM Architecture
The Open Enterprise Management architecture allows clients such as the Compaq Availability Statistics and Performance (ASAP) monitor to communicate with Enterprise Management frameworks through a standard ActiveX interface. As a result, client applications do not have to be framework aware. Conversely, framework commands are sent back to applications through callbacks to the OEM, with the OEM routing these commands to the appropriate client by encapsulated state arbitration. The clients themselves are not required to have knowledge of the proprietary callback formats of any given framework; the OEM translates callbacks from all frameworks to a standard OEM command format. Clients need only integrate with the OEM Server to participate in any management framework. The OEM Server and framework adapters are responsible for all routing and translation functions.
OEM Users Guide520330-001 1 -1
Features of the OEM Server Version 3.0
The following figure shows the basic Open Enterprise Management architecture and component pieces:
This design has the following architectural benefits:
Encapsulates the client interface Minimizes the impact on client applications wanting to participate in enterprise management Provides an adapter interface to enterprise management frameworks Provides client integration with enterprise management frameworks Provides state arbitration between multiple clients
Features of the OEM Server Version 3.0

OEM Server 3.0 includes the following enhancements and new features:
The ability to supply user-configurable icons for OEM entity and state information. All OEM windows, including Alerts and Custom Views, will utilize the specified icons. In addition, any change to the OEM icon set is automatically communicated to all clients and adapters, making it easy to keep the icon sets within the various components in sync. Enhanced Client Request API, Adapter Request API, OEM Callback API, and Client Callback API. All of these APIs now include a SetIcons method, which adapters or clients can utilize to cause the OEM to utilize a different icon set.
Hardware and Software Requirements
Hardware and Software Requirements

Hardware and software required to run the Open Enterprise Management Server are as follows.
Hardware Requirements
IBM-compatible PC, Pentium-166 or higher 16 MB of RAM Mouse or compatible pointing device 10 MB of available disk space (20 MB during installation)
Software Requirements
Microsoft Windows 95, Microsoft Windows 98, Microsoft Windows NT 4.0 (any version), Microsoft Windows 2000 (any version), or Microsoft Windows ME. An optional framework adapter if you want to integrate OEM data with your enterprise management framework
Obtaining Support
Support for the OEM Server is available from the Compaq Computer Corporation Global Customer Support Center at (800) 255-5010.
Obtaining Support
2
Installing the Open Enterprise Management Server
Setup
The OEM Server is installed as an ActiveX component as part of the setup of any client application that uses it. There is no need to perform a stand-alone setup of the OEM.
Files Installed
The OEM Server is installed in the Program Files\Tandem\OEM directory. System and library files are installed in your Windows system directory. On Windows 95 or 98, this is Windows Directory\SYSTEM. On Windows NT, this is Windows Directory\SYSTEM32. The following files are installed: File Name
OEMSERV.CNT OEMSERV.DOC OEMSERV.EXE OEMSERV.HLP OEMSUPP.EXE README.TXT ALL CPUS.OEM ALL DISKS.OEM OBJECTS IN ERROR.OEM COMCTL32.OCX CTL3D32.DLL MFC40.DLL MSVCIRT.DLL MSVCRT.DLL MSVCRT20.DLL MSVCRT40.DLL
Install Location
Application directory\OEM Application directory\OEM Application directory\OEM Application directory\OEM Application directory\OEM Application directory\OEM Application directory\OEM\Views Application directory\OEM\Views Application directory\OEM\Views
Windows system directory Windows system directory Windows system directory Windows system directory Windows system directory Windows system directory Windows system directory
Installing the Open Enterprise Management Server
Registry Changes
File Name
OLEPRO32.DLL VB40032.DLL VEN2232.OLB
Install Location Windows system directory Windows system directory Windows system directory
Registry Changes
The OEM Server updates the system registry with installation and configuration data. This information is stored under the HKEY_CURRENT_USER\SOFTWARE\TANDEM\OEM Server key.
Uninstalling the OEM

The OEM Server is installed as an ActiveX component as part of the setup of any client application that uses it. To uninstall the OEM Server, uninstall any client applications that use it.
3
Configuring the Open Enterprise Management Server
The behavior of the OEM Server and the appearance of the OEM windows can be tailored to fit the needs of any user. The following subsections describe the five main categories of OEM Server settings in detail:
General Options on page 3-1 Adapter Options on page 3-8 Logging Options on page 3-12 Font Options on page 3-14 Advanced Options on page 3-15
General Options
Use the OEM General Options dialog box to control the basic behavior of the OEM Server by:
Specifying the Number of Reporting Levels on page 3-2 Including Intermediate-Level State Values in Frameworks and Display Windows on page 3-2 Reusing Display Windows on page 3-3 Keeping Display Windows on Top on page 3-4 Automatically Closing Max Alerts Windows as They Are Used on page 3-4 Using Custom View Windows for Alerts and Max Alerts on page 3-5 Automatically Saving Custom View Definitions on page 3-5 Synchronizing the OEM Alerts Window and Client Applications on page 3-6 Setting the Icon Size on page 3-7 Choosing a New Icon Set on page 3-7
Opening the OEM General Options Dialog Box
Opening the OEM General Options Dialog Box

To open the OEM General Options dialog box: 1. Either:
Right-click the OEM icon in the system tray. From the menu, choose Options. From the View menu of any OEM display window, choose Options.
The OEM Options dialog box appears. 2. Click the General tab if it is not already selected.
Specifying the Number of Reporting Levels

The Reporting Levels value allows client applications to determine how many levels of object hierarchy are to be reported to the OEM. For example, a Reporting Levels value of 1 could indicate that information should be reported only at the node level. A Reporting Levels value of 2 might indicate that both node and entity class information (for example, DISK and CPU) should be reported. To set the number of Reporting Levels: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Enter the new value in the Reporting Levels field in the State Reporting panel, or use the up arrow and down arrow to adjust the value. 3. Click OK or Apply to save the change, or click Cancel to discard it.
Including Intermediate-Level State Values in Frameworks and Display Windows

In some cases, a client application might not be able to report on objects with the degree of detail given by the Reporting Levels value and instead must supply intermediate-level state information. The OEM Server allows this and tracks this data in the same fashion as all other object state data. You can specify whether these intermediate values should be ignored or passed through to enterprise management framework adapters and included in OEM display windows. To specify intermediate values options: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Include Intermediate Values option:
To allow intermediate values to be passed to adapters and included in display windows, in the State Reporting panel, select the Include Intermediate Values check box. Any intermediate values supplied by client applications are included in updates to framework adapters, and this state information displays in OEM Alerts, Max Alerts, and Custom View windows.
Reusing Display Windows
To ignore intermediate values, in the State Reporting panel, uncheck the Include Intermediate Values check box. No intermediate values are included in updates to framework adapters, and this state information does not appear in OEM Alerts, Max Alerts, or Custom View windows. However, the OEM Server retains this data internally so that you can choose to include it at a later time.
3. Click OK or Apply to save the change, or click Cancel to discard it.
Example
As an example of how the Include Intermediate Values feature works, assume the following:
The OEM Server Reporting Levels value has been set to 3. Client A reports \London\Disk\$System with state 7. Client B reports \London\Disk with state 5.
In this situation, Client A reports at the correct level. However, Client B supplies only two levels of detail. Furthermore, the information Client B supplies specifies state information on an intermediate level of the object hierarchy - \London\Disk. This is considered to be an intermediate level because Client A has already reported more detailed information on \London\Disk, namely that $System has a state of 7. Given this information, what data should be passed to the framework adapters, and what data should appear in Alerts, Max Alerts, and Custom View windows?
If Include Intermediate Values is checked, the \London\Disk\$System state of 7 and the \London\Disk state of 5 are passed to the framework adapters, and both values appear in the appropriate display windows. If Include Intermediate Values is not checked, only the \London\Disk\$System state of 7 are passed through to the framework adapters, and only that value appears in any display windows.
Reusing Display Windows

The OEM Server can display several different types of windows, each of which is customized for a particular class of data. The OEM creates these windows on demand as requests are received. The Re-Use Display Forms option controls whether the OEM uses an existing window of a given type to display new data or creates a new window for each request.
Note. The Re-Use Display Forms setting does not apply to Custom View windows. Because Custom Views display a subset of objects, each active Custom View has its own dedicated window.
To enable or disable display window reuse: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Re-Use Display Forms option:
To enable display window reuse, in the Display panel, select the Re-Use Display Forms check box. All subsequent requests to display a particular type of data use an existing window of that type if one exists. A new window is created if necessary.
To disable display window reuse, in the Display panel, clear the Re-Use Display Forms check box. A new window is created for all subsequent requests to display any type of data.

You can specify whether each new display window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. To specify whether display windows stay on top: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Display Forms Stay On Top option:
To enable creation of on top display windows, in the Display panel, check the Display Forms Stay On Top check box. All subsequent display windows created by the OEM Server are created with the On Top attribute set. This option remains in effect until another On Top window is created.
To disable creation of On Top display windows, in the Display panel, clear the Display Forms Stay On Top check box. All subsequent display windows are created without the On Top attribute set.
Automatically Closing Max Alerts Windows as They Are Used

The OEM Server displays a Max Alerts window in response to a request from a framework adapter or if you choose Max Alerts from an OEM window menu. The Max Alerts window contains a list of all objects in the OEM database whose state is equal to the highest state of any object in the database. For example, if the highest state of any object in the OEMs database is 7, a Max Alerts window contains a list of all objects whose state is 7. When you select an object in a Max Alerts window, the OEM sends a Max Alert command to the client application that reported that object. You can specify whether the OEM should close the Max Alerts window once you have selected an object or whether the window should remain open so that you can choose other objects. To specify whether Max Alerts windows are closed once they are used:
Using Custom View Windows for Alerts and Max Alerts
1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Close Max Alerts Window On Click option:
To close Max Alerts windows once an object has been selected, in the Display panel, check the Close Max Alerts Window On Click check box. Each Max Alerts window closes after you select an object in it. To leave Max Alerts windows open after an object has been selected, in the Display panel, clear the Close Max Alerts Window On Click check box. Max Alerts windows are not closed as you select objects from them.
Using Custom View Windows for Alerts and Max Alerts

The OEM Server can use the new Custom View window format for displaying Alerts and Max Alerts. A Custom View window allows you to navigate through object information in a hierarchical fashion rather than limiting you to a basic list of objects and their states. You can also take advantage of the Custom View display formats, such as choosing large icons or small icons. However, you cannot add object filters to the Alerts or Max Alerts view definitions or alter the existing filters. To specify whether Custom View windows are used for Alerts and Max Alerts display: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Use Custom View Alerts Window option:
To use a Custom View window to display Alerts and Max Alerts data, in the Display panel, check the Use Custom View Alerts Window check box. Alerts and Max Alerts are displayed using a predefined Custom View window. To use the standard Alerts and Max Alerts display windows, in the Display panel, clear the Use Custom View Alerts Window check box. Alerts and Max Alerts are displayed using the standard object list format.
Automatically Saving Custom View Definitions

Each Custom View has an associated set of properties and parameters, which are stored in an OEM view definition file. Each time you make a configuration change to a view, such as adding a specifier or repositioning the window on the screen, you must save the updated information to the view definition file. To save this information automatically, enable the Auto Save View Definitions option. Each time a Custom View window closes, the OEM updates the definition file for that view and automatically preserves the latest configuration information.
Synchronizing the OEM Alerts Window and Client Applications
To specify whether Custom View definitions are automatically saved: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Auto Save View Definitions option:
To save view definitions automatically when a Custom View window closes, in the Display panel, check the Auto Save View Definitions check box. Each Custom View definition file is updated when the corresponding window is closed. To prevent the OEM from automatically saving view definitions, in the Display panel, clear the Auto Save View Definitions check box. To save view definitions , click Save on the Custom View window toolbar or choose Save from the File menu of the Custom View window.
Synchronizing the OEM Alerts Window and Client Applications

Whenever the OEM receives an Alerts or Max Alerts callback from an enterprise management framework, it displays information about the relevant objects in an Alerts or Max Alerts window. When you subsequently select an item in one of these windows, an Alerts or Max Alerts callback is sent to the client application that reported the item in question. In some cases, however, you might prefer to have the client application(s) receive the Alerts or Max Alerts callback at the same time as the OEM. This strategy keeps the client and OEM displays synchronized so that you can quickly see the detailed status of an object. The OEM supports this capability through the Synchronize Alerts and Clients option. When this feature is enabled, the OEM Server automatically passes all Alerts and Max Alerts callbacks to client applications. The client applications can then update their windows at the same time the OEM is updating the Alerts or Max Alerts window. To specify client application synchronization options: 1. Open the OEM Options dialog box and click the General tab if it is not already selected. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Synchronize Alerts And Clients option:
To keep the OEM Alerts window and clients synchronized, in the Display panel, check the Synchronize Alerts And Clients check box. The OEM automatically passes all Alerts and Max Alerts callbacks received from EM frameworks on to client applications. For other callbacks, the OEM Server still updates its Alerts window to contain information on the target object in addition to passing the callback to the appropriate client application. To prevent the OEM from updating client applications automatically whenever an Alerts or Max Alerts callback is received from an enterprise management framework, in the Display panel, clear the Synchronize Alerts And Clients check box. The OEM updates only its own Alerts/Max Alerts windows; no notification is passed to client applications. Any other callbacks received are
Setting the Icon Size
routed to the appropriate client, but OEM windows are not updated to show data for the target object. 3. Click OK or Apply to save the change, or click Cancel to discard it.
Setting the Icon Size

The OEM Server's Alerts, Max Alerts, and Custom View windows contain an icon for each object, each icon depicting an object's state. By default, these icons measure 16 by 16 pixels. If you want, you can set the default icon size to 32 by 32.
Note. Only Alerts, Max Alerts, and Custom View windows support the 32 by 32 icon size; all other display windows always use 16 by 16 icons.
To set the icon size: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Use Large Icons option:
To use the larger 32 by 32 icons, in the Display panel, check the Use Large Icons check box. All Alerts, Max Alerts, and Custom View windows display the large icons. The Custom View windows Small Icon view still uses small icons, but the Large Icon, List, and Details views use large icons. To use the smaller 16 by 16 icons, in the Display panel, clear the Use Large Icons check box. All Alerts, Max Alerts, and Custom View windows display the small icons. The Custom View windows Large Icon view still uses large icons, but the Small Icon, List, and Details views use small icons.
Choosing a New Icon Set

The OEM utilizes entity and state icons to depict information about a given object. Instead of using the OEMs default set, you can supply your own set of icons. To select a new icon set: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Click Choose Icons to display the Icon Server dialog box. 3. In the Icon Server dialog box, select the new icon set. 4. Click OK or Apply in the Icon Server dialog to use the new icon set, or click Cancel to discard the change.
Choosing the Default Tiling Scheme
Choosing the Default Tiling Scheme

As the OEM creates display windows of a given type, it attempts to display them in a nonoverlapping fashion to make it easier to view OEM data. The Tiling option determines whether the OEM displays the windows side by side or top to bottom. The Tiling option also controls how the OEM behaves when responding to tile requests from framework adapters. To specify the default tiling scheme: 1. Open the OEM Options dialog box and click the General tab. (See Opening the OEM General Options Dialog Box on page 3-2.) 2. Set the Tiling option:
To tile windows from top to bottom first and then left to right, in the Tiling panel, click the Top Down option. When a new window is created, the OEM tries to place it below an existing window of the same type. If no space is available, the OEM tries to place the window beside an existing window of the same type. To tile windows first from left to right and then top to bottom, in the Tiling panel, click the Side By Side option. When a new window is created, the OEM tries to place it beside an existing window of the same type. If no space is available, the OEM tries to place the window below an existing window of the same type.
Adapter Options
Framework adapters allow the OEM to communicate with various enterprise management frameworks. This subsection describes the adapter options and how to work with them:
Viewing the Adapter List on page 3-9 Adding an Adapter Entry on page 3-9 Updating an Adapter Entry on page 3-10 Deleting an Adapter Entry on page 3-10 Configuring a Framework Adapter on page 3-10 Adjusting Adapter Priority on page 3-11 Restoring Default Adapter Settings on page 3-11 Using the Add/Update Adapter Dialog on page 3-12
Viewing the Adapter List
Viewing the Adapter List

The Adapter List contains information about each adapter, including the adapter name, its external OLE class name, and its state. Set these values using the Add/Update Adapter dialog. To view the Adapter List: 1. Do one of the following:
Right-click the OEM icon in the system tray and choose Options from the menu. From the View menu of any OEM display window, choose Options.
The OEM Options dialog box appears. 2. Click the Adapters tab to display the currently defined adapters.
Adding an Adapter Entry

For the OEM Server to communicate with an enterprise management framework, you must configure an adapter for that framework within the OEM environment. The configuration information consists of the name of the adapter, its externally accessible OLE class name, and a state specifying whether the adapter should be activated. By default, two framework adapters are preconfigured in the OEM: the Compaq Object Integration Layer (OIL) adapter and the CA TNG adapter. To add an adapter entry: 1. Display the currently defined adapters by opening the OEM Options dialog box and selecting the Adapters tab. (See Viewing the Adapter List on page 3-9.) 2. Click Add. The OEM Server: Add Adapter dialog box appears. 3. Enter the name of the adapter in the Adapter Name field and the OLE class name in the Class Name field. 4. Set the Active option:
Click Yes if you want the adapter to be activated. Click No if you want to configure the adapter now but activate it at a later time.
5. Click OK in the OEM Server: Add Adapter dialog box to add the new entry to the adapter list. Click Cancel to cancel the operation. 6. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made. For more information about specifying adapter properties, see Using the Add/Update Adapter Dialog on page 3-12.
Updating an Adapter Entry
Updating an Adapter Entry

You can change the name, OLE class name, or state of a previously configured framework adapter. Do this, for example, if you stop using a particular enterprise management framework temporarily and want to disable the adapter for that framework. To update an adapter entry: 1. Display the currently defined adapters by opening the OEM Options dialog box and selecting the Adapters tab. (See Viewing the Adapter List on page 3-9.) 2. Select the adapter you want to update. 3. Click Update or double-click the selected item. The OEM Server: Update Adapter dialog box appears. 4. Change any values as needed. 5. Click OK in the OEM Server: Update Adapter dialog box to update the adapter list. Click Cancel to cancel the operation. 6. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made. For more information about specifying adapter properties, see Using the Add/Update Adapter Dialog on page 3-12.
Deleting an Adapter Entry

You can permanently remove an adapter entry from the list. Do this, for example, if you replace your current enterprise management framework and no longer need its corresponding adapter. To delete an adapter entry: 1. Display the currently defined adapters by opening the OEM Options dialog box and clicking the Adapters tab. (See Viewing the Adapter List on page 3-9.) 2. Select the adapter you want to delete. 3. Click Delete. The selected adapter is removed from the adapter list. 4. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made.
Configuring a Framework Adapter

You can configure a framework adapter with its own proprietary configuration options. To configure an adapter: 1. Display the currently defined adapters by opening the OEM Options dialog box and clicking the Adapters tab. (See Viewing the Adapter List on page 3-9.)
OEM Users Guide520330-001 3- 10
Adjusting Adapter Priority
2. Select the adapter you want to configure:
If the Configure option is disabled, the selected adapter does not support any user-configurable options. If the Configure option is enabled, the selected adapter supports user-configurable options. a. Click Configure to open the adapter configuration dialog. b. In the adapter configuration dialog, change any values as needed. These settings are specific to the selected adapter and are outside the control of the OEM Server. c. Click either OK or Apply in the adapter configuration dialog box to save the changes. Click Cancel to discard any changes you have made.
3. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made.
Adjusting Adapter Priority

The OEM Server sends update information to the active framework adapters in the order given by the adapter list. You can alter this order to give adapters higher or lower priority as needed. To adjust the priority of an adapter: 1. Display the currently defined adapters by opening the OEM Options dialog box and clicking the Adapters tab. (See Viewing the Adapter List on page 3-9.) 2. Select the adapter you want to adjust. 3. Click + (plus) to move the adapter up in the list or (minus) to move it down. The adapter list is updated accordingly. 4. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made.
Restoring Default Adapter Settings

By default, four framework adapters are preconfigured in the OEM: the Compaq Object Integration Layer (OIL) adapter, the Tivoli NetView adapter, the HP OpenView adapter, and the CA TNG adapter. To reset the adapter list to contain only default entries: 1. Display the currently defined adapters by opening the OEM Options dialog box and clicking the Adapters tab. (See Viewing the Adapter List on page 3-9.) 2. Click Defaults. The adapter list is updated to contain only the preconfigured adapters.
Using the Add/Update Adapter Dialog
3. Click OK or Apply in the OEM Options dialog box to save the changes. Click Cancel to discard any changes you have made.
Note. This operation does not restore any adapter-specific settings. Use the adapter configuration to restore these settings.
Using the Add/Update Adapter Dialog

Whenever you add or update an adapter entry, the OEM Server: Add/Update Adapter dialog box appears. Use this dialog box to specify configuration information for the given adapter. The OEM Server: Add/Update Adapter dialog box contains these fields:
Adapter Name The Adapter Name field defines the name of the adapter within the OEM Server environment. This name is used only within the OEM itself and can be any value you choose. It cannot contain a backslash (\) or a period (.), and it is limited to 255 characters. It is not case-sensitive.
Class Name The Class Name field specifies the name of the adapters externally accessible OLE interface class. The OEM Server uses this interface to communicate with the adapter. The vendor of the adapter can supply you with the correct class name for the particular adapter.
Active Flag The Active flag controls whether the adapter is activated or deactivated by the OEM.
If you select Yes, the OEM attempts to start the adapter. If successful, the
adapter is marked as Active in the Adapter List. The OEM passes all object and pop-up information to the adapter and passes all process callbacks from it. If the adapter cannot be started because it was not found or an error occurred, it is marked as Not Installed in the Adapter List. The entry remains in the list, but the OEM does not attempt to communicate with the adapter until the problem is corrected and the adapter is reactivated. Inactive in the Adapter List. The entry remains in the list, but the OEM does not attempt to communicate with the adapter until it is reactivated.
If you select No, the OEM shuts down the adapter if it is running and marks it
Logging Options
The OEM Server maintains an in-memory log of error and status information related to the OEM environment and also provides detailed tracing capabilities for interactions with client applications and framework adapters. You can work with the logging and tracing options by:
Setting the Size of the Log on page 3-13 Enabling API and Error Tracing on page 3-13
Opening the OEM Logging Dialog Box
Enabling OEM Timer Tracing on page 3-14
Opening the OEM Logging Dialog Box

To open the OEM Logging dialog box: 1. Do one of the following:
The OEM Options dialog box appears. 2. Click the Logging tab if it is not already selected.
Setting the Size of the Log

You can specify how many messages the OEM Server should retain in its in-memory log. Storing more messages lets you look further back to detect problems or determine when parts of the OEM environment changed state, but it consumes more memory. The OEM default setting of 500 messages should be more than sufficient for most installations, but you can alter that value if necessary. To set the number of log messages the OEM Server retains in the in-memory log: 1. Open the OEM Options dialog box and click the Logging tab. (See Opening the OEM Logging Dialog Box on page 3-13.) 2. Type the new value in the Number Of Log Messages To Retain field, or use the up arrow and down arrow to adjust the value. 3. Click OK or Apply to save the change, or click Cancel to discard it.
Enabling API and Error Tracing

The OEM Server can support many clients and framework adapters simultaneously. Because these entities are all independent, it can be difficult to determine exactly what is going on when one or more pieces are not operating correctly. To help resolve these situations, the OEM Server supplies an API call and error tracing mechanism so that you can view all interactions with the OEM Server. You can understand exactly how clients and framework adapters are using the OEM Server and where things might be going wrong.
Caution. API call and error tracing is disabled by default. You can enable it as needed, but doing so can have a performance impact on the OEM Server. Use API call and error tracing only to diagnose an existing problem.
Enabling OEM Timer Tracing
To enable or disable API and error tracing: 1. Open the OEM Options dialog box and click the Logging tab. (See Opening the OEM Logging Dialog Box on page 3-13.) 2. Set the API/Error Trace Enabled option:
To enable API call and error tracing, in the Tracing panel, check the API/Error Trace Enabled check box. To disable API call and error tracing, in the Tracing panel, clear the API/Error Trace Enabled check box.
Enabling OEM Timer Tracing

It might appear that the OEM Server is not functioning correctly or is a bottleneck between clients and framework adapters. Under these circumstances, use the OEM timer tracing facility to view how the OEM is managing its internal queues and how quickly it is responding to requests.
Caution. Timer tracing is disabled by default. You can enable it as needed, but doing so can have a severe performance impact on the OEM Server. Use timer tracing only to diagnose an existing problem.
To enable or disable timer tracing: 1. Open the OEM Options dialog box and click the Logging tab. (See Opening the OEM Logging Dialog Box on page 3-13.) 2. Set the Timer Event Trace Enabled option:
To enable timer tracing, in the Tracing panel, check the Timer Event Trace Enabled check box. To disable timer tracing, in the Tracing panel, clear the Timer Event Trace Enabled check box.
Font Options
Use the Fonts tab to alter the display font used in Alerts, Max Alerts, Clients, Objects, Pop-ups, and Log display windows. You can change the font itself, adjust the font size, and specify the bold, italic, strikethrough, and underline styles. To alter the OEM font settings: 1. Do one of the following:
Advanced Options
The OEM Options dialog box appears. 2. Click the Fonts tab. 3. Set the desired font options. The list of font names varies from system to system, depending on which fonts are installed in the given environment. The available font sizes can also vary. If a particular size is invalid for a specific font, the OEM automatically uses the closest available font size. 4. Click OK or Apply to save the changes, or click Cancel to discard them.
Advanced Options
Use the Advanced Options dialog box to access OEM Server advanced configuration settings and windows that display information about the OEMs internal data and status. This subsection describes:
Limiting the Number of Icons Used on page 3-15 Supplementary Display Windows on page 3-16
Opening the OEM Advanced Options Dialog Box

To open the OEM Advanced Options dialog box: 1. Do one of the following:
The OEM Options dialog box appears. 2. Click the Advanced tab if it is not already selected.
Limiting the Number of Icons Used

The OEM Server uses entity and state icons to show the type and state of objects in the OEM internal database. Because of the number of entity types and states, the total number of icons in the OEMs entity and state icon matrix can be quite large. This situation is not a problem on Windows NT systems because Windows NT is designed to handle this type of load. On Windows 95 and Windows 98 systems, however, icons occupy space in a GDI pool shared by all applications and the operating system. This space is a limited resource, and the full OEM icon matrix could consume a significant portion of it. To alleviate this problem, you can enable the OEMs Show State Icons Only option. The OEM Server displays only an objects state icon; the entity type icon is not shown. The OEMs GDI resource consumption is reduced by more than 75 percent, making it easier to run other applications concurrently with the OEM.
Supplementary Display Windows
By default, both entity and state icons are shown on Windows NT systems. On Windows 95 and 98 systems, only state icons are shown by default. In either case, you can change the default behavior. To alter the icon set used by the OEM: 1. Open the OEM Options dialog box and click the Advanced tab. (See Opening the OEM Advanced Options Dialog Box on page 3-15.) 2. Set the Show State Icons Only option:
To show state icons alone, check the Show State Icons Only check box. Entity icons are not displayed, greatly reducing GDI resource consumption under Windows 95 and 98. To show both entity and state icons, clear the Show State Icons Only check box. The full OEM entity and state icon matrix is used. On Windows 95 and 98 systems, this option can consume a large amount of the available GDI resources, making it difficult to run other applications concurrently with the OEM and its associated clients and adapters.
Supplementary Display Windows

In addition to the standard Alerts, Max Alerts, and Custom View windows, the OEM Server provides windows so you can view the status of various internal OEM components. These windows are particularly useful for debugging and for verifying that the OEM environment is operating correctly. To display information about a particular type of data: 1. Open the OEM Options dialog box and click the Advanced tab. (See Opening the OEM Advanced Options Dialog Box on page 3-15.) 2. Click one of the following listed choices under Windows to display the associated data: Clients Objects Popups Log Stats Icons About Displays a list of active OEM clients Displays the contents of the OEM object database Displays the contents of the OEM popup database Displays the OEM log Displays OEM usage statistics Displays a table of the current OEM icons Displays OEM version information
OEM Windows
The OEM Server can display several different types of windows, each containing a particular class of OEM data. These windows are created either in response to direct user requests from OEM menus or as a result of callbacks from framework adapters. The behavior of a given type of window is always the same, regardless of the reason for its creation. The following subsections describe each of these OEM window types: The Alerts Window on page 4-1 The Max Alerts Window on page 4-6 The Clients Window on page 4-11 The Objects Window on page 4-15 The Popups Window on page 4-21 The Popup Navigation Window on page 4-26 The Log Window on page 4-29 The Statistics Window on page 4-34 The Icons Window on page 4-38 The Trace Window on page 4-39 The About Window on page 4-40
The Alerts Window

The Alerts window serves as the main window of the OEM Server. It contains a list of objects in the OEM database sorted by object state from highest to lowest. This gives you an easy way to view, in priority order, the state of monitored objects in your network. By default, the Alerts window displays a list of all objects contained in the OEM database. However, enterprise management frameworks can limit this list to a subset of objects by supplying a filter string on Alerts callbacks. If such a filter is supplied, only those objects that match it are displayed. For example, if an enterprise management framework supplied the filter \NewYork\DISK, only disk drives on \NewYork would be displayed in the Alerts window. One object can have multiple entries in the OEM database if it is reported on by more than one client application. Because these clients are, in most cases, reporting on different properties of the object, the reported states could be different. In this situation, the OEM shows all reported states for the object in the Alerts window. For example, if client A reports object X with state 5, and client B reports it with state 3, both entries would appear in the Alerts window. Only the highest state for X, however, is reported to the enterprise management frameworks.
OEM Windows
Opening an Alerts Window
Opening an Alerts Window

You can open an Alerts window using any of the following methods:
Right-click the OEM icon in the system tray and choose Alerts from the menu. From an OEM Max Alerts window View menu, choose Alerts. From an enterprise management framework menu, choose Alerts.
The Re-Use Display Forms option setting affects how Alerts windows are created: If Re-Use Display Forms is checked, an Alerts window is created the first time you choose Alerts from a menu. If you subsequently choose Alerts from a menu again, the existing Alerts window is used to display the newly requested data. If Re-Use Display Forms is cleared, a new Alerts window is created every time you choose Alerts from a menu.
Alerts Window Fields

The Alerts window contains the following fields for each object: Path The complete path for the object. For example, if the object added is \CHICAGO\DISK\$DATA, Path contains \CHICAGO\DISK. The name of the object. For example, if the object added is \CHICAGO\DISK\$DATA, Name contains $DATA. The numeric state of the object. This value is defined by the client application that reported the object. The client-defined context data associated with the object. In general, this field contains descriptive text identifying the reason the object is in its reported state. The name of the client application that reported this object.
Name State Context
Client Name
OEM Windows
Alerts Window Menus
Alerts Window Menus

The Alerts window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Alerts window and how data is displayed in it. Menu Item Alerts Max Alerts New Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows Action Performed Displays a list of all objects and their states Displays a list of all objects whose state is equal to the highest state recorded in the OEM database Creates a new Alerts or Max Alerts window Locks or unlocks the window Enables or disables the On Top property of the window Refreshes the data in the window Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions Aligns OEM windows using the dimensions of the current window Opens the OEM options dialog Closes this window Closes all OEM display windows
Help Menu
Items in the Help menu provide access to information about using the OEM Server. Menu Item Contents Search About Action Performed Displays the Help file table of contents Displays the Help file search dialog Displays OEM Server version information
Sorting Alerts Window Items

To sort the Alerts list by any of the Alerts fields, click the column heading by which you want to sort:
Click once to sort objects in ascending order. Click twice to sort objects in descending order.
OEM Windows
Sizing Alerts Window Columns
Sizing Alerts Window Columns

You can resize the columns in the Alerts window:
To resize each of the columns in the window, select the divider between column headings and drag it right or left as desired. To resize all columns at once: 1. From the View menu, choose Size Columns. 2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Defaults Size To Window Size To Contents Action Performed Sizes each column using the saved value for that column Sizes each column using a fixed percentage of available space Sizes each column based on the largest item in the column
The OEM saves the adjusted column widths in the system registry. These values are used the next time an Alerts window is created.
Aligning Alerts Windows

You can resize and align all Alerts windows using the dimensions of the currently selected Alerts window:
To align Alerts windows, from the View menu, choose Align Windows. All Alerts windows are tiled and resized to match the current window. To specify the tiling method, choose Top Down or Side By Side from the OEM Options window General tab.
Locking the Alerts Window

The OEM Server automatically updates all display windows whenever it receives new data from a client application. In some cases, you might want to prevent this action from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished.
To lock a display window, from the View menu, choose Locked. The indicator (Locked) is appended to the window title, and the OEM does not update the window contents if new data is received. You can manually update the window at any time by choosing Refresh from the View menu.
OEM Windows
Keeping the Alerts Window on Top
To unlock a display window and re-enable updates, choose Locked from the View menu again. The (Locked) indicator disappears, and the OEM updates the window the next time new data is received.
Repeatedly choosing Locked from the View menu toggles the locked attribute on and off.
Keeping the Alerts Window on Top

You can specify whether each new Alerts window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Alerts window, it sets the windows On Top property based on the Display Forms Stay On Top option setting.
If Display Forms Stay On Top is checked, the new window is created with its On Top property enabled. If Display Forms Stay On Top is not checked, the new window is created with its On Top property disabled. If Stay On Top is checked on the View menu, the current window is an On Top window. Choose Stay On Top from the View menu to disable the On Top attribute. If Stay On Top is not checked on the View menu, the current window is not an On Top window. From the View menu, choose Stay On Top to enable the On Top attribute. Repeatedly selecting Stay On Top from the View menu toggles the On Top attribute on and off.
To override the default value and toggle the On Top property of an individual window:
Refreshing Alerts Window Contents

Because the OEM Server automatically updates all display windows whenever new data is received from a client application, there is usually no reason to perform a manual refresh. However, if a window has been locked for some period of time, it might not contain current data. To update the contents with the latest data, from the View menu, choose Refresh.
Creating a New Alerts Window

To create a new Alerts window to view a different set of data: 1. From the View menu, choose New. 2. Choose Alerts Window to create a new Alerts window.
OEM Windows
Navigating to Client Applications

The OEM Server gives you access to active client applications so that you can view detailed information on objects and their states. To navigate to the client that reported a particular object, click the object in the Alerts window. An Alert message is sent to the associated client and that client then provides detailed information about the objects state and history.
Closing the Alerts Window

To close the Alerts window, choose Close from the View menu, or click the close box.
The Max Alerts Window

The Max Alerts window is similar to the Alerts window, except that it only contains information on objects whose state is equal to the highest reported state in the OEM database. For example, if the highest state of any object in the OEM database is 7, the Max Alerts window contains only objects whose state is equal to 7. These objects are sorted by object name. The Max Alerts window allows you to quickly view the list of monitored objects in your network that need the most immediate attention. By default, the Max Alerts window displays a list of all objects contained in the OEM database whose state is equal to the highest reported state. However, enterprise management frameworks can limit this to a subset of objects by supplying a filter string on Max Alert callbacks. If such a filter is supplied, the OEM compares the states of all objects that match the filter and displays only the object or objects with the highest state value. For example, if an enterprise management framework supplies the filter \NewYork\DISK, only the disk drive or drives on \NewYork with the highest state value are displayed in the Max Alerts window. One object can have multiple entries in the OEM database if it is reported on by more than one client application. If these multiple entries have the same state value, and the state values are equal to the maximum reported state, each of the multiple entries appears in the Max Alerts window.
Opening a Max Alerts Window

You can open a Max Alerts window using any of the following methods:
Right-click the OEM icon in the system tray and choose Max Alerts from the menu. From an OEM Alerts window View menu, choose Max Alerts. From an enterprise management framework menu, choose Max Alerts. In this case, a Max Alerts window is created only if more than one object is at the highest state. If a single object is at the highest state, the OEM automatically sends a Max Alert message to the client application that reported that object.
OEM Windows
Max Alerts Window Fields
The setting of the Re-Use Display Forms option affects how Max Alerts windows are created:
If the Include Intermediate Values option is checked, a Max Alerts window is created the first time you choose Max Alerts from a menu. If you subsequently choose Max Alerts from a menu again, the existing Max Alerts window displays the newly requested data. If Re-Use Display Forms is cleared, a new Max Alerts window is created every time you choose Max Alerts from a menu.
Max Alerts Window Fields

The Max Alerts window contains the following fields for each object: Path The complete path for the object. For example, if the object added was \CHICAGO\DISK\$DATA, Path would contain \CHICAGO\DISK. The name of the object. For example, if the object added was \CHICAGO\DISK\$DATA, Name would contain $DATA. The numeric state of the object. This value is defined by the client application that reported the object. The client-defined context data associated with the object. In general, this field contains descriptive text identifying the reason the object is in its reported state. The name of the client application that reported this object.
Name State Context
Client Name
Max Alerts Window Menus

The Max Alerts window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Max Alerts window and how data is displayed in it. Menu Item Alerts Max Alerts New Locked Stay On Top Close On Use Action Performed Displays a list of all objects and their states. Displays a list of all objects whose state is equal to the highest state recorded in the OEM database. Creates a new Alerts or Max Alerts window. Locks or unlocks the window. Enables or disables the On Top property of the window. Enables or disables the Close On Use property of the window.
OEM Windows
Sorting Max Alerts Window Items
Refresh Size Columns Align Windows Options Close Close All Display Windows
Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
Help Menu
Items in the Help menu provide access to information about using the OEM Server. Menu Item Contents Search About Action Performed Displays the Help file table of contents. Displays the Help file search dialog. Displays OEM Server version information.
Sorting Max Alerts Window Items

To sort the Max Alerts list by any of the Max Alerts fields, click the column heading by which you want to sort:
Clicking once sorts objects in ascending order. Clicking twice sorts objects in descending order.
Sizing Max Alerts Window Columns

You can resize the columns in the Max Alerts window:
To resize each of the columns in the window, select the divider between column headings and drag it right or left as desired. To resize all columns at once: 1. From the View menu, choose Size Columns.
OEM Windows
Aligning Max Alerts Windows
2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Defaults Size To Window Size To Contents Action Performed Sizes each column using the saved value for that column. Sizes each column using a fixed percentage of available space. Sizes each column based on the largest item in the column.
The OEM saves the adjusted column widths in the system registry. These values are used the next time a Max Alerts window is created.
Aligning Max Alerts Windows

You can resize and align all Max Alerts windows using the dimensions of the currently selected Max Alerts window.
To align Max Alerts windows, choose Align Windows from the View menu. All Max Alerts windows are tiled and resized to match the current window. To specify the tiling method, from the OEM Options window General tab, choose Top Down or Side By Side.
Locking the Max Alerts Window

The OEM Server automatically updates all display windows whenever new data is received from a client application. In some cases, you might want to prevent this action from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished. To lock and unlock a window:
To lock a display window, from the View menu, choose Locked. The indicator (Locked) is appended to the window title, and the OEM does not update the window contents if new data is received. You can manually update the window at any time by choosing Refresh from the View menu.
To unlock a display window and reenable updates, choose Locked from the View menu again. The (Locked) indicator disappears, and the OEM updates the window the next time new data is received.
Repeatedly selecting Locked from the View menu toggles the locked attribute on and off.
OEM Windows
Keeping the Max Alerts Window on Top
Keeping the Max Alerts Window on Top

You can specify whether each new Max Alerts window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Max Alerts window, it sets the windows On Top property based on the Display Forms Stay On Top option setting:
If Display Forms Stay On Top is checked, the new window is created with its On Top property enabled. If Display Forms Stay On Top is not checked, the new window is created with its On Top property disabled. If Stay On Top is checked on the View menu, the current window is an On Top window. To disable the On Top attribute, choose Stay On Top from the View menu . If Stay On Top is not checked on the View menu, the current window is not an on top window. To enable the On Top attribute, choose Stay On Top from the View menu. Repeatedly selecting Stay On Top from the View menu toggles the On Top attribute on and off.
Refreshing Max Alerts Window Contents

Because the OEM Server automatically updates all display windows whenever new data is received from a client application, there is usually no reason to perform a manual refresh. However, if a window has been locked for some period of time, it might not contain current data. To update the contents with the latest data, choose Refresh from the View menu.
Creating a New Max Alerts Window

To create a new Max Alerts window to view a different set of data: 1. From the View menu, choose New. 2. Choose Max Alerts Window to create a new Alerts window.

The OEM Server gives you access to active client applications so you can view detailed information on objects and their states. To navigate to the client that reported a particular object, click the object in the Max Alerts window. A Max Alert message is sent to the associated client and that client then provides detailed information about the objects state and history.
OEM Windows
Closing the Max Alerts Window
Closing the Max Alerts Window

To close the Max Alerts window, choose Close from the View menu, or click the close box.
The Clients Window

The Clients window contains a list of all client applications using OEM services. To appear in the list, the application must have added objects or popup menu items to the OEM.
Opening a Clients Window

You can open a Clients window using any of the following methods:
Right-click the OEM icon in the system tray and choose Show Clients from the menu. From the View menu of an OEM Objects window or Popups window, choose Clients. From the OEM Options window Advanced tab, choose Clients. If Re-Use Display Forms is checked, a Clients window is created the first time you choose Clients from a menu. If you subsequently choose Clients from a menu again, the existing Clients window is used to display the newly requested data.
The Re-Use Display Forms option setting affects how Clients windows are created:
If Re-Use Display Forms is cleared, a new Clients window is created every time you choose Clients from a menu.
Clients Window Fields

The Clients window contains the following fields for each active client application: Index Client Name Callback The index of the entry within the OEMs client table. This value is an integer between 1 and the number of clients, inclusive. The name of the client application. This value is defined by the client itself. Indication of whether the client application has supplied a callback object. If it has, this field contains the value <Present>. If the client application has not supplied a callback object, this field contains the value <Nothing>. The fully qualified name of the client applications program file.
App Name
OEM Windows
Clients Window Menus
Class Name Window Mgt.
The name of the client applications OLE callback class, if one was supplied. A flag indicating whether the client will participate in window management callbacks (for example, tile or cascade) from the OEM. This value is updated whenever the OEM attempts to perform a window management operation, so the value displayed in the Clients window might not be current if the client application has changed its setting since the last window management callback. The index of the OLE object used by the client to communicate with the OEM.
Instance ID
Clients Window Menus

The Clients window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Clients window and how data is displayed in it. Menu Item Clients Objects Popups Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows Action Performed Displays a list of all active client applications. Displays a list of all objects contained in the OEM database. Displays a list of all popup menu items defined in the OEM. Locks or unlocks the window. Enables or disables the On Top property of the window. Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
OEM Windows
Sorting Clients Window Items
Help Menu
Sorting Clients Window Items

To sort the Clients window list by any of the Clients window fields, click the column heading by which you want to sort:
Sizing Clients Window Columns

You can resize the columns in the Clients window:
To resize each of the columns in the window, select the divider between column headings and drag it right or left as desired. To resize all columns at once: 1. From the View menu, choose Size Columns. 2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Defaults Size To Window Size To Contents Action Performed Sizes each column using the saved value for that column. Sizes each column using a fixed percentage of available space. Sizes each column based on the largest item in the column.
The OEM saves the adjusted column widths in the system registry. These values are used the next time a Clients window is created.
Aligning Clients Windows

You can resize and align all Clients windows using the dimensions of the currently selected Clients window:
To align Clients windows, choose Align Windows from the View menu. All Clients windows are tiled and resized to match the current window.
OEM Windows
Locking the Clients Window
To specify the tiling method, choose Top Down or Side By Side from the OEM Options window General tab.
Locking the Clients Window

The OEM Server automatically updates all display windows whenever new data is received from a client application. In some cases, you might want to prevent this from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished. To lock and unlock a window:
To lock a display window, choose Locked from the View menu. The indicator (Locked) is appended to the window title, and the OEM does not update the window contents if new data is received. You can manually update the window at any time by choosing Refresh from the View menu.
Keeping the Clients Window on Top

You can specify whether each new Clients window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Max Alerts window, it sets the windows On Top property based on the Display Forms Stay On Top option setting:
If Display Forms Stay On Top is checked, the new window is created with its On Top property enabled. If Display Forms Stay On Top is not checked, the new window is created with its On Top property disabled. If Stay On Top is checked on the View menu, the current window is an On Top window. To disable the On Top attribute, choose Stay On Top from the View menu. If Stay On Top is not checked on the View menu, the current window is not an On Top window. To enable the On Top attribute, choose Stay On Top from the View menu. Repeatedly selecting Stay On Top from the View menu toggles the On Top attribute on and off.
OEM Windows
Refreshing Clients Window Contents
Refreshing Clients Window Contents

Closing the Clients Window

To close the Clients window, choose Close from the View menu, or click the close box.
The Objects Window

The Objects window contains a list of all objects in the OEM database. Unlike the Alerts and Max Alerts windows, these objects are displayed in entry order rather than in state order. The purpose of this window is to provide debugging information and to validate the contents of internal OEM tables.
Opening an Objects Window

You can open an Objects window using any of the following methods:
Right-click the OEM icon in the system tray and choose Show Objects from the menu. Choose Objects from an OEM Clients window View menu or Popups window menu. Choose Objects from the OEM Options window Advanced tab.
The Re-Use Display Forms option setting affects objects window creation: If Re-Use Display Forms is checked, an Objects window is created the first time you choose Objects from a menu. If you subsequently choose Objects from a menu again, the existing Objects window is used to display the newly requested data.
If Re-Use Display Forms is cleared, a new Objects window is created every time you choose Objects from a menu.
OEM Windows
Objects Window Fields
Objects Window Fields

The Objects window contains the following fields for each object defined in the OEM database: Type The type of entry. The type is be either Branch or Endpoint. Branches contain object hierarchy information; Endpoints contain the state information reported by a single client application. The complete path for the object. For example, if the object added is \CHICAGO\DISK\$DATA, Path contains \CHICAGO\DISK\. The name of the object. For example, if the object added is \CHICAGO\DISK\$DATA, Name contains $DATA. The number of client applications that have reported state information on this object. This field applies to Branches only. For Branches that have no corresponding Endpoints at the same level, this field contains NI or 0. For Endpoints, this field contains <n/a>. The numeric state of the object. This value is defined by the client application that reported the object. For Endpoints, this field contains the client-reported value. For Branches that have corresponding Endpoints at the same level, this field contains the maximum state value reported for the object. For Branches that have no corresponding Endpoints at the same level, this field contains <n/a>. The client-defined context data associated with the object. In general, this field contains descriptive text identifying the reason the object is in its reported state. For Endpoints, this field contains the client-reported context. For Branches that have corresponding Endpoints at the same level, this field contains the context associated with the maximum state value reported for the object. For Branches that have no corresponding Endpoints at the same level, this field contains <n/a>. The name of the client application that reported this object. For Endpoints, this field contains the client name that reported the value. For Branches that have corresponding Endpoints at the same level, this field contains the name of the client that reported the maximum state value for the object. For Branches that have no corresponding Endpoints at the same level, this field contains <n/a>.
Path
Name Clients
State
Context
Client Name
OEM Windows
Objects Window Menus
Callback
Indication of whether the client application has supplied a callback object. For Endpoints, this field contains the value <Present> if a callback object was supplied or <Nothing> if a callback object was not supplied. For Branches that have corresponding Endpoints at the same level, this field contains the callback indicator associated with the client that reported the maximum state of the object. For Branches that have no corresponding Endpoints at the same level, this field contains <n/a>. Indication of whether this object has been marked for removal from the OEM object database. This field applies only to Endpoints. For Branches, this field contains <n/a>. The number of Branch objects immediately after this object in the hierarchy. This field applies to Branches only. For Branches that contain no subobjects, this field contains NI or 0. For Endpoints, this field contains <n/a>. The propagated state of the object. This field applies to Branches only. The propagated state is the highest state of any subobject of the current object. For Endpoints, this field contains <n/a>. The propagated context of the object. This field applies to Branches only. The propagated context is the context string associated with the propagated state value. For Endpoints, this field contains <n/a>. The propagated client name of the object. This field applies to Branches only. The propagated client name is the name of the client that reported the propagated state value. For Endpoints, this field contains <n/a>. Indication of whether a callback object has been propagated. This field applies to Branches only. The propagated callback contains the value <Present> if the client that reported the propagated state value supplied a callback object. If no callback object was supplied, this field contains <Nothing>. For Endpoints, this field contains <n/a>. The name of the owner of this object. This value should match the name of the object one level above this object and applies to Branches only. For root-level Branches, this field is blank. For Endpoints, this field contains <n/a>.
Deleted
Sub Objects
Prop. State
Prop. Context
Prop. Client Name
Prop. Callback
Parent Name
Objects Window Menus

The Objects window View and Help menus provide access to common OEM display window functions and settings.
OEM Windows
Sorting Objects Window Items
View Menu
Items in the View menu control the Objects window and how data is displayed in it. Menu Item Clients Objects Popups Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows Action Performed Displays a list of all active client applications. Displays a list of all objects contained in the OEM database. Displays a list of all pop-up menu items defined in the OEM. Locks or unlocks the window. Enables or disables the On Top property of the window. Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
Help Menu
Sorting Objects Window Items

To sort the Objects window list by any of the Objects window fields, click the column heading by which you want to sort.
OEM Windows
Sizing Objects Window Columns
Sizing Objects Window Columns

You can resize the columns in the Objects window:
The OEM saves the adjusted column widths in the system registry. These values are used the next time an Objects window is created.
Aligning Objects Windows

You can resize and align all Objects windows using the dimensions of the currently selected Objects window:
To align Objects windows, choose Align Windows from the View menu. All Objects windows are tiled and resized to match the current window. To specify the tiling method, choose Top Down or Side By Side from the OEM Options window General tab.
Locking the Objects Window

To unlock a display window and re-enable updates, choose Locked from the View menu again.
OEM Windows
Keeping the Objects Window on Top
The (Locked) indicator disappears, and the OEM updates the window the next time new data is received.
Keeping the Objects Window on Top

You can specify whether each new Objects window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Objects window, it sets the windows On Top property based upon the Display Forms Stay On Top option setting:
Refreshing Objects Window Contents

Closing the Objects Window

To close the Objects window, choose Close from the View menu, or click the close box.
OEM Windows
The Popups Window
The Popups Window

The Popups window contains a list of all pop-up menu items defined in the OEM database. Pop-up menu items are added by client applications. They consist of command-callback message pairs that define the operations each client can perform on a given type of object. The purpose of this window is to provide debugging information and to validate the contents of internal OEM tables.
Opening a Popups Window

You can open a Popups window using any of the following methods:
Right-click the OEM icon in the system tray and choose Show Popups from the menu. From an OEM Clients window View menu or Objects window menu, choose Popups. From the OEM Options window Advanced tab, choose Popups. If Re-Use Display Forms is checked, an Popups window is created the first time you choose Popups from a menu. If you subsequently choose Popups from a menu again, the existing Popups window is used to display the newly requested data. If Re-Use Display Forms is cleared, a new Popups window is created every time you choose Popups from a menu.
The Re-Use Display Forms option setting impacts how the Popups window is created:
Popups Window Fields

The Popups window contains the following fields for each popup menu item defined in the OEM database: Index The index of the entry within the OEMs popup table. This value is an integer between 1 and the number of popup menu items, inclusive. The type of entity to which the popup menu applies; for example, DISK, CPU, or PROCESS. The caption string that appears on the popup menu itself. The command message returned to the client application when this popup menu item is selected in an enterprise management framework. The name of the client application that defined this popup menu. Indication of whether the client application has supplied a callback object. If it has, this field contains the value <Present>. If the client application has not supplied a callback object, this field contains the value <Nothing>.
Entity Name Menu Caption Callback Command Client Name Callback
OEM Windows
Popups Window Menus
App Name Class Name Callback Type
The fully qualified name of the client applications program file. The name of the client applications OLE callback class, if one was supplied. Callback Type defines how you invoke this menu item and callback. Possible values are:
No value No value indicates that there is no special handling for this menu item. To cause the callback to be invoked, you must choose the item from a popup menu in the enterprise management framework.
<DoubleClick> "<DoubleClick>" causes the client to receive an automatic callback whenever you double-click an item in the enterprise management framework whose class name matches the popups Entity Name. For example, if you double-click DISK in a framework, the <DoubleClick> popup item associated with DISK is automatically invoked. This allows default actions to be associated with double-click events and allows you to bypass the step of bringing up the popup menu.
<Click> "<Click>" causes the client to receive an automatic callback whenever you click an item in the enterprise management framework whose class name matches the popups Entity Name. For example, if you click DISK in a framework, the <Click> popup item associated with DISK is automatically invoked. This allows default actions to be associated with click events and allows you to bypass the step of bringing up the pop-up menu.
Popups Window Menus

The Popups window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Popups window and how data is displayed in it. Menu Item Clients Objects Popups Action Performed Displays a list of all active client applications. Displays a list of all objects contained in the OEM database. Displays a list of all popup menu items defined in the OEM.
OEM Windows
Sorting Popups Window Items
Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows
Locks or unlocks the window. Enables or disables the On Top property of the window. Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
Help Menu
Sorting Popups Window Items

To sort the Popups window list by any of the Popups window fields, click the column heading by which you want to sort:
Sizing Popups Window Columns

You can resize the columns in the Popups window:
To resize each of the columns in the window, select the divider between column headings and drag it right or left as desired. To resize all columns at once: 1. From the View menu, choose Size Columns.
OEM Windows
Aligning Popups Windows
2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Defaults Size To Window Size To Contents Action Performed Sizes each column using the saved value for that column. Sizes each column using a fixed percentage of available space. Sizes each column based on the largest item in the column.
The OEM saves the adjusted column widths in the system registry. These values are used the next time a Popups window is created.
Aligning Popups Windows

You can resize and align all Popups windows using the dimensions of the currently selected Popups window:
To align Popups windows, choose Align Windows from the View menu. All Popups windows are tiled and resized to match the current window. To specify the tiling method, choose Top Down or Side By Side from the OEM Options window General tab.
Locking the Popups Window

The OEM Server automatically updates all display windows whenever it receives new data from a client application. In some cases, you might want to prevent this from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished. To lock and unlock a window:
OEM Windows
Keeping the Popups Window on Top
Keeping the Popups Window on Top

You can specify whether each new Popups window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Popups window, it sets the windows On Top property based upon the Display Forms Stay On Top option setting:
Refreshing Popups Window Contents

Closing the Popups Window

To close the Popups window, choose Close from the View menu, or click the close box.
OEM Windows
The Popup Navigation Window
The Popup Navigation Window

The OEM displays a Popup Navigation window to resolve callback conflicts between client applications. These conflicts arise when two or more clients add a popup menu item with the same menu caption. When you choose that menu item from a popup menu in an enterprise management framework, the OEM cannot determine which client should receive a callback. In these cases, the OEM displays a Popup Navigation window so you can choose which client application to activate. You cannot open a Popup Navigation window directly.
Popup Navigation Window Fields

The Popup Navigation window contains the following fields for each client application that has defined a conflicting popup menu: Entity Name Menu Caption Client Name The type of entity to which the popup applies; for example, DISK, CPU, or PROCESS. The caption string that you selected. The name of a client application that defined this popup menu.
Popup Navigation Window Menus

The Popup Navigation window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Popup Navigation window and how data is displayed in it. Menu Item Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows Action Performed Locks or unlocks the window. Enables or disables the On Top property of the window. Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
OEM Windows
Sorting Popup Navigation Window Items
Help Menu
Sorting Popup Navigation Window Items

To sort the Popup Navigation window list by any of its fields, click the column heading by which you want to sort:
Sizing Popup Navigation Window Columns

You can resize the columns in the Popup Navigation window:
The OEM saves the adjusted column widths in the system registry. These values are used the next time a Popup Navigation window is created.
Aligning Popup Navigation Windows

You can resize and align all Popup Navigation windows using the dimensions of the currently selected Popup Navigation window:
To align Popup Navigation windows, choose Align Windows from the View menu. All Popup Navigation windows are tiled and resized to match the current window.
OEM Windows
Locking the Popup Navigation Window
To specify the tiling method, from the OEM Options window General tab, choose Top Down or Side By Side.
Locking the Popup Navigation Window

Keeping the Popup Navigation Window on Top

You can specify whether each new Popup Navigation window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Popup Navigation window, it sets the windows On Top property based on the Display Forms Stay On Top option setting.
If Display Forms Stay On Top is checked, the new window is created with its On Top property enabled. If Display Forms Stay On Top is not checked, the new window is created with its On Top property disabled. If Stay On Top is checked on the View menu, the current window is an On Top window. To disable the On Top attribute, choose Stay On Top from the View menu. If Stay On Top is not checked on the View menu, the current window is not an on top window. To enable the On Top attribute, choose Stay On Top from the View menu. Repeatedly selecting Stay On Top from the View menu toggles the On Top attribute on and off.
OEM Windows
Refreshing Popup Navigation Window Contents
Refreshing Popup Navigation Window Contents


To choose which client you want to activate, click the corresponding entry in the list. This action causes a callback to be sent to that application. The Popup Navigation window closes automatically once you have selected an item.
Closing the Popup Navigation Window

To close the Popup Navigation window, choose Close from the View menu, or click the close box.
The Log Window

The Log window contains a list of all messages stored in the OEM activity log. Client applications, enterprise management framework adapters, and the OEM server itself generate these messages when significant events or errors occur. The OEM log serves as a central repository of OEM subsystem status information.
Opening a Log Window

You can open a Log window using either of the following methods:
Right-click the OEM icon in the system tray and choose Show Log from the menu. From the OEM Options window Advanced tab, choose Log.
The Re-Use Display Forms option setting does not affect log window creation. The OEM always reuses an existing log window unless that window is locked.
Log Window Fields

The Log window contains the following fields for each message: Index Time Logged Source Type Source Name The index of the entry within the OEM activity log. The time at which the entry was written to the log. The type of application that generated the message. The choices are OEM Server, Adapter, or Client. The name of the application that generated the message. In the case of the OEM Server, this value is OEM. Each adapter and client uses its own name.
OEM Windows
Log Window Menus
Severity
Indication of how critical the message is. The possible values are: 1 = Informational message only. 2 = Warning message. An error occurred, but the OEM can continue to function normally. One or more adapters or clients might be affected, however. 3 = Critical error. The ability of the OEM to continue functioning might be affected.
Msg #
The application-defined message number associated with the event. Because the OEM Server and each adapter and client exist independently, log message numbers could overlap between applications. The application-defined message text.
Msg Text
Log Window Menus

The Log window View and Help menus provide access to common OEM display window functions and settings.
View Menu
Items in the View menu control the Log window and how data is displayed in it. Menu Item Locked Stay On Top Refresh Size Columns Align Windows Options Close Close All Display Windows Action Performed Locks or unlocks the window. Enables or disables the On Top property of the window. Refreshes the data in the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Aligns OEM windows using the dimensions of the current window. Opens the OEM options dialog. Closes this window. Closes all OEM display windows.
OEM Windows
Sorting Log Window Items
Help Menu
Sorting Log Window Items

To sort the Log window list by any of its fields, click the column heading by which you want to sort.
Sizing Log Window Columns

You can resize the columns in the Log window:
To resize each of the columns in the window, select the divider between column headings and drag it right or left as desired. To resize all columns at once: 1. From the View menu, choose Size Columns. 2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is described in the following table: Menu Item Defaults Size To Window Size To Contents Action Performed Sizes each column using the saved value for that column. Sizes each column using a fixed percentage of available space. Sizes each column based on the largest item in the column.
The OEM saves the adjusted column widths in the system registry. These values are used the next time a Log window is created.
Aligning Log Windows

You can resize and align all Log windows using the dimensions of the currently selected Log window:
To align Log windows, choose Align Windows from the View menu. All Log windows are tiled and resized to match the current window.
OEM Windows
Locking the Log Window
To specify the tiling method, from the OEM Options window General tab, choose Top Down or Side By Side.
Locking the Log Window

The OEM Server automatically updates all display windows whenever it receives new data from a client application. In some cases, you might want to prevent this action from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished. To lock and unlock a window:
Keeping the Log Window on Top

You can specify whether each new Log window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Log window, it sets the windows On Top property based on the Display Forms Stay On Top option setting:
If Display Forms Stay On Top is checked, the new window is created with its On Top property enabled. If Display Forms Stay On Top is not checked, the new window is created with its On Top property disabled. If Stay On Top is checked on the View menu, the current window is an On Top window. To disable the On Top attribute, choose Stay On Top from the View menu. If Stay On Top is not checked on the View menu, the current window is not an On Top window. To enable the On Top attribute, choose Stay On Top from the View menu. Repeatedly selecting Stay On Top from the View menu toggles the on top attribute on and off.
OEM Windows
Refreshing Log Window Contents
Refreshing Log Window Contents

Because the OEM Server automatically updates all display windows whenever it receives new data from a client application, there is usually no reason to perform a manual refresh. However, if a window has been locked for some period of time, it might not contain current data. To update the contents with the latest data, choose Refresh from the View menu.
Closing the Log Window

To close the Log window, choose Close from the View menu, or click the close box.
OEM Server Log Messages

The following table lists all OEM Server log message numbers and their descriptions. This table does not include messages that could be generated by client applications or enterprise management framework adapters. Because clients and adapters are independent applications, the OEM is neither aware of nor able to control the messages they log.
Message Number 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 Description The OEM server was started successfully. The OEM server completed initialization. The specified adapter was started successfully. The specified adapter was not started because its configured OLE interface object could not be created. The OEM could not create an internal callback object for the specified adapter. The specified adapter was stopped. An OLE error was encountered while trying to communicate with the specified adapter. The specified adapter encountered an internal error while processing a request. A client application has connected to the OEM. A client application has disconnected from the OEM. An OLE error was encountered while trying to communicate with a client application. The OEM could not send a callback message to a client application because no callback object was specified. The OEM encountered an error while attempting to create an internal object. No popup item was found matching the caption supplied by the adapter on a callback. The OEM encountered an error while maintaining its internal queues.
OEM Windows
The Statistics Window
Message Number 1015 1016 1017 1018 1019 1020
Description The OEM encountered an error while maintaining its popup menu table. The OEM encountered an error while maintaining its object tables. The OEM encountered an error while maintaining its client table. The OEM encountered an error while maintaining its adapter table. The OEM encountered an error while accessing the system registry. The OEM encountered an error while processing a Custom View definition file.
The Statistics Window

The Statistics window displays the contents of a number of the internal counters maintained within the OEM Server. Use these counters to validate the internal state of the OEM itself and ensure that all components are behaving as expected.
Opening a Statistics Window

You can open a Statistics window using either of the following methods:
Right-click the OEM icon in the system tray and choose Show Stats from the menu. Choose Stats from the OEM Options window Advanced tab.
Statistics window creation is not impacted by the Re-Use Display Forms option setting. The OEM displays only one Statistics window.
Statistics Window Fields

The Statistics window contains the following fields for each counter: Name Value The name of the counter. The value of the counter.
Statistics Window Menus

The Statistics window View and Help menus provide access to common OEM display window functions and settings.
OEM Windows
Sorting Statistics Window Items
View Menu
Items in the View menu control the Statistics window and how data is displayed in it. Menu Item Auto Refresh Refresh Close Action Performed Enables or disables automatic refresh of data displayed in the window. Manually refreshes the data displayed in the window. Closes this window.
Help Menu
Sorting Statistics Window Items

To sort the Statistics window list by any of its fields, click the column heading by which you want to sort.
Sizing Statistics Window Columns

To resize the columns in the Statistics window, select the divider between column headings and drag it right or left as desired. The OEM saves the adjusted column widths in the system registry. These values are used the next time a Statistics window is created.
Automatically Refreshing Displayed Statistics

When the Statistics window is created, its Auto Refresh property is enabled by default. In this mode, the OEM updates the data in the Statistics window every two seconds. To override the default value and toggle the Auto Refresh property of the window:
If Auto Refresh is checked on the View menu, the data in the Statistics window are refreshed automatically. To disable automatic refresh, choose Auto Refresh from the View menu. If Auto Refresh is not checked on the View menu, the data in the Statistics window are not refreshed automatically. To re-enable automatic refresh, choose Auto Refresh from the View menu.
OEM Windows
Manually Refreshing Displayed Statistics
Repeatedly selecting Auto Refresh from the View menu toggles the auto refresh attribute on and off.
Manually Refreshing Displayed Statistics

If auto refresh of the Statistics window is disabled, you can manually refresh the displayed data to retrieve current counter values. To force the window to be updated with the latest data, choose Refresh from the View menu.
Closing the Statistics Window

To close the Statistics window, choose Close from the View menu, or click the close box.
OEM Server Statistics

The following table lists and describes the use of the counters displayed in the Statistics window.
Counter Name Adapter Info Class Instances Adapter Table Class Instances Adapter Table Items Client Info Class Instances Client Message Callbacks Client Table Class Instances Client Table Items Command Callbacks Command Queue Items Current Callback Class Instance ID Current Request Class Instance ID Description The number of configured adapters. This value should be equal to the number of adapters contained in the list on the Adapters tab of the Options dialog + 2. (The 2 are OEM internal entries.) The number of adapter tables in the OEM. This value should be 1 in most cases. The number of items in the adapter list on the Adapters tab of the Options dialog. The number of active clients. This value should equal the number of entries in the Clients window. The number of ClientMessage callbacks performed by the OEM. The number of client tables in the OEM. This value should be 1 in most cases. The number of entries in the Clients window. The number of command-related callbacks performed by the OEM. The number of command items waiting to be processed by the OEM. Except when actually processing a command callback, this number should be 0. The index number of the last OEM callback object created. In general, there should be one of these for each framework adapter that has been activated. This is true even if the adapter has since been stopped. The index number of the last OEM request class object created. In general, there should be one of these for each client that has connected to the OEM. This is true even if the client has since been shut down.
OEM Windows
OEM Server Statistics
Counter Name Custom View Forms Active Display Forms Active Log Message Class Instances Log Table Class Instances Message Class Instances Messages Logged Object Class Instances Object Hierarchy Class Instances Object Info Class Instances Object Table Class Instances Object Table Items Object-Client Class Instances Object-Client Collection Class Instances Objects Added Objects Deleted Objects Updated OEM Server Callback Class Instances OEM Server Request Class Instances
Description The number of OEM Custom View forms that are active. The number of OEM display forms that are active, not including Statistics, Icons, Trace, or About windows. The number of items contained in the activity log. The number of log tables in the OEM. This value should be 1 in most cases. The number of internal OEM message objects in existence. Except under load, this number should be 0. The total number of messages logged. This value could be greater than the Log Message Class Instances value if the number of messages logged exceeds the configured capacity of the OEM activity log. The number of active Object Interface objects. There should be one of these for each active client application. The number of Branch objects contained in the OEM Object database.
The number of temporary Object Info objects. These objects are used to store object data for display purposes. This value should be 0 in most cases. The number of object tables in the OEM. This value should be 1 in most cases. The number of entries in the OEM object database. The number of Endpoints in the OEM Object database. The number of collection objects used to store Endpoint data for the same object. The number of items added to the OEM Object database or to Custom Views. The number of items deleted from the OEM Object database or from Custom Views. The number of items updated in the OEM Object database or in Custom Views. The number of active OEM callback objects. There should be one of these for each active adapter. The number of active request class objects. There should be one of these for each active client application.
OEM Windows
The Icons Window
Counter Name Options Class Instances Popup Class Instances Popup Info Class Instances Popup Query Class Instances Popup Table Class Instances Popup Table Items Popups Added Popups Deleted Popups Updated Queue Class Instances Request Queue Items Sends To Client Specifier Class Instances String Class Instances
Description The number of options objects in the OEM. This value should be 1 in most cases. The number of active Popup Interface objects. There should be one of these for each active client application. The number of objects created to track entries in the Popup database. This value should match the Popup Table Items value. The number of active Popup Query objects. These objects are used to track queries against the Popup database. In general, this value should be 0 unless a callback or menu command is being processed. The number of popup tables in the OEM. This value should be 1 in most cases. The number of entries in the OEM Popup database. The number of items added to the OEM Popup database. The number of items deleted from the OEM Popup database. The number of items updated in the OEM Popup database. The number of OEM internal queues. This value should be 2. The number of request items waiting to be processed by the OEM. Except when actually processing a request, this number should be 0. The number of messages sent to client applications. The number of active Specifier objects. These objects are used by Custom Views to filter data from the Object database. There should be one object for each specifier of each active Custom View. The number of active OEM String objects. These objects are normally used during initialization and update processing. This value should be 0 under most circumstances.
The Icons Window

The Icons window contains a matrix of all OEM state and entity icons. Use this window to view all possible icons that might be contained in Alerts, Max Alerts, and Custom View windows. If the Show State Icons Only option is enabled, the Icons window will not contain the OEM entity icons.
Opening the Icons Window

To open the Icons window: 1. Do one of the following:
Right-click the OEM icon in the system tray and choose Options from the menu.
OEM Windows
Closing the Icons Window
From the View menu of any OEM display window, choose Options. The OEM Options dialog box displays.
2. Click the Advanced tab. 3. Click the Icons button in the Windows panel. An Icons window displays. The Re-Use Display Forms option setting does not affect icons window creation. The OEM will display only one Icons window.
Closing the Icons Window

To close the Icons window, click the close box.
The Trace Window

The Trace window contains OEM debugging information. Use this window, and tracing in general, only when you are attempting to troubleshoot a problem. Tracing can have a negative impact on overall OEM performance.
Opening the Trace Window

To open the Trace window: 1. Do one of the following:
Right-click the OEM icon in the system tray and choose Options from the menu. Choose Options from the View menu of any OEM display window. The OEM Options dialog box displays.
2. Click the Logging tab. To enable API Error tracing, check the API/Error Trace Enabled check box. To enable Timer Event tracing, check the Timer Event Trace Enabled check box.
The trace window is created automatically by the OEM when the first data is written to the window. The Re-Use Display Forms option setting does not affect trace window creation. The OEM will display only one Trace window.
Closing the Trace Window

To close the Trace window, click the close box.
OEM Windows
The About Window
The About Window

The About window contains OEM version information. You will need this data if you require support services for the OEM.
Opening the About Window

You can open the About window using any of the following methods:
Right-click the OEM icon in the system tray and choose About from the menu. From the OEM Options window Advanced tab, choose About. From any OEM display window Help menu, choose About.
The Re-Use Display Forms option setting does not affect about window creation. The OEM will display only one About window.
Closing the About Window

To close the About window, click the OK button or the close box.
Custom Views
The OEM Server provides a Custom View facility that you can use to create your own logical groupings of OEM objects. You can base these groupings on any criteria you choose, and can include only objects whose states fall within the range you specified. By creating Custom Views, you can form subsets of OEM objects that span different branches of the object hierarchy. For example, all objects related to a particular application can be added to one view, while all objects related to another application can be added to another. You can also create views that group all objects of a like type, such as all CPUs or all disks, and then display the states and relationships of these objects separately from any unassociated objects. These Custom Views can help you more easily determine the state of entire applications and subsystems so you can detect and diagnose problems more quickly.
Custom Grouping of Objects

Unlike the Alerts and Max Alerts windows, which display all objects within a given branch of the OEM hierarchy, Custom Views let you combine objects from disparate branches of the tree. Individual elements or sets of elements from anywhere in the object hierarchy can be grouped into a single, logical collection. For example, you could group objects based on type, application function, or geographic location. The states and relationships of these objects can then be displayed independently of any other objects or views defined within the OEM. The same object can also reside in any number of Custom Views, so including the node \Seattle in a West Coast Custom View does not preclude you from also including that node in a Funds Transfer Custom View.
State Filtering
In addition to providing logical grouping of objects, Custom Views also permit you to add state filters as part of the view configuration. Using this state filtering mechanism, you can choose to only include objects in the view whose states fall within a particular range of values. For example, you might create a view of all objects that have failed or are in danger of failing; another view of all objects whose state has degraded since the prior update; and maybe another view that shows all objects that are up. By combining state filtering and logical grouping of objects, it becomes relatively easy to create a very refined view configuration that quickly and efficiently alerts you to problems in an application or subsystem.
Independent State Propagation and Arbitration for Each View

Because the OEM treats each Custom View as an independent entity, the OEM propagates state information and performs state arbitration separately for each view. As a result, the states of high-level objects in a view accurately represent the propagated
Custom Views
Hierarchical and Object-based Display of Data
values of underlying objects within that view only, and not within the OEM object database as a whole. For example, suppose the objects \Chicago\Disk\$System and \Chicago\Disk\$Data are added to the OEM object database, $System with a state of 6 and $Data with a state of 4. Within the OEM database and standard Alerts displays, \Chicago\Disk reflects the highest state of any subordinate object in this case 6, the state of $System. However, if you created a Custom View that included \Chicago\Disk\$Data, but not \Chicago\Disk\$System, the state of \Chicago\Disk within that view is 4 the state of $Data. Because \Chicago\Disk\$System was not included in the view configuration, the state of that drive has no impact on the Custom View. The Custom View always reflects the states of objects contained within it only, regardless of what is occurring elsewhere.
Hierarchical and Object-based Display of Data

You can choose to view data hierarchically or object based in Custom View windows. The hierarchical display presents data in highest-level to lowest-level order. The states of the higher-level objects are determined by propagating state information from lowerlevel objects. You navigate to items by drilling down through the hierarchy. It is easy to find objects of interest because the number of items at any level is generally low, but some navigation is almost always necessary to get to the lowest level of data. The object-based display is virtually identical to the standard Alerts window: it shows a list of all lowest-level objects contained in the view. No navigation is needed to find the state of an object. All information is easily at hand, so there is no need to move through different levels of the hierarchy to find specific object-state information, but information for a specific object can be difficult to find as the number of entries increases. Because each display method has advantages and disadvantages, the OEM Custom View facility makes it easy to switch between them. Only the display changes, not the underlying view data.
Display of All Clients or Max Client Modes

The OEM architecture allows any number of client applications to supply state information on a particular object. The state propagation and arbitration engines ensure that the most critical state data is reflected in higher levels of the object hierarchy and forwarded to the EM framework adapters. The standard Alerts and Max Alerts windows contain an entry for each client that reported a particular object. For example, if ClientA reports \Chicago\Disk\$System with state 5 and ClientB reports \Chicago\Disk\$System with state 2, both entries appear in any Alerts window that includes information on that branch of the tree. Custom View windows give you the option to continue to display data in this same fashion or to display data only for the client reporting the maximum state. Using the previous example, the latter scheme shows only ClientAs \Chicago\Disk\$System entry because it is the maximum reported state for that object. This maximum client-only option is particularly useful when object counts are high because it further limits the
Custom Views
Alerts and Max Alerts Custom Views
amount of data displayed at any given time to those items that are of most critical interest. You can switch between all client and max client modes whenever you want. The underlying view data is not changed.
Alerts and Max Alerts Custom Views

The Alerts and Max Alerts Custom View windows contain most of the features of the standard Alerts and Max Alerts windows, along with the new Custom View features that make them easier to use. If you want, you can use the Custom View windows instead of the standard windows. To enable this feature, check Use Custom View Alerts Window on the General tab of the OEM Options dialog box. A key difference between the Alerts and Max Alerts Custom Views and other Custom Views is that you cannot configure specifiers for the Alerts or Max Alerts views. In the case of the Alerts Custom View, however, you can supply a minimum state value to display using the Alerts Min State field on the toolbar. To include all objects, enter a 0 in this field. To include only those objects at a given state or higher, enter that value in the field. For example, a Min State value of 5 causes the Alerts Custom View to include only those objects whose state is 5 or higher.
Custom View Window Layout

Custom View windows contain several features that make them easier to use than standard OEM display windows.
Custom View Object List

The Object List contains the actual view data in the Custom View window. In addition to the object names, you can display the object state and context, as well as the name of the client application that reported the object. You can view data in any of four ways: large icons, small icons, list and details. Large Icon view, Small Icon view, and List view show only the object name. Details view shows the object name, state, context, and client name. The data in the Object List portion of the screen is defined by the display mode of the view. In hierarchical mode, the Object List contains only those objects at the current level of the view. To see objects at a different level, you must ascend or descend within the hierarchy. In object-based mode, all lowest-level objects are displayed simultaneously. No navigation is necessary to obtain information on an object.
Custom Views
Custom View Window Fields
Custom View Window Fields

A Custom View window contains the following fields for each object: Name State Context The fully qualified name of the object; for example, \CHICAGO\DISK\$DATA. The numeric state of the object. This value is defined by the client application that reported the object. The client-defined context data associated with the object. In general, this field contains descriptive text identifying the reason the object is in its reported state. The name of the client application that reported this object.
Client Name
Custom View Links Bar

The links bar is displayed on the left side of the Custom View window when the window is operating in hierarchical mode. As you navigate to lower levels of the object hierarchy, icons representing the higher levels you descended from are added to the links bar. You can immediately return to the corresponding level of the hierarchy by clicking on one of these icons. This capability is useful for object hierarchies that contain many levels because you can quickly return to any level without ascending through each intervening level. If the Custom View window is operating in object-list mode, the links bar is not shown.
Custom View Menus

The Custom View File, View, and Help menus provide access to all Custom View commands and options.
Custom Views
Custom View Menus
File Menu
Items in the File menu control the Custom View window. Menu Item New Custom View Open Save Save As Action Performed Creates a new Custom View window configured with the default properties. Opens an existing Custom View definition file using the current window. Saves the current Custom View properties to the active configuration file. Saves the current Custom View properties to a view configuration file that you specify, and changes the active configuration file to the new file. Closes this window. Closes all OEM display windows.
Close Close All Display Windows
View Menu
Items in the View menu control the Custom View configuration and how data is displayed in the window. Menu Item Up One Level Properties Properties As Text Locked Stay On Top Size Columns Refresh OEM Options Action Performed Ascends one level in the object hierarchy when in hierarchical view mode. Displays the configuration dialog box for this view. Displays the properties of this view in text format. Locks or unlocks the window. Enables or disables the On Top property of the window. Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Refreshes the data in the window. Displays the OEM Options dialog box.
Custom Views
The Toolbar
Help Menu
Items in the Help menu provide access to information about using the OEM Server. Menu Item Contents Search About Action Performed Displays the Help file Table of Contents. Displays the Help file Search dialog box. Displays OEM Server version information.
The Toolbar
The Custom View toolbar provides quick access to common commands and operations. The buttons included on the toolbar are: Open View Definition File Save Configuration Up One Level Refresh Lock Window/Unlock Window Configure View Properties Hierarchical View Object View Large Icons Small Icons List Details Size Columns Using Default Settings Size Columns Based on Window Size Size Columns Based on Contents Opens an existing Custom View definition using the current window. Saves the current Custom View properties to the active configuration file. Ascends one level in the object hierarchy when in hierarchical view mode. Refreshes the data in the window. Locks or unlocks the window. Displays the configuration dialog box for this view. Switches to hierarchical display mode. Switches to object list display mode. Displays data using large icon format. Displays data using small icon format. Displays data using list format. Displays data using detailed report format (all columns). Sizes columns using the default/saved settings. Sizes columns using fixed percentages of the existing window size. Sizes columns using the size of the maximum item in each column.
Custom Views
The MinState Field
The MinState Field

The MinState field is located on the right side of the toolbar. It is used to quickly filter which objects are displayed in the View, based on the state of those objects. The MinState field defines the minimum object state to display in the View. In order to be included, an object's state must be greater than or equal to the MinState of the View. It is important to note that this filtering takes place after all View specifiers are evaluated, and thus it only applies to the objects that comprise the View. For example, if you define a View made up of CPUs whose state is greater than 5, the MinState setting for the View will apply only to those objects. Therefore, setting the MinState to a value less than 5 does not cause any additional objects to appear in the View, because the View definition dictates that only CPUs with a state greater than 5 are included. However, if you set the MinState to 7, CPUs with states of 5 or 6 will not be displayed, because the extra MinState filtering effectively hides those objects. The MinState field is particularly useful in Views that contain a large number of objects, since it lets you rapidly narrow the display to focus on those objects that are in the most critical states. To set the MinState value for a View, enter a state value between 0 and 9 in the Minimum State field, or use the up and down arrow buttons located to the right of the field to incrementally adjust the value.
The Status Bar

The status bar consists of two sections: the left section contains the number of items currently displayed in the Object List portion of the window, and the right section contains information on the progress of current operations, errors encountered, and so on.
Configuring Custom View Properties

Custom Views contain several user-configurable parameters that you can use to define both the data contained within the view and how that data is displayed. This section describes these parameters, explains how to work with them, and includes the following operations:
Setting Object Specifiers and State Filters on page 5-7 Choosing the Display Mode on page 5-12 Selecting the View Format on page 5-13 Selecting the Client State Reporting Option on page 5-14 Altering the Window Layout on page 5-14
Setting Object Specifiers and State Filters

Object specifiers are the key element of Custom Views. By adding specifiers to a view definition, you determine which objects will comprise the view. Each Custom View can
Custom Views
contain any number of specifiers, and only objects that match at least one of the specifiers will be included in the view. Object Specifiers consist of two separate parts: a template string and an optional state filtering expression. The format of the template string must adhere to the following rules:
It can contain any number of levels. A backslash path delimiter must separate levels (\). Any level can contain the wildcard characters *, ?, and #, where * corresponds to any number of characters, ? corresponds to any single character, and # corresponds to any single digit from 0 through 9. The OEM reserved characters backslash (\) and comma (,) cannot be included. If the final level of the template is *, you do not need to include it unless it is at the root level. For example, \Chicago\Disk\* is equivalent to \Chicago\Disk from a template standpoint. At the root level, however, you must include the * to get all objects because a null specifier template will not match any objects.
For example, the template \*\Process matches all Process objects on all nodes. The template \SanFran\Disk\$Data* matches all Disk objects on node SanFran whose names begin with $Data. And the template \A*\*\?ATM* matches all objects on any node beginning with the letter A whose name began with any character, followed by the letters ATM, and optionally followed by any other text. The state filtering portion of a specifier, if supplied, allows you to further limit the number of items within a view by only including those objects whose states fall within a specified range. This capability lets you target the items of highest interest to you. For example, a specifier might be \*\CPU, State >= 6. This matches all CPUs on any node whose state is greater than or equal to 6. The OEM evaluates each views specifiers whenever a client application updates the OEM. This process involves querying the central OEM database and comparing each object to each specifier for each active view. If an object in the OEM database matches the specifiers template, and that objects state falls within the range dictated by the specifiers state filter expression, that object is added to the Custom View in question. Because each specifier is re-evaluated whenever the OEM is updated by a client application, it is critical to note here that the set of objects contained within a particular Custom View can change as these updates occur. For example, if you specify a state filter, and an objects state changes as part of an update, that object can no longer pass the filter and is removed from the view as a result.
Viewing Existing Specifiers

To view the existing specifiers for a Custom View, choose Properties from the View menu, or click Configure View Properties on the toolbar. The properties dialog box for the Custom View appears. The current specifier templates and filter expressions are listed under Specifiers.
Custom Views
Adding a New Specifier

To add a new specifier to a Custom View: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears. 2. Click Add. The Add New Specifier dialog box for the view appears. 3. Enter a specifier template. This value must conform to the rules described in Setting Object Specifiers and State Filters on page 5-7. 4. Enter a state filter:
To include all objects regardless of state, select the All option under Include States. To filter based on the state value, select the Filter option under Include States. The filter expression consists of a series of dropdown lists and state input fields. Supply a filter expression by selecting a comparison operator (<, <=, =, >=, >, <>) from the first dropdown list and then enter the comparison state value in the adjoining field. The up and down arrow controls on this field operate only in the range of 0 through 9 (the standard OEM state values), but you can enter any positive integer value directly in the field. If this completes the filter expression, select Done from the second drop-down list. If you want to add a second comparison to the filter expression, choose AND or OR from the second drop-down list and repeat the previous procedure for the second comparison operator and associated state value field.
When the OEM evaluates this specifier as part of updating a Custom View, an object must pass the entire filter expression to be included in that view. 5. Click OK to accept the new specifier, or Cancel to discard the entry. The Add New Specifier dialog box closes. 6. Click OK or Apply in the properties dialog box to save the change, or Cancel to discard it.
Updating an Existing Specifier

If you want, you can update an existing specifier. To update an existing specifier: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar.
Custom Views
The properties dialog box for the Custom View appears. 2. Select the specifier to be updated. 3. Click Update or double-click the selected item. The Update Specifier dialog box for the chosen specifier appears. 4. Enter a specifier template. This value must conform to the rules described in Setting Object Specifiers and State Filters on page 5-7. 5. Enter a state filter. To include all objects regardless of state, select the All option under Include States. To filter based on the state value, select the Filter option under Include States. The filter expression consists of a series of dropdown lists and state input fields. Supply a filter expression by selecting a comparison operator (<, <=, =, >=, >, <>) from the first dropdown list and then enter the comparison state value in the adjoining field. The up and down arrow controls on this field operate only in the range of 0 through 9 (the standard OEM state values), but you can enter any positive integer value directly in the field. If this completes the filter expression, select Done from the second drop-down list. To add a second comparison to the filter expression, choose AND or OR from this drop-down list and repeat the previous procedure for the second comparison operator and associated state value field. When the OEM evaluates this specifier as part of updating a Custom View, an object must pass the entire filter expression to be included in that view. 6. Click OK to accept the changes, or click Cancel to discard them. The Update Specifier dialog box closes. 7. Click OK or Apply in the properties dialog box to save the change, or click Cancel to discard it.
Deleting an Existing Specifier

If you want, you can delete a single existing specifier. To delete an existing specifier: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears. 2. Select the specifier to be deleted. 3. Click Delete. The specifier is removed from the list.
Custom Views
4. Click OK or Apply in the properties dialog box to save the change, or click Cancel to discard it.
Clearing All Existing Specifiers

If you want, you can clear all existing specifiers at once. To clear all existing specifiers: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears. 2. Click Clear. The specifier list is cleared. 3. Click OK or Apply in the properties dialog box to save the change, or click Cancel to discard it.
Custom Views
Choosing the Display Mode
The Add/Update Specifier Dialog Box

Whenever you add a new specifier to a Custom View or update an existing specifier, the Add/Update Specifier dialog box appears. This dialog box contains several fields that allow you to configure the specifier: Specifier template This is the specifiers template string. This value must conform to the rules described in Setting Object Specifiers and State Filters on page 5-7. This option determines what state filtering is performed:
Include States otption
To include all objects regardless of state, click All. To enter a filter expression, click Filter.
Filter expression
To include all objects regardless of state, select the All option under Include States. To filter based on the state value, select the Filter option under Include States. The filter expression is made up of a series of dropdown lists and state input fields. Supply a filter expression by selecting a comparison operator (<, <=, =, >=, >, <>) from the first dropdown list and then enter the comparison state value in the adjoining field. The up and down arrow controls on this field operate only in the range of 0 through 9 (the standard OEM state values), but you can enter any positive integer value directly into the field. If this completes the filter expression, select DONE from the second drop-down list. To add a second comparison to the filter expression, choose AND or OR from this drop-down list and repeat the previous procedure for the second comparison operator and associated state value field. When the OEM evaluates this specifier as part of updating a Custom View, an object must pass the entire filter expression to be included in that view.
Choosing the Display Mode

Custom View windows provide two different ways to view data: hierarchically and as a simple list of objects. The hierarchical display presents data in highest-level to lowest-level order. The states of the higher-level objects are determined by propagating state information from lowerlevel objects. You navigate to items by drilling down through the hierarchy. It is easy to find objects of interest because the number of items at any level is generally low, but some navigation is almost always necessary to get to the lowest level of data.
Custom Views
Selecting the View Format
The object-based display is virtually identical to the standard Alerts window: it shows a list of all lowest-level objects contained in the view. No navigation is needed to find the state of an object. All information is easily at hand, so there is no need to move through different levels of the hierarchy to find specific object-state information, but information for a specific object can be difficult to find as the number of entries increases. To choose a display mode: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears. 2. Specify the display mode:
To display objects hierarchically, click Hierarchical in the Mode panel. To display objects using a simple list, click Object in the Mode panel.
To quickly switch between hierarchical and object display modes, click the Hierarchical View and Object View buttons on the toolbar. 3. Click OK or Apply to save the change, or click Cancel to discard it.
Selecting the View Format

The Custom View facility provides several options for graphically representing object data within the window. These options include: Large Icons Each entry contains the object name and a 32x32 icon that represents the objects state. By default, objects are listed left to right and top to bottom in descending order by state. Each entry contains the object name and a 16x16 icon that represents the objects state. By default, objects are listed left to right and top to bottom in descending order by state. Each entry contains the object name and an icon that represents the objects state. The icon size used depends on the OEMs Use Large Icons setting. If this option is enabled, a 32x32 icon is displayed; otherwise a 16x16 icon is used. By default, objects are listed top to bottom and left to right in descending order by state. Each entry contains the object name, state, context, and reporting client name. The icon size used depends on the OEMs Use Large Icons setting. If this option is enabled, a 32x32 icon is displayed; otherwise a 16x16 icon is used. By default, objects are listed top to bottom in descending order by state.
Small Icons
List
Details
To specify the view format: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears.
Custom Views
Selecting the Client State Reporting Option
2. Specify the view format:
To use large icon format, click Large Icon in the View panel. To use small icon format, click Small Icon in the View panel. To use list format, click List in the View panel. To use details format, click Details in the View panel.
To quickly switch between the various view formats, click the Large Icons, Small Icons, List, and Details buttons on the toolbar. 3. Click OK or Apply to save the change, or click Cancel to discard it.
Selecting the Client State Reporting Option

Within the OEM environment, multiple clients can report on the same object and can report different states for that object. The OEM handles this by tracking each entry separately and performing state arbitration and propagation to ensure that only the most critical state value is forwarded to EM framework adapters and reflected in higher layers of the hierarchy. When displaying this data in a Custom View window, you can determine whether an entry is shown for each client that reported a particular item, or if only one entry corresponds to the highest reported state for the item. To specify that all client entries are shown or that only the maximum client entry is shown: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar. The properties dialog box for the Custom View appears. 2. Specify how the client state is to be reported:
To display all reported states for each object, click All Clients in the State Reporting panel. To display only the maximum reported state for each object, click Max Client in the State Reporting panel.
Altering the Window Layout

By default, each Custom View window contains a toolbar, a status bar, and possibly a links bar, depending on the display mode selected. You can hide some or all of these objects based on how you use the OEM. To enable or disable display of the toolbar, status bar, or links bar: 1. Choose Properties from the View menu, or click the Configure View Properties button on the toolbar.
Custom Views
Working With Custom Views
The properties dialog box for the Custom View appears. 2. Configure the window layout:
To enable the toolbar, check the Toolbar check box in the Display panel. To disable the toolbar, clear the Toolbar check box in the Display panel. To enable the status bar, check the Status Bar check box in the Display panel. To disable the status bar, clear the Status Bar check box in the Display panel. To enable the links bar, check the Links Bar check box in the Display panel. To disable the links bar, clear the Links Bar check box in the Display panel. You can change the Links Bar setting only while in hierarchical display mode; the links bar is automatically disabled when in object view display mode.
Note. As a shortcut, you can disable the links bar by dragging the divider located between the links bar and the object list off the left side of the window.
Working With Custom Views

This subsection describes how to work with Custom Views and includes the following sections:
Creating a New Custom View on page 5-16 Opening an Existing Custom View on page 5-16 Saving a Custom View Configuration on page 5-17 Sorting Custom View Window Items on page 5-17 Sizing Custom View Window Columns on page 5-17 Locking the Custom View Window on page 5-18 Keeping the Custom View Window on Top on page 5-18 Refreshing Custom View Window Contents on page 5-19 Navigating to Client Applications on page 5-19 Closing a Custom View Window on page 5-19
Custom Views
Creating a New Custom View
Creating a New Custom View

You can create new Custom Views at any time and create as many as you need. To create a new Custom View: 1. Do one of the following:
Right-click the OEM icon in the system tray and choose New Custom View. From a Custom View windows File menu, choose New Custom View.
A new Custom View window named Default is created using the default configuration settings. 2. Alter these settings as desired. For example, you can add or remove specifiers and state filters or change the display mode. 3. Save the configuration to a new Custom View definition file by choosing Save As from the File menu. The new file name is used as the name of the new view. By default, view definition files are saved to the OEM_program_directory\Views folder, but you can change this location when you save the configuration.
Note. Saving the configuration using the default view name of Default updates the default configuration for all subsequent new views. This action can be useful if, for example, you want to use a certain set of configuration properties in all cases. By updating the default configuration settings, all new views pick up these options automatically, reducing the number of options you must set each time you create a new view.
Opening an Existing Custom View

You can open an existing Custom View using either of two methods. Method 1: 1. Right-click the OEM icon in the system tray and choose Open Custom View. A dialog box appears so you can choose the Custom View definition file to open. 2. Select the file and click Open. The OEM reads the configuration information from the definition file and creates a new window to display the Custom View data. Method 2: 1. Choose Open from an existing Custom View windows File menu, or click Open on the toolbar. A dialog box appears so you can choose which Custom View definition file to open. 2. Select the file and click Open. The OEM reads the configuration information from the definition file and displays the Custom View data using the existing window. In this case, the existing display
Custom Views
Saving a Custom View Configuration
properties of the window (such as view format and window position) are used rather than the settings stored in the view definition file. The Custom View window is updated with the new view name, and the data is refreshed using the specifiers defined in the view definition file. In addition, the view definition file becomes the active definition file for the view, and subsequent save operations default to that location. In addition, at startup the OEM Server automatically opens any Custom View windows that were active the last time the OEM was shut down.
Saving a Custom View Configuration

When you save a Custom View configuration, you can save it to the active view definition file or to a new view definition file. You will probably want to save to the active view definition file unless you are creating a new Custom View. To do so, choose Save from the File menu, or click Save on the toolbar. To save the configuration to a new definition file, choose Save As from the File menu. A dialog box appears so you can specify the location to which the configuration should be saved. Once you have selected the path and entered a new file name, click Save to save the configuration data. The current window is updated to show the new view name, and the active view definition file becomes the newly created file. By default the OEM creates new view definition files in the OEM_program_directory\Views folder, but you can change this location using the Save dialog box. If the OEMs Auto Save View Definitions option is enabled, all Custom View configurations are automatically saved when a Custom View window is closed or the OEM shuts down. In this case, you need not manually save each Custom View configuration.
Sorting Custom View Window Items

You can sort the items in a Custom View object list using any of the Custom View fields. To sort items: 1. Make sure you are using Details view format. 2. Click the column heading by which you want to sort:
Click once to sort objects in ascending order. Click twice to sort objects in descending order.
The sort order is preserved if you subsequently switch to Large Icons, Small Icons, or List view.
Sizing Custom View Window Columns

You can resize each of the columns in the window. To do so, make sure you are using Details view format, select the divider between column headings, and drag it right or left as desired. You can also resize all columns at once.
Custom Views
Locking the Custom View Window
To resize all columns at once: 1. From the View menu, choose Size Columns. 2. Choose Defaults, Size To Window or Size To Contents: Menu Item Defaults Size To Windows Size To Contents Action Performed Sizes each column using the saved value for that column. Sizes each column using a fixed percentage of available space. Sizes each column based on the largest item in the column.
The OEM stores the adjusted column widths in the view definition file when you subsequently save the view configuration. The values are then restored the next time the view is opened.
Locking the Custom View Window

The OEM Server automatically updates all Custom View windows whenever new data is received from a client application. In some cases, you might want to prevent this action from occurring for a particular window; for example, if you are analyzing the data in the window and want to ensure that it does not change until you are finished. To lock and unlock a window:
To lock a Custom View window, choose Locked from the View menu from the menu, or click Lock Window on the toolbar. The indicator (Locked) is appended to the window title, and the OEM does not update the window contents if new data is received. You can manually update the window at any time by choosing Refresh from the View menu from the menu or by clicking Refresh on the toolbar. To unlock a display window and re-enable updates, choose Locked from the View menu from the menu, or click Unlock Window on the toolbar. The (Locked) indicator disappears, and the OEM updates the window the next time new data is received. Repeatedly selecting Locked from the View menu from the menu or clicking Lock Window/Unlock Window on the toolbar toggles the locked attribute on and off.
Keeping the Custom View Window on Top

You can specify whether each new Custom View window created by the OEM always remains on top. Windows with the On Top property enabled cannot be obscured by any other window on your system. When the OEM creates a new Custom View window, it sets the windows On Top property based on the Display Forms Stay On Top option setting. If the Display Forms Stay On Top check box is checked, the new window is created with its On Top property enabled. If the Display Forms Stay On Top check box is not checked, the new window is created with its On Top property disabled. You can override the default value or toggle the On Top property of a window.
Custom Views
Refreshing Custom View Window Contents
If Stay On Top on the View menu is checked, the current window is an On Top window. Choose Stay On Top from the View menu to disable the On Top attribute. If Stay On Top on the View menu is not checked, the current window is not an On Top window. Choose Stay On Top from the View menu to enable the On Top attribute. Repeatedly selecting Stay On Top from the View menu toggles the On Top attribute on and off.
Refreshing Custom View Window Contents

Because the OEM Server automatically updates all Custom View windows whenever it receives new data from a client application, there is generally no reason to perform a manual refresh. However, if a window has been locked for some period of time, it might not contain current data. To update the contents with the latest data, choose Refresh from the View menu from the menu, or click the Refresh button on the toolbar.

The OEM Server gives you access to active client applications so that you can view detailed information on objects and their states. To navigate to the client that reported a particular object, click the object in the Custom View window. An Alert message is sent to the associated client and that client then provides detailed information about the objects state and history. You can also invoke any Popup command defined for an object by right-clicking that object in a Custom View window. A popup menu appears showing the applicable commands. Select the desired item, and the corresponding command is sent to the appropriate client application.
Closing a Custom View Window

To close a Custom View window, choose Close from the File menu or click the close box.
Custom Views
Closing a Custom View Window
OEM External Specification
The OEM external specification serves as a reference for developers wanting to use the OEM Server in their own development efforts. The following sections detail the OEM architecture and provide descriptions of the APIs for both client applications and enterprise management framework adapters.
Component Terminology
The following component terms are used in this specification: Adapter- A generic term used to describe the general notion of an interface adapter. It can be either the EM Adapter or the OEM Adapter. Client - Client applications that use the OEM Server. Enterprise Management (EM) Adapter - Adapter that provides an encapsulated adapter interface between the enterprise management framework and the OEM Server. It is an ActiveX component. Enterprise Management (EM) Framework - The enterprise management framework currently operating on the workstation. For example, a framework can be the Compaq OIL or Tivoli. From the client and OEM Server perspective, it does not matter which framework is running. OEM Adapter - A generic adapter used by the OEM Gateway. This adapter also serves as an adapter skeleton as well as a means for development, test, and validation of an enterprise specific adapter. It is an ActiveX component. OEM Gateway - The overall Open Enterprise Management architecture described in this document, including the OEM Server, OEM Adapter, EM Adapter, and associated request and callback API calls. OEM Server - The Open Enterprise Management Server portion of the OEM Gateway described in this document. The OEM Server provides communication between the Clients and the EM Adapter. The EM Adapter in turn communicates with the enterprise management framework. It is an ActiveX component.
Interface Terminology
The following interface terms are used in this specification. Figure A-1 shows a possible information path.
OEM Users Guide520330-001 A- 1
Architectural Overview
Figure A-1. OEM Information Path Example

OEM Gateway
EM Adapter
Adapter Specific Processing EM Framework Adapter Request API
Queue, State Arbitration, and Aggregation Processing
OEM Request API
Node, Entity, Object, State Reporting
Adapter Callback API Adapter Interface Transform
OEM Server Client
OEM Callback API
Queue, State Arbitration, and Callback Processing
Client Callback API
Specific Node, Entity, Object, Reporting
VST100.vsd
OEM Request API - the interface between the clients and the OEM Server. Adapter Request API - the interface between the OEM Server and the Adapter. Adapter Callback API - the callback interface between the EM framework and the EM Adapter. OEM Callback API - the callback interface between the EM Adapter and the OEM Server. Client Callback API - the callback interface between the OEM Server and the clients.
The OEM Gateway consists of two functional pieces:
The Open Enterprise Management Server (OEM Server) One or more Enterprise Management framework adapters (EM Adapters)
The OEM Server acts as the interface to client applications and includes the following features: Standard OEM Gateway Request API Standard Client Callback API Inbound and outbound queues to prevent application blocking and deadlocks
Management of EM framework updates, including object aggregation and state arbitration Client tracking to enable framework callbacks to client applications Servicing of EM framework alerts, automatically directing the user to the appropriate client for the highest alert level Debugging and trace mechanisms to assist in client application development Graphical user interface (GUI) to configure OEM options and view the OEM state User-definable views for custom filtering and logical grouping of objects
The EM Adapter is responsible for interfacing with a specific enterprise management framework It includes the following: Standard Adapter Request API Standard OEM Gateway Callback API Translation of requests to framework-specific operations State propagation in cases where the OEM Server reports on objects at a lower level than the framework Translation of EM framework notifications or callbacks to OEM Gateway standard callbacks and commands
Open Enterprise Management Server
Open Enterprise Management Server

This section describes the following components of the OEM Server:
Architecture and Design Considerations for the OEM Server (next) OEM Request API (Client Application to OEM) on page A-5 Client Callback API (OEM to Client Application) on page A-23
Architecture and Design Considerations for the OEM Server

The Open Enterprise Management (OEM) Server provides a standard interface to client applications needing to integrate with an Enterprise Management Framework. The server executes as a standard Win32 ActiveX EXE, which allows any OLE-enabled application to communicate with it. For a client application to use the OEM, the client must:
Use the OEM Request API to pass request information to the OEM. For more information, see OEM Request API (Client Application to OEM) on page A-5. Support OLE Automation callbacks, which effectively means it must run as an ActiveX EXE. Create a callback class that implements the Client Callback API to receive command information from the OEM. For more information, see Client Callback API (OEM to Client Application) on page A-23.
The OEM Request API allows client applications to add managed objects and their corresponding popup menus to the framework, set object state, and remove managed objects or popups from the framework. In addition, the OEM request API also supplies a set of debugging methods to assist in client application development. The intent is that this standardized interface be simple to use from a client standpoint; the EM Adapter portion of the OEM Gateway handles all framework-specific issues. The Client Callback API provides a standard means of communicating framework notification or command information back to client applications. The client is not required to have any knowledge of the workings of the framework; the only requirement is that the client must completely implement the set of methods and properties that make up the API. The OEM Server is a shared resource; as such, it could potentially become a bottleneck for client applications or the EM framework. To remedy this situation, the OEM Server maintains inbound and outbound queues on both the request and callback side. It immediately queues all requests received from clients and replies to them. This prevents clients from being blocked while the server is processing the request. The same mechanism is used when processing callbacks from the EM framework adapter; the server queues the commands and replies to the request. This allows the adapter (and potentially the framework) to continue with other operations while the callback is being handled by the server.
OEM Request API (Client Application to OEM)

The OEM Request API defines the interface that client applications use to access the Open Enterprise Management Gateway. The examples included in the following descriptions are given using pseudo code similar to Visual BASIC; they might not be syntactically correct for Visual BASIC or any other environment.
ReportingLevels
ReportingLevels returns the number of levels the OEM Server requires in the object hierarchy. All clients must ensure that they report objects at this level. For example, if ReportingLevels is 3, the OEM Server expects to receive objects in the form \node\entity_type\object_name, where:
node
is a node name.
entity_type
is the type of object being reported on (for example, CPU or DISK).

object_name
is the name of the actual object. If ReportingLevels is 1, only \node would be expected.
Function ReportingLevels() As Integer
Parameters None Return Value The number of levels in the OEM Server object hierarchy. Considerations All clients using the OEM must determine the supported ReportingLevels before reporting objects to the OEM and must report only at that level. Because ReportingLevels is user-configurable, clients should check the value before every OEM update. Example
Dim OEM As New OEMClass Dim Levels As Integer Levels = OEM.ReportingLevels
Popup.Add
Use Popup.Add to add a popup menu for a given entity (class or object) to the EM Framework. The framework subsequently uses the popup to direct commands back to the OEM Gateway, which in turn passes them through to the appropriate client application. In some cases, the framework might not support true dynamic menus, instead relying on static menus or other means of invoking commands against objects. In these cases, the popups might not be added to the framework, but popup menu definitions are still required by the OEM Gateway to route these commands to the correct client.
Function Popup.Add(EntityName As String, MenuCaption As String, CallbackCommand As String, CallbackObject As Object, CallbackAppName As String, CallbackClassName As String, CallbackType As String, ClientName As String) As Integer
Parameters
EntityName (input)
is the name of the entity to which the popup applies. This menu can be associated with entries at any level in the object hierarchy. For example, specifying CPU for EntityName associates the popup menu with all CPU objects. Specifying \Dallas\CPU\0 associates the menu only with CPU 0 on node Dallas.
MenuCaption (input)
is the caption that appears on the popup menu for this item.
CallbackCommand (input)
is the command returned to the client application when this menu item is selected. This command can be any text and is completely at the discretion of the client application. This allows clients to determine what command they receive when a particular menu item is chosen instead of requiring the OEM Gateway or EM framework to impose a set of rules.
CallbackObject (input)
is the clients instantiated callback object. This must be specified; otherwise the OEM Gateway cannot pass the command back to the client application.
CallbackAppName (input)
is the fully qualified (path included) name of the client application. This is retained by the OEM Gateway to programmatically start the client if needed.
CallbackClassName (input)
is the name of the clients callback class. This is required in cases where the CallbackObject reference has become invalid and the OEM Gateway must create a new callback object for the client to return command information.
CallbackType (input)
specifies whether this is a special type of menu item and callback, as follows:
'<DoubleClick>'
causes the client to receive an automatic callback when a user double-clicks an item in the framework where the object class name matches EntityName (for example, EntityName is Disk, and the user double-clicks Disk in the framework). This allows default actions to be associated with double-click events, rather than requiring a user to always bring up the complete popup menu.
'<Click>'
causes the client to receive an automatic callback when a user clicks an item in the framework where the object class name matches EntityName (for example, EntityName is Disk, and the user clicks Disk in the framework). This allows default actions to be associated with click events, rather than requiring a user to always bring up the complete popup menu.
'<Expand>'
causes the client to receive an automatic callback when a user expands a branch of the object hierarchy where the object class name matches EntityName (for example, EntityName is Disk, and the user expands the Disk branch of the hierarchy in the framework). This makes it easy for clients to dynamically populate frameworks on a demand basis as the user navigates to lower levels of the hierarchy.
'<Collapse>'
causes the client to receive an automatic callback when a user collapses a branch of the object hierarchy where the object class name matches EntityName (for example, EntityName is Disk, and the user collapses the Disk branch of the hierarchy in the framework). This makes it easy for clients to dynamically depopulate or clean up frameworks on a demand basis as the user ascends the hierarchy. Set this parameter to to disable any special handling for this menu item. Not all frameworks support this feature.
ClientName (input)
is a client-defined name used to identify the owner of the popup. For most clients this can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands).
Return Value
0 if the request was queued successfully An OEM error number if an error occurred
Considerations For a client application to receive Max Alert callback commands, it must add a popup entry with the caption Max Alert. When the user selects Max Alert from the popup menu, the OEM Gateway determines which client is reporting the highest alert level for the selected object and callback to that client using the specified CallbackObject. For a client application to enable Alert callbacks, it must add a popup entry with the caption Alerts. When the user selects Alerts from the popup menu, the OEM Gateway displays a list of all clients reporting an alert for the selected object. The user can then choose which one is of interest, and the OEM Gateway calls back to the appropriate client using the specified CallbackObject. If the given MenuCaption already exists for this EntityName, the user can choose the desired client whenever that menu item is selected. For example, assume both NsxGem and OMF GUI add a menu item with caption Status to the CPU entity. If a user subsequently chooses Status from a popup menu in the framework, the OEM Gateway displays a dialog listing both clients. The user can then navigate to the appropriate client. Example
Dim OEM As New OEMClass Dim MyCallbackObject As New MyCallbackClass Dim RC As Integer RC = OEM.Popup.Add('DISK', 'Disk Performance', 'DISK PERFORMANCE COMMAND', MyCallBackObject, App.Path & App.EXEName, 'MyClient.MyCallbackClass', 'MyClientName')
In this example, a popup menu item is added for all DISK entities. The caption that appears on the menu is Disk Performance. When a user selects this item, the command DISK PERFORMANCE COMMAND is passed back to the client application.
Popup.Delete
Use Popup.Delete to remove a popup menu for a given entity (class or object) from the EM Framework. In some cases, the framework might not support true dynamic menus, instead relying on static menus or other means of invoking commands against objects. In these cases, the popups might not be removed from the framework, but the OEM Gateway still maintains popup menu definitions internally for popups added using the Popup.Add method. Removing one of these popups allows the OEM Gateway to alter its callback mechanism for the affected entity.
Function Popup.Delete(EntityName As String, MenuCaption As String, ClientName As String) As Integer
Parameters
EntityName (input)
is the name of the entity to which the popup applies. This menu can be associated with entries at any level in the object hierarchy. For example, specifying CPU for EntityName associates the popup menu with all CPU objects. Specifying \Dallas\CPU\0 associates the menu only with CPU 0 on node Dallas.
MenuCaption (input)
ClientName (input)
is a client-defined name used to identify the owner of the popup. For most clients this can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands). Return Value
Considerations For a client application to remove a popup menu, it must first have added it using the Popup.Add method. Example
Dim OEM As New OEMClass Dim RC As Integer RC = OEM.Popup.Delete('DISK', 'Disk Performance', 'MyClientName')
In this example, the popup menu item Disk Performance is removed for all DISK entities.
Popup.Cleanup
Use Popup.Cleanup to remove all popup menus for a given client name. This is particularly useful when a client application is shutting down and all popups associated with it must be removed from the OEM Gateway and EM framework.
Function Popup.Cleanup(ClientName As String) As Integer
Parameters
ClientName (input)
is a client-defined name used to identify the owner of the popups. For most clients, this can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands). Return Value
Considerations For a client application to remove any popup menus, it must first have added them using the Popup.Add method. If a client application is using multiple ClientNames, it should call Popup.Cleanup for each of these names when shutting down. Example
Dim OEM As New OEMClass Dim RC As Integer RC = OEM.Popup.Cleanup('MyClientName')
In this example, all popup menu items associated with MyClientName are removed.
OEM Users Guide520330-001 A -10
Object.Add
Use Object.Add to add objects to the EM Framework. To add multiple objects as part of a single operation, block them together. Although the OEM Gateway could require that client applications report objects at level n, the EM framework adapter could report at a higher level. In these cases, only the higher-level objects are added to the framework.
Function Object.Add(Path As String, ObjectNames As String, CallbackObject As Object, ClientName As String) As Integer Path (input)
is the full path of all objects included in ObjectNames, for example \NewYork. If this value is not , it is prefixed to each item contained in the ObjectNames list. This simplifies building the ObjectNames list for client applications in cases where a large number of objects are to be added.
ObjectNames (input)
is a comma-separated list of all objects to be added, along with their states and any associated context. The format of ObjectNames is:
ObjectName[:State[:Context]] [,ObjectName[:State[:Context]], ]
ObjectName
is the fully qualified name of the object (unless a Path has been specified).
State
is the numerical state of the object.

Context
is optional text enclosed in double quotation marks (). Context is retained by the OEM Gateway for each object and displayed along with the object name during Alerts processing.
is the clients instantiated callback object. All framework notifications or commands associated with the objects added in this operation are returned through the supplied CallbackObject. If this value is Nothing, the callback object associated with the given ClientName is used.
ClientName (input)
is a client-defined name used to identify the owner of a particular object and determine the related client callback object. For most clients, this name can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands).
Return Value
Considerations You need not specify a State and Context for each object in ObjectNames. If you do not include State and/or Context information, the default values of 0 and , respectively, are used. However, you must include a State if you want to include Context. Example
Dim OEM As New OEMClass Dim MyCallbackObject As New MyCallbackClass Dim RC As Integer RC = OEM.Object.Add('\Chicago', 'CPU\0:4:'''High Swap Rate''', CPU\1:2:'''Moderate Busy Percent''' ', MyCallBackObject, 'MyClientName')
In this example, the Path \Chicago is prefixed to each object name. This causes the object \Chicago\CPU\0 to be added with state 4, and the object \Chicago\CPU\1 to be added with state 2.
Object.Delete
Use Object.Delete to remove objects from the EM Framework. To remove multiple objects as part of a single operation, block them together. Although the OEM Gateway could require that client applications report objects at level n, the EM framework adapter could report at a higher level. In these cases, the framework determines whether the higher level objects should be removed from the framework. In most cases, this decision is based on whether all subordinate objects have been removed.
Function Object.Delete(Path As String, ObjectNames As String, ClientName As String) As Integer
Parameters
Path (input)
is the full path of all objects included in ObjectNames; for example \NewYork. If this value is not , it is prefixed to each item contained in the ObjectNames list. This simplifies building the ObjectNames list for client applications in cases where a large number of objects are to be deleted.
ObjectNames (input)
is a comma-separated list of all objects to be deleted. While the standard ObjectNames format of:
ObjectName[:State[:Context]] [,ObjectName[:State[:Context]], ]
is supported, the State and Context values are ignored for delete operations.
ClientName (input)
is a client-defined name used to identify the owner of a particular object and determine the related client callback object. For most clients, this can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands). Return Value
Considerations For an object to be deleted from the OEM Gateway and EM framework, it must first have been added using the Object.Add method. Example
Dim OEM As New OEMClass Dim RC As Integer
RC = OEM.Object.Delete('\Chicago', 'CPU\0, CPU\1', 'MyClientName')
In this example, the Path \Chicago is prefixed to each object name. This causes the objects \Chicago\CPU\0 and \Chicago\CPU\1 to be removed.
Object.Cleanup
Use Object.Cleanup to remove all objects for a given client name. This is particularly useful when a client application is shutting down and all objects associated with it must be removed from the OEM Gateway and EM framework.
Function Object.Cleanup(ClientName As String) As Integer
Parameters
ClientName (input)
is a client-defined name used to identify the owner of the objects. For most clients this can simply be the application name. However, more complex clients might need to use more than one ClientName and CallbackObject to localize processing for different types of commands (for example, one ClientName and CallbackObject for DISK commands and another for CPU commands). Return Value
Considerations For a client application to remove any objects, it must first have added them using the Object.Add method. If a client application is using multiple ClientNames, it should call Object.Cleanup for each of these names when shutting down. Example
Dim OEM As New OEMClass Dim RC As Integer RC = OEM.Object.Cleanup('MyClientName')
In this example, all objects associated with MyClientName are removed.
LogMessage
LogMessage is used to add an event message to the OEM event log. This log serves as a central source of information relating to the OEM environment and can be viewed by users through the OEM main window. Client applications can use this facility to keep a record of errors encountered interacting with the OEM, to log application state information regarding the OEM, or other such tasks.
Sub LogMessage(ClientName As String, ClientMessageNumber As Long, MessageText As String, Severity As Integer)
Parameters
ClientName (input)
is a client-defined name used to identify the source of the event message.

ClientMessageNumber (input)
is a client-defined message number for this event. The OEM Server does nothing with this value other than display it in the log, so multiple clients can use the same message numbers.
MessageText (input)
is the event text.

Severity (input)
is the severity associated with the message, on a scale of 0 (lowest: informational message) to 3 (highest: critical problem). The OEM Server log display is sorted in descending order by event severity. Return Value None Considerations The OEM Server automatically adds the date and time to each logged message; clients do not need to include this information in the MessageText field. Example
Dim OEM As New OEMClass OEM.LogMessage 'MyClientName', 1312, 'Unknown command received from OEM', 1
In this example, the client application logs its message 1312 with severity 1.
SetIcons
Use SetIcons to inform the OEM that the user has changed the default icon set in a client application. The OEM subsequently passes this update to all other adapters and clients, and modifies its own icon set if the Use Common Icons option is enabled.
Function SetIcons(IconDirectoryName As String) As Integer
Parameters
IconDirectoryName (input)
is the name of the directory containing the object and state images to use. Return Value
0 if the OEM has accepted the call and handled the request (even if the icon set is not updated) Non-zero if the OEM cannot process the request
Considerations If the Use Common Icons option is disabled, the OEM still passes the update information to all clients and adapters. However, the OEM does not modify its own icon set to utilize the new icons given in IconDirectoryName. The client that called SetIcons receive a SetIcons callback from the OEM; the directory name passed is identical to that supplied on the initial call. Example
Dim OEM As New OEMClass Dim RC As Integer RC = OEM.SetIcons 'C:\MyIcons'
In this example, the client application sets the icon directory to C:\MyIcons.
DebugDisplayPopups
DebugDisplayPopups causes the OEM server to display a list of all popup menus currently maintained in the OEM configuration. This list is useful when you debug client applications to determine if Popup.Add, Popup.Delete, and Popup.Cleanup calls are having the desired results.
Sub DebugDisplayPopups()
Parameters None Return Value None Example

OEM.DebugDisplayPopups
DebugDisplayObjects
DebugDisplayObjects causes the OEM server to display a list of all objects currently maintained in the OEM configuration. This list is useful when you debug client applications to determine if Object.Add, Object.Delete, and Object.Cleanup calls are having the desired results.
Sub DebugDisplayObjects()

OEM.DebugDisplayObjects
DebugTraceEnable
DebugTraceEnable causes the OEM server to display a trace window and log all request and command activity. This information can be useful in diagnosing client problems during development. Trace information includes all requests from clients, requests sent to the EM framework adapter, commands received from the EM framework adapter, commands passed through to clients, and key internal information.
Sub DebugTraceEnable()

OEM.DebugTraceEnable
DebugTraceDisable
DebugTraceDisable causes the OEM server to stop tracing.
Sub DebugTraceDisable()
Parameters None Return Value None Consideration Tracing must first have been enabled using DebugTraceEnable. Example
OEM.DebugTraceDisable
DebugQueuePause
DebugQueuePause suspends processing of the OEM servers request queue. This action allows a number of client requests to be queued without updating active adapters or display forms.
Sub DebugQueuePause()
Parameters None Return Value None Consideration Queue processing can be reactivated using DebugQueueResume. Example
OEM.DebugQueuePause
DebugQueueResume
DebugQueueResume activates processing of the OEM servers request queue. Sub DebugQueueResume() Parameters None Return Value None Consideration Queue processing must have been suspended previously using DebugQueuePause. Example
OEM.DebugQueueResume
Client Callback API (OEM to Client Application)

The Client Callback API defines the set of methods and properties that client applications must include in their callback class definition so the Open Enterprise Management Gateway can pass back command information. The examples included in the following descriptions are given using pseudo code similar to Visual BASIC; they might not be syntactically correct for Visual BASIC or any other environment.
Command
Use the Command method to return framework command information to the client application. This method is called for a given callback object whenever the user selects a popup menu item associated with that callback.
Function Command(Path As String, ObjectName As String, CallbackCommand As String) As Integer
Parameters
Path (input)
is the full path of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, Path is \NewYork\DISK.
ObjectName (input)
is the name of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM.
CallbackCommand (input)
is the command corresponding to the menu item chosen by the user. Return Value
0 if the client has accepted and handled the command Non-zero if the client cannot or will not process the command
Considerations The value of CallbackCommand is set by the client application using the Popup.Add method. Whatever text was specified in the CallbackCommand parameter when the popup was added is returned, unaltered, to the client application when the user selects the menu item. The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the client has accepted the command, and a non-zero value indicates the client cannot or will not process the command. It is important that client applications return the appropriate value, because the OEM Gateway could behave differently based on the outcome of the call.
Example
Dim RC As Integer ClientCallbackObject was passed in a Popup.Add or Object.Add call RC = ClientCallbackObject.Command('\East\CPU', '3', 'CPU State')
In this example, the command CPU State is passed back to the client for object \East\CPU\3. The CPU State callback command was originally added by the client using the Popup.Add method.
ClientMessage
Use the ClientMessage method to pass framework-specific requests or commands to a client application. This allows a client to include custom features for a specific framework or a framework to include custom features for a specific client. In either case, the OEM Gateway acts as a simple router and pass-through server; any data sent from the framework is passed unaltered to the specified client.
Function ClientMessage(ClientName As String, Path As String, ObjectName As String, Message As String) As Integer
Parameters
ClientName (input)
is the name of the client to receive the message.

Path (input)
is the full path of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, Path is \NewYork\DISK. This value can be if the message does not relate to a specific object.
ObjectName (input)
is the name of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM. This value can be if the message does not relate to a specific object.
Message (input)
is the message to be passed to the client application. Return Value
0 if the client has accepted and handled the message Non-zero if the client cannot or will not process the message
Considerations The OEM Gateway determines the callback object for the message based on the given ClientName; therefore, the client application must previously have made itself known to the OEM Gateway by specifying ClientName in a Popup.Add or Object.Add call. The OEM Gateway only evaluates the return value as zero or non-zero. A zero return value from the call indicates that the client has accepted the command, and a non-zero value indicates the client cannot or will not process the command. It is important that client applications return the appropriate value, because the OEM Gateway could behave differently based on the outcome of the call.
Example
Dim RC As Integer ClientCallbackObject was passed in a Popup.Add or Object.Add call RC = ClientCallbackObject.ClientMessage('MyClientName', 'Custom Framework Message')
In this example, the message Custom Framework Message is passed back to the client corresponding to MyClientName.
WindowManagementEnabled
The OEM Server uses the WindowManagementEnabled method to determine whether a client application needs to receive window management callbacks (for example, tile requests or minimize requests). The OEM queries this value for each client before sending a window management notification. If a client will participate in window management operations, this function should return True. If it will not participate in window management operations, this function should return False.
Function WindowManagementEnabled() As Boolean
Parameters None Return Value
True if the client will participate in window management operations False if the client will not participate in window management operations
Considerations This method is called by the OEM Gateway when the user or framework has invoked a window management function (for example, Tile or Cascade). The OEM first queries each client to determine whether that client will participate in the operation. For those that do take part, the appropriate callback method (for example, Move or Height) is then called. To maintain compatibility with OEM version 1.0, the OEM Server assumes that each client will accept window management notifications unless its WindowManagementEnabled function returns False. As a result, a client application that does not include this function in its callback class receives all window management messages. Example
Dim RC As Boolean ' ClientCallbackObject was passed in a Popup.Add or Object.Add call RC = ClientCallback.WindowManagementEnabled If RC = True Then ' Send appropriate window management callback to the client
Move
Use the Move method to inform the client application to move its display window so that its top left corner is at the specified coordinates.
Function Move(Left As Single, Top As Single) As Integer
Parameters
Left (input)
is the new left position of the window.

Top (input)
is the new top of the window. Return Value
0 if the client has accepted and handled the request Non-zero if the client cannot or will not process the request
Considerations This method is called by the OEM Gateway when the user or framework has invoked a window management function (for example, Tile or Cascade). The client application determines which window should be positioned. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. This is a request only; the client can choose not to position the window if necessary (for example, if the user has already explicitly positioned the window). The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the client has accepted the command, and a non-zero value indicates the client cannot or will not process the command. It is important that client applications return the appropriate value, because the OEM Gateway might behave differently based on the outcome of the call. If the client applications WindowManagementEnabled function returns False, this method is not called by the OEM. Example
Dim RC As Integer ' ClientCallbackObject was passed in a Popup.Add or Object.Add call ' Assume FrameworkWindow is defined elsewhere in the OEM RC = ClientCallbackObject.Move(FrameworkWindow.Left + 10, FrameworkWindow.Top + 10)
In this example, the OEM Gateway has requested that the client position the upper left corner of its window 10 pixels to the right and 10 pixels down from the main framework window.
Height
Use the Height method to inform the client application to adjust the height of its display window to the new value.
Function Height(NewHeight As Single) As Integer
Parameters
NewHeight (input)
is the new height of the window. Return Value
Considerations This method is called by the OEM Gateway when the user or framework has invoked a window management function (for example, Tile or Cascade). The client application determines which window should be adjusted. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. This is a request only; the client can choose not to adjust the window height if necessary (for example, if the user has already explicitly set the height of the window). The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the client has accepted the command, and a non-zero value indicates the client cannot or will not process the command. It is important that client applications return the appropriate value because the OEM Gateway might behave differently based on the outcome of the call. If the client applications WindowManagementEnabled function returns False, this method is not called by the OEM. Example
Dim RC As Integer ' ClientCallbackObject was passed in a Popup.Add or Object.Add call ' Assume FrameworkWindow is defined elsewhere in the OEM RC = ClientCallbackObject.Height(FrameworkWindow.Height / 2)
In this example, the OEM Gateway has requested that the client adjust the height of its window to be half the height of the framework window.
Width
Use the Width method to inform the client application to adjust the width of its display window to the new value.
Function Height(NewWidth As Single) As Integer
Parameters
NewWidth (input)
is the new width of the window. Return Value
Considerations This method is called by the OEM Gateway when the user or framework has invoked a window management function (for example, Tile or Cascade). The client application determines which window should be adjusted. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. This is a request only; the client can choose not to adjust the window width if necessary (for example, if the user has already explicitly set the width of the window). The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the client has accepted the command, and a non-zero value indicates the client cannot or will not process the command. It is important that client applications return the appropriate value, because the OEM Gateway might behave differently based on the outcome of the call. If the client applications WindowManagementEnabled function returns False, this method is not called by the OEM. Example
Dim RC As Integer ' ClientCallbackObject was passed in a Popup.Add or Object.Add call ' Assume FrameworkWindow is defined elsewhere in the OEM RC = ClientCallbackObject.Width(FrameworkWindow.Width / 2)
In this example, the OEM Gateway has requested that the client adjust the width of its window to be half the width of the framework window.
WindowCaption
The WindowCaption method returns the caption of the client applications display window.
Function WindowCaption() As String
Parameters None Return Value The window caption of the client applications display window. Considerations This method is used by the OEM Gateway, EM framework, or both to assist users in navigating to the correct client application. The client application determines which windows caption is returned. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. Example
Dim ThisCaption As String ' ClientCallbackObject was passed in a Popup.Add or Object.Add call ThisCaption = ClientCallbackObject.WindowCaption
WindowState
The WindowState method should be implemented by the client application as a pair of property procedures: Property Get (read) and Property Let (write). The OEM Gateway retrieves this value to determine the current state (normal, minimized, maximized) of the clients display window and also sets the state of the window when requested by the user. Property Get WindowState
Property Get WindowState() As Integer
Parameters None Return Value The current state of the client applications display window, corresponding to standard VB window state constants (vbNormal, vbNormal, vbMaximized, vbMinimized) Considerations This property is used by the OEM Gateway when the user or framework has invoked a window management function (for example, Minimize All or Restore All). The client application determines the window for which it will return data. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. If the client applications WindowManagementEnabled function returns False, this property is not used by the OEM. Example
Dim WS As Integer ' ClientCallbackObject was passed in a Popup.Add or Object.Add call WS = ClientCallbackObject.WindowState
Property Let WindowState

Property Let WindowState(vNewValue)
Parameters
vNewValue (input)
is the new window state.

Return Value None Considerations This property is set by the OEM Gateway when the user or framework has invoked a window management function (for example, Minimize All or Restore All). The client application determines which window is affected by the operation. It might be the main window for the application, or it might be a subordinate window that is responsible for displaying information relevant to the framework or callback object. The client can choose to ignore the request and not alter the state of any window if necessary. If the client applications WindowManagementEnabled function returns False, this property is not used by the OEM. Example
' ClientCallbackObject was passed in a Popup.Add or Object.Add call ClientCallbackObject.WindowState = vbMinimized
In the previous example, the client window would be minimized.
SetIcons
SetIcons is used to inform the client that the user has changed the default icon set within a framework, the OEM, or a client application. The client can then update its own icon set to utilize the new images if applicable.
Parameters
0 if the client has accepted the call and handled the request (even if the icon set is not updated) Non-zero if the client cannot or will not process the request
Considerations The client determines whether or not it will honor the SetIcons request and update its icon set accordingly. In some cases you might want to allow users to specify different icons sets within different components of the OEM infrastructure; in these cases, the client can simply ignore the SetIcons request. A client that calls the OEMs SetIcons method receives a SetIcons callback from the OEM; the directory name passed is identical to that supplied on the initial call. Example
Dim RC As Integer ' ClientCallbackObject was passed in a Popup.Add or Object.Add call RC = ClientCallback.SetIcons 'C:\MyIcons'
In this example, the OEM sets the icon directory to C:\MyIcons.
Framework Adapter
Framework Adapter
This section describes:
Architecture and Design Considerations for Framework Adapters (next) Adapter Request API (OEM to Adapter) on page A-36 OEM Callback API (Adapter to OEM) on page A-53 Adapter Callback API (Framework to Adapter) on page A-68
Architecture and Design Considerations for Framework Adapters

The Enterprise Management framework adapter (EM Adapter) is responsible for interfacing with a specific enterprise management framework. Requests received from the OEM Server are translated to framework-specific operations and passed to the framework. Subsequent commands received from the framework are translated to standard OEM Server operations and passed back to the server (and eventually the client application). The OEM Server communicates with the adapter using OLE Automation. Therefore, the adapter must be an OLE ActiveX server, either in-process (DLL) or out-of-process (EXE). For an adapter to function properly within the OEM environment, it must:
Fully implement the Adapter Request API. For more information, see Adapter Request API (OEM to Adapter) on page A-36. Use the OEM Callback API to communicate with the OEM Server. For more information, see OEM Callback API (Adapter to OEM) on page A-53.
In some instances, the framework might not support the full set of features available in the OEM environment. In this case, the adapter still must implement the complete Adapter Request API, even if a particular request has no meaning for the framework. The adapter design should also take into account that some frameworks might take a significant amount of time to process a request, which blocks the requester as a result. If this is the case for a particular framework, develop the adapter as an ActiveX EXE so that it has its own thread of execution. In addition, it should queue requests from the OEM Server and immediately reply back to it to avoid blocking it while the framework services the request.
Adapter Request API (OEM to Adapter)

The Adapter Request API defines the interface that the OEM Server uses to communicate with the EM Adapter. The examples included in the following descriptions are given using pseudo code similar to Visual BASIC; they might not be syntactically correct for Visual BASIC or any other environment.
Popup.Add
Popup.Add is used to add a popup menu for a given entity (class or object) to the framework. The framework subsequently uses the popup to direct commands back to the OEM Gateway, which in turn passes them through to the appropriate client application. In some cases, the framework might not support true dynamic menus, instead relying on static menus or other means of invoking commands against objects. In these cases, the adapter could choose to do nothing with the information received, but it must support the method.
Function Popup.Add(EntityName As String, MenuCaption As String, CallbackObject As Object, CallbackAppName As String, CallbackClassName As String, CallbackType As String) As Integer
Parameters
EntityName (input)
is the name of the entity to which the popup applies. This menu can be associated with entries at any level in the object hierarchy. For example, specifying CPU for the EntityName associates the popup menu with all CPU objects. Specifying \Dallas\CPU\0 associates the menu only with CPU 0 on node Dallas.
MenuCaption (input)
is the OEM Servers instantiated callback object.

CallbackAppName (input)
is the fully qualified (path included) name of the OEM Server. This can be retained by the adapter to programmatically start the server if needed.
CallbackClassName (input)
is the name of the OEM Servers callback class. This is required in cases where the CallbackObject reference has become invalid and the adapter needs to create a new callback object for the server to return command information.
CallbackType (input)
specifies whether this is a special type of menu item and callback, as follows:
<DoubleClick>
causes the client to receive an automatic callback when a user double-clicks an item in the framework where the object class name matches EntityName (for example, EntityName is Disk, and the user double-clicks Disk in the
framework). This allows default actions to be associated with double-click events, rather than requiring a user to always bring up the complete popup menu.
<Click>
causes the client to receive an automatic callback when a user clicks an item in the framework where the object class name matches EntityName (For example, EntityName is Disk, and the user clicks Disk in the framework.) This allows default actions to be associated with click events, rather than requiring a user to always bring up the complete popup menu. Set this parameter to to disable any special handling for this menu item. Not all frameworks support this feature. Return Value
0 if the request was accepted by the adapter Non-zero if the adapter cannot service the request
Considerations The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the adapter has accepted the request, and a non-zero value indicates the adapter cannot or will not process the request. It is important that the adapter return the appropriate value because the OEM Server could behave differently based on the outcome of the call. Example
Dim Adapter As New EMAdapterClass Dim OEMServerCallbackObject As New OEMServerCallbackClass Dim RC As Integer RC = Adapter.Popup.Add('DISK', 'Disk Performance', OEMServerCallbackObject, App.Path & App.EXEName, 'OEMServer.OEMServerCallbackClass')
In this example, a popup menu item is added for all DISK entities. The caption that appears on the menu is Disk Performance.
Popup.Delete
Use the Popup.Delete method to remove a popup menu for a given entity (class or object) from the framework. In some cases, the framework might not support true dynamic menus, instead relying on static menus or other means of invoking commands against objects. In these cases, the adapter might choose to do nothing with the information received, but it must support the method.
Function Popup.Delete(EntityName As String, MenuCaption As String) As Integer
Parameters
EntityName (input)
is the name of the entity to which the popup applies. This menu can be associated with entries at any level in the object hierarchy. For example, specifying CPU for the EntityName associates the popup menu with all CPU objects. Specifying \Dallas\CPU\0 associates the menu only with CPU 0 on node Dallas.
MenuCaption (input)
is the caption that appears on the popup menu for this item. Return Value
Considerations The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the adapter has accepted the request, and a non-zero value indicates the adapter cannot or will not process the request. It is important that the adapter return the appropriate value, because the OEM Server might behave differently based on the outcome of the call. Example
Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.Popup.Delete('DISK', 'Disk Performance')
In this example, the popup menu item Disk Performance is removed for all DISK entities.
Popup.Clear
Use the Popup.Clear method to remove all popup menus from the EM framework. This is particularly useful when the OEM Gateway and its clients are shutting down and nonfunctioning menu items must be removed from the framework.
Function Popup.Clear() As Integer
Considerations The adapter should remove only popup menus added by the OEM and its clients. Popup menus added through other mechanisms should remain within the framework. Example
Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.Popup.Clear
Object.Add
Use the Object.Add method to add objects to the EM Framework. Add multiple objects as part of a single operation by blocking them together. While the OEM Server can report objects at level n, the framework itself can report at a higher level. It is the adapters responsibility to roll up objects and propagate states as needed in this case.
Function Object.Add(Path As String, ObjectNames As String, CallbackObject As Object) As Integer
Parameters
Path (input)
is the full path of all objects included in ObjectNames; for example \NewYork. If this value is not , it is prefixed to each item contained in the ObjectNames list. This simplifies building the ObjectNames list for the OEM Server in cases where a large number of objects are to be added.
ObjectNames (input)
is a comma-separated list of all objects to be added, along with their states and potentially associated context. If the adapters IncludeContext method returns False (context is not to be included with object information), the format of ObjectNames is:
ObjectName[:State] [,ObjectName[:State], ] ObjectName
State
is the numerical state of the object. If the adapters IncludeContext method returns True (context is to be included with object information), the format of ObjectNames is:
ObjectName[:State[:Context]][,ObjectName[:State[:Context]], ]
ObjectName
State
is the numerical state of the object.

Context
is optional text enclosed in double quotation marks ().

is the OEM Servers instantiated callback object. The adapter uses this object to pass command information from the framework back to the OEM Server. Return Value
Considerations State might not be specified for every object in the ObjectNames list. The OEM Gateway evaluates the return value only as zero or non-zero. A zero return value from the call indicates that the adapter has accepted the request, and a non-zero value indicates the adapter cannot or will not process the request. It is important that the adapter return the appropriate value because the OEM Server might behave differently based on the outcome of the call. Example
Dim Adapter As New EMAdapterClass Dim OEMServerCallbackObject As New OEMServerCallbackClass Dim RC As Integer RC = Adapter.Object.Add('\Chicago', 'CPU\0:4, CPU\1:2', OEMServerCallbackObject)
In this example, the Path \Chicago is prefixed to each object name. This causes the object \Chicago\CPU\0 to be added with state 4 and the object \Chicago\CPU\1 to be added with state 2.
Object.Delete
Use the Object.Delete is used to remove objects from the EM Framework. Remove multiple objects as part of a single operation by blocking them together. Although the OEM Server reports objects at level n, the framework itself could report at a higher level. In these cases, the adapter and framework determine whether the higher level objects should be removed from the framework. In most cases, this decision is based on whether all subordinate objects have been removed.
Function Object.Delete(Path As String, ObjectNames As String) As Integer
Parameters Path (input) is the full path of all objects included in ObjectNames; for example \NewYork. If this value is not , it is prefixed to each item contained in the ObjectNames list. This simplifies building the ObjectNames list for the OEM Server in cases where a large number of objects are to be deleted. ObjectNames (input) is a comma-separated list of all objects to be deleted. The standard ObjectNames format is supported:
ObjectName[:State] [,ObjectName[:State], ]
But the State values are ignored for delete operations. Return Value
Considerations Delete requests from client applications first pass through the OEM Server. Once all references to a particular object have been removed, the OEM Server generates a delete request for that object and passes it to the adapter. Example Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.Object.Delete('\Chicago', 'CPU\0, CPU\1') In this example, the Path \Chicago is prefixed to each object name. This causes the objects \Chicago\CPU\0 and \Chicago\CPU\1 to be removed.
Object.Clear
Use the Object.Clear method to remove all objects from the EM framework. This is particularly useful when the OEM Gateway and its clients are shutting down and objects must be removed from the framework.
Function Object.Clear() As Integer
Considerations The adapter should remove only objects added by the OEM and its clients. Objects added through other mechanisms should remain within the framework. Example Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.Object.Clear
AdapterName
Use the AdapterName method to allow the OEM Server to determine the name of a particular adapter. This is used by the OEM when displaying messages and performing other such tasks.
Function AdapterName() As String
Parameters None Return Value The name of the adapter Example

Dim Adapter As New EMAdapterClass Dim AdptName As String AdptName = Adapter.AdapterName
SetCallback
Use the SetCallback method to inform an adapter of its OEM callback object. Usually, the adapter receives this object as part of an Object.Add or Popup.Add call. When the OEM Server must pass a callback object to an adapter outside the scope of either of these functions, however, SetCallback is used.
Sub SetCallback(CallbackObject As Object)
Parameters
is the OEM Servers instantiated callback object. The adapter uses this object to pass command information from the framework back to the OEM Server. Return Value None Considerations Because the OEM might need to update a callback object reference at any time, each adapter should implement the SetCallback method in addition to handling callback objects specified as part of a Popup.Add or Object.Add call. Example
Dim Adapter As New EMAdapterClass Dim OEMServerCallbackObject As New OEMServerCallbackClass Adapter.SetCallback OEMServerCallbackObject
IncludeContext
Use the IncludeContext method to inform the OEM Server that it should include each objects context data when calling the adapters Object.Add method. This allows the adapter to pass this additional information on to the enterprise management framework so it can be displayed to users.
Function IncludeContext() As Boolean
True if the adapter needs to receive context data for each object False if the adapter does not need to receive context data for each object
Considerations To maintain compatibility with earlier versions of adapters, the OEM Server assumes that each adapter does not accept context information. If an adapter needs to receive context as part of Object.Add calls, it must supply an IncludeContext method, and that method must return True. If the method is not supplied or it does not return True, context is not included by the OEM. The IncludeContext value is evaluated on a per-adapter basis. In environments where more than one adapter is active, a particular adapters IncludeContext setting has no impact on other adapters. Example
Dim Adapter As New EMAdapterClass Dim RC As Boolean RC = Adapter.IncludeContext If RC = True Then ' Build and send object list containing object names, states, and context Else ' Build and send object list containing object names and states only End If
IsConfigurable
Use the IsConfigurable method to allow the OEM Server to determine whether a particular adapter can be configured. If this value is true, the OEM Server calls the adapters Configure method when requested by the user. If this value is false, the user cannot alter the adapter.
Function IsConfigurable() As Boolean
True if the adapter can be configured False if the adapter cannot be configured
Considerations If this value is true, the adapters Configure method is called as needed. If this value is false, the adapters Configure method is not called. Example
Dim Adapter As New EMAdapterClass Dim Config As Boolean Config = Adapter.IsConfigurable
Configure
Use the Configure method to allow the user to set any adapter- specific options. The OEM Gateway contains a configuration interface; through this facility, users can also specify adapter properties. The adapters Configure method is called whenever the user attempts to set adapter options. At that point, the adapter can display a modal dialog to allow the user to alter adapter parameters as needed.
Function Configure() As Integer
0 if the adapter supports user-configurable options Non-zero if the adapter does not support user-configurable options
Considerations The adapter should return zero if it displayed a configuration dialog or non-zero if it did not. If a non-zero value is returned, the OEM Server informs the user that no userconfigurable options were available. Example
Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.Configure
FrameworkWindowPosition
The FrameworkWindowPosition method is used to allow the OEM Server to determine the position and size of the main framework window. These values are subsequently used by the OEM when performing window management functions.
Function FrameworkWindowPosition(Left As Single, Top As Single, Width As Single, Height As Single) As Integer
Parameters
Left (output)
is the left position of the framework window. This value is returned to the OEM Server.
Top (output)
is the top position of the framework window. This value is returned to the OEM Server.
Width (output)
is the width of the framework window. This value is returned to the OEM Server.
Height (output)
is the height of the framework window. This value is returned to the OEM Server. Return Value
0 if the adapter accepted the request Non-zero if the adapter cannot accept the request
Consideration If the adapter cannot obtain the size or position of the framework window, it should set each of the parameters to -1 and return a non-zero value. Example
Dim Dim Dim Dim Dim Dim Adapter As New EMAdapterClass RC As Integer Left As Single Top As Single Width As Single Height As Single
RC = Adapter.FrameworkPosition(Left, Top, Width, Height)
SetIcons
Use SetIcons to inform the adapter that the user has changed the default icon set within a framework, the OEM, or a client application. The adapter can then update its own icon set to utilize the new images if applicable.
Parameters
0 if the adapter has accepted the call and handled the request (even if the icon set is not updated) Non-zero if the adapter cannot or will not process the request
Considerations The adapter determines whether or not it will honor the SetIcons request and update its icon set accordingly. In some cases, you might want to allow users to specify different icons sets within different components of the OEM infrastructure; in these cases, the adapter can simply ignore the SetIcons request. An adapter that calls the OEMs SetIcons callback method receives a SetIcons call from the OEM; the directory name passed is identical to that supplied on the initial call. Example
Dim Adapter As New EMAdapterClass Dim RC As Integer RC = Adapter.SetIcons 'C:\MyIcons'
In this example, the OEM sets the icon directory to C:\MyIcons.
CloseAdapter
The CloseAdapter method is used to inform the adapter that it can shut down. The OEM server calls this method for each adapter when exiting or for a specific adapter if that adapter is deactivated by the user. Once the OEM server has called this method for an adapter, it does not attempt to communicate with the adapter again without instantiating a new adapter interface object.
Sub CloseAdapter()
Parameters None Return Value None Considerations The adapter should destroy all references to OEM server objects when this method is called. Avoid situations in which the server or adapter cannot exit due to outstanding external references. Example
Dim Adapter As New EMAdapterClass Adapter.CloseAdapter
OEM Callback API (Adapter to OEM)

The OEM Callback API defines the set of methods and properties that adapters use to pass command information back to the OEM Server. The examples included in the following descriptions are given using pseudo code similar to Visual BASIC; they might not be syntactically correct for Visual BASIC or any other environment.
Command
The Command method is used to return framework command information to the OEM Server. This method is called whenever the user selects a popup menu item in the framework, or when some other means is used to invoke a command.
Function Command(Path As String, ObjectName As String, Caption As String) As Integer
Parameters
Path (input)
is the full path of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, Path is \NewYork\DISK.
ObjectName (input)
is the name of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM.
Caption (input)
is the caption of the selected menu item. The OEM Server uses this value to determine which client application should receive the command. Return Value
0 if the OEM Server has accepted and handled the command. Non-zero if the OEM Server cannot or will not process the command
Considerations The Caption item is originally set by the client application using the Popup.Add method. The caption returned by the framework for that item must be identical to the caption specified by the client. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary.
Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.Command('\East\CPU', '3', 'State')
In this example, the caption State is passed back to the OEM Server for object \East\CPU\3. The State popup menu was originally added by the client using the Popup.Add method.
ClientMessage
Use the ClientMessage method to pass framework-specific requests or commands to a client application through the OEM Server. This allows a client to include custom features for a specific framework or a framework to include custom features for a specific client. In either case, the OEM Gateway acts as a simple router and passthrough server; any data sent from the framework is passed unaltered to the specified client.
Function ClientMessage(ClientName As String, Path As String, ObjectName As String, Message As String) As Integer
Parameters
ClientName (input)
is the name of the client to receive the message.

Path (input)
is the full path of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, Path is \NewYork\DISK. This value can be if the message does not relate to a specific object.
ObjectName (input)
is the name of the selected object. For example, if the selected object is \NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM. This value can be if the message does not relate to a specific object.
Message (input)
is the message to be passed to the client application. Return Value
0 if the OEM Server has accepted and handled the message Non-zero if the OEM Server cannot or will not process the message
Considerations The OEM Gateway determines the callback object for the message based on the given ClientName, so the client application must have made itself known previously to the OEM Gateway by specifying ClientName in a Popup.Add or Object.Add call. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary.
Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.ClientMessage('MyClientName', 'Custom Framework Message')
In this example, the message Custom Framework Message is passed back to the OEM Server and then on to the client corresponding to MyClientName.
RefreshObjects
The RefreshObjects method causes the OEM Server to repopulate the requesting adapter with all object information. This method can be used by an adapter to ensure that its object information is synchronized with that of the OEM Server.
Function RefreshObjects() As Integer
Considerations The OEM Server queues the request from the adapter and replies immediately; this is necessary to prevent potential deadlocks. Subsequent queue processing causes the adapter to receive an object update through the standard Object.Add mechanism. The OEM Server does not first clear object information from the adapter. The adapter itself should do this before making the RefreshObjects call. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.RefreshObjects
RefreshPopups
The RefreshPopups method causes the OEM Server to repopulate the requesting adapter with all popup information. This method can be used by an adapter to ensure that its popup information is synchronized with that of the OEM Server.
Function RefreshPopups() As Integer
Considerations The OEM Server queues the request from the adapter and replies immediately; this is necessary to prevent potential deadlocks. Subsequent queue processing causes the adapter to receive popup updates through the standard Popup.Add mechanism. The OEM Server does not first clear popup information from the adapter. The adapter itself should do this before making the RefreshPopups call. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.RefreshPopups
Tile
The Tile method is used to allow the EM framework to tile all client application windows.
Function Tile(Left As Single, Top As Single, Width As Single, Height As Single) As Integer
Parameters
Left (input)
is the left position of the area in which client windows are to be tiled.
Top (input)
is the top position of the area in which client windows are to be tiled.
Width (input)
is the width of the area in which client windows are to be tiled.

Height (input)
is the height of the area in which client windows are to be tiled. Return Value
Considerations When this method is called, the OEM Server uses each client callback objects Move, Height, and Width methods to tile client application windows. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary.
Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call ' Assume FrameworkWindow is defined elsewhere in the adapter RC = OEMServerCallbackObject.Tile(FrameworkWindow.Left + FrameworkWindow.Width, FrameworkWindow.Top, 200, 300)
In this example, the adapter requests that the OEM Server tile all client windows immediately to the right of the framework window, in an area 200 pixels wide x 300 pixels high.
Cascade
Use the Cascade method to allow the EM framework to cascade all client application windows.
Function Cascade(Left As Single, Top As Single, Width As Single, Height As Single) As Integer
Parameters
Left (input)
is the left position of the area in which client windows are to be cascaded.
Top (input)
is the top position of the area in which client windows are to be cascaded.
Width (input)
is the width of the area in which client windows are to be cascaded.

Height (input)
is the height of the area in which client windows are to be cascaded. Return Value
Considerations When this method is called, the OEM Server uses each client callback objects Move, Height, and Width methods to cascade client application windows. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call ' Assume FrameworkWindow is defined elsewhere in the adapter RC = OEMServerCallbackObject.Cascade(FrameworkWindow.Left, FrameworkWindow.Top + FrameworkWindow.Height, 600, 600)
In the previous example, the adapter requests that the OEM Server cascade all client windows immediately to below the framework window, in an area 600 pixels wide x 600 pixels high.
MinimizeAll
Use the MinimizeAll method to allow the EM Framework to minimize all client application windows.
Function MinimizeAll() As Integer
Considerations When this method is called, the OEM Server uses each client callback objects WindowState property to minimize client application windows. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.MinimizeAll
RestoreAll
Use the RestoreAll method to allow the EM Framework to restore all client application windows.
Function RestoreAll() As Integer
Considerations When this method is called, the OEM Server uses each client callback objects WindowState property to restore client application windows. The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not. If a non-zero value is returned, the adapter is not required to do anything. However, it might choose to perform some sort of error processing if necessary. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.MinimizeAll
LogMessage
LogMessage is used to add an event message to the OEM event log. This log serves as a central source of information relating to the OEM environment and can be viewed by users from the OEM main window. Adapters can use this facility to perform tasks such as keeping a record of errors encountered interacting with the OEM or framework or logging adapter state information.
Sub LogMessage(AdapterName As String, AdapterMessageNumber As Long, MessageText As String, Severity As Integer)
Parameters
AdapterName (input)
is an adapter-defined name used to identify the source of the event message.

AdapterMessageNumber (input)
is an adapter-defined message number for this event. The OEM Server does nothing with this value other than display it in the log, so multiple adapters can use the same message numbers.
MessageText (input)
is the event text.

Severity (input)
is the severity associated with the message, on a scale of 0 (lowest; informational message) to 3 (highest; critical problem). The OEM Server log display is sorted in descending order by event severity. Return Value None Considerations The OEM Server automatically adds the date and time to each logged message, so adapters do not need to include this information in the MessageText field. Example
' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call OEMServerCallbackObject.LogMessage 'MyAdapterName', 100, 'Adapter started', 0
In this example, the adapter logs its message 100 with severity 0.
SetIcons
Use SetIcons to inform the OEM that the user has changed the default icon set in a framework adapter. The OEM subsequently passes this update to all other adapters and clients and modifies its own icon set if the Use Common Icons option is enabled.
Parameters
0 if the OEM has accepted the call and handled the request (even if the icon set is not updated) Non-zero if the OEM cannot process the request
Considerations If the Use Common Icons option is disabled, the OEM still passes the update information to all clients and adapters. However, the OEM does not modify its own icon set to utilize the new icons given in IconDirectoryName. The adapter that called SetIcons subsequently receives a SetIcons call from the OEM; the directory name passed is identical to that supplied on the initial call. Example
Dim RC As Integer ' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call RC = OEMServerCallbackObject.SetIcons 'C:\MyIcons'
In this example, the adapter sets the icon directory to C:\MyIcons.
DebugTraceEnable
DebugTraceEnable causes the OEM server to display a trace window and log all request and command activity. This can be useful in diagnosing adapter problems during development. Trace information includes all requests from clients, requests sent to the EM framework adapter, commands received from the EM framework adapter, commands passed through to clients, and key internal information.
Sub DebugTraceEnable()

' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call OEMServerCallbackObject.DebugTraceEnable
DebugTraceDisable
DebugTraceDisable causes the OEM server to stop tracing.
Sub DebugTraceDisable()
Parameters None Return Value None Considerations Tracing must first have been enabled using DebugTraceEnable. Example
' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call OEMServerCallbackObject.DebugTraceDisable
DebugQueuePause
DebugQueuePause suspends processing of the OEM servers callback command queue. This allows a number of adapter callbacks to be queued without updating client applications.
Sub DebugQueuePause()
Parameters None Return Value None Consideration Queue processing can be reactivated using DebugQueueResume. Example
' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call OEMServerCallbackObject.DebugQueuePause
DebugQueueResume
DebugQueueResume activates processing of the OEM servers callback command queue.
Sub DebugQueueResume()
Parameters None Return Value None Consideration Queue processing must have been suspended previously using DebugQueuePause. Example
' OEMServerCallbackObject was passed in a Popup.Add or Object.Add call OEMServerCallbackObject.DebugQueueResume
Adapter Callback API (Framework to Adapter)
Adapter Callback API (Framework to Adapter)

The Adapter Callback API defines the mechanism or mechanisms used for an enterprise management framework to communicate information to its EM Adapter. Because this is an adapter-specific function, there is no standard API; the adapter determines its particular callback scheme based upon the capabilities of the framework. However, the adapter should attempt to implement all features described in this specification if it is possible within the constraints of the framework.
API Summary
This section lists the syntax for the API calls described previously. For detailed information about a particular API method or property, see the appropriate section of this document.
OEM Request API

Function ReportingLevels() As Integer Function Popup.Add(EntityName As String, MenuCaption As String, CallbackCommand As String, CallbackObject As Object, CallbackAppName As String, CallbackClassName As String, CallbackType As String, ClientName As String) As Integer Function Popup.Delete(EntityName As String, MenuCaption As String, ClientName As String) As Integer Function Popup.Cleanup(ClientName As String) As Integer Function Object.Add(Path As String, ObjectNames As String, CallbackObject As Object, ClientName As String) As Integer Function Object.Delete(Path As String, ObjectNames As String, ClientName As String) As Integer Function Object.Cleanup(ClientName As String) As Integer Sub LogMessage(ClientName As String, ClientMessageNumber As Long, MessageText As String, Severity As Integer) Function SetIcons(IconDirectoryName As String) As Integer Sub DebugDisplayPopups() Sub DebugDisplayObjects() Sub DebugTraceEnable() Sub DebugTraceDisable() Sub DebugQueuePause() Sub DebugQueueResume()
Adapter Request API
Adapter Request API

Function Popup.Add(EntityName As String, MenuCaption As String, CallbackObject As Object, CallbackAppName As String, CallbackClassName As String, CallbackType As String) As Integer Function Popup.Delete(EntityName As String, MenuCaption As String) As Integer Function Popup.Clear() As Integer Function Object.Add(Path As String, ObjectNames As String, CallbackObject As Object) As Integer Function Object.Delete(Path As String, ObjectNames As String) As Integer Function Object.Clear() As Integer Function AdapterName() As String Sub SetCallback(CallbackObject As Object) Function IncludeContext() As Boolean Function IsConfigurable() As Boolean Function Configure() As Integer Function FrameworkWindowPosition(Left As Single, Top As Single, Width As Single, Height As Single) As Integer Function SetIcons(IconDirectoryName As String) As Integer Sub CloseAdapter()
OEM Callback API
OEM Callback API

Function Command(Path As String, ObjectName As String, Caption As String) As Integer Function ClientMessage(ClientName As String, Path As String, ObjectName As String, Message As String) As Integer Function RefreshObjects() As Integer Function RefreshPopups() As Integer Function Tile(Left As Single, Top As Single, Width As Single, Height As Single) As Integer Function Cascade(Left As Single, Top As Single, Width As Single, Height As Single) As Integer Function MinimizeAll() As Integer Function RestoreAll() As Integer Sub LogMessage(AdapterName As String, AdapterMessageNumber As Long, MessageText As String, Severity As Integer) Function SetIcons(IconDirectoryName As String) As Integer Sub DebugTraceEnable() Sub DebugTraceDisable() Sub DebugQueuePause() Sub DebugQueueResume()
Client Callback API
Client Callback API

Function Command(Path As String, ObjectName As String, CallbackCommand As String) As Integer Function ClientMessage(ClientName As String, Path As String, ObjectName As String, Message As String) As Integer Function WindowManagementEnabled() As Boolean Function Move(Left As Single, Top As Single) As Integer Function Height(NewHeight As Single) As Integer Function Width(NewWidth As Single) As Integer Function WindowCaption() As String Property Get WindowState() As Integer Property Let WindowState(vNewValue) Function SetIcons(IconDirectoryName As String) As Integer
Class Name Standards

This section proposes OLE Automation class name standards for each of the OLE components that make up the OEM. This issue is significant because of the complexity of the overall environment; an inappropriately named class can lead to confusion for developers and customers alike. Anyone developing a client application or framework adapter for the OEM environment should adhere to the following standard:
Component and Function OEM Server (Request) OEM Server (Callback) Adapter (Request) Client (Callback) Class Name Template OEMServerRequestClass OEMServerCallbackClass adapternameAdapterRequestClass clientnameClientCallbackClass Example OEMServerRequestClass OEMServerCallbackClass TNGAdapterRequestClass, GenericAdapterRequestClass NSXGEMClientCallbackClass, OMFClientCallbackClass, ICCClientCallbackClass
Object Name Standards
Object Name Standards

There is a wide range of possible object names and name space conventions. Although a completely unstructured set of naming conventions is possible, this approach could lead to chaos for both users and clients. If each client adopted its own naming convention, it would be impossible for clients to share information about objects and classes that are identified with different naming rules. For clients to present a unified front for shared objects, they must use a common set of name space conventions. Objects representing Compaq NonStop Kernel entities should adhere to standard NonStop Kernel hierarchical notation, and objects representing Windows or UNIX entities should adhere to those hierarchical name space representations. For OEM, the name space should provide the following:
Hierarchical object class relationships Logical names of object class instances Association of operations with object classes Association of client callbacks with object classes Possibility for icon associations with object classes
These rules are voluntary constraints so that clients can share objects and class names. These are not limitations, and the name space constraints can be enhanced in the future as needed. The following sections summarize the abstract OEM name space conventions to be used by clients when communicating with the OEM.
Rule #1 - Hierarchical Name Space
Rule #1 - Hierarchical Name Space

Construct object names according to the following hierarchical name space rule:
name ::= class object [ class object [ class object ] ... ]
name ::= hierarchical name of the object or class instance. class ::= name of the class instance. object ::= name of the object instance. Class and object instances indicated by class object pairing should adhere to what is generally accepted as the conventional hierarchical model for the object. For example, on NonStop Kernel systems, node names are listed first. When working with hierarchical name space organizations that refer to NonStop Kernel nodes, the node name should appear first in the name.
Rule #2 - Path Delimiter

Class and object names must be separated by the path separator delimiter. This delimiter is defined as the backslash character. This character has been chosen to minimize conflicts between NonStop Kernel names, DOS 8.3 names, and Windows long file names.
Rule #3 - Null Classes and Objects

The initial class name can be null when the object name is a Compaq node name. Because a Compaq node name delimiter is also a backslash, object/class names added under a Compaq node can logically start with the backslash character delimiter. Additionally, the trailing object name can be null, thus allowing specification of classes hierarchies without underlying object instances.
Rule #4 - Case Sensitivity

Names are not case sensitive. For example, \Chicago\Disk\$System is equivalent to \chicago\disk\$system. Because the OEM maintains the case of names as they are initially defined and displays these names as such, clients should adopt case consistency conventions. Compaq recommends adopting the convention used by Windows Explorer, where the first letter of each name is in uppercase and the remainder in lowercase.
Rule #5 - Class Names

Class names that refer to classes that are shared by multiple clients must adhere to consistent use of well-known names. For example, CPU and disk classes must be referred to as "Cpu" and "Disk" by all clients that reference them:
\Chicago\Cpu\0, \Chicago\Cpu\1 \Chicago\Disk\$System, \Chicago\Disk\$Data \Chicago\Process\$Cmon \London\Transaction\London.2.8232
State Conventions
State Conventions
The OEM acts as a shared repository of state information for monitored objects. As such, each client must use an identical state reporting scheme to ensure that accurate information is reflected in the OEM and enterprise management frameworks. Client applications that use the OEM should adopt the following state reporting model: State 1 2 3 4 5 6 7 8 9 Meaning Exists, no state information is known Up or OK Low Usage Medium Usage High Usage Warning Critical Down State Degradation
Glossary
Adapter. Used as a generic term to describe the general notion of an interface adapter. It can be either the EM Adapter or the OEM Adapter. Client. Client applications that use the OEM Server. Enterprise Management (EM) Adapter. Provides an encapsulated adapter interface between the enterprise management framework and the OEM Server. It is an ActiveX component. Enterprise Management (EM) Framework. The enterprise management framework currently operating on the workstation. For example, a framework could be the Compaq OIL or Tivoli. From the client and OEM Server perspective, it does not matter which framework is running. OEM Adapter. The OEM Adapter is a generic adapter used by the OEM Gateway. This adapter also serves as an adapter skeleton as well as a means for development, test, and validation of an enterprise specific adapter. It is an ActiveX component. OEM Gateway. The term OEM Gateway refers to the overall Open Enterprise Management architecture described in this document, including the OEM Server, OEM Adapter, EM Adapter, and associated request and callback API calls. OEM Server. The term OEM Server refers to the Open Enterprise Management Server portion of the OEM Gateway described in this document. The OEM Server provides communication between the Clients and the EM Adapter. The EM Adapter in turn communicates with the enterprise management framework. It is an ActiveX component.
OEM Users Guide520330-001 Glossary -1
Glossary
OEM Server
OEM Users Guide520330-001 Glossary -2
Index
A
About window 4-40 ActiveX 1-1, 2-1, 2-2 Adapter Callback API A-68 Adapter entry adding 3-9 deleting 3-10 updating 3-10 Adapter list 3-9 Adapter priority 3-11 Adapter Request API A-36 AdapterName (Adapter Request API) A-45 Adding an adapter entry 3-9 Add/Update Adapter dialog box 3-12 Alerts window 4-1
D
DebugDisplayObjects (OEM Request API) A-18 DebugDisplayPopups (OEM Request API) A-17 DebugQueuePause (OEM Callback API) A67 DebugQueuePause (OEM Request API) A21 DebugQueueResume (OEM Callback API) A-67 DebugQueueResume (OEM Request API) A-22 DebugTraceDisable A-20 DebugTraceDisable (OEM Callback API) A-66 DebugTraceEnable (OEM Callback API) A-66 DebugTraceEnable (OEM Request API) A19 Default adapter settings, restoring 3-11
C
CA TNG Adapter 3-9, 3-11 Cascade (OEM Callback API) A-61 Client Callback API A-23 ClientMessage (Client Callback API) A-25 ClientMessage (OEM Callback API) A-55 Clients window 4-11 CloseAdapter (Adapter Request API) A-52 Command (Client Callback API) A-23 Command (OEM Callback API) A-53 Compaq Object Integration Layer (OIL) Adapter 3-9, 3-11 Configure (Adapter Request API) A-49 Configuring OEM server 3-1 Custom View facility 5-1 Custom View window 3-5 Custom View windows customizing properties 5-7 object list 5-3 working with 5-15
E
Error tracing 3-13
F
Files installed 2-1 Font settings 3-14 FrameworkWindowPosition (Adapter Request API) A-50
G
GDI resource consumption, reducing 3-15
H
Hardware requirements 1-3 Height (Client Callback API) A-30 Hierarchical display of data 5-2
OEM Users Guide 520330-001 Index- 1
Index
I
Icons limiting number used 3-15 size of 3-7 Icons window 4-38 IncludeContext (Adapter Request API) A47 Installation 2-1 Intermediate-level state information 3-2 IsConfigurable (Adapter Request API) A48
OEM Server statistics 4-36 OLE automation class name standards A-71 On Top property 3-4 Open Enterprise Management architecture 1-1
P
Popup Navigation window 4-26 Popups window 4-21 Popup.Add (Adapter Request API) A-37 Popup.Add (OEM Request API) A-6 Popup.Cleanup (OEM Request API) A-10 Popup.Clear (Adapter Request API) A-40 Popup.Delete (Adapter Request API) A-39 Popup.Delete (OEM Request API) A-9 Property Get WindowState (Client Callback API) A-33 Property Let WindowState (Client Callback API) A-33
L
Log setting size of 3-13 window 4-29 Logging and tracing options 3-12 LogMessage (OEM Callback API) A-64 LogMessage (OEM Request API) A-15
M
Max Alerts window 3-4, 4-6 MinimizeAll (OEM Callback API) A-62 Move (Client Callback API) A-28
R
RefreshObjects (OEM Callback API) A-57 RefreshPopups (OEM Callback API) A-58 Reporting levels, specifying 3-2 ReportingLevels (OEM Request API) A-5 RestoreAll (OEM Callback API) A-63 Re-Use Display Forms option 3-3
O
Object name standards A-72 Objects window 4-15 Object-based display of data 5-2 Object.Add (Adapter Request API) A-41 Object.Add (OEM Request API) A-11 Object.Cleanup (OEM Request API) A-14 Object.Clear (Adapter Request API) A-44 Object.Delete (Adapter Request API) A-43 Object.Delete (OEM Request API) A-13 OEM Callback API A-53 OEM Request API A-5 OEM Server log messages 4-33
S
SetCallback (Adapter Request API) A-46 SetIcons (Adapter Request API) A-51 SetIcons (Client Callback API) A-35 SetIcons (OEM Callback API) A-65 SetIcons (OEM Request API) A-16 Setting icon size 3-7 Software requirements 1-3 State arbitration 5-1 State filters 5-1 State reporting conventions A-74
Index
Statistics window 4-34 Supplementary display windows (for internal OEM components) 3-16 Synchronize Alerts and Clients option 3-6 System registry, changes to 2-2
T
Tile (OEM Callback API) A-59 Tiling option 3-8 Timer tracing 3-14 Trace window 4-39
U
Uninstalling OEM server 2-2
W
Width (Client Callback API) A-31 WindowCaption (Client Callback API) A32 WindowManagementEnabled (Client Callback API) A-27 WindowState (Client Callback API) A-33
Index

Oem Users Guide

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Oem Users Guide

Hochgeladen von

Copyright:

Verfügbare Formate

OEM Users Guide

U.S. Government Customers

OEM Users Guide

1. Introducing the Open Enterprise Management Server

2. Installing the Open Enterprise Management Server

Compaq Computer Corporation 520330-001 i

3. Configuring the Open Enterprise Management Server

3. Configuring the Open Enterprise Management Server

Keeping Display Windows on Top

Using the Add/Update Adapter Dialog 3-12 3-13

3. Configuring the Open Enterprise Management Server (continued)

3. Configuring the Open Enterprise Management Server (continued)

Sizing Alerts Window Columns 4-4

Navigating to Client Applications 4-6

Sizing Max Alerts Window Columns 4-9

4. OEM Windows (continued)

4. OEM Windows (continued)

Sizing Objects Window Columns 4-19 4-19 4-19 4-20

4. OEM Windows (continued)

4. OEM Windows (continued)

4. OEM Windows (continued)

4. OEM Windows (continued)

OEM Users Guide520330-001 vi

5. Custom Views (continued)

5. Custom Views (continued)

The Add/Update Specifier Dialog Box

OEM Users Guide520330-001 vii

5. Custom Views (continued)

5. Custom Views (continued)

A. OEM External Specification

Client Callback API (OEM to Client Application) ClientMessage Move A-28

WindowManagementEnabled Height A-30 Width A-31 WindowCaption A-32 WindowState A-33

OEM Users Guide520330-001 viii

A. OEM External Specification (continued)

A. OEM External Specification (continued)

Object.Add A-41 Object.Clear A-44

SetIcons A-65 DebugTraceEnable DebugTraceDisable DebugQueuePause

A. OEM External Specification (continued)

A. OEM External Specification (continued)

Glossary Index Figures

OEM Users Guide520330-001 x

Whats New in This Manual

New and Changed Information

OEM Users Guide520330-001 xi

Whats New in This Manual

New and Changed Information

OEM Users Guide520330-001 xii

About This Manual

Your Comments Invited

OEM Users Guide520330-001 xiii

About This Manual

General Syntax Notation

[ ] Brackets. Brackets enclose optional syntax items. For example:

About This Manual

General Syntax Notation

About This Manual

Notation for Messages

Notation for Messages

OEM Users Guide520330-001 xvi

About This Manual

Notation for Management Programming Interfaces

Notation for Management Programming Interfaces

OEM Users Guide520330-001 xvii