Using the OVOPCMSG Interface to Send Messages - ironstream_for_micro_focus_omi - 7.2

Ironstream for Micro Focus® OMi for IBM Z® Administration

Product type
Software
Portfolio
Integrate
Product family
Ironstream
Product
Ironstream > Ironstream for Micro Focus® OMi
Version
7.2
Language
English
Product name
Ironstream for Micro Focus OMi for IBM Z
Title
Ironstream for Micro Focus® OMi for IBM Z® Administration
Copyright
2021
First publish date
2007
ft:lastEdition
2023-08-23
ft:lastPublication
2023-08-23T16:21:59.136387

The OVOPCMSG interface is available to send messages directly to the Ironstream IBM Z agent without going through the system console and bypassing the mainframe message filtering. The interface may be used from the TSO command line, a batch job, or a high level language or REXX program. The use of the OVOPCMSG interface requires that the Ironstream IBM Z agent's OPC subtask be configured and active.

The OVOPCMSG has parameters that will be used to pass information to the OMi open message interface the same as using the opcmsg command on a Unix or Windows managed node. Each parameter is passed to the OVOPCMSG interface as a keyword followed by a value.

The following keywords are available:

Keyword

Description

TXT

(Required) The message text to be sent to the OMi server.

SEV

(Optional) The message severity. The severity must be one of the 5 standard OMi severities: NORMAL, WARNING, MINOR, MAJOR, or CRITICAL. The

default is NORMAL.

GRP

(Optional) The message group assigned to the message. The default is OS.

APP

(Optional) The application assigned to the message. The default is EVOPCMSG.

OBJ

(Optional) The object assigned to the message. The default is EVOPCMSG.

OPT

(Optional) The OPT parameter specifies any optional variables that are to be sent to the OMi server along with the message. The optional variable is specified first, followed by an equals sign and then the value of the optional variable. Multiple optional variables are allowed, separated by a space. For example:

OVOPCMSG "TXT=Hello" "OPT=VAR1='info' VAR2='more info'"

PORT

(Optional) The TCP port number configured for the Ironstream IBM Z agent OPC subtask. If the PORT parameter is not specified on the OPC card in SYSIN, the OVOPCMSG interface will look for the port number in the

/etc/vp390info configuration file in the HFS. The entry in the configuration file must start in column 1 with the format:

EV390_OPCMSG_PORT portnum

where portnum is the port number.

If the port number is not defined on the OPC SYSIN parameter card and is not found in the /etc/vp390info file, the default port is 6108.

SPORT

(Optional) The SPORT parameter specifies a source port that the EVOPCMSG program is to use when sending a message to the VP390 address space. If SPORT is not specified, TCP/IP will pick a random unused port number.

MFHOST

(Optional) The name of the mainframe host where the Ironstream IBM Z agent is running. If the MFHOST parameter is not specified, the OVOPCMSG interface will look for the mainframe host name in the /etc/vp390info configuration file in the HFS. The entry in the configuration file must start in column 1 with the format:

EV390_OPCMSG_HOST hostname

where hostname is the host name of the mainframe system where the Ironstream IBM Z agent is running. If the hostname is not found in the

/etc/vp390info file, the default hostname is “localhost”. If “localhost” is not defined or DNS is not configured on the mainframe system, then the OVOPCMSG interface will attempt the connection on the loopback address, 127.0.0.1.

If the OVOPCMSG module is called by a program running in Unix System Services (USS) the OVOPCMSG module should reside in a LINKLST library and an external link must be created in an HFS directory that is part of the program path (PATH environment variable) in the environment in which the program is running. For example, if the /bin directory is in the USS environment's PATH, copy the OVOPCMSG module from the Ironstream LOAD dataset into a LINKLST dataset, then use the following command in the USS environment to create the external link:

ln -e OVOPCMSG /bin/ovopcmsg

Example use from the TSO command line:

CALL 'EV390.V72.LOAD(OVOPCMSG)' '"TXT=This is a test" SEV=CRITICAL OBJ=TESTOBJ'

The Ironstream IBM Z agent's SAMP dataset contains samples for calling the OVOPCMSG interface from other programs:

Interface

SAMP member name

Assembler Program

OPCMSGA

COBOL Program

OPCMSGCO

ILE/C Program

OPCMSGC

REXX CList

OPCMSGL