次の方法で共有

フロントエンドマニフェストのドキュメンテーション

  • [アーティクル]

このドキュメントは、Fabric ワークロードのフロントエンド マニフェストの構造と構成に関する詳細なガイドです。 これらの JSON ベースのマニフェストにより、Fabric でカスタマイズされた一貫性のあるエクスペリエンスをユーザーに提供するのに不可欠なワークロードの外観、ID、動作を、パートナーが定義することができます。

フロントエンド マニフェストは、次の 2 つの主要コンポーネントで構成されます。

  • 製品マニフェスト: ワークロード ID とブランド化を定義します。
  • 項目マニフェスト: ユーザー操作要素など、ワークロード内の個々の項目に関する詳細な構成。

製品マニフェスト

製品マニフェストは、ワークロードの製品のコア属性を定義し、その ID、ブランド化、およびユーザー操作の構成を指定します。

属性

  • name (文字列): 製品の一意のシステム名。
  • displayName (文字列): ユーザー フレンドリな表示名。
  • fullDisplayName (文字列): 製品のわかりやすい名前。
  • favicon (文字列): 製品のファビコンへのパス。
  • icon (オブジェクト): assets フォルダーに格納されている製品のアイコンへのパス (例: "assets/icon.png")。

ホーム ページの構成

ワークロードのホーム ページのレイアウトとコンテンツを定義します。

  • homePage (オブジェクト): ホーム ページの構成設定。
    • learningMaterials (配列): ワークロードの詳細ページに表示される学習教材のリスト。
      • title (文字列): 学習教材のタイトル。
      • introduction (文字列): 教材の簡単な説明。
      • description (文字列): 教材の詳細な説明。
      • onClick (オブジェクト): 教材がクリックされたときにトリガーされるアクション。
      • image (文字列): 教材に関連付けられているイメージへのパス。
    • recommendedItemTypes (配列): ワークロードの詳細ページに表示される推奨項目の種類のリスト。

体験を作る

製品に新しい項目を作成するための構成。ユーザー操作のオプションを指定します。

  • createExperience (オブジェクト): ワークロード項目を作成するための構成。
    • description (文字列): 作成エクスペリエンスの一般的な説明。
    • cards (配列): 作成プロセス中に表示されるカードのリスト。
      • title (文字列): カードのタイトル。
      • description カードの簡単な説明。
      • icon (オブジェクト): カードで使用されるアイコンへのパス。
      • onClick (オブジェクト): カードがクリックされたときにトリガーされるアクション。
      • availableIn (配列): カードが使用できる場所。
      • itemType (文字列): 作成されたカードにリンクされている項目の種類。

ワークスペースの設定と製品の詳細

  • workspaceSettings (オブジェクト): ワークスペース機能に固有の設定。
    • getWorkspaceSettings (オブジェクト): ワークスペースの設定を取得するアクションが含まれています。
  • productDetail (オブジェクト): 製品のブランド化と情報に関する追加情報。
    • publisher (文字列): 製品の発行元。
    • slogan (文字列): 製品のスローガン。
    • description (文字列): 製品の簡単な説明。
    • image (オブジェクト): 製品イメージの構成。
      • mediaType (整数): イメージのメディアの種類。
      • source (文字列): イメージへのパス。
    • slideMedia (配列): 製品の詳細ページのスライドで使用されるメディア ファイルのリスト。
      • 制限: slideMedia 配列では、10 個以下の 項目を使用できます。
      • 各項目 (オブジェクト):
        • mediaType (整数): スライドのメディアの種類。 画像には 0 を使用し、ビデオには 1 を使用します。
        • ソース (文字列): 画像またはビデオ ソースへのパス。
        • 注: ビデオの場合: ビデオの URL を指定します。 サポートされている形式は次のとおりです。
          • https://youtube.com/embed/<id> または https://www.youtube.com/embed/<id>
            • 例: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
          • https://player.vimeo.com/video/<number>
            • 注: vimeo URLに www. を含めないでください。

slideMedia 構成の例:

"slideMedia": [
  {
    "mediaType": 1,
    "source": "https://youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi"
  },
  {
    "mediaType": 0,
    "source": "assets/images/SlideImage1.png"
  }
]

項目マニフェスト

項目マニフェストでは、属性、アイコン、エディター パス、ジョブ関連の設定など、ワークロード内の個々の項目に関する構成の詳細が定義されます。

属性

  • name (文字列): 項目の一意のシステム名。
  • displayName (文字列): 項目に表示されるユーザー フレンドリ名。
  • displayNamePlural (文字列): 表示を目的とした表示名の複数形。

エディターとアイコンの構成

  • editor (オブジェクト): Fabric ワークロード アプリ内の項目のエディターに対するパス構成。
    • path (文字列): エディターへの相対パス。
  • icon (オブジェクト): 項目を表すアイコンを指定します。
    • name (文字列): assets フォルダー内のアイコン ファイルへのパス (例: "assets/icon.svg")。

コンテキスト メニュー項目

項目のコンテキスト メニューで使用できるアクションを定義し、ユーザーに操作オプションを提供します。

  • contextMenuItems (配列): コンテキスト メニューのアクションのリスト。
    • name (文字列): アクションのシステム名。
    • displayName (文字列): アクションの表示名。
    • icon (オブジェクト): アクションのアイコン。
      • name (文字列): アイコン ファイルへのパス (例: "assets/icon.svg")。
    • handler (オブジェクト): メニュー項目のアクション ハンドラー。
      • action (文字列): トリガーされるアクションの名前。
    • tooltip (文字列): アクションに対するオプションのヒント テキスト。

監視と DataHub 構成

  • supportedInMonitoringHub (ブール値): 監視ハブで項目を表示可能またはフィルター処理可能にするかどうかを指定します。
  • supportedInDatahubL1 (ブール値): DataHub L1 で項目を表示可能またはフィルター処理可能にするかどうかを指定します。

項目のジョブ アクションの構成

アイテムジョブインスタンスに関連するジョブ関連アクションの構成。

  • itemJobActionConfig (オブジェクト): 項目のジョブに関連するアクションを定義します。
    • registeredActions (オブジェクト): 詳細、キャンセル、再試行などのジョブ アクションが含まれています。
      • detail (オブジェクト): ジョブの詳細を表示するアクション。
      • cancel (オブジェクト): ジョブを取り消すアクション。
      • retry (オブジェクト): ジョブを再試行するアクション。

項目設定

項目設定の構成オプション。

  • itemSettings (オブジェクト): 項目の追加設定。
    • schedule (オブジェクト): スケジュール情報が含まれています。
      • itemJobType (文字列): Fabric 共有 UI からスケジュールされるジョブの種類。
      • refreshType (文字列): 項目の更新機能を指定します。 指定できる値は、"None"、"Refresh"、"Run" です。
    • recentRun (オブジェクト): 最近のジョブ実行の構成。
      • useRecentRunsComponent (ブール値): Fabric 共有の最近の実行コンポーネントを使用するかどうか。
    • getItemSettings（オブジェクト）: カスタム項目設定のための設定。
      • アクション (文字列): カスタム項目設定の一覧を返す対応するアクションの名前。

タスクフローの項目カテゴリ

Fabric Task Flow Frameworkと統合するための項目カテゴリを定義します。

  • itemJobTypes (配列): タスク フロー フレームワーク内の項目に割り当てられるカテゴリを指定します。 各項目には、最大 2 つのカテゴリを含めることができます。 サポートされているカテゴリは次のとおりです。
    • "getData"
    • "storeData"
    • "prepareData"
    • "analyzeAndTrainData"
    • "trackData"
    • "visualizeData"
    • "develop"
    • "generalTask"
    • "others"

カテゴリが指定されていない場合は、"others" が既定値として使用されます。

注

マニフェストに追加された新しい属性を開発してテストするときは、サンプル リポジトリから最新の検証スクリプトとツールを同期済みであることを確認してください。

この手順が必要なのはローカル開発においてだけであり、クラウド モードでは必要ありません。