uCosminexus Message Service Client Light for ebXML　クライアント操作ガイド

[目次][用語][索引][前へ][次へ]

6.3　クライアント共通定義ファイル

クライアント共通定義ファイルは，CMS Lightクライアントの実行環境を定義するファイルです。

ここでは，クライアント共通定義ファイルの形式，ファイルの格納先，定義する項目について説明します。

＜この節の構成＞
(1)　形式
(2)　ファイルの格納先
(3)　定義できるコンテナ
(4)　定義できるキー
(5)　定義例

(1)　形式

XML形式です。記述形式の詳細については，「6.2　定義ファイルの形式」を参照してください。

(2)　ファイルの格納先

<CMS Lightクライアントインストールディレクトリ>\conf\HSRCCommon.xml

(3)　定義できるコンテナ

クライアント共通定義ファイルで定義できるコンテナの一覧を，次の表に示します。

表6-4　クライアント共通定義ファイルで定義できるコンテナ一覧

項番 コンテナ 説明 必須/任意
1 AUTHOR オーサー情報 必須
2 PARTNER パートナー情報
3 ACCOUNT アカウント情報
4 TRANSPORT トランスポート情報 任意
5 BASIC HTTPベーシック認証情報
6 CLIENTCERTIFICATE SSLクライアント認証情報
7 TRACE_LOG トレースログの出力設定
8 ERROR_LOG エラーログの出力設定
9 MESSAGE_LOG 通信ログの出力設定
10 PUTDOCUMENT ドキュメント送信コマンドの引数情報 任意※
11 GETDOCUMENT ドキュメント受信コマンドの引数情報

注※
通常はコマンドの引数として指定するクライアント引数情報ファイルに記述しますが，クライアント共通定義ファイルにも定義できます。これらのコンテナに定義できるキーについては，「6.4　クライアント引数情報ファイル」を参照してください。
なお，PUTDOCUMENT（ドキュメント送信コマンドの引数情報）コンテナがクライアント共通定義ファイルに定義されている場合，簡易環境設定GUIでクライアント共通定義ファイルを読み込み，［OK］ボタンおよび［適用］ボタンでファイルが上書きされると，該当するコンテナは削除されます。
簡易環境設定GUIでクライアント共通定義ファイルを読み込むために，必ずGETDOCUMENT（ドキュメント受信コマンドの引数情報）コンテナを，クライアント共通定義ファイルに定義してください。

(4)　定義できるキー

クライアント共通定義ファイルで定義できるキー要素の一覧を，次の表に示します。

表6-5　クライアント共通定義ファイルで定義できるキー要素一覧

項番 コンテナ キー 説明 デフォルト値 必須/任意
1 AUTHOR
（オーサー情報）		 AUTH_ID
（クライアントID）		 サーバ企業から通知された，クライアントを認識するための識別子を，63バイト以内の文字列で指定します。AUTH_ID（クライアントID）は複数指定できます。 なし。 必須
2 PARTNER
（パートナー情報）		 PARTNER_ID
（サーバID）		 サーバ企業から通知された，取引先を認識するための識別子を，63バイト以内の文字列で指定します。PARTNER_ID（サーバID）は複数指定できます。 なし。 必須
3 ACCOUNT
（アカウント情報）		 CLIENT_URI
（CMS LightクライアントのURI）		 サーバ企業から通知された，CMS LightクライアントのURIを，255バイト以内の文字列で指定します。 なし。 必須
4 SERVER_URI
（接続先サーバのURI）		 サーバ企業から通知された，接続先サーバのURIを，255バイト以内の文字列で指定します。 なし。 必須
5 ENDPOINT
（接続先サーバのエンドポイント）		 サーバ企業から通知された，接続先サーバのURLを指定します。 なし。 必須
6 TRANSPORT
（トランスポート情報）		 PROXY_ADDRESS
（HTTPプロキシアドレス）		 HTTPプロトコルを使用してメッセージを送信する場合に，HTTPプロキシサーバのアドレスを指定します。 なし。 任意
7 PROXY_PORT
（HTTPプロキシポート）		 HTTPプロトコルを使用してメッセージを送信する場合に，HTTPプロキシサーバのポート番号を，0〜65,535の整数値で指定します。 なし。 任意
8 AUTH_USER
（HTTPプロキシ認証ユーザー）		 HTTPプロキシサーバで接続ユーザー認証をする場合に，該当するプロキシサーバの管理者から通知された，ユーザー名を指定します。ユーザー名を指定します。 なし。 任意
9 AUTH_PASSWORD
（HTTPプロキシ認証パスワード）		 HTTPプロキシサーバで接続ユーザー認証をする場合，該当するプロキシサーバの管理者から通知された，パスワードを指定します。 なし。 任意
10 SSL_PROXY_ADDRESS
（HTTPSプロキシアドレス）		 HTTPSプロトコルを使用してメッセージを送信する場合に，HTTPSプロキシサーバのアドレスを指定します。 なし。 任意
11 SSL_PROXY_PORT
（HTTPSプロキシポート）		 HTTPSプロトコルを使用してメッセージを送信する場合に，HTTPSプロキシサーバのポート番号を，0〜65,535の整数値で指定します。 なし。 任意
12 SSL_AUTH_USER
（HTTPSプロキシ認証ユーザー）		 HTTPSプロキシサーバで接続ユーザー認証をする場合に，該当するプロキシサーバの管理者から通知された，ユーザー名を指定します。 なし。 任意
13 SSL_AUTH_PASSWORD
（HTTPSプロキシ認証パスワード）		 HTTPSプロキシサーバで接続ユーザー認証をする場合に，該当するプロキシサーバの管理者から通知された，パスワードを指定します。 なし。 任意
14 BASIC
（HTTPベーシック認証情報）		 AUTH_USER
（HTTPベーシック認証ユーザー）		 HTTPベーシック認証をする場合に，サーバ企業から通知された，ユーザー名を指定します。 なし。 必須
15 AUTH_PASSWORD
（HTTPベーシック認証パスワード）		 HTTPベーシック認証をする場合に，サーバ企業から通知された，パスワードを指定します。 なし。 必須
16 CLIENTCERTIFICATE
（SSLクライアント認証情報）		 CERTIFICATE_FILE※1
（クライアント証明書ファイル）		 SSLクライアント認証をする場合に，クライアント証明書ファイルの絶対パスを指定します。 なし。 必須
17 TRACE_LOG
（トレースログの出力設定）		 DIR_PATH※2
（トレースログファイル保存先ディレクトリ）		 トレースログファイルを保存するディレクトリの絶対パスを，200バイト以内の文字列で指定します。
なお，指定したディレクトリがない場合，指定したパスにディレクトリが作成されます。		 <CMS Lightクライアントインストールディレクトリ>\log 任意
18 OUTPUT_FILE_MAX_VALUE
（トレースログファイル数）		 トレースログファイルの出力ファイル数を，1〜64の整数値で指定します。
トレースログファイルが指定したファイル数を超えた場合，ラップアラウンド形式で保存されます。		 4 任意
19 FILE_SIZE_MAX_VALUE
（トレースログファイルの最大サイズ）		 個々のトレースログファイルの最大サイズ（バイト）を，4,096〜16,777,216の整数値で指定します。
トレースログファイルのサイズが指定したサイズを超えた場合，新しいトレースログファイルが作成されます。		 8,388,608 任意
20 ERROR_LOG
（エラーログの出力設定）		 DIR_PATH※2
（エラーログファイル保存先ディレクトリ）		 エラーログファイルを保存するディレクトリの絶対パスを，200バイト以内の文字列で指定します。
省略した場合，デフォルト値に示すディレクトリに格納されます。
なお，指定したディレクトリがない場合，指定したパスにディレクトリが作成されます。		 <CMS Lightクライアントインストールディレクトリ>\log 任意
21 OUTPUT_FILE_MAX_VALUE
（エラーログファイル数）		 エラーログファイルの出力ファイル数を，1〜64の整数値で指定します。
エラーログファイルが指定したファイル数を超えた場合，ラップアラウンド形式で保存されます。		 4 任意
22 FILE_SIZE_MAX_VALUE
（エラーログファイルの最大サイズ）		 個々のエラーログファイルの最大サイズ（バイト）を，4,096〜16,777,216の整数値で指定します。
エラーログファイルのサイズが指定したサイズを超えた場合，新しいエラーログファイルが作成されます。		 8,388,608 任意
23 MESSAGE_LOG
（通信ログの出力設定）		 DIR_PATH※2
（通信ログファイル保存先ディレクトリ）		 通信ログファイルを保存するディレクトリの絶対パスを，200バイト以内の文字列で指定します。
なお，指定したディレクトリがない場合，指定したパスにディレクトリが作成されます。		 <CMS Lightクライアントインストールディレクトリ>\log 任意
24 OUTPUT_FILE_MAX_VALUE
（通信ログファイル数）		 通信ログファイルの出力ファイル数を，1〜64の整数値で指定します。
通信ログファイルが指定したファイル数を超えた場合，ラップアラウンド形式で保存されます。		 4 任意
25 FILE_SIZE_MAX_VALUE
（通信ログファイルの最大サイズ）		 個々の通信ログファイルの最大サイズ（バイト）を，4,096〜16,777,216の整数値で指定します。
通信ログファイルのサイズが指定したサイズを超えた場合，新しい通信ログファイルが作成されます。		 8,388,608 任意

注※1
SSLクライアント認証を使用する場合，クライアント証明書，およびクライアント証明書を認証するCA証明書またはクライアント証明書を認証するCA証明書チェーンのインストールが必要です。クライアント証明書ファイルは，あらかじめ自マシンにインストールしたクライアント証明書から，DERエンコードでエクスポートしたX.509形式のファイルを作成して取得してください。証明書のエクスポートの方法については，OSのドキュメントを参照してください。

注※2
ログファイルの出力先にネットワーク上の共有ファイルシステムは指定できません。

注意
  • TRANSPORTコンテナ，TRACE_LOGコンテナ，ERROR_LOGコンテナ，およびMESSAGE_LOGコンテナに対応するキーの定義はすべて任意ですが，キーをすべて省略し，コンテナだけを記述する場合はエラーとなります。
  • BASICコンテナ，およびCLIENTCERTIFICATEコンテナの定義は任意ですが，これらのコンテナを定義する場合は，対応するキーの定義が必須になります。
(a)　TRANSPORT（トランスポート情報）について

トランスポート情報について，エンドポイントがHTTPとHTTPSの場合に分けて説明します。

接続先サーバのエンドポイントがHTTPの場合
  • TRANSPORTコンテナのPROXY_ADDRESSキーとPROXY_PORTキーが存在するときは，それらをプロキシサーバ情報として使用します。さらに，AUTH_USERキーとAUTH_PASSWORDキーが存在するときは，プロキシ認証も行います。
  • TRANSPORTコンテナのPROXY_ADDRESSキーとPROXY_PORTキーが存在しないときは，プロキシサーバは使用しません。
注意
TRANSPORTコンテナのPROXY_ADDRESSキーとPROXY_PORTキーを指定するとき，またはAUTH_USERキーとAUTH_PASSWORDキーを指定するときは，同時に指定する必要があります。どちらか一方を指定したときは，定義内容のエラーとなります。

接続先サーバのエンドポイントがHTTPSの場合
  • TRANSPORTコンテナのSSL_PROXY_ADDRESSキーとSSL_PROXY_PORTキーが存在するときは，それらをプロキシサーバ情報として使用します。さらに，SSL_AUTH_USERキーとSSL_AUTH_PASSWORDキーが存在するときは，プロキシ認証も行います。
  • TRANSPORTコンテナのSSL_PROXY_ADDRESSキーとSSL_PROXY_PORTキーが存在しないときは，プロキシサーバは使用しません。
注意
SSL_PROXY_ADDRESSキーとSSL_PROXY_PORTキーを指定するとき，またはSSL_AUTH_USERキーとSSL_AUTH_PASSWORDキーを指定するときは，同時に指定する必要があります。どちらか一方を指定したときは，定義内容のエラーとなります。
なお，接続先サーバとSSL通信をする方法については，「付録A　接続先サーバとSSL通信をするための手順」を参照してください。

(5)　定義例

クライアント共通定義ファイルの定義例を次に示します。

<?xml version="1.0" encoding="Shift_JIS"?>
<Configuration
xmlns="http://www.hitachi.co.jp/soft/xml/ebxml/mscl/conf/HSRCConfig.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
  <Container id="ACCOUNT">
    <Key id="CLIENT_URI">cliuri.co.jp</Key>
    <Key id="SERVER_URI">svruri.co.jp</Key>
    <Key id="ENDPOINT">http://www.svruri.co.jp/edi-service</Key>
  </Container>
 
  <Container id="TRACE_LOG">
    <Key id="DIR_PATH">C:\Program files\Hitachi\ebxml\mscl\log</Key>
    <Key id="OUTPUT_FILE_MAX_VALUE">4</Key>
    <Key id=" FILE_SIZE_MAX_VALUE">8388608</Key>
  </Container>
 
  <Container id="ERROR_LOG">
    <Key id="DIR_PATH">C:\Program files\Hitachi\ebxml\mscl\log</Key>
    <Key id="OUTPUT_FILE_MAX_VALUE">4</Key>
    <Key id="FILE_SIZE_MAX_VALUE">8388608</Key>
  </Container>
 
  <Container id="MESSAGE_LOG">
    <Key id="DIR_PATH">C:\Program files\Hitachi\ebxml\mscl\log</Key>
    <Key id="OUTPUT_FILE_MAX_VALUE">4</Key>
    <Key id="FILE_SIZE_MAX_VALUE">8388608</Key>
  </Container>
 
  <Container id="AUTHOR">
    <Key id="AUTH_ID">4569951110016</Key>
  </Container>
 
  <Container id="PARTNER">
    <Key id="PARTNER_ID">4912345000019</Key>
  </Container>
 
</Configuration>

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.