csmlshistory電文の実行履歴情報の表示

形式

csmlshistory [<HCSCサーバ名>]
            [-c <クライアント相関ID>]
            [-m <メッセージ共通ID>]
            [-i <サービスリクエストID>]
            [-t <照会開始日時>,<照会終了日時>]
            [-rs <サービスリクエスタからの入力サービス名>]
            [-s <サービス名>]
            [-jm <JMSメッセージID>]
            [-jc <JMS相関識別子>]
            [-l {new|all}]
            [-d {nml|ext|msg}]
            [-ul <電文データ長>]
            [-r <表示レコード数>]
            [-k {list|count}]
            [-u <DBユーザID> [-p <DBパスワード>]]

注※ 一つ以上指定します。すべてを省略することはできません。

機能

データベースを使用する構成でHCSCサーバをセットアップした場合,電文の実行履歴の情報を表示します。HCSCサーバが停止している場合でも表示できます。

引数

<HCSCサーバ名> ~<英数字およびアンダーライン(_)> ((1-8文字))

自HCSCサーバ名を指定します。CSM_SV_NAME環境変数にHCSCサーバ名を設定すると,このオプションの指定を省略できます。

-c <クライアント相関ID> ~<英数字および記号> ((1-255文字))

クライアント相関IDで検索する場合に指定します。

-m <メッセージ共通ID> ~<英数字および記号,コロン(:),およびピリオド(.)> ((1-75文字))

メッセージ共通IDで検索する場合に指定します。

-i <サービスリクエストID> ~<英数字および記号,コロン(:),およびピリオド(.)> ((1-84文字))

サービスリクエストIDで検索する場合に指定します。

-t <照会開始日時>,<照会終了日時> ~<半角数字>

開始日時,終了日時で検索する場合に指定します。照会開始日時と照会終了日時の間のコンマ(,)の前後に余分なスペースを指定しないでください。なお,指定できる日時の形式は次の形式です。また,日時には存在するものを指定してください。

-rs <サービスリクエスタからの入力サービス名> ~<XMLスキーマのNCName型の文字列> ((1-64バイト))

サービスリクエスタの入力サービス名で検索する場合に指定します。

-s <サービス名> ~<XMLスキーマのNCName型の文字列> ((1-64バイト))

呼び出し先のサービス名で検索する場合に指定します。

-jm <JMSメッセージID> ~<英数字および記号,コロン(:),およびピリオド(.)> ((1-255文字))

JMSヘッダのJMSMessageIDの値で検索する場合に指定します。

-jc <JMS相関識別子> ~<文字列> ((1-255文字))

JMSヘッダのJMSCorrelationIDの値で検索する場合に指定します。

-l {new|all} ~<<new>>

実行履歴情報の検索方法を指定します。

-d {nml|ext|msg} ~<<nml>>

実行履歴の表示方法を指定します。

-ul <電文データ長> ~ ((0-65535バイト)) <<1024>>

出力する電文データ(ユーザ電文)の上限値を指定します。このオプションは-dオプションにmsgを指定したときだけ有効になります。また,0を指定した場合は上限値がなくなります。

-r <表示レコード数> ~<整数> ((1-1000)) <<100>>

表示するレコード数を指定します。該当するレコード数が指定値より小さい場合は,該当するレコード数だけ表示します。

-k {list|count} <<list>>

指定した条件を満たす履歴情報について,内容を表示するか,またはエントリ数を表示するかを指定します。

-u <DBユーザID>

HCSCサーバで使用しているデータベースのユーザIDを指定します。HCSCサーバが起動している場合は,このオプションを指定しても無効になります。HCSCサーバが停止している場合は,必ずこのオプションを指定します。ただし,次の条件を満たす場合は,このオプションを省略できます。

また,HCSCサーバが停止している場合でも,データベースの設定で認証が必要ないときは,このオプションを指定しないでください。

-p <DBパスワード>

HCSCサーバで使用しているデータベースのパスワードを指定します。HCSCサーバが起動している場合は,このオプションを指定しても無効になります。HCSCサーバが停止している場合は,必ずこのオプションを指定します。ただし,次の条件を満たす場合は,このオプションを省略できます。

また,HCSCサーバが停止している場合でも,データベースの設定で認証が必要ないときは,このオプションを指定しないでください。

表示形式

(1)実行履歴情報の内容(-k list指定時)

EntryCount:エントリ番号
TimeStamp:実行履歴採取時刻
HCSCServerName:受付HCSCサーバ名
ClusterName:サービス部品を呼び出したHCSCサーバのクラスタ名
HistoryDirection:実行履歴採取方向
HCSCCommonID:メッセージ共通ID
ServiceRequestID:サービスリクエストID
ClientID:クライアント相関ID
JMSMessageID:JMSメッセージID
JMSCorrelationID:JMS相関識別子
RequestType:サービスリクエスタ種別
RequestProtocolKind:リクエストのプロトコル種別
RequestServiceName:サービスリクエスタからの入力サービス名
ServiceName:呼び出し先のサービス名
ServiceKind:サービスの種別
AdapterName:サービスアダプタまたはビジネスプロセスのサービスID
ServiceProtocolKind:サービスアダプタの種類
ServiceOperationName:サービス部品のオペレーション名
ConnectProtocolKind:連携プロトコル種別
RequestUserTelegramType:ユーザ電文の種別
ResponseUserTelegramType:ユーザへの応答電文の種別
BPActivity:ビジネスプロセス用アクティビティ番号
BPProcessID:ビジネスプロセス用プロセスID
BPRequestType:ビジネスプロセス用要求タイプ
ReplyToQueueName:応答用のキュー名
RouteHistory:経路履歴情報
ErrorCode:エラー情報
Version:実行履歴情報コンテナのバージョン番号
Revision:実行履歴情報コンテナのリビジョン番号
UserTelegram:ユーザ電文

注 表示するエントリが複数ある場合,エントリごとに改行で区切ります。


説明

表示項目説明-dオプションを設定した場合に表示される情報
基本情報(nmlを指定)電文データ以外の情報(extを指定)電文データを含むすべての情報(msgを指定)
EntryCountエントリ番号を示します。
TimeStamp実行履歴採取時刻を示します。java.text.SimpleDateFormatで定義されているフォーマットに,YYYY/MM/DD hh:mm:ss.SSSの形式で表示されます。
  • YYYY:西暦年
  • MM:月
  • DD:日
  • hh:時
  • mm:分
  • ss:秒
  • SSS:ミリ秒
HCSCServerName受付HCSCサーバ名を示します。×
ClusterNameサービス部品を呼び出したHCSCサーバのクラスタ名を示します。
HistoryDirection実行履歴採取方向を示します。次のどれかが表示されます。
  • Service Request Direction:送信方向
    送信方向には次の二つの場合があります。

    ・サービスリクエスタ→メッセージング基盤→ビジネスプロセス
    ・ビジネスプロセス→メッセージング基盤→サービス部品
  • Service Response Direction:応答方向
    応答方向には次の二つの場合があります。

    ・ビジネスプロセス→メッセージング基盤→サービスリクエスタ
    ・サービス部品→メッセージング基盤→ビジネスプロセス
  • Service Error:サービス部品呼び出しエラー
  • Service Fault:サービス部品またはアダプタからのフォルト
HCSCCommonIDメッセージ共通IDを示します。
ServiceRequestIDサービスリクエストIDを示します。
ClientIDクライアント相関IDを示します。×
JMSMessageIDJMSメッセージIDを示します。×
JMSCorrelationIDJMS相関識別子を示します。×
RequestTypeサービスリクエスタ種別を示します。次のどれかが表示されます。
  • ClientProgram:クライアントプログラム
  • BusinessProcess:ビジネスプロセス
×
RequestProtocolKindリクエストのプロトコル種別を示します。次のどれかが表示されます。
  • WebService:同期(Webサービス)
  • SessionBean:同期(SessionBean)
  • MDB_WSR:非同期(MDB(WS-R))
  • MDB_DBQ:非同期(MDB(DBキュー))
  • BusinessProcess:ビジネスプロセス
×
RequestServiceNameサービスリクエスタからの入力サービス名を示します。
ServiceName呼び出し先のサービス名を示します。
ServiceKindサービス部品の種別を示します。次のどれかが表示されます。
  • ServiceAdapter:サービスアダプタ(単体サービス部品)
  • BusinessProcess:ビジネスプロセス
×
AdapterNameサービスアダプタまたはビジネスプロセスのサービスIDを示します。×
ServiceProtocolKindサービスアダプタの種類を示します。次のどれかが表示されます。
  • WebService:同期(Webサービス)
  • SessionBean:同期(SessionBean)
  • MDB_WSR:非同期(MDB(WS-R))
  • MDB_DBQ:非同期(MDB(DBキュー))
  • Custom:カスタムアダプタ
×
ServiceOperationNameサービス部品のオペレーション名を示します。×
ConnectProtocolKind連携プロトコル種別を示します。「null」が表示されます。×
RequestUserTelegramTypeユーザ電文の種別を示します。次のどれかが表示されます。
  • XML:XML電文
  • BINARY:バイナリ電文
  • ANY:任意形式の電文
×
ResponseUserTelegramTypeユーザへの応答電文の種別を示します。次のどれかが表示されます。
  • XML:XML電文
  • BINARY:バイナリ電文
  • ANY:任意形式の電文
×
BPActivityビジネスプロセス用アクティビティ番号を示します。ビジネスプロセスのアクティビティインスタンスを識別するための番号です。×
BPProcessIDビジネスプロセス用プロセスIDを示します。×
BPRequestTypeビジネスプロセス用要求タイプを示します。×
ReplyToQueueName応答用のキュー名を示します。×
RouteHistory経路履歴情報を示します。HCSCサーバ名またはサービスアダプタのサービスIDを「->」でつなげた文字列で表示されます。×
ErrorCodeエラー情報を示します。HistoryDirection=Service Errorの場合,次のどれかのエラー理由とエラーコードが表示されます。
  • HCSCサーバ内で検出したエラーのエラー理由
  • ビジネスプロセス基盤でのロールバック発生理由
  • 電文の二重配信理由
Version実行履歴情報コンテナのバージョン番号を示します。
Revision実行履歴情報コンテナのリビジョン番号を示します。
UserTelegramユーザ電文を示します。××
(凡例)
○:表示されます
×:表示されません
注※
HistoryDirection=Service Faultの場合,サービス部品やカスタムアダプタからのフォルト情報やSOAPフォルト情報の内容が,次のXML形式で表示されます(実際はすべて改行されないで表示されます)。
<SOAP1.1の場合>

<?xml version="1.0" encoding="UTF-8"?>
<cscmsgerror>
<errorcode>エラーコード</errorcode>
<errorstring>エラー情報</errorstring>
<processinstanceID/>
<errordetail>
<cscmsgcode>フォルト情報のFaultCode</cscmsgcode>
<cscmsgstring>フォルト情報のFaultString</cscmsgstring>
<cscmsgactor>フォルト情報のFaultActor</cscmsgactor>
<cscmsgdetail>フォルト情報のDetail</cscmsgdetail>
<exceptionName>フォルト名(例外名)</exceptionName>
</errordetail>
</cscmsgerror>

<SOAP1.2の場合>

<?xml version="1.0" encoding="UTF-8"?>
<cscmsgerror>
<errorcode>エラーコード</errorcode>
<errorstring>エラー情報</errorstring>
<processinstanceID/>
<errordetail>
<cscmsgcode>
<cscmsgvalue>SOAP Fault情報のCode</cscmsgvalue>
</cscmsgcode>
<cscmsgreason>
<cscmsgtext>SOAP Fault情報のReason</cscmsgtext>
</cscmsgreason>
<cscmsgnode>SOAP Fault情報のNode</cscmsgnode>
<cscmsgrole>SOAP Fault情報のRole</cscmsgrole>
<cscmsgdetail>SOAP Fault情報のDetail</cscmsgdetail>
<cscmsgfaultname>フォルト名(例外名)</cscmsgfaultname>
</errordetail>
</cscmsgerror>

(2)実行履歴情報のエントリ数(-k count指定時)

RecordCount:レコード数

説明

表示項目説明
RecordCountレコード数を示します。履歴参照条件に該当したレコードの数が表示されます。

戻り値

戻り値意味
0正常終了しました。
1コマンドが異常終了しました。
9実行権限のチェックエラーが発生しました。

注意事項