6.11 Application

以下にApplication定義と定義例を示します。Applicationの詳細については「Application」を参照してください。

(表)Application定義

ラベル デフォルト値 必須 説明
apiVersion: Yes APIバージョン
1.0を指定する
kind: Yes applicationを指定する
type: No resourceを指定する
Ops Iの運用機能に追加する新しい定義であることを示す
name: Yes Application定義の内部名
nameは以下のルールに従う必要があります。
  • 本YAMLファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字:
      a~z A~Z 0~9
    • 半角の特殊文字:
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー(_)
  • その他の注意点は「YAMLファイル作成時の注意」2~4を参照
label: Yes YAMLファイルに記載する運用機能の表示名
includes: No このYAMLファイルで利用する関連YAMLファイルを記載
メモメモ
  • 記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。
  • includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。例えば、表示させるGUIを定義したUIのYAMLファイルを取り込む場合に使用します。
- kind: Yes 読み込むYAMLファイルの種類
  name: Yes 読み込むYAMLファイルの内部名
description: No このYAMLファイルに対する詳細説明
テンプレート機能を利用して記述することができる
link: いずれかが必要 このアプリケーションアイコンのハイパーリンク
tabs: このアプリケーションのタブ
- name: No このタブの名前
  label: Yes このタブの表示名
テンプレート機能を利用して記述することができる。
  description: No このタブの説明
テンプレート機能を利用して記述することができる。
  ui: いずれかが必要 UI定義の名前。
UI定義は、事前に"includes"ラベルで指定する必要がある。
指定できるUI定義はUIバージョン1.0のみ。タブに表示する画面は、uipathを用いて指定することを推奨。
  uipath: Uipath定義の名前
Uipath定義は、事前に"includes"ラベルで指定する必要がある。
  visible: true No このタブの表示設定
  • true:表示
  • false:非表示
falseを指定した場合は、このタブに含まれるアイテムも非表示となる。
  items: No アプリケーションタブをドロップダウンリストで表示。入れ子でitemsを設定することはできない。
  - name: No アイテムの名前
    label: Yes アイテムの表示名
    description: No アイテムの説明
    uipath: Yes Uipath定義の名前
Uipath定義は、事前に"includes"ラベルで指定する必要がある。
    visible: Yes このアイテムの表示設定
  • true:表示
  • false:非表示
icon: true No このアプリケーションのアイコン
以下のMaterial iconsから指定できる。
https://v5.mui.com/material-ui/material-icons/
例)AccountBalance
order: 9999 No アプリケーションの順序
1~9999の整数で指定し、昇順で表示される。
ただし、1の位が0の値はOps I内部で使用するため、指定しないでください。
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

(表)Ops I初期登録済みのApplicationのorderの値

名前 orderの値
リクエスト 150
タスク 200
ドキュメント 400
システム 900
Git 1000
シークレット 1100
ITSM 1200
自動化 1300
サイト 1400
マニュアル 9000

<定義例>

apiVersion: 1.0
kind: application
type: resource
name: ledger_mgt
label: 台帳管理
description: 管理する台帳を確認
icon: LibraryBooks
order: 955

includes:
  - kind: ui
    name: display_lend_vm_info_ui
    
tabs:
  - name: display_lend_vm_info
    label: VM貸出台帳
    description: VM貸出台帳を一覧表示する。
    ui: display_lend_vm_info_ui