Among the commands for menu information operations, the following three subcommands use XML:
fscsm_menu create (Addition of menu information)
fscsm_menu modify (Modification of menu information)
fscsm_menu export (Output of menu information)
The format of the XML file corresponding to the command above is explained below.
The elements of the XML must be specified using the following hierarchical structure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <menus> <menu menuName="Menu Name" menuId="Menu ID"> <contractId>Contract ID</contractId> <unitPrices type="basicCharge"> <unitPrice>Basic Charge</unitPrice> </unitPrices> <unitPrices type="initialCost"> <unitPrice>Initial Cost</unitPrice> </unitPrices> <commentSummary>Description Summary</commentSummary> <commentDetail>Description Details</commentDetail> <icon>Icon</icon> <basicMenus> <basicMenu menuId="Basic Menu ID">Basic Menu Information</basicMenu> </basicMenus> <extendedOptions> <extendedOption optionId="Operation Option ID"> <unitPrices> <unitPrice>Unit Price of Operation Option</unitPrice> </unitPrices> </extendedOption> </extendedOptions> <serviceOptions> <serviceOption optionId="Configuration Option ID"> <optionType>Configuration Option Type</optionType> <unitPrices> <unitPrice>Unit Price of Configuration Option</unitPrice> </unitPrices> </serviceOption> </serviceOptions> <vendorUniqueAttribute>Vendor Unique Parameter</vendorUniqueAttribute> <releaseStartDate>Release Start Date</releaseStartDate> <releaseEndDate>Release End Date</releaseEndDate> <status>Status</status> <authLevel>Approval Level</authLevel> </menu> </menus> |
Element (Element Name or Element Name and Attribute) | Required or Displayed | Specifiable Values During Addition or Modification | |||||
---|---|---|---|---|---|---|---|
Addition | Modification | Output | |||||
Menu Name | Yes | Yes | Yes | Specify a character string containing 1 to 64 characters. | |||
Menu ID | Yes | Yes *1 | Yes | Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap with the IDs of other menus. Specify a unique value. | |||
Contract ID | Yes | Yes *1 | Yes | Specify the contract ID of an existing user. | |||
Types of Charges for the Basic Menu | Yes | Yes | Yes | Specify one of the following: | |||
Value | Description | ||||||
basicCharge | Basic charge | ||||||
initialCost | Initial cost | ||||||
Basic Charge | Yes | Yes | Yes | Specify a numerical value 0 or greater. Specifiable values will vary based on the unit of currency.* 2 For prices which have yet to be specified (are awaiting discussion), specify "-1" or "-1.0000". | |||
Initial Cost | Yes | Yes | Yes | Specify a numerical value 0 or greater. Specifiable values will vary based on the unit of currency.* 2 For prices which have yet to be specified (are awaiting discussion), specify "-1" or "-1.0000". | |||
Description Summary | No | No | Yes | Specify a character string containing 0 to 256 characters. | |||
Description Details | No | No | Yes | Specify a character string containing 0 to 1024 characters. | |||
Icon | Yes | Yes | Yes | Specify the name of a file found in the following folder. | |||
Basic Menu ID | Yes | Yes *1 | Yes | For menu-related contract information, the vendor ID is specified. Specify the basic menu ID (basicMenu menuId) defined in the cloud vendor definition file corresponding to this vendor ID. (This attribute must be specified for all menus mentioned in the cloud vendor definition file.) Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | |||
Basic Menu Information | Yes | Yes | Yes | Specify a character string containing 1 to 256 characters. | |||
Operation Option ID | No *3 | No *4 | Yes | Specify optionID of the desired operation option according to the operation option information in extraOption.xml. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | |||
Unit Price of Operation Option | No | No *4 | Yes | Specify a numerical value 0 or greater. Specifiable values will vary based on the unit of currency.* 4 | |||
Configuration Option ID | No | No *4 | Yes | For menu-related contract information, the vendor ID is specified. Specify optionId defined in the cloud vendor definition file corresponding to this vendor ID. | |||
Configuration Option Type | No | No *1 | Yes | Specify one of the following character strings: | |||
Value | Description | ||||||
vm | Instance type | ||||||
image | System disk image | ||||||
disk | Additional data disk | ||||||
snapshot | Snapshot | ||||||
slb | SLB | ||||||
rdb | RDB | ||||||
Unit Price of Configuration Option | No | No *4 | Yes | Specify a numerical value 0 or greater. Specifiable values will vary based on the unit of currency.* 2 | |||
Vendor Specific Information | Yes | Yes | Yes | For menu-related contract information, the vendor ID is specified. Specify id of deployParameter defined in the cloud vendor definition file corresponding to this vendor ID. If no deployParameter is defined, please specify an empty element. | |||
Published From | No | No | Yes | Specify a date and time when publishing of the menu will be started. Specify the value in the format, YYYY-MM-DD hh:mm:ss. Between 2000-01-01 00:00:00 and 3000-12-31 23:59:59 | |||
Published Until | No | No | Yes | Specify a date and time when publishing of the menu will end. Specify the value in the format, YYYY-MM-DD hh:mm:ss. | |||
Status | Yes | Yes | Yes | Specify one of the following character strings: | |||
Value | Description | ||||||
published | The menu is published. | ||||||
hidden | The menu is hidden. | ||||||
Approval Level | Yes | Yes | Yes | Specify an integer (1 or larger). The maximum specifiable value is the value of org.depth.max defined in the system information file. For details, refer to "2.10.1 System Information". Specify the hierarchical levels of the organization which must approve the platform or service. If 1 is specified, approvals are required from the top organization. When only approval of the project is required, specify "prj-manager_approval". When no approval is required, specify "no_approval". |
The meanings of the entries listed under "Required or Displayed" are as follows:
Yes: Entry is required, or element is output.
No: Can be omitted.
-: Specification is not permitted, or element is not output.
*1: Modification is not possible.
*2: Specifiable values will vary based on the unit of currency. Export the unit of currency using the 5.2.9 Unit of Currency Operation Commands, and confirm the value of currency.fraction.digits.
Value of "currency.fraction.digits" | Input Value of UnitPrice Changes |
---|---|
0 | 11 or less digits of integer and 4 or less digits after the decimal point |
1 | 10 or less digits of integer and 5 or less digits after the decimal point |
2(Default) | 9 or less digits of integer and 6 or less digits after the decimal point |
3 | 8 or less digits of integer and 7 or less digits after the decimal point |
*3: This element is not included if it is omitted during addition.
*4: If this element is omitted during modification, the content of the element from before modification is deleted.