6.5.1 Parameter Settings Definition File

File name

Any time

Description

This is an XML file that describes the configuration information for parameters that can be set in the software.

Refer to "4.1 Definition of Parameters to be Set" for information on parameter settings definitions.

File format

Parameter settings definition XML files will have the following format:

<?xml version="1.0" encoding="UTF-8"?>
<parameterSetting version="1.0">
	<name>parmSettingsDefinitionName</name>
	<description>desc</description>
	<method>parmSetupMethod</method>
	<parameters>
		<parameter>
			<key>[parmKey]</key>
			<type>[parmValType]</type>
			<value>[defaultValIfParmIsMandatory (if type is boolean, number, or string)]</value>
			<array>[defaultValIfParmIsMandatory (if type is string array)]
				<element>elementVal</element> 
				...
			</array>
			<map>[defaultValIfParmIsMandatory> (if type is map)]
				<entry>
					<subkey>mapSubkey</subkey>
					<value>mapVal</value> 
				</entry>
				...
			</map>
			<label>[parmLabel]</label>
			<description>[parmDesc]</description>
		</parameter>
		...
	</parameters>
</parameterSetting>

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 settings definition name.	O
description	string UTF-8	256 characters or less	Specifies the parameter settings definition description.	O
method	string ASCII	Select an option	Specifies the parameter setup method.	Y	Select from the following options: "cmd": Calls the startup script (startup.cmd). "sh": Calls the startup script (startup.sh).
parameters	-	-	Specifies multiple parameters that can be configured in the software.	N
parameter	-	1 or more	Specifies the parameter key and value pairs that can be configured in 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: true, false number: Number string: Character string string array: Character string array map Refer to "4.1.2 Parameter Types" for information on types.
[ value ]	string UTF-8	4096 characters or less	Specifies the default value if a value must be set. The value can be changed when configuring this parameter, but it cannot be left blank. Can only be specified if type is boolean, number or string. The value, array, and map elements are mutually exclusive.	O	The <type> tag determines what type of value can be specified. Refer to "4.1 Definition of Parameters to be Set" for information on values.
[ array ]	-	-	Specifies the default value if a value must be set. Can only be specified if the type is string array. The value, array, and map elements are mutually exclusive.	N	Use the element tag to specify array elements. Do not specify the element tag if there are zero arrays.
[ element ]	string UTF-8	4096 characters or less	Specifies the elements in an array when the default value type for the mandatory parameter is "array".	Y	Use a character string to specify the elements in an array. It is also possible to specify an empty string.
[ map ]	-	-	Specifies the default value if a value must be set. Can only be specified if type is map. . The value, array, and map elements are mutually exclusive.	N	Use the entry tag to specify map entries. Do not specify the entry tag if there are zero maps.
[ entry ]	-	-	Used with each key-value pair to specify the value when the default value type for the mandatory parameter is map.	N	Use the key tag to specify keys and the value tag to specify values.
subkey	string ASCII	256 bytes or less	Specifies the subkey when the default value type for the mandatory parameter is map.	Y	Characters that can be used are alphanumeric characters, periods (.), underscores (_), and hyphens (-). However, the first character must only be alphabetic.
value	string UTF-8	4096 characters or less	Specifies the value when the default value type for the mandatory parameter is map.	Y	Use a character string to specify map values. It is also possible to specify an empty string.
[ label ]	string UTF-8	64 characters or less	Specifies the label used to display the parameter in the window.	O
[ description ]	string UTF-8	256 characters or less	Specifies the parameter description.	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"?>
<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>