業務システム操作コマンドでXMLを利用するサブコマンドは、以下の3種類です。
fscsm_bizsystem create(業務システム情報の登録)
fscsm_bizsystem modify(業務システム情報の変更)
fscsm_bizsystem export(業務システム情報の出力)
上記コマンドに対応したXMLファイルの形式について説明します。
XMLの要素は、下記の階層構造で指定する必要があります。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bizSystems> <bizSystem> <bizSystemId>業務システムID</bizSystemId> <bizSystemCode>業務システムコード</bizSystemCode> <bizSystemName>業務システム名</bizSystemName> <menu menuId="メニューID"> <extendedOptions> <extendedOption optionId="運用オプションID"/> </extendedOptions> </menu> <bizSystemAdmin>責任者ID</bizSystemAdmin> <projectId>プロジェクトID</projectId> <comment>業務システム情報の説明</comment> <auth>キーペア名</auth> <createDate>業務システム登録日</createDate> </bizSystem> </bizSystems> |
要素の内容 (「要素名」または「要素名 属性」) | 省略可否、表示有無 | 登録、変更時の指定値 | ||
---|---|---|---|---|
登録時 | 変更時 | 出力時 | ||
業務システムID | ○ | ○ ※1 | ○ | 先頭半角英数字(小文字)で、半角英数字(小文字)、アンダースコア("_")、ハイフン("-")およびピリオド(".")で構成された1~32文字の文字列を指定します。 業務システムIDは他の業務システム情報の業務システムIDと重複できません。必ず異なる値を指定してください。 |
業務システムコード | ○ | ○ | ○ | 全角半角に関係なく1~64文字の文字列を指定します。 |
業務システム名 | ○ | ○ | ○ | 全角半角に関係なく1~64文字の文字列を指定します。 |
メニューID | ○ | ○ ※1 | ○ | 登録済のメニュー情報のIDを指定します。 既存のメニューのIDは、メニュー操作コマンドを実行して取得してください。 |
運用オプションID | △ | △ ※2 | ○ | 業務システムに指定しているメニューで指定されている運用オプションのoptionIdを指定します。 先頭半角英数字(小文字)で、半角英数字(小文字)、アンダースコア("_")、ハイフン("-")およびピリオド(".")で構成された1~32文字の文字列を指定します。 |
責任者ID | ○ | ○ | ○ | 登録されているユーザーIDを指定します。 既存のユーザーIDは、ユーザー操作コマンドを実行して取得してください。 projectIdで指定されているプロジェクトに属するユーザーである、かつ、業務システム提供部門 承認者、または、業務システム提供部門のロールを持つ特権管理者である必要があります。 |
プロジェクトID | ○ | ○ | ○ | 登録されているプロジェクトのプロジェクトIDを指定します。 先頭半角英数字(小文字)で、半角英数字(小文字)、アンダースコア("_")、ハイフン("-")およびピリオド(".")で構成された1~32文字の文字列を指定します。 |
業務システムの説明 | △ | △ | ○ | 全角半角に関係なく0~256文字の文字列を指定します。 |
キーペア名 | △ | △ | ○ | クラウド管理用ポータルで作成したキーペアが存在する場合は、キーペア名が出力されます。コマンドからの登録/変更はできません。値を指定しても反映はされず、変更前の値が保持されます。 |
業務システム登録日 | ○ | △ ※1 | ○ | YYYY-MM-DDの形式で指定します。 |
「省略可否、表示有無」列の記号は以下を参照してください。
○:指定必須、または出力されます
△:省略可または、場合により省略可
×:指定不可または、出力されません
※1:変更不可
※2:変更時に要素を省略した場合、変更前の要素の内容が削除されます。