EMS Manual

Distributor Commands and Responses
EMS Manual—426909-005
17-2
Extended Programmatic Interface
At any time, at most one application can be in charge of a distributor (can send it ADD,
ALTER, DELETE, GETEVENT and CONTROL command messages). In addition, up to
15 secondary applications can receive information from the distributor (can send it
STATUS and GETVERSION command messages). If the user has the proper access
authority (that is, super group access or the same access ID as distributors), these
secondary applications can also be used to send filter control commands (ADD,
ALTER, DELETE, REPLACE, or CONTROL) and to change the EOF delay control
parameter.
Extended Programmatic Interface
The EMS distributor supports an extended, object-oriented command set developed
before the SPI common extensions standard was released. This command set is
similar, but does not fully comply with the SPI common extensions (extended SPI)
standard.
The object-oriented distributor commands provide additional functionality relative to the
distributor commands that still use the basic SPI interface. The extended programmatic
interface for the distributor supports multiple or field-level wild-card objects in these
commands and, where appropriate, returns multiple-object information. The objects
supported are the EMS distributor (ZCOM-OBJ-DIST), EMS filter (ZCOM-OBJ-
FILTER), event source (ZCOM-OBJ-SOURCE), forwarding target (ZCOM-OBJ-
TARGET), and event destination (ZCOM-OBJ-TEXTOUT).
For all of these object types, an object hierarchy is assumed. In these cases, ZCOM-
OBJ-FILTER, -SOURCE, -TARGET, and -TEXTOUT are all considered to be
subordinate to ZCOM-OBJ-DIST. However, no hierarchical naming is allowed or
supported.
The extended programmatic interface supports the distributor commands ZCOM-CMD-
ADD, ZCOM-CMD-ALTER, ZCOM-CMD-DELETE, and ZCOM-CMD-STATUS. The
extended programmatic interface requires specification of a ZCOM object type and
ZEMS-CMD-GETEVENT Gets the next event message to pass the current filter.
GETEVENT applies only to consumer distributors.
ZEMS-CMD-GETVERSION Gets the version number of the programmatic interface.
ZEMS-CMD-REPLACE Replaces one configured filter in a distributor with another
filter.
ZCOM-CMD-STATUS
*
Gets information about the distributor, its associated filters,
event sources, and destinations.
ZEMS-CMD-STATUS Gets information about the distributor, its associated filters,
event sources, and destinations.
Table 17-1. Distributor Commands Summary (page 2 of 2) (continued)
Command Name Description
* Command supports the extended programmatic interface. (All have a ZCOM- prefix.)