5.3.4 Menu Information

Among the commands that operate menu information, the following three types of commands use XML:

fscsm_menu create (menu information registration)
fscsm_menu modify (menu information modification)
fscsm_menu export (menu information output)

The formats of the XML files corresponding to each of these commands are explained below.

Elements of XML must be as the following stratum structure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<menus>

    <menu rId="Resource ID of the Menu" menuName="Menu Name" menuId="Menu ID">

        <contractRId>Resource ID of the Contract</contractRId>

        <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 (Name or Attribute)	Omission or Display			Acceptable Value in Registration or Modificaiton
	Registration	Modification	Output
Resource ID of the menu (menu rId)	×	×	○	-
Menu Name (menu menuName)	○	○	○	Specify a character string containing 1 to 64 characters.
Menu ID (menu menuId)	○	○ *1	○	Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap other user ID. Specify a unique value.
Resource ID of the Contract (contractRId)	○	○ *1	○	Specify an integer number within 8-digit as the resource ID of the contract. Use contract operation commands to get resource ID of the existing contract.
Price Type of Basic Menu (unitPrices type)	○	○	○	Specify one of the followings:
				Value			Description
				basicCharge			Basic Charge
				initialCost			Initial Cost
Basic Charge (unitPrice)	○	○	○	Specify zero or a larger number consisting of 9 or less digits of integer and 6 or less digits after the decimal point. *5 If a price is determined after meeting, specify -1 or -1.0000.
Initial Cost (unitPrice)	○	○	○	Specify zero or a larger number consisting of 9 or less digits of integer and 4 or less digits after the decimal point. *5 If a price is determined after meeting, specify -1 or -1.0000.
Description Summary (commentSummary)	△	△	○	Specify a character string containing 0 to 256 characters.
Description Details (commentDetail)	△	△	○	Specify a character string containing 0 to 1024 characters.
Icon (icon)	△ *2	△ *3	○	Specify the file name put in the following folder. %FSCSM_HOME%\conf\images\ A character string containing 1 to 256 characters.
Basic Menu ID (basicMenu menuId)	○	○ *4	○	Specify the menuId defined in the vendor information. (This element must be specified with respect to all menus written in the vendor information.) Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Basic Menu Information (basicMenu)	○ *4	○ *4	○	Specify a character string containing 1 to 256 characters.
Operation Option ID (extendedOption optionId)	△ *2	△ *3	○	Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). If an operation option ID is specified, please specify the unit price of operation option ID at the same time.
Unit Price of Operation Option (unitPrice)	△	△ *3	○	Specify zero or a larger number consisting of 9 or less digits of integer and 6 or less digits after the decimal point. *5 If a price is determined after meeting, specify -1 or -1.0000.
Configuration Option ID (serviceOption optionId)	△	△ *3	○	Specify the optionId defined in the vendor information. Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). If an operation configuration option ID is specified, please specify the unit price of configuration option ID at the same time.
Configuration Option Type (optionType)	△	△ 1 3	○	Specify one of the followings:
				Value	Description
				vm	Instance Type
				image	System Disk Image
				disk	Additional Data Disk
				snapshot	Snapshot
				slb	SLB
				rdb	RDB
Unit Price of Configuration Option (unitPrice)	△	△ *3	○	Specify zero or a larger number consisting of 9 or less digits of integer and 4 or less digits after the decimal point. *5 If a price is determined after meeting, specify -1 or -1.0000.
Vendor Unique Parameter (vendorUniqueAttribute)	○	○	○	Specify the id of deployParameter defined in the vendor information. If no deployParameter is defined, please specify an empty element. A character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Release Start Date (releaseStartDate)	△	△	○	Date and time when publishing of the menu is started. Specify the value in the format of YYYY-MM-DD hh:mm:ss. A value in the following range can be specified: Between 2000-01-01 00:00:00 and 3000-12-31 23:59:59 When omitted, 2000-01-01 00:00:00 is specified. Specify a date before the releaseEndDate. If the date is not intended to be modified on the operation of modifying menu, please specify the date set before.
Release End Date (releaseEndDate)	△	△	○	Date and time when publishing of the menu is ended. Specify the value in the format of YYYY-MM-DD hh:mm:ss. A value in the following range can be specified: Between 2000-01-01 00:00:00 and 3000-12-31 23:59:59 When omitted, 3000-12-31 23:59:59 is specified. Specify a date after the releaseStartDate. If the date is not intended to be modified on the operation of modifying menu, please specify the date set before.
Status (status)	○	○	○	Specify one of the followings:
				Value		Description
				published		The menu is published to platform providers.
				hidden		The menu is not published to platform providers.
Approval Level (authLevel)	○	○	○	Specify a number (1 or larger). The maximum number which is permitted to be specified is a value of org.depth.max defined in the system infotmation. Refer to "2.5.1 System Information" for details. Specify the hierarchical levels of the request for platforms and services. If the approval level is 1, approvals are needed by the top organization.

Refer to the following about symbols of the "Omission or Display" column.

○: Entry is mandatory, or element is output.

△: Omission is permitted.

×: Specifying is not permitted, or element is not output.

*1: Modifying is not permitted.

*2: The elements are not registered if specifying is omitted when the menu is registered.

*3: The value registered before is deleted if the element is omitted in the XML during executing menu modification command.

*4: The element is not registered if specifying is omitted in the XML when the menu is registered or modified. For modification of the element, modify it from GUI.

*5: The input value of UnitPrice changes according to the value of "currency.fraction.digits" in the output of the fscsm_currency export command as the following table.

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