5.3.5 Platform Information

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

fscsm_bizsystem create (Addition of platform information)
fscsm_bizsystem modify (Modification of platform information)
fscsm_bizsystem export (Export of platform 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"?>
<bizSystems>
    <bizSystem>
        <bizSystemId>Platform ID</bizSystemId>
        <bizSystemCode>Platform Code</bizSystemCode>
        <bizSystemName>Platform Name</bizSystemName>
        <menu menuId="Menu ID">
            <extendedOptions>
                <extendedOption optionId="Operation Option ID"/>
            </extendedOptions>
        </menu>
        <bizSystemAdmin>Supervisor ID</bizSystemAdmin
        <projectId>Project ID</projectId>
        <comment>Comment of the Platform Information</comment>
        <auth>Key pair name</auth>
        <createDate>Addition Date of the Platform</createDate>
    </bizSystem>
</bizSystems>

Element (Element Name or Element Name and Attribute)	Required or Displayed			Specifiable Values During Addition or Modification
Element (Element Name or Element Name and Attribute)	Addition	Modification	Output	Specifiable Values During Addition or Modification
Platform ID (bizSystemId)	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 platform IDs of the information of other platforms. Specify a unique value.
Platform Code (bizSystemCode)	Yes	Yes	Yes	Specify a character string containing 1 to 64 characters.
Platform Name (bizSystemName)	Yes	Yes	Yes	Specify a character string containing 1 to 64 characters.
Menu ID (menu menuId)	Yes	Yes *1	Yes	Specify the ID of an already added menu information. Obtain an existing menu ID by executing menu operation commands.
Operation Option ID (extendedOption optionId)	No	No *2	Yes	Specify optionId of the operation option specified in the menu specified for the platform. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Supervisor ID (bizSystemAdmin)	Yes	Yes	Yes	Specify the user ID of an existing user. Obtain the user ID of an existing user by executing user operation commands. The user must belong to the project specified by projectId, and have the role of platform provider approver or platform provider.
Project ID (projectId)	Yes	Yes	Yes	Specify the project ID of an added project. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Description of the Platform (comment)	No	No	Yes	Specify a character string containing 0 to 256 characters.
Key Pair Name (auth)	No	No	Yes	When a key pair created using the Cloud Management Portal exists, the key pair name is output. Key pair names cannot be added or modified using commands. Even when a value is specified, the value is not reflected and the original value is retained.
Add Platform Date (createDate)	Yes	No *1	Yes	Specify the value in the format of YYYY-MM-DD.

The meanings of the entries listed under "Required or Displayed" are as follows:

Yes: Entry is required, or element is output.

No: Omission is always or sometimes permitted.

-: Specification is not permitted, or element is not output.

*1: Modification is not possible.

*2: If this element is omitted during modification, the content of the element from before modification is deleted.