adshecho command (issues a specified event notification message as a JP1 event)
- Organization of this page
Format
adshecho [-d] event-notification-message
Description
This command issues a specified event notification message as a JP1 event. The issued JP1 event is displayed in JP1/IM - View. If you are running the debugger with the standard input and output redirected to the user-reply functionality, the specified event notification message is output to the standard output.
The JP1 event is issued after waiting for a fixed amount of time (specified in the USERREPLY_JP1EVENT_INTERVAL parameter) to elapse since the last JP1 event was issued. For details about the USERREPLY_JP1EVENT_INTERVAL parameter, see USERREPLY_JP1EVENT_INTERVAL parameter (specifies the minimum interval at which JP1 events are to be issued) in 7. Parameters Specified in the Environment Files.
Arguments
- -d
-
Specifies that during debugging, the output destination for the specified event notification message is to be set to the standard output. This option is ignored except during debugging.
When the specification is a character string that begins with a hyphen (-), it is treated as an option specification if it consists entirely of valid options. If such a character string does not consist entirely of valid hyphens, or if the character string does not begin with a hyphen (-), it is treated as an event notification message from that position.
- event-notification-message ~<any character-string>((0 to 1,023 bytes))
-
Specifies the event notification message that is to be issued as a JP1 event.
The character encoding of the specified event notification message must be consistent with the character encoding of the JP1/Base running on the same host. If the character encodings are different, characters might become garbled.
The specified event notification message is issued as a JP1 event after its contents are converted by the echo -E event-notification-message command. If more than one event notification message is specified, an error results (KNAX7403-E).
Return codes
|
Return code |
Meaning |
Response |
Whether to retry |
|---|---|---|---|
|
0 |
Normal termination |
None |
-- |
|
1 |
A non-recoverable system error occurred:
|
Contact a system administrator. |
N |
|
4 |
An error occurred in JP1 event processing. |
Take action based on the information in the error message. See 11.4.4 Handling Error Information Displayed in the User-Reply Functionality. |
Y |
|
5 |
An error occurred in JP1 event processing. |
Take action based on the information in the error message. See 11.4.4 Handling Error Information Displayed in the User-Reply Functionality. |
N |
|
6 |
The JP1 event failed to be transmitted to the specified host. |
Check the following:
|
Y |
|
7 |
The JP1/Base library cannot be found. |
Check if JP1/Base is installed on the host where JP1/Advanced Shell is installed. If JP1/Base is installed and this occurs anyway, re-install JP1/Base. |
N |
|
8 |
The connection to the JP1/Base event service on the local host failed. |
Check that the JP1/Base event service is running on the host where JP1/Advanced Shell is installed. |
Y |
|
10 |
The specified format is invalid. |
Check the format of the command. |
N |
|
128+ signal number (UNIX only) |
The adshecho command received a signal and terminated. |
Confirm that the job received a signal and terminated. |
N |
|
200 (Windows only) |
The adshecho command was forcibly terminated. |
Confirm that the job was forcibly terminated. |
N |
- Legend:
-
Y: Retry
N: Do not retry
--: Not applicable
Notes
-
Do not run this command in the background. If you run it in the background, flow control (specified by the USERREPLY_JP1EVENT_INTERVAL parameter) will not work.
-
Do not execute this command in an environment without JP1/Base and JP1/IM, unless you are running the debugger with standard input and output redirected to the user-reply functionality.
The following problems might occur during execution:
-
If JP1/Base is not installed on the host running JP1/Advanced Shell, the command will terminate with an error.
-
If the JP1/Base event service is not running on the host running JP1/Advanced Shell, the command will terminate with an error.
-
If JP1/Base or the JP1/Base event service is not running on the host specified in HOSTNAME_JP1IM_MANAGER, the command will terminate with an error.
-
-
Even if JP1/IM - Manager is not running on the host specified in HOSTNAME_JP1IM_MANAGER, the command works and will successfully transmit a JP1 event once the event reaches the JP1/Base event service on the host specified in HOSTNAME_JP1IM_MANAGER.
-
If the command terminates with an error from which it is possible to retry the command, the command might succeed when it is re-executed. Before re-executing the command, see the example job definition scripts in 3.7.5 How to handle adshecho and adshread commands that terminate with an error for help in preparing the job definition script.
-
Do not execute this command in conjunction with the pipe symbol.
-
Do not execute this command in conjunction with the redirection symbols.