Knowledge Base > Agent's Job Messenger

Agent's Job Messenger

All OS agents have a Job Messenger that can be used to run and monitor jobs. You call it in the HEADER and TRAILER of Include objects. These specific job includes are available in the system client 0000.

A sample excerpt of the Include object HEADER.MVS:

//JMLDS EXEC PGM=&UC_JOBMD,
// PARM='JNR=&UC_REALNR MNR=&UC_CLIENT PNR=&UC_IP_PORT IPA=&UC_IP_ADR
//             TYP=S TXT="        Job started" 2>&1'

A sample excerpt of the Include object TRAILER.MVS:

//JMLDE    EXEC PGM=&UC_JOBMD,COND=EVEN,
// PARM='JNR=&UC_REALNR MNR=&UC_CLIENT PNR=&UC_IP_PORT IPA=&UC_IP_ADR
//             TYP=E STP=&UC_REPORT_STEPS RET=&RETCODE 2>&1'

Note that PARM statements must not exceed 100 characters.

General Start Parameters

There are several parameters that can be assigned to the Job Messenger. The following table shows the parameters that apply to all Job Messengers.

Parameter

Description

IPA

The IP address.

JNR

The RunID of the job.

MNR

Client

PNR

The port number.

RET

The return code.

TYP

The type ("S" - start Job Messenger, "E" - end Job Messenger, "V" - register a variable)

For the GCOS8 Job Messenger, the following additional rules apply: "R" - restart, "A" - abnormal end, "X" - Job Messenger stop and "J" - job report from the RSM system.

TXT

This text is subsequently output at the beginning of the job report and in the status text's detail window.

Note that the parameter TXT= is limited to 32 characters. Use blanks for the first 8 digits because they are reserved for the Automation Engine. All other digits can be used for your individual text.

Some Job Messengers have additional start parameters:

Operating system

Parameter

Description

GCOS8

RFN

The job report's file name.

 

SNM

The job's sequential number.

 

SW

The status of the Job Messenger.

 

TIMEOUT

The period in seconds after which a timeout occurs for the connection between the agent and the Job Messenger (default value: 60).

z/OS

STP

The logging of step return codes.

"0" - No logging (default value) is made.
"1" - The Job Messenger records return codes.

 

RETRY

The number of connection attempts (default value: 4).

 

WAIT

The time interval between the individual connection attempts (default value: 30 seconds).

OS/400 OUT

The Job Messenger's message logging.

"0" - No logging (default) is made.
"1" - The job report also includes Job Messenger messages.

UNIX and VMS

RETRY

The number of connection attempts.

Default value: 3 for UNIX and VMS

 

TIMEOUT

The period in seconds after which a timeout occurs for the connection between the agent and the Job Messenger (default value: 60).

 

WAIT

The time interval between the individual connection attempts.

Default value: 120 seconds for UNIX and VMS 120.

UNIX and Windows CMD

The command that should be processed on the agent's computer.

Within this command, you can also use passwords that have been encrypted by using a PromptSet object. To do so, you must specify the PromptSet variable that includes the value of the encrypted PromptSet text field. The Job Messenger automatically identifies and decrypts the passwords.

Note that the Job Messenger does NOT decrypt passwords that have been encrypted by using UCYBCRYP.EXE.

You use the message call in the Process tab of the jobs.
An example for Windows:
&UC_JOBMD CMD="ping localhost"

 

See also:

Job Includes