Systemwalker Software Configuration Manager Developer's Guide

6.5.2 Parameter Information File

File name

Any name

Description

This is a file in CSV or XML format that describes the values to be set in the software parameters. Parameters for which values can be set in the software are the parameters defined in the parameter settings definition.

Refer to "Parameter Value Settings" in the Operation Guide for details on parameter information.

CSV file format

Parameter information CSV files will have the format shown below.

Modify the parameter information as necessary, based on this information.

Purpose of line	Line/row	Row 1	Row 2	Row 3	Row 4
Header	Line 1	#Parameters	Key	Value	Status
Name	Line 2	parameterInfo	name	[Parameter information name]
Description	Line 3	parameterInfo	description	[Parameter information description]
Parameters	Line 4	parameters	[Parameter key]	[Parameter value]	[Parameter status]
...	Line 5...	parameters	...	...	...

Explanation of lines

The following table explains the lines and their settings:

Purpose of line	Description	Mandatory	Settings
Header	The header is deemed to be specified if the first line of the CSV file starts with a hash (#) symbol.	N	Apart from the # symbol, the header may contain any content. Omit the line if not specifying a header.
Name	This line specifies the parameter information name.	Y
Description	This line specifies the parameter information description.	N	Omit the line if not specifying a parameter information description.
Parameters	This line specifies the parameter key and value.	N	Add the same number of lines as the number of parameter keys you wish to specify. Omit the line if not specifying any parameter keys.

Explanation of items

The following table explains the item names and their settings.

Item names in square brackets [ ] can be omitted line by line. Omit the fourth row if omitting all parameter statuses.

Item	Type	Allowable range	Description	Mandatory	Settings
Parameter information name	string	256 characters or less	Specifies the parameter information name.	N
[Parameter information description]	string	256 characters or less	Specifies the description of the parameter information.	N
Parameter key	string	If type is boolean, number or string: 256 bytes or less If type is string array or map: 514 bytes or less	If type is boolean, number of string: specifies the parameter key. If type is string array: specifies the element index. If type is map: specifies the subkey.	Y	Only the key contained in the parameter settings definition can be specified. Enclose the string array index and the map subkey in square brackets ([ ]). The string array index starts from 1. When using a parameter settings definition from "Parameter Reference", specify the parameter key.
Parameter value	string	4096 characters or less	Specifies the parameter value.	N	The value depends on the parameter settings definition restrictions. Refer to "Predefined Parameters" of the Operation Guide for information on values.
Parameter status	string	32 characters or less	Specifies the parameter value.	N	Specify whether to set a parameter or not. The following values can be set to indicate the status: Set a value: set Do not set a value: Empty string, notset

Key-value description

Keys and values should be specified as shown in the table below:

Parameters		Specification
Type	Value characteristics	Key	Value
boolean	Value specified	Key	Value
number	Value specified	Key	Value
string	Value specified	Key	Value
	Empty string	Key	Empty string
string array	Value specified (1 or more elements)	Key [ index ]	Value
	Empty string (1 or more elements)	Key [ index ]	Empty string
	0 elements	Key	Empty string
map	Value specified (1 or more entries)	Key [ subkey ]	Value
	Empty string (1 or more entries)	Key [ subkey ]	Empty string
	0 entries	Key	Empty string

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

Parameter information XML files will have the format shown below.

Modify the parameter information as necessary, based on this information.

<?xml version="1.0" encoding="UTF-8"?>
<parameterInfo version="3.0">
	<name><parm information name></name>
	<description><desc></description>
	<parameters>
		<parameter>
			<key>[<parm key>]</key>
			<value>[<parm val> (if type is boolean, number, or string)]</value>
			<array>[<parm val> (if type is string array)] 
				<element><element val> </element> 
				...
			</array>
			<map>[<parm val> (if type is map)] *1 *4
				<entry>
					<subkey><map subkey></subkey>
					<value><map val></value> 
				</entry>
				...
			</map>
		</parameter>
		...
	</parameters>
</parameterInfo>

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

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 information name.	O
[ description ]	string UTF-8	256 characters or less	Specifies the description of the parameter information.	O
parameters	-	-	Specifies multiple parameters to be set in the software.	N
[ parameter ]	-	0 or more	Specifies the parameter key and value pairs to be set in the software.	N
key	string ASCII	1 to 256 bytes	Specifies the parameter key.	Y	Only the key contained in the parameter settings definition can be specified. When using a parameter settings definition from "Parameter Reference", specify the parameter key.
[ value ]	string UTF-8	4096 characters or less	Specifies the parameter value. Can only be specified if type is boolean, number or string. One and only one <value>, <array>, or <map> tag must be specified.	O	The value depends on the parameter settings definition restrictions. Refer to "Predefined Parameters" of Operation Guide for information on values.
[ array ]	-	-	Specifies the parameter value. Can only be specified if type is string array. One and only one <value>, <array>, or <map> tag must be specified.	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 parameter value type 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 parameter value. Can only be specified if type is map. One and only one <value>, <array>, or <map> tag must be specified.	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 parameter value type is map.	N	Use the key tag to specify keys and the value tag to specify values.
subkey	string ASCII	1 to 256 bytes	Specifies the subkey when the parameter value type 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 parameter value type is map.	Y	Use a character string to specify map values. It is also possible to specify an empty string.

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"?>
<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>