CA Automation Point Keywords › Keyword for Interfacing with Third-Party Applications › EXPORTMSG Keyword

EXPORTMSG Keyword

The EXPORTMSG keyword tells CA Automation Point to send the message to an ApExportMsg function created by the user, which then forwards messages to a third-party software application.

This keyword has the following format:

EXPORTMSG (MESSAGE(MessageText) [SOURCE(SourceOfMsg)] [SEVERITY(OneCharSevCode)]
           [APPTEXT(ApplicationText)])	

MESSAGE

Specifies the text of the message to be sent to the ApExportMsg function. For example, the CA Automation Point variable &MSG could be supplied as this parameter.

SOURCE

Specifies the name of the source of the message. If the SOURCE parameter is not supplied when the EXPORTMSG command is issued from CA Automation Point rules, the name of the session from which the message came is used as a default.

SEVERITY

Specifies a one-character severity code whose use is defined by each site. The implementation of ApExportMsg can treat severity in any fashion appropriate for the site. If the SEVERITY parameter is not supplied when the EXPORTMSG command is issued from CA Automation Point rules, a default value of E is used if the exported message is an action message; otherwise the default value is I. The default value is always I when the EXPORTMSG command is issued from a REXX program.

APPTEXT

Specifies the application text specific to your implementation of ApExportMsg. It enables you to pass application-specific text from CA Automation Point rules into ApExportMsg. For example, you may have implemented ApExportMsg to send messages to any one of several third-party applications. The contents of the APPTEXT parameter could be used to indicator to which of these third-party applications the message is to be sent.

Usage Note:

To use this command, an APOPTIONS.DLL must be created containing a function named ApExportMsg. See the EXPORTMSG.TXT file in the CA Automation Point SAMPLE\EXPORTMSG directory for details on this functionality.

Example:

Suppose that CA Automation Point receives the following message from CA OPS/MVS on the host:

OPS000I REXX IPL9672

The following sample rule invokes EXPORTMSG, which passes the message to ApExportMsg (), which provides interaction with third-party software:

MSGID (OPS000I REXX IPL9672) 
	EXPORTMSG (MESSAGE(&MSG) SEVERITY(E) SOURCE(AP3672) APPTEXT(IPL STATE))

The ApExportMsg function would take this information and make a call to the third-party software. The third-party software would evaluate the call and return a value to ApExportMsg. The ApExportMsg function would then either return a zero to CA Automation Point with no message or return a non-zero return code and an error message that would be recorded in the ASOTRACE.LOG.