OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-6
OEM Request API (Client Application to OEM)
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.
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 client’s 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 client’s 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.
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