ファイル名
任意
使用用途
ソフトウェアのパラメーターに設定する値を記述したCSV形式とXML形式のファイルです。ソフトウェアに値を設定できるパラメーターは、パラメーター設定定義で定義したパラメーターになります。
パラメーター情報の詳細については、『運用ガイド』の「パラメーター値の設定」を参照してください。
ファイル形式（CSV）
CSV形式のパラメーター情報ファイルは、以下の形式となっています。
この情報を参考にして、必要に応じてパラメーター情報を修正してください。
行の目的 | 行/列 | 1列目 | 2列目 | 3列目 | 4列目 |
|---|---|---|---|---|---|
ヘッダー | 1行目 | #Parameters | Key | Value | Status |
名前 | 2行目 | parameterInfo | name | [パラメーター情報の名前] | |
説明 | 3行目 | parameterInfo | description | [パラメーター情報の説明] | |
パラメーター | 4行目 | parameters | [パラメーターのキー] | [パラメーターの値] | [パラメーターの状態] |
・・・ | 5行目・・・ | parameters | ・・・ | ・・・ | ・・・ |
行の説明および設定内容について示します。
行の目的 | 説明 | 必須 | 設定内容 |
|---|---|---|---|
ヘッダー | 1行目の先頭に#がある場合は、CSVのヘッダーが指定されたと判定します。 | △ | 先頭の#以外は、任意の内容が指定できます。ヘッダーを指定しない場合は、行を省略します。 |
名前 | パラメーター情報の名前を指定する行になります。 | ○ | |
説明 | パラメーター情報の説明を指定する行になります。 | △ | パラメーター情報の説明を指定しない場合は、行を省略します。 |
パラメーター | パラメーターのキーと値を指定する行になります。 | △ | パラメーターのキーを指定したい数と、同じ数の行を追加します。パラメーターのキーを1つも指定しない場合は、行を省略します。 |
必須欄の記号は、以下を意味しています。
○：必ず行を指定してください。
△：行は省略可能です。
項目名の説明および設定内容について示します。
項目名の[ ]は、行単位に省略可能な項目名であることを示しています。また、すべてのパラメーターの状態を省略する場合は、4列目を省略してください。
項目名 | 型 | 設定範囲 | 説明 | 必須 | 設定内容 |
|---|---|---|---|---|---|
パラメーター情報の名前 | string | 256文字以内 | パラメーター情報の名前を指定します。 | △ | |
[ パラメーター情報の説明 ] | string | 256文字以内 | パラメーター情報の説明を指定します。 | △ | |
パラメーターのキー | string | boolean型、number型、string型合 string array型、map型 | パラメーターのキーを指定します。string array型の場合は、インデックスも指定します。map型の場合は、サブキーも指定します。 | ○ | パラメーター設定定義に含まれるkeyだけが指定可能です。 string array型のインデックスやmap型のサブキーは、[ ] (角括弧)で囲います。string array型のインデックスは「1」から開始します。 「パラメーターリファレンス」のパラメーター設定定義を使用する場合は、そのパラメーターのキーを指定します。 |
パラメーターの値 | string | 4096文字以内 | パラメーターの値を指定します。 | △ | 値は、パラメーター設定定義の制約に依存します。値の詳細については、『運用ガイド』の「事前定義のパラメーター」を参照してください。 |
パラメーターの状態 | string | 32文字以内 | パラメーターの値を指定します。 | △ | パラメーターを設定するか、設定しないかの状態を指定します。状態は以下の値が設定できます。
|
必須欄の記号は、以下を意味しています。
○：必ず値を指定してください。
△：値は省略可能です。
キーと値の記述方法を、以下の表に示します。
パラメーター | 記述方法 | ||
|---|---|---|---|
型 | 値の特徴 | キー | 値 |
boolean | 値の指定あり | キー | 値 |
number | 値の指定あり | キー | 値 |
string | 値の指定あり | キー | 値 |
空文字 | キー | 空文字 | |
string array | 値の指定あり | キー[インデックス] | 値 |
空文字 | キー[インデックス] | 空文字 | |
要素が0個 | キー | 空文字 | |
map | 値の指定あり | キー[サブキー] | 値 |
空文字 | キー[サブキー] | 空文字 | |
エントリーが0個 | キー | 空文字 | |
使用例（CSV）
#Parameters,Key,Value,Status parameterInfo,name,Parameter Info, parameterInfo,description,Parameter Info, parameters,key.isParameter,true,set parameters,key.number,100,set parameters,key.parameter,parameter,set parameters,key.parameter.list[1],first,set parameters,key.parameter.list[2],second,set parameters,key.parameter.list[subkey.right],right,set parameters,key.parameter.list[subkey.left],left,set
ファイル形式（XML）
XML形式のパラメーター情報ファイルは、以下の形式となっています。
この情報を参考にして、必要に応じてパラメーター情報を修正してください。
<?xml version="1.0" encoding="UTF-8"?> <parameterInfo version="3.0"> <name>[パラメーター情報の名前]</name> <description>[説明]</description> <parameters> <parameter> <key>[パラメーターのキー]</key> <value>[パラメーターの値(boolean、number、stringの場合)]</value> <array>[パラメーターの値(string arrayの場合)] <element>[配列の値]</element> … </array> <map>[パラメーターの値(mapの場合)] <entry> <subkey>[マップのサブキー]</subkey> <value>[マップの値]</value> </entry> … </map> </parameter> … </parameters> </parameterInfo>
以下にそれぞれの項目 (タグ) の説明および設定内容について示します。
タグ名の[ ]は、省略可能なタグであることを示しています。
タグ名 | 型 | 設定範囲 | 説明 | 必須 | 設定内容 |
|---|---|---|---|---|---|
name | string | 256文字以内 | パラメーター情報の名前を指定します。 | △ | |
[ description ] | string | 256文字以内 | パラメーター情報の説明を指定します。 | △ | |
parameters | － | － | ソフトウェアに設定する複数のパラメーターを指定します。 | × | |
[ parameter ] | － | 0個以上 | ソフトウェアに設定するパラメーターをキーと値で指定します。 | × | |
key | string | 1～256Bytes | パラメーターのキーを指定します。 | ○ | パラメーター設定定義に含まれるkeyだけが指定可能です。 「パラメーターリファレンス」のパラメーター設定定義を使用する場合は、そのパラメーターのキーを指定します。 |
[ value ] | string | 4096文字以内 | パラメーターの値を指定します。 型がboolean、number、stringの場合は、valueタグを使用して値を指定します。valueタグ、arrayタグおよびmapタグは、1つを指定する必要はありますが、同時に複数を指定できません。 | △ | 値は、パラメーター設定定義の制約に依存します。値の詳細については、『運用ガイド』の「事前定義のパラメーター」を参照してください。 |
[ array ] | － | － | パラメーターの値を指定します。 型がstring arrayの場合は、arrayタグを使用して値を指定します。valueタグ、 arrayタグおよびmapタグは、1つを指定する必要はありますが、同時に複数を指定できません。 | × | 配列の要素は、elementタグで指定します。0個の配列は、elementタグを指定しません。 |
[ element ] | string | 4096文字以内 | パラメーターの値の型が配列の場合に、配列の要素を指定します。 | ○ | 配列の要素を文字列で指定します。空文字の指定も可能です。 |
[ map ] | － | － | パラメーターの値を指定します。 型がmapの場合は、mapタグを使用して値を指定します。valueタグ、arrayタグおよびmapタグは、1つを指定する必要はありますが、同時に複数を指定できません。 | × | mapのエントリーは、entryタグで指定します。0個のマップは、entryタグを指定しません。 |
[ entry ] | － | － | パラメーターの値の型がマップの場合に、1つのキーと値の組にentryタグを使用して値を指定します。 | × | キーと値を、keyタグとvalueタグで指定します。 |
subkey | string | 1～256Bytes | パラメーターの値の型がマップの場合に、サブキーを指定します。 | ○ | 使用可能文字は英数字、「.」、「_」および「-」です。 ただし、先頭は英字だけです。 |
value | string | 4096文字以内 | パラメーターの値の型がマップの場合に、値を指定します。 | ○ | マップの値を文字列で指定します。空文字の指定も可能です。 |
必須欄の記号は、以下を意味しています。
○：タグを指定した場合は、必ず値を指定してください。
△：値は省略可能です。
×：値の設定は不要です。タグだけの指定です。
使用例（XML）
<?xml version="1.0" encoding="UTF-8"?> <parameterInfo version="3.0"> <name>Parameter Info</name> <description>Parameter Info</description> <parameters> <parameter> <key>key.isParameter</key> <value>true</value> </parameter> <parameter> <key>key.number</key> <value>100</value> </parameter> <parameter> <key>key.parameter</key> <value>parameter</value> </parameter> <parameter> <key>key.parameter.list</key> <array> <element>first</element> <element>second</element> </array> </parameter> <parameter> <key>key.parameters</key> <map> <entry> <subkey>subkey.right</subkey> <value>right</value> </entry> <entry> <subkey>subkey.left</subkey> <value>left</value> </entry> </map> </parameter> </parameters> </parameterInfo>
