5.3.5 Platform Information

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

fscsm_bizsystem create (platform information registration)
fscsm_bizsystem modify (platform information modification)
fscsm_bizsystem export (platform 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"?>

<bizSystems>

    <bizSystem rId="Resource ID of the Platform">

        <bizSystemId>Platform ID</bizSystemId>

        <bizSystemCode>Platform Code</bizSystemCode>

        <bizSystemName>Platform Name</bizSystemName>

        <menu rId="Resource ID of the Menu">

            <extendedOptions>

                <extendedOption optionId="Operation  Option ID"/>

            </extendedOptions>

            <serviceOptions/>

        </menu>

        <bizSystemAdmin>Administrator ID</bizSystemAdmin>

        <orgRId>Resource ID of the Organization</orgRId>

        <comment>Description</comment>

        <auth>File Name of the Keypair</auth>

        <createDate>Registration Date of the Platform</createDate>

    </bizSystem>

</bizSystems>

Element (Name or Attribute)	Omission or Display			Acceptable Value in Registration or Modificaiton
Element (Name or Attribute)	Registration	Modification	Output	Acceptable Value in Registration or Modificaiton
Resource ID of the Platform (bizSystem rId)	×	×	○	-
Platform ID (bizSystemId)	○	○ *1	○	Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap other Platform ID. Specify a unique value.
Platform Code (bizSystemCode)	○	○	○	Specify a character string containing 1 to 64 characters.
Platform Name (bizSystemName)	○	○	○	Specify a character string containing 1 to 64 characters.
Resource ID of the Menu (menu rId)	○	○ *1	○	Specify the resource ID of the existing menu. Specify an integer number within 8-digit. Refer to resource ID of the existing menu by execute contract operation commands.
Operation Option ID (extendedOption optionId)	△	△ *2	○	Specify the optionId defined in the system information. Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".").
Administrator ID (bizSystemAdmin)	○	○	○	Specify the user ID of the existing user. Use organization operation commands to get the existing user ID. This user must belong to organization corresponding to the orgRId and its role must be platform providers - approver or representative. And the ID and resource ID of the organization (orgRId) cannot be modified at the same time.
Resource ID of the Organization (orgRId)	○	○	○	Specify the resource ID of the existing organization. Organization whose attribute is leaf, can be only specified. Specify an integer number within 8-digit. Use organization operation commands to get resource ID of the organization. And the resource ID and administrator ID (bizSystemAdmin) cannot be modified at the same time.
Description (comment)	△	△	○	Specify a character string containing 0 to 256 characters.
File Name of hte Keypair (auth)	△	△	○	Specify the file name of keypair if platform is registered or modified using the menu of AWS. Refer to "2.5.6 Storage Location of Key Pair Files for AWS" for details. This element doesn't need to be specified in the case of Azure, ROR or no cloud providers.
Registration Date of the Platform (createDate)	○	△ *1	○	Specify the value in the format of YYYY-MM-DD hh:mm:ss.

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 value registered before is deleted if the element is omitted in the XML when the palatform is modified.

Note

The <serviceOptions/> is only displayed when platform export is executed.