B. Information Passed by Event Jobs
This appendix describes the information that can be inherited from an event job.
Information received by an event job can be referenced by succeeding jobs or jobnets. To enable referencing, open the Detailed Definition - [Receive JP1 Event] - [Passing Information] dialog box, then set the specific passing information as a macro variable. The information you can set in the macro variable depends on the type of event job. For examples of defining a macro variable, see 2.4.4(6) Passing information received by an event job.
The following table lists the passing information for each type of event job.
|
Icon name |
Variable |
Description |
Windows |
UNIX |
Size (bytes) |
|---|---|---|---|---|---|
|
Common |
CMTMOUT#1 |
Whether the job timed out t: Timed out f: Other than timeout |
Y |
Y |
1 |
|
Receive JP1 event |
EVID |
Event ID (basic-code:extended-code#2) A string representing the event ID in basic-code:extended-code format |
Y |
Y |
17 |
|
EVUSR |
Source user name |
Y |
Y |
20 |
|
|
EVGRP |
Source group name |
Y |
Y |
20 |
|
|
EVHOST |
Source event server |
Y |
Y |
255 |
|
|
EVIPADDR |
Source IP address |
Y |
Y |
39 |
|
|
EVMSG |
Message text |
Y |
Y |
1,023 |
|
|
EVDETAIL |
Detailed event information#3 |
Y |
Y |
1,023 |
|
|
EVSEV |
Extended severity levels |
Y |
Y |
11 |
|
|
EV: extended-attribute-name#4 |
Optional extended attribute |
Y |
Y |
4,085 |
|
|
EVENV1 to EVENV9#5 |
Extracted data |
Y#6 |
Y |
4,085 |
|
|
EVUSRID |
Source user ID |
Y |
Y |
10 |
|
|
EVGRPID |
Source group ID |
Y |
Y |
10 |
|
|
EVPROCESSID |
Source process ID |
Y |
Y |
10 |
|
|
EVDATE |
Event date (yyyy/mm/dd) |
Y |
Y |
10 |
|
|
EVTIME |
Event time (hh:mm:ss) |
Y |
Y |
8 |
|
|
Monitoring files |
FLFNAME |
Full path of changed file |
Y |
Y |
Windows: 258 UNIX: 509 |
|
FLCOND |
One of the following established monitoring conditions: c (Create) d (Delete) s (Change size) m (Final time write) |
Y |
Y |
1 |
|
|
FLCTIME |
File update time (yyyy/mm/dd. hh:mm:ss) |
Y |
Y |
19 |
|
|
FLSIZE |
Size of changed file |
Y |
Y |
20 |
|
|
Receive |
MLRCVADDRESS |
Sender of received mail#7 |
Y |
Y |
256#8 |
|
MLRCVSUBJECT |
Subject of received mail |
Y |
Y |
256#9 |
|
|
MLRCVBODY |
Name of file containing received mail text |
Y |
-- |
258 |
|
|
MLRCVATTACHFILEnn (nn: 01 to 20) |
Name of attached file |
Y |
-- |
258#10 |
|
|
MLRCVATTACHLIST |
Name of file listing attached files |
Y |
-- |
258#11 |
|
|
MLRCVMAILBODY |
Name of file containing the body of received mail (1 file set internally) |
-- |
Y |
452 |
|
|
MLRCVTIME |
Mail arrival time |
Y |
Y |
40 |
|
|
Receive MQ message |
MQRCVCORRELATION |
Correlation ID of received message |
Y |
Y |
24 |
|
MQRCVDISCRIMINATION |
Message ID of received message |
Y |
Y |
24 |
|
|
MQRCVQUEUE |
Name of queue which received the message |
Y |
Y |
48 |
|
|
MQRCVMODELQUEUE |
Model queue name |
Y |
Y |
48 |
|
|
MQRCVMESSAGEFILE |
Name of file in which received message was stored as a message structure (1 file set internally) |
Y |
Y |
Windows: 258 UNIX: 452 |
|
|
Receive MSMQ message |
MSRCVQUEUEPATH |
Queue path of received message |
Y |
-- |
259 |
|
MSRCVMUTUAL |
Correlation ID of received message |
Y |
-- |
20 |
|
|
MSRCVMESSAGELABEL |
Message label of received message |
Y |
-- |
249 |
|
|
MSRCVAPPLICATION |
Application information about received message (hex numeric) |
Y |
-- |
8 |
|
|
MSRCVMESSAGEFILE |
Name of file in which received message was stored as a message structure (1 file set internally) |
Y |
-- |
258 |
|
|
Log file trapping |
LFFNAME |
Full path of trapped log file |
Y |
Y |
258 |
|
LFDATA |
Trapped data (truncated if over 511 bytes) |
Y |
Y |
511 |
|
|
Monitoring event log |
NELOG |
Log type |
Y |
-- |
255 |
|
NEEVKIND |
Event type |
Y |
-- |
20 |
|
|
NESOURCE |
Source |
Y |
-- |
255 |
|
|
NECLASS |
Class |
Y |
-- |
4,085 |
|
|
NEEVID |
Event ID |
Y |
-- |
16 |
|
|
NEDETAIL |
Explanation (truncated if over 1,023 bytes) |
Y |
-- |
1,023 |
|
|
Interval control |
N/A |
N/A |
N/A |
N/A |
N/A |
- Legend:
-
Y: Can be specified
--: Cannot be specified
N/A: Not applicable
- Note1
-
The following characters are replaced by blanks if contained in the passing information:
\r, \n, \b, and \f
- Note2
-
Estimate the sizes of the macro variable names and passing information in advance so that their total size does not exceed 4,096 bytes. Be especially careful when start conditions are combined using AND. In this case, the macro variable name and passing information of all event jobs defined in the start conditions are merged. The data merged in this way could easily exceed 4,096 bytes.
- #1
-
If the event job ends normally on detecting an event, f is stored in CMTMOUT. If the timeout period is exceeded, t is stored in CMTMOUT. If the event job ends abnormally due to an error, nothing is stored in CMTMOUT.
- #2
-
For extension-code, 0 is always set.
- #3
-
Detailed event information refers to details about the basic attributes of a JP1 event, but is set only when the details are in text format. For details about the JP1 event attributes, see A.2 JP1 event attributes in the JP1/Automatic Job Management System 3 Administration Guide.
- #4
-
The extended-attribute-name is a character string of up to 32 bytes, determined by the JP1/Base event service. For details on extended attribute names, see the JP1/Base User's Guide.
- #5
-
The extracted data, if any, is stored in the following sequence in EVENV1 to EVENV9, after regular expressions are checked. Note that this sequence differs from the order in which the parameters are specified in the ajsdefine command.
-
Source user name
-
Source group name
-
Source event server
-
Message text
-
Detailed event information
-
Optional extended attribute
Within the extended attribute, regular expressions are checked in the order in which the JP1 events were received, and the extracted data, if any, is stored in order in EVENV1 to EVENV9.
-
- #6
-
This is set only when extended regular expressions are used.
- #7
-
In Windows, this variable is set to the type of information specified for the NextAddress environment setting parameter. If you specify Address, the sender's email address is set. If you specify Nickname, the sender's display name (nickname) is set.
For the setup to link with a mail system on a Windows host, see 2.3.4 Setting up the environment for the mail system linkage in the JP1/Automatic Job Management System 3 Linkage Guide.
- #8
-
If the OS of the host on which an email reception monitoring job is executed is Windows, an upper limit is placed on the number of characters and the number of bytes. The upper limit on the number of characters is 255.
- #9
-
If the OS of the host on which an email reception monitoring job is executed is Windows, an upper limit is placed on the number of characters and the number of bytes. The upper limit on the number of characters is 253.
- #10
-
Each attached file is saved, and the file name is set to the full path.
Multiple attached files are not saved in any particular order. When 21 or more files are received, only 20 file names can be passed.
- #11
-
The attached files are saved and a list of the files is created. The list file name is set to the full path.