4.3.1 パラメーター設定定義ファイル

ファイル名

任意

使用用途

ソフトウェアに設定できるパラメーターの構成情報を記述したXMLファイルです。

パラメーター設定定義の詳細については、「2.1 設定するパラメーターの定義」を参照してください。

ファイル形式

パラメーター設定定義 (XMLファイル) は以下の形式となっています。

<?xml version="1.0" encoding="UTF-8"?>
<parameterSetting version="1.0">
	<name>[パラメーター設定定義の名前]</name>
	<description>[説明]</description>
	<method>[パラメーター設定の方式]</method>
	<parameters>
		<parameter>
			<key>[パラメーターのキー]</key>
			<type>[パラメーターの値の型]</type>
			<value>[設定必須パラメーターのデフォルト値(boolean、number、stringの場合)]</value>
			<array>[設定必須パラメーターのデフォルト値(string arrayの場合)]
				<element>[配列の値]</element> 
				…
			</array>
			<map>[設定必須パラメーターのデフォルト値(mapの場合)]
				<entry>
					<subkey>[マップのサブキー]</subkey>
					<value>[マップの値]</value> 
				</entry>
				…
			</map>
			<label>[パラメーターのラベル]</label>
			<description>[パラメーターの説明]</description>
		</parameter>
		…
	</parameters>
</parameterSetting>

以下にそれぞれの項目 (タグ) の説明および設定内容について示します。

この情報を参考にして、必要に応じてパラメーター設定定義を修正してください。

タグ名の[ ]は、省略可能なタグであることを示しています。

タグ名	型	設定範囲	説明	必須	設定内容
name	string UTF-8	256文字以内	パラメーター設定定義の名前を指定します。	△
description	string UTF-8	256文字以内	パラメーター設定定義の説明を指定します。	△
method	string ASCII	選択	パラメーター設定方式を指定します。	○	以下から選択します。「cmd」：スタートアップスクリプトのstartup.cmdを呼び出します。「sh」：スタートアップスクリプトのstartup.shを呼び出します。
parameters	－	－	ソフトウェアに設定できる複数のパラメーターを指定します。	×
parameter	－	1個以上	ソフトウェアに設定できるパラメーターをキーと値で指定します。	×
key	string ASCII	1～256Bytes	パラメーターのキーを指定します。	○	使用可能文字は英数字、「.」、「_」および「-」です。ただし、先頭は英字だけです。
type	string ASCII	選択	値の型を指定します。	○	以下から選択します。「boolean」：真偽値「number」：数値「string」：文字列「string array」：文字列の配列「map」：(マップ) 型の詳細については、「2.1.2 パラメーターの型」を参照してください。
[ value ]	string UTF-8	4096文字以内	値を必ず設定する場合は、デフォルト値を指定します。パラメーター設定のときに、値は変更できますが、値を設定しないに変更することはできません。型がboolean、number、stringの場合は、valueタグを使用して値を指定します。valueタグ、arrayタグおよびmapタグは同時に複数を指定できません。	△	指定可能な値は型(type)の制約を受けます。値の詳細については、「2.1 設定するパラメーターの定義」を参照してください。
[ array ]	－	－	値を必ず設定する場合は、デフォルト値を指定します。型がstring arrayの場合は、arrayタグを使用して値を指定します。valueタグ、arrayタグおよびmapタグは同時に複数を指定できません。	×	配列の要素は、elementタグで指定します。0個の配列は、elementタグを指定しません。
[ element ]	string UTF-8	4096文字以内	設定必須パラメーターのデフォルト値の型が配列の場合に、配列の要素を指定します。	○	配列の要素を文字列で指定します。空文字の指定も可能です。
[ map ]	－	－	値を必ず設定する場合は、デフォルト値を指定します。型がstring arrayの場合は、mapタグを使用して値を指定します。valueタグ、arrayタグおよびmapタグは同時に複数を指定できません。	×	mapのエントリーは、entryタグで指定します。0個のマップは、entryタグを指定しません。
[ entry ]	－	－	設定必須パラメーターのデフォルト値の型がマップの場合に、1つのキーと値の組にentryタグを使用して値を指定します。	×	キーと値を、keyタグとvalueタグで指定します。
subkey	string ASCII	1～256Bytes	設定必須パラメーターのデフォルト値の型がマップの場合に、サブキーを指定します。	○	使用可能文字は英数字、「.」、「_」および「-」です。ただし、先頭は英字だけです。
value	string UTF-8	4096文字以内	設定必須パラメーターのデフォルト値の型がマップの場合に、値を指定します。	○	マップの値を文字列で指定します。空文字の指定も可能です。
[ label ]	string UTF-8	64文字以内	パラメーターを画面上に表示する場合のラベルを指定します。	△
[ description ]	string UTF-8	256文字以内	パラメーターの説明を指定します。	△

必須欄の記号は、以下を意味しています。

○：タグを指定した場合は、必ず値を指定してください。

△：値は省略可能です。

×：値の設定は不要です。タグだけの指定です。

使用例(XML)

<?xml version="1.0" encoding="UTF-8"?>
<parameterSetting version="1.0">
	<name>Setting Definition</name>
	<description>Parameter Setting Definition</description>
	<method>cmd</method>
	<parameters>
		<parameter>
			<key>key.isParameter</key>
			<type>boolean</type>
			<value>true</value>
			<label>isParameter</label>
			<description>boolean</description>
		</parameter>
		<parameter>
			<key>key.number</key>
			<type>number</type>
			<value>100</value>
			<label>number</label>
			<description>number</description>
		</parameter>
		<parameter>
			<key>key.parameter</key>
			<type>string</type>
			<value>parameter</value>
			<label>parameter</label>
			<description>string</description>
		</parameter>
		<parameter>
			<key>key.parameter.list</key>
			<type>string array</type>
			<array>
				<element>first</element>
				<element>second</element>
			</array>
			<label>list</label>
			<description>array</description>
		</parameter>
		<parameter>
			<key>key.parameters</key>
			<type>map</type>
			<map>
				<entry>
					<subkey>subkey.right</subkey>
					<value>right</value>
				</entry>
				<entry>
					<subkey>subkey.left</subkey>
					<value>left</value>
				</entry>
			</map>
			<label>parameters</label>
			<description>map</description>
		</parameter>
	</parameters>
</parameterSetting>