4.3.3 Parameter Collection Definition File

File name

Any name

Description

This is an XML file that describes the configuration information for parameters to be collected by the software.

Refer to "2.2 Definition of Parameters to be Collected" for information on parameter collection definitions.

File format

Parameter collection definition XML files will have the following format:

<?xml version="1.0" encoding="UTF-8"?>
<parameterCollecting version="1.0">
	<name>parameterCollectionName</name>
	<method>parameterCollectionMethod</method>
	<parameters>
		<parameter>
			<key>[parameterKey]</key>
			<type>[parameterValueType]</type>
			<label>[parameterLabel]</label>
		</parameter>
		...
	</parameters>
</parameterCollecting>

The table below describes the items (tags) and their settings.

Modify parameter settings definitions as necessary, based on the information in this table.

Tag names in square brackets [ ] are optional.

Tag name	Type	Allowable range	Description	Mandatory	Settings
name	string UTF-8	256 characters or less	Specifies the parameter collection name.	O
method	string ASCII	Select an option	Specifies the parameter collection method.	Y	Select from the following options: "cmd": Calls the discovery script (discover.cmd) "sh": Calls the discovery script (discover.sh)
parameters	-	-	Specifies multiple parameters that can be collected from the software.	N
parameter	-	1 or more	Specifies the parameter key and value pairs that can be collected from the software.	N
key	string ASCII	256 bytes or less	Specifies the parameter key.	Y	Characters that can be used are alphanumeric characters, ".", "_", and "-". However, the first character must only be alphabetic.
type	string ASCII	Select an option	Specifies the value type.	Y	Select from the following options: boolean number string string array map Refer to "2.1.2 Parameter Types" for information on types.
[ label ]	string UTF-8	64 characters or less	Specifies the label used to display the parameter in the window.	O

Legend for column 'Mandatory':

Y: If the tag is specified, then a value is also required

O: Optional

N: The tag can be specified without a value

Example (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>