6.2.3 Uipath

以下にUipath定義と定義例を示します。Uipathの詳細については「画面のURL定義(Uipath)」を参照してください。

(表)Uipath 定義(UIバージョン1.1)

ラベル デフォルト値 必須 説明
apiVersion: Yes APIバージョン
1.1を指定する
kind: Yes uipathを指定する
type: No resourceを指定する
Ops Iの運用機能に追加する新しい定義であることを示す
name: Yes Uipath定義の内部名
nameは以下のルールに従う必要があります。
  • 本YAMLファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字:
      a~z A~Z 0~9
    • 半角の特殊文字:
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー(_)
  • その他の注意点は「YAMLファイル作成時の注意」2~4を参照
label: Yes YAMLファイルに記載する運用機能の表示名
includes: No このYAMLファイルで利用する関連YAMLファイルを配列で記載
メモメモ
  • 記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。
  • includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。例えば、Uipathで設定したURLで表示させるUIを定義したUIのYAMLファイルを取り込む場合に使用します。
- kind: Yes 読み込むYAMLファイルの種類
  name: Yes 読み込むYAMLファイルの内部名
description: No このYAMLファイルに対する詳細説明
pathType: Yes パスセグメントのタイプについて以下から指定する。
  • static:静的なパスセグメント
  • dynamic:動的なパスセグメント
path: No pathTypeがstaticの場合、パスセグメントの値を指定する。空文字の設定は不可。
navigateTo: No このYAMLファイルのuipathで表示させるUIコンポーネント、または遷移先のuipathの種類と内部名を指定する。
  kind: Yes 遷移先のYAMLファイルの種類
"ui"または"uipath"が指定できる。
  nameType: static No 遷移先のタイプ
  • static:nameで指定したUIまたはUipathのYAMLファイルのnameを表示する。
  name: Yes 表示するUIのYAMLファイルのname、または遷移先のUipathのYAMLファイルのnameを指定する。
children: No コンポーネント内に配置する子コンポーネントを配列で記載。
pathTypeがdynamicであるuipathマニフェストをchildrenに指定する場合、配列の要素数は1つでなければならない。
例:
  • ケース1(指定可能)
    • UipathのYAMLファイル(pathType:static)
    • UipathのYAMLファイル(pathType:static)
  • ケース2(type混在のため指定不可)
    • UipathのYAMLファイル(pathType:static)
    • UipathのYAMLファイル(pathType:dynamic)
  • ケース3(type:dynamicが複数のため指定不可)
    • UipathのYAMLファイル(pathType:dynamic)
    • UipathのYAMLファイル(pathType:dynamic)
  • ケース4(指定可能)
    • UipathのYAMLファイル(pathType:dynamic)
- kind: Yes IncludeするYAMLファイルの種類
  name: Yes IncludeするYAMLファイルの内部名
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

<定義例>

---
apiVersion: 1.1
kind: uipath

## Meta data
type: resource
name: service_detail_by_id
label: "{{.Values.label}}"
description: "{{.Values.description}}"

## Dependencies
includes:
  - kind: ui
    name: service_detail_ui

pathType: dynamic
navigateTo:
  kind: ui
  nameType: static
  name: service_detail_ui