Top
Cloud Services Management V1.1.0 Operation Guide
FUJITSU Software
Chapter 5 Command Reference > 5.3 Format of XML Files Used in Commands > 5.3.4 Menu Information
PreviousNext

5.3.4 Menu Information

Among the commands for menu information operations, the following three subcommands use XML:

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
(menu menuName)

Yes

Yes

Yes

Specify a character string containing 1 to 64 characters.

Menu ID
(menu menuId)

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
(contractId)

Yes

Yes

*1

Yes

Specify the contract ID of an existing user.
Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Use contract operation commands to obtain the ID of an existing contract.

Types of Charges for the Basic Menu
(unitPrices type)

Yes

Yes

Yes

Specify one of the following:

Value

Description

basicCharge

Basic charge

initialCost

Initial cost

Basic Charge
(unitPrice)

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
(unitPrice)

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
(commentSummary)

No

No

Yes

Specify a character string containing 0 to 256 characters.

Description Details
(commentDetail)

No

No

Yes

Specify a character string containing 0 to 1024 characters.

Icon
(icon)

Yes

Yes

Yes

Specify the name of a file found in the following folder.
%FSCSM_HOME%\conf\images\
A character string containing 1 to 256 characters can be specified.

Basic Menu ID
(basicMenu menuId)

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
(basicMenu)

Yes

Yes

Yes

Specify a character string containing 1 to 256 characters.

Operation Option ID
(extendedOption optionId)

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 (".").
When specifying an operation option ID, specify the unit price of the operation option ID at the same time.

Unit Price of Operation Option
(unitPrice)

No

No

*4

Yes

Specify a numerical value 0 or greater. Specifiable values will vary based on the unit of currency.* 4
For prices which have yet to be specified (are awaiting discussion), specify "-1" or "-1.0000".

Configuration Option ID
(serviceOption optionId)

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.
Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
When specifying a configuration option ID, specify the unit price of the configuration option ID at the same time.

Configuration Option Type
(optionType)

No

No

*1
*4

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
(unitPrice)

No

No

*4

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

Vendor Specific Information
(vendorUniqueAttribute)

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.
Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").

Published From
(releaseStartDate)

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.
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 releaseEndDate.
When making no changes to the Published Until date, specify the date which was specified before the modification operation.

Published Until
(releaseEndDate)

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.
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, 12/31/3000 11:59:59 PM is specified.
Specify a date after the releaseStartDate.
When making no changes to the Published Until date, specify the date which was specified before the modification operation.

Status
(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
(authLevel)

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.

PreviousNext
Copyright 2015-2016 FUJITSU LIMITED