jevsendd
- Organization of this page
Function
The jevsendd command registers the JP1 events to the event server and checks whether the registration was successful. Even if a JP1 event is not registered when an event service is running, you can still use this command to check whether the event is registered.
Format
jevsendd [-i event-ID]
[-m message]
[[-e extended-attribute-name=extended-attribute-value]...]
-d destination-event-server-name
[-s source-event-server-name]
[-f initial-polling-interval-in-seconds]
[-p polling-interval-in-seconds]
[-t checking-times]
Required execution permission
In Windows: None.
In UNIX: None.
Command directory
- In Windows:
-
installation-folder\bin\
- In UNIX:
-
/opt/jp1base/bin/
Arguments
-i event-ID
Specify the event ID of the JP1 event to be registered. The specifiable range is 0 to 1FFF, and 7FFF8000 to 7FFFFFFF. If you omit this option, the default is 0.
-m message
Specify the message text of the JP1 event to be registered. The length of the message text can be no more than 1,023 bytes.
-e extended-attribute-name=extended-attribute-value
Specify the extended attributes of the JP1 event to be registered. Specify the attributes in separate lines, in the form -e extended-attribute-name=extended-attribute-value. Do not insert a blank (such as a space or tab character) between the equals sign and extended attribute value. Extended attributes are a set of no more than 100 of the following items. The total length of all the attribute values must not exceed 10,000 bytes.
|
Extended attribute |
Contents |
Format |
|---|---|---|
|
Extended attribute name |
Name that expresses the attribute meaning. |
Character string of no more than 32 bytes, consisting of alphanumeric characters, and underscores (first character an alphabetic character; all characters upper case) |
|
Extended attribute value |
Contents of the attribute |
Character string (0 to 10,000 bytes) |
JP1 events with SEVERITY specified as an extended attribute name are listed in the Event Console window of JP1/IM - View. For the SEVERITY extended attribute, specify one of the values listed in 17.1.2 Extended attributes. Be sure to write the first character in upper case.
-d destination-event-server-name
Specify the name of the destination event server. Specify the event server name as a character string of no more than 255 bytes.
- Notes
-
-
A JP1 event forwarded with this option specified cannot be acquired from the event server of the local host.
-
When the event server of a remote host is specified in this option, the retry setting in the forward-limit parameter in the event server settings file (conf) does not apply to event forwarding.
-
Do not specify any event server names that are specified for -s (or ones that are assumed when the option is omitted). Specifying the same event server name for -s and this option causes unnecessary event forwarding, which increases the risk that JP1 events cannot be registered due to forwarding errors.
-
-s source-event-server-name
Specify the name of the event server to be used for forwarding the event. You can only specify an event server that runs on the local host. If you omit this option, the logical host name set in the environment variable JP1_HOSTNAME is assumed as the event server name. If the environment variable JP1_HOSTNAME is not set, the event server name is assumed to be the same as the local host name. Specify the event server name as a character string of no more than 255 bytes.
This option is primarily for use in a cluster system.
-f initial-polling-interval (in seconds)
Specify the timeout for the first arrival verification after sending the JP1 event to the destination server, from 1 to 10 seconds. If you omit this option, the default is 3 seconds.
-p polling-interval (in seconds)
Specify the interval to the second and further arrival verifications if the JP1 event has not arrived by the first arrival verification, from 3 to 600 seconds. If you omit this option, the default is 10 seconds.
-t checking-times
Specify how many times to perform an arrival verification after the first verification, from 0 to 999 times. If you omit this option, the default is 6.
Notes
-
Insert one or more spaces between each option and its value.
-
If you want to enter one or more spaces in a message text or extended attribute value, enclose the text or value in double quotation marks (").
-
A double quotation mark (") preceded with a backslash (\") is interpreted as a double quotation mark.
-
If the special characters shown below are to be included, enclose them in double quotation marks (").
# ; | & ( ) ^ < > space, and /or tab characters
-
The number of bytes that can be specified in the command options is system-dependent. Set the length within the limits of the OS.
-
In a UNIX system, if a message or extended attribute contains non-ASCII Japanese characters, make sure the correct encoding is specified in the LANG environment variable.
-
This command does not return control until the arrival is verified or an error is detected.
Return values
|
0 |
Normal end |
|
1 |
Invalid argument |
|
2 |
Processing is continuing (if the arrival cannot be verified within the maximum time for waiting for arrival). |
|
3 |
Transfer failed |
|
255 |
Other error |
Further explanation
The following figure shows the flow of processing with the -f, -p, and -t options specified.
|
|
![[Figure]](GRAPHICS/ZU130600.GIF)
You can use the following expression to obtain the maximum time for waiting for arrival:
Maximum-time-for-waiting-for-arrival = (number-of-seconds-specified-in--f-option) + (number-of-seconds-specified-in--p-option) x (number-of-times-specified-in--t-option)
If the command cannot check the arrival within the maximum time, it outputs an error message and terminates.