11.2.2 Parameter Information Details

Parameter information files use the following XML format:

<?xml version="1.0" encoding="UTF-8"?>
<parameterInfo version="2.0">
	<id>[Parameter information ID]</id>
	<ownerOrg>[Owner (tenant)]</ownerOrg>
	<ownerUser>[Owner (user)]</ownerUser>
	<softwareSetupId>[Software setup information ID]</softwareSetupId>
	<lcid>[Locale ID]</lcid>
	<name>[Parameter information name]</name>
	<description>[Description]</description>
	<parameters>
		<parameter>
			<key>[Parameter key]</key>
			<value>[Parameter value]</value>
		</parameter>
		...
	</parameters>
</parameterInfo>

The following table shows descriptions of each of these items (tags), as well as their settings:

Modify parameter information if necessary, by referring to the information in this table.

Tag names in square brackets [can be omitted.

Tag name	Format	Setting range	Description	Mandatory	Settings
id	string ASCII	0 to 32 Bytes	The parameter ID.	Optional	Specify an empty string when adding a new parameter ID. Specify the ID to be updated when updating a parameter ID.
ownerOrg	String ASCII	Fixed value	The tenant name to which the parameter information belongs.	Yes	The value is fixed as "cfmgadm"
ownerUser	String ASCII	Fixed value	The user ID of the user registering the parameter information.	Yes	The value is fixed as "cfmgadm"
softwareSetupId	string ASCII	1 to 32 Bytes	The target software setup ID.	Yes	Specify a registered software setup ID. Software setup information in "Chapter 12 Middleware Parameter Setting Information" can be used for the specification as well.
lcid	string ASCII	Fixed value	The locale.	Yes	The value is fixed as "en"
name	string UTF-8	Up to 64 characters	The parameter information.	Optional
description	string UTF-8	Up to 256 characters	The parameter information description.	Optional
parameters	-	-	The multiple parameters set in the software.	No
parameter	-	0 or more	The parameter set in software with a key and value.	No
key	string UTF-8	Up to 64 characters	The parameter key.	Yes	Specify the parameter key if you are using software setup information from "Chapter 12 Middleware Parameter Setting Information". Valid characters are numerics and "." However, the first character must be alphabetic. It is only possible to specify keys included in software setup information.
value	String UTF-8	Up to 4,096 characters	The parameter value.	Optional	Values are dependent on software setup information constraints.

The meanings of the symbols in the Mandatory column are as follows:

Yes: If a tag was specified, you must specify the value.

Optional: Value can be omitted.

No: A value setting is not required. Tag only specification.