8.3.6 コマンドプロパティファイル（property.xml）
利用者のユーザID/パスワードなどの情報を記述したXMLファイルです。コマンドの実行時引数として指定します。パスワードはそのままの文字列で記述しますので，アクセス権を設定するなど適切なセキュリティを設定してください。コマンドプロパティファイルの仕様を次に示します。
|
項番 |
項目 |
形式または値 |
|---|---|---|
|
1 |
ファイル形式 |
XML形式 |
|
2 |
文字コード |
UTF-8 |
|
3 |
改行コード |
CR+LF |
コマンドプロパティファイルは次の形式で記述します。
<?xml version="1.0" encoding="utf-8" ?>
<property>
<serverUrl>値</serverUrl>
<userId>値</userId>
<password>値</password>
<authenticationMethod>値</authenticationMethod>
<certificatePath>値</certficatePath>
<certificatePassword>値</certificatePassword>
<useProxy>値</useProxy>
<proxyHost>値</proxyHost>
<proxyPort>値</proxyPort>
<proxyId>値</proxyId>
<proxyPassword>値</proxyPassword>
<errorNotice>値</errorNotice>
<errorMailSubject><![CDATA[値]]></errorMailSubject>
<errorMailMessage><![CDATA[値]]></errorMailMessage>
<notificationToCompanion>値</notificationToCompanion>
</property>それぞれの設定項目について，以下に示します。
|
項番 |
設定項目 |
要素名 |
説明 |
初期設定値 |
|---|---|---|---|---|
|
1 |
接続先サーバのURL |
serverUrl |
接続先サーバのURLを指定します。 （例）https://jp1dh. hitachi.co.jp/ |
なし |
|
2 |
ユーザID |
userId |
接続先サーバへのログインユーザIDを指定します。 認証方式が「電子証明書認証」の場合は指定を省略できます。「標準パスワード認証」の場合は必ず指定する必要があります。 （例）user@company |
なし |
|
3 |
ユーザパスワード |
password |
接続先サーバへのログインユーザパスワードを指定します。 認証システムが「LDAP認証システム」の場合は，接続先のディレクトリ・サーバに登録されているパスワードを指定します。 認証方式が「電子証明書認証」の場合は指定を省略できます。「標準パスワード認証」の場合は必ず指定する必要があります。 パスワード文字列※1を平文で記述するか，パスワード文字列のダイジェスト※2を16進表記で記述してください。認証システムに「LDAP認証システム」を使用している場合，ダイジェスト形式は指定できません。 平文での記述例：password ダイジェストで指定する場合は「text:HEX:」のあとに，40文字のダイジェスト文字列を記入します。ダイジェスト文字列部分には，大文字・小文字の区別はありません。 ダイジェストは，エクスポート時にパスワード欄に表示されているものを記述できます。 ダイジェストでの記述例 text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8 なお，平文のパスワード文字列として「text:HEX:」で始まる文字列は指定できません。 （例）password |
なし |
|
4 |
認証方式 |
authenticationMethod |
認証方式を指定します。省略した場合は標準パスワード認証で動作します。
|
PASSWORD |
|
5 |
証明書ファイルのパス |
certificatePath |
証明書ファイルのパスを絶対パス形式で指定します。 認証方式に「標準パスワード認証」を使用する場合は，指定を省略できます。「電子証明書認証」を使用する場合は，必ず指定する必要があります。 |
なし |
|
6 |
証明書ファイルのパスワード |
certificatePassword |
証明書ファイルのパスワードを指定します。 認証方式に「標準パスワード認証」を使用する場合は，指定を省略できます。「電子証明書認証」を使用する場合は，必ず指定する必要があります。 |
なし |
|
7 |
プロキシ使用フラグ |
useProxy |
プロキシサーバを使用するかどうかを指定します。
大文字・小文字は区別しません。指定できる値以外を指定した場合は，エラーとなります。 （例）true |
false |
|
8 |
プロキシサーバホスト名 |
proxyHost |
プロキシサーバのホスト名またはIPアドレスを指定します。 （例1）Proxyserver （例2）192.168.0.1 |
なし |
|
9 |
プロキシサーバポート番号 |
proxyPort |
プロキシサーバのポート番号を指定します。0〜65535の範囲で指定できます。 （例）3128 |
なし |
|
10 |
プロキシ認証ID |
proxyId |
プロキシサーバの認証IDを指定します。 （例）user |
なし |
|
11 |
プロキシ認証パスワード |
proxyPassword |
プロキシサーバの認証パスワードを指定します。 （例）password |
なし |
|
12 |
コマンドエラー通知メールの要否 |
errorNotice |
コマンドの実行時にエラーが発生した場合に，エラーが発生したことを通知するメールを送付するかどうかを指定します。 送付する場合：true 送付しない場合：false 大文字・小文字は区別しません。指定できる値以外を指定した場合は，エラーとなります。項目自体が省略された場合はfalseを設定します。 このタグを2つ以上指定した場合は，最後のタグで指定した値が反映されます。 （例）true |
false |
|
13 |
コマンドエラー通知メールのタイトル |
errorMailSubject |
コマンドエラー通知メールのタイトルを，128文字以内で指定します。 指定した場合は，指定したタイトルに製品名を追加して，メールタイトルとして設定されます。 このタグの指定を省略した場合は，システムのデフォルトのメールタイトルを設定して，エラー通知メールを送信します。 指定できる文字は，一般的にメールのタイトルとして使用できる文字です。 なお，&，<，>を含む場合は，表3-9に示すXMLのエスケープ文字の形式で指定してください。指定できる値以外を指定した場合は，エラーとなります。 このタグを2つ以上指定した場合は，最後のタグで指定した値が反映されます。 |
なし |
|
14 |
コマンドエラー通知メールの本文※3 |
errorMailMessage |
コマンドエラー通知メールの本文を，512文字以内で指定します。 このタグの指定を省略した場合は，本文なしのエラー通知メールを送信します。 指定できる文字は，一般的にメールの本文として使用できる文字です。 なお，&，<，>を含む場合は，表3-9に示すXMLのエスケープ文字の形式で指定してください。指定できる値以外を指定した場合は，エラーとなります。 このタグを2つ以上指定した場合は，最後のタグで指定した値が反映されます。 |
なし |
|
15 |
配送の宛先または送信元へのエラー通知メールの要否 |
notificationToCompanion |
コマンド実行時のエラー通知メールを，送信の場合は配送の宛先ユーザに，受信の場合は配送の送信元ユーザに送付するかどうかを指定します。 なお，このタグの指定はデータ送受信管理コマンドには無効です。 送付する場合：true 送付しない場合：false 大文字・小文字は区別しません。指定できる値以外を指定した場合は，エラーとなります。項目自体が省略された場合はfalseを設定します。 このタグを2つ以上指定した場合は，最後のタグで指定した値が反映されます。 （例）true |
なし |
- 注※1
-
入力できる文字数，文字の種類は，認証ルールで設定された文字数以内の半角英数字と記号です。
使用できる記号は「!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~」です。
- 注※2
-
ダイジェストはJP1/DH - Serverがパスワードをデータベースに保管する形式で，この値から実際のパスワード文字列を復元することができない形式です。エクスポートCSVのパスワード項目には，ダイジェストの形式でパスワードの情報が出力されます。
- 注※3
-
エラー通知メールの内容を，次に示します。
JP1/DH - Server ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ■コマンドエラー通知 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ コマンドでエラーが発生しました。 実行者:コマンドの実行ユーザの名前（コマンド実行ユーザのメールアドレス） コマンド種別:コマンドの種別 ユーザが指定したメール本文 ※このメールへの返信はできません。予めご了承ください。 JP1/DH - Server
ユーザが指定するメール本文以外は，コマンド実行ユーザの設定言語に応じた言語（日本語/英語/中国語）で表示されます。
値は，XMLの入力規則に従って入力してください。特に，XMLにおける特殊な記号を使う際はご注意ください。次の文字を使用する場合は，エンティティ参照（エスケープ文字）に置き換えるか，CDATAセクションを利用してください。また，コマンドプロパティファイルの文字コードはUTF-8で保存してください。UTF-8以外で保存されていると，読み込みに失敗することがあります。
|
項番 |
文字 |
エンティティ参照による表記 |
|---|---|---|
|
1 |
< |
< |
|
2 |
> |
> |
|
3 |
& |
& |
|
4 |
" |
" |
|
5 |
' |
' |
なお，改行などの制御文字は，XMLの規格に従ったエンティティで表示される場合があります。XMLの属性の出現順は，XMLの規約に従い順序性を持ちません。
日時を表すデータはISO8601:2004に基づいたW3C-DTF形式である「YYYY-MM-DDThh:mm:ssTDZ」で表現されます。タイムゾーン（TDZ）は，OSのタイムゾーンに応じたオフセット時間となります。日本の場合は+09:00です。
設定例を次に示します。
<?xml version="1.0" encoding="utf-8" ?>
<property>
<serverUrl>https://jp1dh. hitachi.co.jp/</serverUrl>
<userId>user@company</userId>
<password>password</password>
<authenticationMethod>PASSWORD</authenticationMethod>
:
:
<useProxy>true</useProxy>
<proxyHost>proxyserver</proxyHost>
<proxyPort>8080</proxyPort>
<proxyId>proxyid</proxyId>
<proxyPassword>proxypassword</proxyPassword>
<errorNotice>true</errorNotice>
<errorMailSubject><![CDATA[エラー通知]]></errorMailSubject>
<errorMailMessage><![CDATA[エラーが発生したコマンドを確認してください。]]></errorMailMessage>
<notificationToCompanion>true</notificationToCompanion>
</property>