Software setup information files use the following XML format:
<?xml version="1.0" encoding="UTF-8"?> <softwareSetup version="2.0"> <id>[Software setup information ID]</id> <ownerOrg>[Owner (tenant)]</ownerOrg> <ownerUser>[Owner (user)]</ownerUser> <lcid>[Locale ID]</lcid> <name>[Software setup information name]</name> <description>[Description]</description> <method>[Parameter setup method]</method> <parameters> <parameter> <key>[Parameter key]</key> <type>[Parameter value type]</type> <value>[Default value of mandatory setup parameter]</value> <label>[Parameter label]</label> <description>[Parameter description]</description> </parameter> ... </parameters> </softwareSetup> |
The following table shows descriptions of each of these items (tags), as well as their settings:
Modify software setup information files if necessary, by referring to the information in this table.
Tag names in square brackets [ ] can be omitted.
Tag name | Format | Allowable range | Description | Mandatory | Settings |
---|---|---|---|---|---|
id | string | 0 to 32 Bytes | The software setup ID. | Optional | Specify an empty string when adding a new software setup ID. |
ownerOrg | string | Fixed value | The tenant name to which the software setup information belongs. | Yes | The value is fixed as "cfmgadm" |
ownerUser | string | Fixed value | The user ID of the user registering the software setup information. | Yes | The value is fixed as "cfmgadm" |
lcid | string | Fixed value | The software setup information locale. | Yes | The value is fixed as "en" |
name | string UTF-8 | Up to 64 characters | The software setup name. | Optional | |
description | string | Up to 256 characters | The software setup description. | Optional | |
method | string | Select an option | The parameter setup method. | Yes | Select one of the following options: |
parameters | - | - | Multiple parameters that can be set up in the software. | No | |
parameter | - | 1 or more | The parameter key and value that can be set up in the software. | No | |
key | string | 1 to 256 Bytes | The parameter key. | Yes | The characters that can be used are numerics and "." However, the first character must be alphabetic. |
type | string | Select an option | The value type. | Yes | Select one of the following options: |
[ value ] | string | Up to 4,096 characters | The parameter value required in order for the software to run at deployment. | Optional | Omit values for parameters that are not set up at deployment. Specifiable values are subject to type restrictions. |
[ label ] | string | Up to 64 characters | The label used when the parameter is displayed in the window. | Optional | |
[ description ] | string | Up to 256 characters | The parameter description. | Optional |
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.