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

<定義例>

---
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