ファイル名
任意 |
使用用途
ソフトウェアからパラメーターを収集できるパラメーターの構成情報を記述したXMLファイルです。
パラメーター収集定義の詳細については、「2.2 収集するパラメーターの定義」を参照してください。
ファイル形式
パラメーター収集定義 (XMLファイル) は以下の形式となっています。
<?xml version="1.0" encoding="UTF-8"?> <parameterCollecting version="1.0"> <name>[パラメーター収集の名前]</name> <method>[パラメーター収集の方式]</method> <parameters> <parameter> <key>[パラメーターのキー]</key> <type>[パラメーターの値の型]</type> <label>[パラメーターのラベル]</label> </parameter> … </parameters> </parameterCollecting>
以下にそれぞれの項目 (タグ) の説明および設定内容について示します。
この情報を参考にして、必要に応じてパラメーター設定定義を修正してください。
タグ名の[ ]は、省略可能なタグであることを示しています。
タグ名 | 型 | 設定範囲 | 説明 | 必須 | 設定内容 |
---|---|---|---|---|---|
name | string UTF-8 | 256文字以内 | パラメーター収集の名前を指定します。 | △ | |
method | string | 選択 | パラメーター収集方式を指定します。 | ○ | 以下から選択します。
|
parameters | - | - | ソフトウェアから収集できる複数のパラメーターを指定します。 | × | |
parameter | - | 1個以上 | ソフトウェアから収集できるパラメーターをキーと値で指定します。 | × | |
key | string | 1~256Bytes | パラメーターのキーを指定します。 | ○ | 使用可能文字は英数字、「.」、「_」および「-」です。 ただし、先頭は英字だけです。 |
type | string | 選択 | 値の型を指定します。 | ○ | 以下から選択します。
型の詳細については、「2.1.2 パラメーターの型」を参照してください。 |
[ label ] | string | 64文字以内 | パラメーターを画面上に表示する場合のラベルを指定します。 | △ |
必須欄の記号は、以下を意味しています。
○:タグを指定した場合は、必ず値を指定してください。
△:値は省略可能です。
×:値の設定は不要です。タグだけの指定です。
使用例(XML)
<?xml version="1.0" encoding="UTF-8"?> <parameterCollecting version="1.0"> <name>Collecting Definition</name> <method>cmd</method> <parameters> <parameter> <key>key.isParameter</key> <type>boolean</type> </parameter> <parameter> <key>key.number</key> <type>number</type> </parameter> <parameter> <key>key.parameter</key> <type>string</type> </parameter> <parameter> <key>key.parameter.list</key> <type>string array</type> </parameter> <parameter> <key>key.parameters</key> <type>map</type> </parameter> </parameters> </parameterCollecting>