本檔提供 Fabric 工作負載中前端指令清單結構和設定的詳細指南。 這些 JSON 型指令清單可讓合作夥伴定義工作負載外觀、身分識別和行為，為使用者在 Fabric 中提供量身打造且一致的體驗至關重要。
前端指令清單包含兩個主要元件：
- 產品概要：定義工作負載身份和品牌形象。
- 專案指令清單：工作負載內個別專案的詳細設定，包括用戶互動元素。
產品目錄清單
產品手冊定義了工作負載產品的核心屬性，並指定其身分識別、品牌，以及用戶互動的組態。
屬性
- name （string）：產品的唯一系統名稱。
- displayName （string）：用戶易記的顯示名稱。
- fullDisplayName （string）：產品的描述性名稱。
- favicon （字串）：產品的 favicon 路徑。
- icon （object）：產品圖示的路徑，儲存在 assets 資料夾中（例如“assets/icon.png”）。
首頁組態
定義工作負載首頁的配置和內容。
-
homePage （object）：首頁的組態設定。
-
learningMaterials （陣列）：工作負載詳細數據頁面上顯示的學習教材清單。
- title （string）：學習教材的標題。
- 簡介 （字串）：材料簡介。
- description （string）：材料的詳細描述。
- onClick（object）：點擊材質時觸發的動作。
- image （string）：與材質相關聯的影像路徑。
- recommendedItemTypes （array）：工作負載詳細數據頁面上顯示的建議項目類型清單。
-
learningMaterials （陣列）：工作負載詳細數據頁面上顯示的學習教材清單。
建立體驗
在產品中建立新項目的配置，指定用戶互動的選項。
-
createExperience （object）：建立工作負載專案的組態。
- description （string）：建立體驗的一般描述。
-
卡片 （array）：建立程式期間顯示的卡片清單。
- title （string）：卡片的標題。
- description （string）：卡片的簡短描述。
- icon （object）：卡片中使用的圖示路徑。
- onClick （object）：按兩下卡片時所觸發的動作。
- availableIn （array）：卡片可供使用的位置。
- itemType （字串）：連結至所建立卡片的項目類型。
工作區設定和產品詳細數據
-
workspaceSettings （物件）：工作區功能特有的設定。
- getWorkspaceSettings （物件）：包含可擷取工作區設定的動作。
-
productDetail （object）：產品商標和資訊的其他詳細數據。
- publisher （string）：產品的發行者。
- 口號 （字串）：產品口號。
- description （string）：產品的簡短描述。
-
image （object）：產品映像的設定。
- mediaType （整數）：影像的媒體類型。
- source （string）：影像的路徑。
-
slideMedia （array）：產品詳細數據頁面投影片中使用的媒體檔案清單。
-
限制：
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.。
- 注意：在 vimeo URL 中 不要包含
-
-
mediaType （整數）：投影片的媒體類型。 針對影像使用
-
限制：
slideMedia 組態範例：
"slideMedia": [
{
"mediaType": 1,
"source": "https://youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi"
},
{
"mediaType": 0,
"source": "assets/images/SlideImage1.png"
}
]
物品清單
專案指令清單會定義工作負載內個別專案的組態詳細數據，包括屬性、圖示、編輯器路徑和作業相關設定。
屬性
- name （string）：專案的唯一系統名稱。
- displayName （string）：針對項目顯示的用戶易記名稱。
- displayNamePlural （字串）：顯示名稱的複數形式以供顯示之用。
編輯器和圖示組態
-
editor （object）：Fabric 工作負載應用程式中專案編輯器的路徑組態。
- path （string）：編輯器的相對路徑。
-
icon （object）：指定代表項目的圖示。
- name （string）：assets 資料夾中圖示檔案的路徑（例如“assets/icon.svg”。
內容功能表項目
定義專案操作功能表中可用的動作，為使用者提供互動選項。
-
contextMenuItems （array）：操作功能表中的動作清單。
- name （string）：動作的系統名稱。
- displayName （字串）：動作的顯示名稱。
-
圖示 （物件）：動作的圖示。
- name （string）：圖標檔的路徑（例如“assets/icon.svg”。
-
handler （object）：功能表項的動作處理程式。
- action （string）：所觸發動作的名稱。
- tooltip （字串）：動作的選擇性工具提示文字。
監控和 DataHub 配置
- supportedInMonitoringHub （布林值）：指定該項目是否可以在監視中樞中顯示或篩選。
- supportedInDatahubL1 （布林值）：指定項目是否可以在 DataHub L1 中顯示或篩選。
項目工作動作設定
與專案作業實例相關聯的作業相關動作組態。
-
itemJobActionConfig （物件）：定義與專案作業相關的動作。
-
registeredActions （物件）：包含作業動作，例如詳細數據、取消和重試。
- detail （object）：用於檢視作業詳細數據的動作。
- cancel （object）：取消作業的動作。
- retry （object）：重試作業的動作。
-
registeredActions （物件）：包含作業動作，例如詳細數據、取消和重試。
項目設定
項目設定的組態選項。
-
itemSettings （object）：項目的額外設定。
-
schedule （object）：包含排程資訊。
- itemJobType （string）：要從 Fabric 共用 UI 中排程的工作類型。
-
refreshType （字串）：指定項目的重新整理功能。 可能的值包括
"None"、"Refresh"與"Run"。
-
recentRun （object）：最近執行作業的組態。
- useRecentRunsComponent （boolean）：是否要使用 Fabric 共享最近的執行元件。
-
getItemSettings （object）：自定義項目設定的組態。
- 動作（字串）：將傳回自定義項目設定清單的對應動作名稱。
-
schedule （object）：包含排程資訊。
專案工作流程類別
定義項目類別，以便與 Fabric Task Flow Framework整合。
-
itemJobTypes （array）：指定指派給工作流程架構內項目的類別。 每個專案最多可以有兩個類別。 支援的類別包括：
"getData""storeData""prepareData""analyzeAndTrainData""trackData""visualizeData""develop""generalTask""others"
如果未指定任何類別，則會使用 "others" 做為預設值。