9.4.4 adshechoコマンド(指定した事象通知メッセージをJP1イベントとして発行する)
形式
adshecho [-d] 事象通知メッセージ
機能
指定された事象通知メッセージをJP1イベントとして発行します。発行されたJP1イベントは,JP1/IM - Viewに表示されます。ただし,ユーザー応答機能の入出力先に標準入出力を指定してデバッグ実行した場合,事象通知メッセージを標準出力に表示します。
JP1イベントは,前回のJP1イベントの発行時刻から所定の時間(USERREPLY_JP1EVENT_INTERVALパラメーターで指定)が経過するのを待って発行されます。USERREPLY_JP1EVENT_INTERVALパラメーターについては,「7. 環境ファイルで設定するパラメーター」の「USERREPLY_JP1EVENT_INTERVALパラメーター(JP1イベントの最小発行間隔を指定する)」を参照してください。
引数
- -d
デバッグ実行時に事象通知メッセージの出力先を標準出力にします。デバッグ実行以外の場合,指定は無視されます。
「-」で始まる文字列は,すべて有効なオプション文字列が指定されている場合はオプションの指定として扱われます。不当なオプション文字列が指定された「-」で始まる文字列,または「-」で始まらない文字列が指定された場合は,その位置から事象通知メッセージとして扱われます。
- 事象通知メッセージ 〜<任意文字列>((0〜1,023バイト))
JP1イベントとして発行する事象通知メッセージを指定します。
事象通知メッセージの文字コードは,同一ホスト内で稼働するJP1/Baseと合わせてください。文字コードが異なると文字化けします。
指定された事象通知メッセージは,コマンド「echo -E 事象通知メッセージ」の実行時と同様の変換内容がJP1イベントとして発行されます。複数の事象通知メッセージが指定された場合はエラー(KNAX7403-E)となります。
終了コード
終了コード |
意味 |
対処 |
リトライの可否 |
---|---|---|---|
0 |
正常終了 |
なし。 |
− |
1 |
続行不可能なエラーが発生
|
システム管理者に連絡してください。 |
× |
4 |
JP1イベントの処理中にエラーが発生 |
メッセージに出力されたエラー情報を基に,「ユーザー応答機能で表示されるエラー情報の意味および対処方法」を参照して対処してください。 |
○ |
5 |
JP1イベントの処理中にエラーが発生 |
メッセージに出力されたエラー情報を基に,「ユーザー応答機能で表示されるエラー情報の意味および対処方法」を参照して対処してください。 |
× |
6 |
指定されたホストへのJP1イベントの転送に失敗 |
次の点を確認してください。
|
○ |
7 |
JP1/Baseのライブラリが見つからない |
Advanced Shellがインストールされているホストに,JP1/Baseがインストールされているか確認してください。 JP1/Baseがインストールされていてこの現象が発生した場合は,JP1/Baseを再インストールしてください。 |
× |
8 |
自ホストのJP1/Baseのイベントサービスの接続に失敗 |
Advanced Shellがインストールされているホストで,JP1/Baseのイベントサービスが起動しているか確認してください。 |
○ |
10 |
指定された形式が不正 |
コマンドの形式を確認してください。 |
× |
128+シグナル番号【UNIX限定】 |
adshechoコマンドがシグナルを受信して終了 |
ジョブがシグナルを受信して終了していることを確認してください。 |
× |
200【Windows限定】 |
adshechoコマンドが強制終了 |
ジョブが強制終了されていることを確認してください。 |
× |
- (凡例)
○:リトライ可
×:リトライ不可
−:対象外
注意事項
このコマンドは別プロセスで実行しないでください。別プロセスで実行した場合,流量制御(USERREPLY_JP1EVENT_INTERVALパラメーターで指定)が機能しません。
このコマンドは,ユーザー応答機能の入出力先に標準入出力を指定してデバッグ実行する場合を除いて,JP1/BaseやJP1/IMが存在しない環境では実行しないでください。
実行すると次の問題が発生します。
Advanced Shellが稼働するホストにJP1/Baseがインストールされていない場合,コマンドはエラー終了します。
Advanced Shellが稼働するホストのJP1/Baseのイベントサービスが稼働していない場合,コマンドはエラー終了します。
HOSTNAME_JP1IM_MANAGERで指定されたホストにJP1/Baseがインストールされていない,またはJP1/Baseのイベントサービスが稼働していない場合,コマンドはエラー終了します。
HOSTNAME_JP1IM_MANAGERで指定されたホストのJP1/IM - Managerが稼働していない場合でも,HOSTNAME_JP1IM_MANAGERで指定されたホストのJP1/BaseのイベントサービスにJP1イベントが到達した時点でJP1イベントの送信に成功したとしてコマンドは動作します。
リトライ可能なエラーでコマンドが終了した場合は,そのコマンドを再実行することで成功する可能性があります。コマンドを再実行したい場合は,「3.8.5 adshechoコマンドまたはadshreadコマンドがエラー終了した場合の対処」に記載しているジョブ定義スクリプトの記述例を参考として,そのコマンドを再実行するようにジョブ定義スクリプトを作成してください。
このコマンドはパイプ記号と組み合わせて実行しないでください。
このコマンドはリダイレクト記号と組み合わせて実行しないでください。