HPUX registratio[4]
registration(4) registration(4)
NAME
registration - format for HP OvenView Network Node Manager menu
registration files
DESCRIPTION
The HP OpenView Network Node Manager (NNM) provides easy extensibility
without programming. By adding menu registration files, you can
integrate existing network and system management applications into the
HP OpenView menu bar and use the object selection capability built
into the network map. To add the menu items associated with an
application to the user interface, place a new registration file, or
edit an existing registration file in the directory
/usr/etc/nm/registration/$LANG.
An application registration file consists of one or more application
menu specifications. An application menu specification defines all of
the top level menus, cascading menus, and menu items for a given
application. The format for registration files is given below. Note
that the syntax is verbose; this was intended to increase the
readability of the file and to simplify the parser which reads the
file.
APPLICATION MENU SPECIFICATIONS
An application menu specification consists of four types of lines in
the file. The first line of an application specification must be an
OVwApplication line. The end of an application specification is
denoted by the next OVwApplication line in the file or end of file.
Between the start of the application menu specification and the end of
the application menu specification are OVwMenu, OVwCascade, and
OVwMenuItem lines which specify the top level menus, cascading menus
and menu items for the application.
Note: Any component of a specification which is a string containing
blanks must be enclosed in single quotes (').
OVwApplication
The OVwApplication line initializes the menu registration for an
application. This line must precede any other menu registration lines
associated with an application.
Syntax:
OVwApplication AppName AppType AppClass [ Argv ]
Argument Description
AppName The name of the application.
AppType Type of application For NNM, this must be TypeIII.
- 1 - Formatted: August 11, 1996
registration(4) registration(4)
AppClass The class of the application For NNM, the only
supported class is ARPA.
Argv Command line to use when invoking the application.
The special symbol {} is replaced by current
select list as arguments. For ARPA class
applications, the select list consists of the
hostnames for the selected objects. If Argv is
not specified on the OVwApplication line, an Argv
must be provided with each menu item added by the
application on a OVwMenuItem line.
OVwMenu
Add a menu label to the node manager menu bar.
Syntax:
OVwMenu Label
Argument Description
Label The label to place in the menu bar.
OVwMenuCascade
Add a cascaded menu to another menu.
Syntax:
OVwMenuCascade MenuList Label
Argument Description
MenuList Sequence of menu labels separated by @ which
uniquely specifies where to add the cascaded menu
(see example below). Think of it as an absolute
path name through the menu structure to the menu
where you want to add the label. The MenuList
must refer to an existing menu in the menu
structure created by previous OVwMenu and
OVwMenuCascade lines.
Label Label for the cascade menu.
OVwMenuItem
Add a menu item to a menu (either regular or cascaded menu).
Syntax:
OVwMenuItem MenuList Label ItemId Sharable SymType [
- 2 - Formatted: August 11, 1996
registration(4) registration(4)
Argument Description
MenuList Sequence of menu labels separated by @ which
uniquely specifies where to add the menu item (see
example below). Think of it as an absolute path
name through the menu structure to the menu where
you want to add the label. The MenuList must
refer to an existing menu in the menu structure
created by previous OVwMenu and OVwMenuCascade
lines.
Label The label for the menu item.
ItemId Application assigned number associated with the
menu item. For NNM, this argument is required but
ignored. It is recommended that the value 1 be
supplied.
Sharable Can the menu be shared? The recognized values for
this argument are Shared and Exclusive. A Shared
menu item allows other applications to share the
same menu item for different SymTypes.
SymType Type of symbol which the application supports.
The special name AllTypes indicates that the menu
item is valid for all symbols. Specifying a class
type registers the menu item for all symbols in a
given class. If an application needs to register
a menu item for several SymTypes, the OVwMenuItem
line must be repeated in the file with all
arguments containing the same value as the first
OVwMenuItem line except for the SymType. The
following symbol and class types are valid:
tab(;); lB lB l l. Class;Symbols
Computer;Host ;PC ;Workstation ;MiniComputer
;MainFrame Connector;Repeater ;Hub ;Bridge
;Gateway Device;T1Mux ;TerminalServer ;Modem
;LanAnalyzer ;Printer ;PBX ;X25Switch
Network;IPNetwork ;WAN ;VoiceNetwork
;BusSegment ;StarSegment
Argv Command line to use when invoking the application.
The special symbol {} is replaced by current
select list as arguments. The select list
consists of the hostnames for the selected
objects. If Argv is specified here, it overrides
any command line specified on the OVwApplication
line. If no Argv is specified, the command line
on the OVwMenuItem for this application line will
be used.
- 3 - Formatted: August 11, 1996
registration(4) registration(4)
EXAMPLES
The following registration file could be used to integrate the XYZ
Corporation widget control software into the menu bar. It creates a
cascade menu called "Widget Manager" under the "Control" menu with two
items, "Query" and "Reset". These items are only selectable when
"Connector", "Computer", or "Device" symbol type(s) have been selected
on the network map. The same application is invoked by the menu
items, but a different option, "-query" or "-reset", is specified.
Note: the backslashes (\) at the end of lines are provided for
readability only and are not valid in a menu registration file.
#
# XYZ Corporation Registration File
# for adding widget control program.
#
OVwApplication widget TypeIII ARPA
OVwMenu Control
OVwMenuCascade Control 'Widget Manager'
#
OVwMenuItem 'Control@Widget Manager' Query 1 Shared Connector \
'/usr/local/bin/widget -query {}'
OVwMenuItem 'Control@Widget Manager' Query 1 Shared Computer \
'/usr/local/bin/widget -query {}'
OVwMenuItem 'Control@Widget Manager' Query 1 Shared Device \
'/usr/local/bin/widget -query {}'
#
OVwMenuItem 'Control@Widget Manager' Reset 1 Shared Connector \
'/usr/local/bin/widget -reset {}'
OVwMenuItem 'Control@Widget Manager' Reset 1 Shared Computer \
'/usr/local/bin/widget -reset {}'
OVwMenuItem 'Control@Widget Manager' Reset 1 Shared Device \
'/usr/local/bin/widget -reset {}'
NOTES
The MenuList in the OVwMenuCascade and OVwMenuItem lines must refer to
a menu which has already been registered (either by the current
application or an application whose registration file has already been
processed) Currently, xnm does not process registration files in a
deterministic order, therefore write the application registration
files so that they do not depend on other applications. This is done
by adding all top level menus and cascades explicitly in the
application specification. If the label in an OVwMenu line is a
duplicate, the line is ignored. Similarly, if the MenuList and Label
in an OVwMenuCascade line duplicates an existing cascaded menu, the
line is ignored.
A conflict exists if two applications (or the same application)
attempt to register for the same menu item and symbol type. In this
case the first application to register is associated with the menu
- 4 - Formatted: August 11, 1996
registration(4) registration(4)
item and symbol. The second registration for the item fails and an
error is logged to standard error for xnm and the OVwMenuItem line is
ignored.
AUTHOR
registration was developed by HP.
- 5 - Formatted: August 11, 1996