Synopsis
[Windows]
jobschmsgeventex message-event-name[:project name[/job-net-name]] [-h host-name|-f file name] [-p param [-c suffix]] [-sys {all | subsystem number}] [-d mmdd | -dx| -n| -s]
[UNIX]
jobschmsgeventex message-event-name[:project name[/job-net-name]] [-h host-name] [-p param [-c suffix]] [-sys {all | subsystem number}] [-d mmdd | -dx| -n| -s]
Description
The jobschmsgeventex command generates a message event based on the process date in addition to the specifications of the conventional message event generation command (jobschmsgevent).
Options
message-event-name
Specify the message event name to be generated with 12 or fewer bytes.
project name
Specify a project name to generate message events for job nets in a specific project only.
If this option is used with the -dx, -d, -n or -s option, message events will be reported to the project specified for the operating day obtained with the -dx, -d, -n or -s option. If a project name for the operating day is specified, the operating day obtained with the -dx, -d, -n or -s option will be ignored and message events will be reported to the specified project.
job-net-name
Specify a target job net if you generate a message event only for a particular job net.
-h host-name
Specify the name of the host where a message event is to be generated. The host name must be specified with 64 or less alphanumeric characters.
-f file name [Windows]
Specify the file name that contains a list of hosts of servers where a message event is to be generated.
-p param
Specify the variable parameter to be passed to each job in the job net started by the message event. If this option is specified, the "@.VPARAM@" variables in the job definitions will be replaced with the specified variable parameter when the job net starts as a result of receiving the message event.
Specify the variable parameter using a string that is no more than 200 bytes long. The variable parameter should not include user-defined characters.
The variable parameter can be omitted. In this case, the "@.VPARAM@" variables in the job definitions will be replaced with an empty string before the jobs start.
Only job nets that wait for a single message event can receive the variable parameter specified with this option.
Variable parameters are not passed to job nets (child job nets) in the second or lower levels of nested job nets.
This option can be specified only once.
-c suffix
Use a string of up to 30 bytes long to specify the suffix that is attached to the names of job nets that are copied and started. Alphanumeric characters and hyphens (-) can be used, but only alphanumeric characters can be used for the first character. Be sure to specify this option together with (but after) the "-p" option.
Job nets that are started by specifying a variable parameter will be copied to a job net whose name has the specified suffix appended, and the copied job net will be started. For nested job nets, job nets in the second and lower levels will also be copied. This enables multiple job nets with different parameters to be executed in parallel and also allows the execution results of job nets with different parameters to be held without the execution results of one job net overwriting the execution results of another.
The names and comments of job nets that are copied become "source job net name (or comment) + underscore (_) + string specified by the suffix option".
Copying takes place when the job net starts (or, for nested job nets, when the parent job net starts). Job nets that have been copied are overwritten the next time a job net with the same name is copied.
Note that this option is invalid for job nets in groups.
-sys {all | subsystem number}
Specify the subsystem number using "all" or a value between 0 and 9 where a message event is to be generated. When "all" is specified, the message event is generated in all subsystems. If omitted, the message event is generated in subsystem 0. When, however, activated as a job for the Jobscheduler, the message event is generated in the subsystem having the same number as that of the activated-from subsystem.
-dx
This option is specified when defining this command as a job in a job net. The command cannot be executed with this option specified from the jobs that have not been registered with a schedule by dates project, or from the network jobs and distributed execution jobs that have been registered with a schedule by dates project.
If this option is specified, message events will be generated for the schedule information of the same operating day as the operating day of the job net with which this command is registered. Unlike the -s option, messages are not enabled for unapplied job nets for which Valid only on startup days has been set.
To generate message events on another host, use the -dx option together with the -h option and run as a local job.
-d mmdd
This option generates message events for schedule information of the specified operating day. Messages are not enabled for unapplied job nets for which Valid only on startup days has been set.
-n
This option is specified when defining this command as a job in a job net. The command cannot be executed with this option specified from the jobs that have not been registered with a schedule by dates project, or from the network jobs and distributed execution jobs that have been registered with a schedule by dates project.
If this option is specified, message events will be generated for schedule information of the operating day following the operating day of the job net with which this command has been registered. Messages will also be enabled for unapplied job nets for which Valid only on startup days has been set.
To generate message events on another host, use the -n option together with the -h option and run as a local job.
-s
This option is specified when defining this command as a job in a job net. The command cannot be executed with this option specified from the jobs that have not been registered with a schedule by dates project, or from the network jobs and distributed execution jobs that have been registered with a schedule by dates project.
If this option is specified, message events will be generated for the schedule information of the same operating day as the operating day of the job net with which this command is registered. Unlike the -dx option, messages are also enabled for unapplied job nets for which Valid only on startup days has been set.
To generate message events on another host, use the -s option together with the -h option and run as local job.
Return Values
Normal termination
Abended
Command Location
Windows | Systemwalker Operation Manager Installation Directory\mpwalker.jm\bin |
Solaris | /opt/FJSVstem/bin |
Privilege Required
This command is executable with the general users' privileges.
Cautions
See "Cautions" in the 4.16 jobschmsgevent Command .
It is not possible to use the -n or -s option to report message events to servers running Systemwalker Operation Manager V13.1.0 or earlier.
If this is attempted, the following error message will be output and the message event generation process will terminate abnormally:
MpStem: ERROR: 10376: The option is not supported on the specified host. (specified host name) |
Execution Results/Output Format
None
Error contents are output to the standard output.
