5.5.2 Inherited information
When an event monitor detects an event, it stores the information obtained. This information is called inherited information. The inherited information can be referred to using the methods described in Table 5-7 List of inherited information of event monitors.
When you want to refer to the results of execution conditions for the job executed on event, use the unit name used in execution conditions in the following table to specify a unit name in a method. When you want to refer to the results of the unit in an action flow, specify the user-defined unit name in a method.
- Example
-
-
To refer to the name of the file containing file names that is detected by the file monitor used as execution conditions:
${JDS:@Event.Monitor file.GetFlInfoList()}-
To refer to the sender of the email that is detected by the Monitoring mail reception item in an action flow:
${JDS:unit-name.GetMailFrom()} -
|
No. |
Event monitor |
Unit name used in execution conditions |
Method |
Description |
|---|---|---|---|---|
|
1 |
File monitor |
Monitor file |
unit-name.GetFlInfoList() |
Obtains the name of the file#1 that contains the full name, size, and update time of the monitored files for which the file monitor detected an event. |
|
2 |
Monitor any event |
Monitor any event |
unit-name.GetStdOutFile() |
Returns the name of the file that stores output of messages to the standard output when the monitoring conditions were met. |
|
3 |
unit-name.GetStdErrFile() |
Returns the name of the file that stores output of messages to the standard error output when the monitoring conditions were met. |
||
|
4 |
unit-name.GetStdOut() |
Returns the message output to the standard output when the monitoring condition was met.#2 |
||
|
5 |
unit-name.GetStdErr() |
Returns the message output to the standard error output when the monitoring condition was met.#2 |
||
|
6 |
unit-name.GetExitCode() |
Returns the return code of the command when the monitoring condition was met. |
||
|
7 |
Monitoring mail reception |
Monitor mail |
unit-name.GetMailBodyFilePath() |
Obtains the path of the file that stores email message text. |
|
8 |
unit-name.GetMailSubject() |
Obtains the subject of the email. |
||
|
9 |
unit-name.GetMailFrom() |
Obtains the sender of the email. |
||
|
10 |
unit-name.GetMailReplyTo() |
Obtains the email address to reply to. |
||
|
11 |
unit-name.GetMailTo() |
Obtains the email address in the To field. |
||
|
12 |
unit-name.GetMailCc() |
Obtains the email address in the CC field. |
||
|
13 |
unit-name.GetMailAttachFileList() |
Obtains the name of the file#3 that contains a list of paths of attached files. |
||
|
14 |
Windows event monitor |
Monitor Windows event |
unit-name.GetStdOut() |
Obtains the name of the Windows user who triggered the detected Windows event. |
- #1
-
The file that contains the full name, size, and update time of the monitored files is in CSV format.
Information is output to this file in the following format:
"condition","full-name-of-detected-file","file-size (bytes)","update-time-of-file (yyyy/mm/dd hh:mm:ss)"
Depending on the detected event, one of the following types is output as a condition:
-
c: The file was created.
-
d: The file was deleted.
-
m: The update time of the file was updated.
-
s: The file size was updated.
-
- #2
-
The output from the GetStdOut or GstStdErr method includes line breaks, such as \n, CR+LF, and LF. Thus, if you specify the GetStdOut or GetStdErr method as a parameter of an action item, the command line stops at the linefeed. If you are using Windows and want to output messages without linefeeds, we recommend using the cpaecho command. For details on the cpaecho command, see cpaecho in 9. Commands. If output cannot be inherited correctly, make sure that no linefeed is included in the command output.
- #3
-
Full paths to all the attached files are output to the file, with line feeds separating them.