本文档详细指导如何在 Fabric 工作负载中构造和配置前端清单。 通过这些基于 JSON 的清单，合作伙伴能够定义工作负载外观、标识和行为，这对于在 Fabric 中为用户提供定制且一致的体验至关重要。
前端清单由两个主要组件组成：
- 产品清单：定义工作负荷标识和品牌。
- 项清单：工作负载中各个项的详细信息配置，包括用户交互元素。
产品清单
产品清单定义工作负载产品的核心属性，指定其标识、品牌和用户交互配置。
特性
- name（字符串）：用于产品的唯一系统名称。
displayName （字符串）：用户友好的显示名称。 - fullDisplayName（字符串）：产品的描述性名称。
- favicon（字符串）：产品网站图标的路径。
- icon（对象）：产品图标的路径，存储在资产文件夹中（例如“assets/icon.png”）。
主页配置
定义工作负载主页的布局和内容。
- homePage（对象）：主页的配置设置。
- learningMaterials（数组）：工作负载详细信息页上显示的学习材料列表。
- title（字符串）：学习材料的标题。
- 简介（字符串）：材料的简要介绍。
- description（字符串）：材料的详细描述。
- onClick（事件对象）：单击材料时触发的操作。
- image（字符串）：与材料关联的图像的路径。
- recommendedItemTypes（数组）：工作负载详细信息页上显示的推荐项类型的列表。
- learningMaterials（数组）：工作负载详细信息页上显示的学习材料列表。
创建体验
在产品中创建新项时的配置，用于指定用户交互选项。
- createExperience（对象）：用于创建工作负载项的配置。
- description（字符串）：创建体验的一般说明。
- 卡片（数组）：创建过程中显示的卡片列表。
- title（字符串）：卡片的标题。
- description（字符串）：卡片的简要说明。
- icon（对象）：卡片中使用的图标的路径。
- onClick（对象）：单击卡片时触发的操作。
- availableIn（数组）：可以使用卡片的位置。
- itemType（字符串）：关联到已创建卡片的项目类型。
-
createItemDialogConfig （对象）：创建项目对话框配置。
- onCreationFailure （对象）：在项创建失败时触发的操作。
- onCreationSuccess（操作）：在创建项成功时触发的操作。
注意
createItemDialogConfig用法需要在index.worker.ts中添加onCreationFailure和onCreationSuccess操作处理程序。 可以在 示例存储库中找到示例。
工作区设置和产品详细信息
- workspaceSettings（对象）：特定于工作区功能的设置。
- getWorkspaceSettings（对象）：包含用于检索工作区设置的操作。
- productDetail（对象）：产品品牌和信息的其他详细信息。
- 发布者（字符串）：产品的出版者。
- slogan（字符串）：产品口号。
- description（字符串）：产品的简短说明。
- image（对象）：产品映像的配置。
- mediaType（整数）：图像的媒体类型。
- source（字符串）：图像的路径。
-
slideMedia（数组）：用于产品详情页幻灯片的媒体文件列表。
-
限制： 数组中不允许超过
slideMedia项。 - 每个项目（对象）：
-
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（字符串）：用于项目的唯一系统名称。
- displayName（字符串）：用于显示该项的用户友好名称。
- displayNamePlural（字符串）：用于显示目的的显示名称的复数形式。
编辑器和图标配置
- editor（对象）：Fabric 工作负载应用中项编辑器的路径配置。
- path（字符串）：编辑器的相对路径。
- icon（对象）：指定表示项的图标。
- name（字符串）：资产文件夹中图标文件的路径（例如“assets/icon.svg”）。
上下文菜单项
定义项上下文菜单中可用的操作，为用户提供交互选项。
- contextMenuItems（数组）：上下文菜单中的操作列表。
- name（字符串）：操作的系统名称。
- displayName（字符串）：操作的显示名称。
- icon（对象）：操作的图标。
- name（字符串）：图标文件的路径（例如“assets/icon.svg”）。
- handler（对象）：菜单项的操作处理程序。
- action（字符串）：所触发操作的名称。
- tooltip（字符串）：此操作的可选工具提示文字。
监视和 DataHub 配置
- supportedInMonitoringHub（布尔）：指定是否可以在监视中心显示或筛选该项。
- supportedInDatahubL1（布尔）：指定该项是否可以在 DataHub L1 中显示或筛选。
项作业操作配置
与项作业实例关联的作业相关操作的配置。
- itemJobActionConfig（对象）：定义与项作业相关的操作。
- registeredActions（对象）：包含详细信息、取消和重试等作业操作。
- detail（对象）：用于查看作业详细信息的操作。
- cancel（对象）：用于取消作业的操作。
- retry（对象）：用于重试作业的操作。
- registeredActions（对象）：包含详细信息、取消和重试等作业操作。
项目设置
项设置的配置选项。
-
itemSettings（对象）：物品的额外设置。
-
schedule（对象）：包含调度信息。
- itemJobType（字符串）：要从 Fabric 共享 UI 计划的作业类型。
- refreshType（字符串）：指定项的刷新功能。 可能的值包括
"None"、"Refresh"和"Run"。
-
recentRun（对象）：最近作业运行的配置。
- useRecentRunsComponent（布尔）：是否使用 Fabric 共享的最近运行组件。
-
getItemSettings（对象）：自定义项设置的配置。
- 动作（字符串）：对应动作的名称，将返回自定义项设置列表。
-
schedule（对象）：包含调度信息。
项目任务流程类别
定义项类别，以便与 Fabric 任务流框架集成。
- itemJobTypes（数组）：指定分配给任务流框架中的项的类别。 每个项最多可以有两个类别。 支持的类别包括：
"getData""storeData""prepareData""analyzeAndTrainData""trackData""visualizeData""develop""generalTask""others"
如果未指定任何类别，则 "others" 用作默认值。
项目 OneLake 目录类别
定义您在 OneLake 目录中项目显示的类别。
-
oneLakeCatalogCategory （数组）：指定 OneLake 目录中显示该项的类别。 每个项最多可以有两个类别。 支持的类别包括：
"Data""Insight""Process""Solution""Configuration""Other"
如果未指定任何类别，则不会在 OneLake 目录中显示该项。
创建项目对话框配置
定义创建项对话框配置，该配置用于在单击项类型时显示工作负载中心的对话框。
-
createItemDialogConfig （对象）：创建项目对话框配置。
- onCreationFailure （动作）：创建条目失败时触发的动作。
- onCreationSuccess（对象）：创建项成功时触发的动作。
注意
createItemDialogConfig用法需要在index.worker.ts中添加onCreationFailure和onCreationSuccess操作处理程序。 可以在 示例存储库中找到示例。