OEM User’s 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.
Document History Part Number Product Version Published 520330-001 OEM Version 3.0 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.
OEM User’s Guide Glossary Index What’s New in This Manual xi Manual Information xi New and Changed Information xi About This Manual xiii Audience xiii Organization xiii Your Comments Invited xiii Notation Conventions xiv 1. Introducing the Open Enterprise Management Server OEM Architecture 1-1 Features of the OEM Server Version 3.0 Hardware and Software Requirements Hardware Requirements 1-2 1-3 1-3 Software Requirements 1-3 Obtaining Support 1-3 2.
3. Configuring the Open Enterprise Management Server Contents 3.
3. Configuring the Open Enterprise Management Server (continued) Contents 3. Configuring the Open Enterprise Management Server (continued) Limiting the Number of Icons Used 3-15 Supplementary Display Windows 3-16 4.
4. OEM Windows (continued) Contents 4.
4. OEM Windows (continued) Contents 4.
4. OEM Windows (continued) Contents 4.
5. Custom Views (continued) Contents 5. Custom Views (continued) Custom View Object List 5-3 Custom View Window Fields 5-4 Custom View Links Bar 5-4 Custom View Menus 5-4 File Menu 5-5 Items in the File menu control the Custom View window.
5. Custom Views (continued) Contents 5. Custom Views (continued) 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 Open Enterprise Management Server A-4 Architecture and Design Considerations for the OEM Server OEM Request API (Client Application to OEM) A-5 A-5 ReportingLevels Popup.Add A-6 Popup.Delete A-9 Popup.Cleanup A-10 Object.Add A-11 Object.
A. OEM External Specification (continued) Contents A. OEM External Specification (continued) SetIcons A-35 Framework Adapter A-36 Architecture and Design Considerations for Framework Adapters Adapter Request API (OEM to Adapter) A-36 Popup.Add A-37 A-39 Popup.Delete Popup.Clear A-40 Object.Add A-41 A-43 Object.Delete Object.
A. OEM External Specification (continued) Contents A.
What’s New in This Manual Manual Information OEM User’s Guide Abstract This manual describes the OEM Server and Enterprise Management Adapter components of the Open Enterprise Management (OEM) Gateway product.
New and Changed Information What’s New in This Manual OEM User’s Guide—520330-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.
Notation Conventions About This Manual 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.
General Syntax Notation About This Manual { } 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.
Notation for Messages About This Manual !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).
Notation for Management Programming Interfaces About This Manual [ ] 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.
Change Bar Notation About This Manual !r. The !r notation following a token or field name indicates that the token or field is required. For example: ZCOM-TKN-OBJNAME !o. token-type ZSPI-TYP-STRING. !r 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.
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.
Introducing the Open Enterprise Management Server Features of the OEM Server Version 3.
Introducing the Open Enterprise Management Server 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.
Introducing the Open Enterprise Management Server OEM User’s Guide—520330-001 1 -4 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.
Installing the Open Enterprise Management Server File Name Install Location OLEPRO32.DLL Windows system directory VB40032.DLL Windows system directory VEN2232.OLB Windows system directory Registry Changes 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.
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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server • 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.
Configuring the Open Enterprise Management Server • Keeping Display Windows on Top 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server • 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: • • 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 Logging tab if it is not already selected.
Configuring the Open Enterprise Management Server 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. 3.
Configuring the Open Enterprise Management Server 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.
Configuring the Open Enterprise Management Server 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.
4 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.
Opening an Alerts Window OEM Windows 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.
Alerts Window Menus OEM Windows 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.
Sizing Alerts Window Columns OEM Windows 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.
Keeping the Alerts Window on Top OEM Windows • 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.
Navigating to Client Applications 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 object’s state and history.
Max Alerts Window Fields OEM Windows 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.
Sorting Max Alerts Window Items OEM Windows Refresh Refreshes the data in the window. Size Columns Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Align Windows Aligns OEM windows using the dimensions of the current window. Options Opens the OEM options dialog. Close Closes this window. Close All Display Windows Closes all OEM display windows. Help Menu Items in the Help menu provide access to information about using the OEM Server.
Aligning Max Alerts Windows OEM Windows 2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Action Performed Defaults Sizes each column using the saved value for that column. Size To Window Sizes each column using a fixed percentage of available space. Size To Contents Sizes each column based on the largest item in the column. The OEM saves the adjusted column widths in the system registry.
Keeping the Max Alerts Window on Top OEM Windows 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.
Closing the Max Alerts Window OEM Windows 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.
Clients Window Menus OEM Windows Class Name The name of the client application’s OLE callback class, if one was supplied. Window Mgt. A flag indicating whether the client will participate in window management callbacks (for example, tile or cascade) from the OEM.
Sorting Clients Window Items OEM Windows Help Menu Items in the Help menu provide access to information about using the OEM Server. Menu Item Action Performed Contents Displays the Help file table of contents. Search Displays the Help file search dialog. About Displays OEM Server version information.
Locking the Clients Window OEM Windows • 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.
Refreshing Clients Window Contents OEM Windows Refreshing Clients 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.
Objects Window Fields OEM Windows 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. Path The complete path for the object. For example, if the object added is \CHICAGO\DISK\$DATA, Path contains \CHICAGO\DISK\. Name The name of the object.
Objects Window Menus OEM Windows Callback Indication of whether the client application has supplied a callback object. For Endpoints, this field contains the value if a callback object was supplied or 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.
Sorting Objects Window Items OEM Windows View Menu Items in the View menu control the Objects window and how data is displayed in it. Menu Item Action Performed Clients Displays a list of all active client applications. Objects Displays a list of all objects contained in the OEM database. Popups Displays a list of all pop-up menu items defined in the OEM. Locked Locks or unlocks the window. Stay On Top Enables or disables the On Top property of the window.
Sizing Objects Window Columns OEM Windows Sizing Objects Window Columns You can resize the columns in the Objects 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.
Keeping the Objects Window on Top OEM Windows 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. 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.
The Popups Window OEM Windows 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.
Popups Window Menus OEM Windows App Name The fully qualified name of the client application’s program file. Class Name The name of the client application’s OLE callback class, if one was supplied. Callback Type 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.
Sorting Popups Window Items OEM Windows Locked Locks or unlocks the window. Stay On Top Enables or disables the On Top property of the window. Refresh Refreshes the data in the window. Size Columns Sizes the display columns according to their contents, saved dimensions, or OEM default dimensions. Align Windows Aligns OEM windows using the dimensions of the current window. Options Opens the OEM options dialog. Close Closes this window.
Aligning Popups Windows OEM Windows 2. Choose Defaults, Size To Window, or Size To Contents. The behavior of each of these options is as follows: Menu Item Action Performed Defaults Sizes each column using the saved value for that column. Size To Window Sizes each column using a fixed percentage of available space. Size To Contents Sizes each column based on the largest item in the column. The OEM saves the adjusted column widths in the system registry.
Keeping the Popups Window on Top OEM Windows 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 window’s On Top property based upon 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.
The Popup Navigation Window OEM Windows 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.
Sorting Popup Navigation Window Items OEM Windows Help Menu Items in the Help menu provide access to information about using the OEM Server. Menu Item Action Performed Contents Displays the Help file table of contents. Search Displays the Help file search dialog. About Displays OEM Server version information.
Locking the Popup Navigation Window OEM Windows • To specify the tiling method, from the OEM Options window General tab, choose Top Down or Side By Side. Locking the Popup Navigation Window The OEM Server automatically updates all display windows whenever new data is received from a client application.
Refreshing Popup Navigation Window Contents OEM Windows Refreshing Popup Navigation 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.
Log Window Menus OEM Windows 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.
Sorting Log Window Items OEM Windows Help Menu Items in the Help menu provide access to information about using the OEM Server. Menu Item Action Performed Contents Displays the Help file table of contents. Search Displays the Help file search dialog. About Displays OEM Server version information. 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. • • Clicking once sorts objects in ascending order.
Locking the Log Window OEM Windows • 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.
Refreshing Log Window Contents OEM Windows 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.
The Statistics Window OEM Windows Message Number Description 1015 The OEM encountered an error while maintaining its popup menu table. 1016 The OEM encountered an error while maintaining its object tables. 1017 The OEM encountered an error while maintaining its client table. 1018 The OEM encountered an error while maintaining its adapter table. 1019 The OEM encountered an error while accessing the system registry.
Sorting Statistics Window Items OEM Windows View Menu Items in the View menu control the Statistics window and how data is displayed in it. Menu Item Action Performed Auto Refresh Enables or disables automatic refresh of data displayed in the window. Refresh Manually refreshes the data displayed in the window. Close Closes this window. Help Menu Items in the Help menu provide access to information about using the OEM Server.
Manually Refreshing Displayed Statistics OEM Windows • 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.
OEM Server Statistics OEM Windows Counter Name Description Custom View Forms Active The number of OEM Custom View forms that are active. Display Forms Active The number of OEM display forms that are active, not including Statistics, Icons, Trace, or About windows. Log Message Class Instances The number of items contained in the activity log. Log Table Class Instances The number of log tables in the OEM. This value should be 1 in most cases.
The Icons Window OEM Windows Counter Name Description Options Class Instances The number of options objects in the OEM. This value should be 1 in most cases. Popup Class Instances The number of active Popup Interface objects. There should be one of these for each active client application. Popup Info Class Instances The number of objects created to track entries in the Popup database. This value should match the Popup Table Items value.
Closing the Icons Window OEM Windows • 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.
The About Window OEM Windows 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.
5 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.
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.
Alerts and Max Alerts Custom Views 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.
Custom View Window Fields Custom Views Custom View Window Fields A Custom View window contains the following fields for each object: Name The fully qualified name of the object; for example, \CHICAGO\DISK\$DATA. State The numeric state of the object. This value is defined by the client application that reported the object. Context 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.
Custom View Menus Custom Views File Menu Items in the File menu control the Custom View window. Menu Item Action Performed New Custom View Creates a new Custom View window configured with the default properties. Open Opens an existing Custom View definition file using the current window. Save Saves the current Custom View properties to the active configuration file.
The Toolbar Custom Views Help Menu Items in the Help menu provide access to information about using the OEM Server. Menu Item Action Performed Contents Displays the Help file Table of Contents. Search Displays the Help file Search dialog box. About Displays OEM Server version information. The Toolbar The Custom View toolbar provides quick access to common commands and operations.
The MinState Field Custom Views 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.
Setting Object Specifiers and State Filters 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 (\).
Setting Object Specifiers and State Filters 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.
Setting Object Specifiers and State Filters 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.
Setting Object Specifiers and State Filters 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.
Choosing the Display Mode Custom Views 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 specifier’s template string. This value must conform to the rules described in Setting Object Specifiers and State Filters on page 5-7.
Selecting the View Format Custom Views 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.
Selecting the Client State Reporting Option Custom Views 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.
Working With Custom Views 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.
Creating a New Custom View Custom Views 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 window’s 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.
Saving a Custom View Configuration Custom Views 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.
Locking the Custom View Window Custom Views 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 Action Performed Defaults Sizes each column using the saved value for that column. Size To Windows Sizes each column using a fixed percentage of available space. Size To Contents Sizes each column based on the largest item in the column.
Refreshing Custom View Window Contents Custom Views To override the default value and toggle the On Top property of an individual window: • • • 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.
Closing a Custom View Window Custom Views OEM User’s Guide—520330-001 5- 20
A 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.
Architectural Overview OEM External Specification Figure A-1. OEM Information Path Example OEM Gateway Queue, State Arbitration, and Aggregation Processing EM Adapter Adapter Specific Processing EM Framework Adapter Request API Adapter Callback API OEM Request API Node, Entity, Object, State Reporting OEM Server Client Adapter Interface Transform OEM Callback API Queue, State Arbitration, and Callback Processing Client Callback API Specific Node, Entity, Object, Reporting VST100.
Architectural Overview OEM External Specification • • • • • • 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 v
Open Enterprise Management Server OEM External Specification 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 ne
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification CallbackType (input) specifies whether this is a special type of menu item and callback, as follows: '' 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).
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification Return Value • • 0 if the request was queued successfully An OEM error number if an error occurred 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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() Parameters None Return Value None Example OEM.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification 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.
OEM Request API (Client Application to OEM) OEM External Specification DebugQueuePause DebugQueuePause suspends processing of the OEM server’s 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.
OEM Request API (Client Application to OEM) OEM External Specification DebugQueueResume DebugQueueResume activates processing of the OEM server’s request queue. Sub DebugQueueResume() Parameters None Return Value None Consideration Queue processing must have been suspended previously using DebugQueuePause. Example OEM.
Client Callback API (OEM to Client Application) OEM External Specification 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.
OEM External Specification Client Callback API (OEM to Client Application) 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.
OEM External Specification Client Callback API (OEM to Client Application) 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.
OEM External Specification Client Callback API (OEM to Client Application) 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.
Client Callback API (OEM to Client Application) OEM External Specification 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.
Client Callback API (OEM to Client Application) OEM External Specification 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.
OEM External Specification Client Callback API (OEM to Client Application) 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.
Client Callback API (OEM to Client Application) OEM External Specification 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.
Client Callback API (OEM to Client Application) OEM External Specification 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.
Client Callback API (OEM to Client Application) OEM External Specification WindowCaption The WindowCaption method returns the caption of the client application’s display window. Function WindowCaption() As String Parameters None Return Value The window caption of the client application’s 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.
Client Callback API (OEM to Client Application) OEM External Specification 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 client’s display window and also sets the state of the window when requested by the user.
OEM External Specification Client Callback API (OEM to Client Application) 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.
Client Callback API (OEM to Client Application) OEM External Specification 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. Function SetIcons(IconDirectoryName As String) As Integer Parameters IconDirectoryName (input) is the name of the directory containing the object and state images to use.
Framework Adapter OEM External Specification 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 f
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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. “” 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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 adapter’s responsibility to roll up objects and propagate states as needed in this case. Function Object.
Adapter Request API (OEM to Adapter) OEM External Specification CallbackObject (input) is the OEM Server’s instantiated callback object. The adapter uses this object to pass command information from the framework back to the OEM Server. Return Value • • 0 if the request was accepted by the adapter Non-zero if the adapter cannot service the request 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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 CallbackObject (input) is the OEM Server’s instantiated callback object.
Adapter Request API (OEM to Adapter) OEM External Specification IncludeContext Use the IncludeContext method to inform the OEM Server that it should include each object’s context data when calling the adapter’s 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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 adapter’s Configure method when requested by the user. If this value is false, the user cannot alter the adapter.
Adapter Request API (OEM to Adapter) OEM External Specification 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 adapter’s 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
Adapter Request API (OEM to Adapter) OEM External Specification 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. Function SetIcons(IconDirectoryName As String) As Integer Parameters IconDirectoryName (input) is the name of the directory containing the object and state images to use.
Adapter Request API (OEM to Adapter) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification RestoreAll Use the RestoreAll method to allow the EM Framework to restore all client application windows.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification 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. Function SetIcons(IconDirectoryName As String) As Integer Parameters IconDirectoryName (input) is the name of the directory containing the object and state images to use.
OEM Callback API (Adapter to OEM) OEM External Specification 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.
OEM Callback API (Adapter to OEM) OEM External Specification DebugQueuePause DebugQueuePause suspends processing of the OEM server’s 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.
Adapter Callback API (Framework to Adapter) OEM External Specification 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.
Adapter Request API OEM External Specification 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.
OEM Callback API OEM External Specification 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 I
Client Callback API OEM External Specification 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 Proper
Object Name Standards OEM External Specification 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.
Rule #1 - Hierarchical Name Space OEM External Specification 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.
State Conventions OEM External Specification 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.
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.
OEM Server Glossary OEM User’s Guide—520330-001 Glossary -2
Index A D 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 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
I 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 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 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 win
T 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 OEM User’s Guide— 520330-001 Index- 3
W Index OEM User’s Guide— 520330-001 Index- 4
