Документация по манифестам внешнего интерфейса

В этом документе содержится подробное руководство по структуре и настройке интерфейсных манифестов в рабочих нагрузках Fabric. Эти манифесты на основе JSON позволяют партнерам определять внешний вид рабочей нагрузки, удостоверение и поведение, необходимые для предоставления пользователям специализированного и согласованного интерфейса в Fabric.

Интерфейсные манифесты состоят из двух основных компонентов:

• манифест продукта: определяет идентификацию рабочей нагрузки и брендинг.
• Манифест элемента: сведения о конфигурации отдельных элементов в рабочей нагрузке, включая элементы взаимодействия с пользователем.

Манифест продукта

Манифест продукта определяет основные атрибуты продукта в рамках рабочей нагрузки, указывая его идентичность, фирменную символику и конфигурацию для взаимодействия с пользователем.

Атрибуты

• name (string): уникальное системное имя продукта.
• displayName (string): понятное отображаемое имя.
• fullDisplayName (string): описательное имя продукта.
• favicon (строка): Путь к favicon продукта.
• значок (объект): Путь к значку продукта, хранящимся в папке ресурсов (например, "assets/icon.png").

Конфигурация домашней страницы

Определяет макет и содержимое домашней страницы задачи.

• homePage (object): параметры конфигурации для домашней страницы.
  • учебные Материалы (массив): список учебных материалов, отображаемых на странице данных о рабочей нагрузке.
    • title (string): Название учебного материала.
    • введение (строка): краткое введение в материал.
    • description (string): подробное описание материала.
    • onClick (объект): действие, активируется при щелчке материала.
    • image (string): Путь к изображению , связанному с материалом.
  • recommendedItemTypes (array): список рекомендуемых типов элементов, отображаемых на странице сведений о рабочей нагрузке.

Создать впечатление

Конфигурации для создания новых элементов в продукте, указывая параметры взаимодействия с пользователем.

• createExperience (object): Конфигурация для создания элементов рабочей нагрузки.
  • description (string): общее описание интерфейса создания.
  • карточки (массив): список карточек, отображаемых во время процесса создания.
    • title (string): Заголовок карточки.
    • description (string): Краткое описание карточки.
    • значок (объект): Путь к значку , используемому в карточке.
    • onClick (объект): действие активируется при щелчке карточки.
    • availableIn (array): места, где доступна карта.
    • itemType (string): тип элемента, связанного с созданной карточкой.

Параметры рабочей области и сведения о продукте

• workspaceSettings (object): параметры, относящиеся к функциональным возможностям рабочей области.
  • getWorkspaceSettings (object): содержит действие для получения параметров рабочей области.
• productDetail (object): дополнительные сведения о фирменной символии продукта и сведениях.
  • publisher (string): Издатель продукта.
  • лозунг (строка): Лозунг продукта.
  • description (string): Краткое описание продукта.
  • image (object): Конфигурация образов продуктов.
    • mediaType (целое число): тип носителя изображения.
    • source (string): Путь к изображению.
  • 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>
          • Примечание: не включайте , и www. в URL-адрес vimeo.

Пример конфигурации slideMedia:

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

Манифест элемента

Манифест элемента определяет сведения о конфигурации отдельных элементов в рабочей нагрузке, включая атрибуты, значки, пути редактора и параметры, связанные с заданием.

Атрибуты

• name (string): уникальное системное имя элемента.
• displayName (string): Понятное имя, отображаемое для элемента.
• displayNamePlural (string): Множественное число отображаемого имени для целей показа.

Настройка редактора и значка

• редактор (объект): конфигурация пути для редактора элемента в приложении рабочей нагрузки Fabric.
  • path (string): Относительный путь к редактору.
• значок (объект): указывает значок , представляющий элемент.
  • name (string): Путь к файлу значка в папке ресурсов (например, "assets/icon.svg").

Элементы контекстного меню

Определяет действия, доступные в контекстном меню элемента, предоставляя пользователям параметры взаимодействия.

• contextMenuItems (array): список действий в контекстном меню.
  • имя (строка): системное имя действия.
  • displayName (string): отображаемое имя действия.
  • значок (объект): значок для действия.
    • name (string): Путь к файлу значка (например, "assets/icon.svg").
  • обработчик (объект): функция для обработки действий в элементе меню.
    • действие (строка): имя активированного действия.
  • подсказка (строка): необязательный текст подсказки для действия.

Мониторинг и настройка DataHub

• supportedInMonitoringHub (boolean): указывает, может ли элемент отображаться или фильтроваться в Центре мониторинга.
• supportedInDatahubL1 (boolean): указывает, может ли элемент отображаться или фильтроваться в DataHub L1.

Конфигурация действия задачи элемента

Конфигурации для действий, связанных с заданием, связанных с экземпляром задания элемента.

• itemJobActionConfig (object): определяет действия, связанные с заданиями элемента.
  • registeredActions (object): содержит действия задания, такие как подробности, отмена и повторная попытка.
    • details (object): Действие для просмотра сведений о задании.
    • cancel (object): Действие для отмены задания.
    • повторная попытка (объект): действие для повтора задания.

Параметры элемента

Параметры конфигурации для параметров элемента.

• itemSettings (object): дополнительные параметры элемента.
  • расписание (объект): содержит сведения о планировании.
    • itemJobType (string): тип задания для планирования из общего пользовательского интерфейса Fabric.
    • refreshType (string): указывает возможность обновления элемента. Возможными значениями являются "None", "Refresh" и "Run".
  • recentRun (object): Конфигурация для последних запусков заданий.
    • useRecentRunsComponent (boolean): следует ли использовать общий компонент последних запусков Fabric.
  • getItemSettings (object): Конфигурация для параметров пользовательского элемента.
    • действие (строка): название соответствующего действия, возвращающее список параметров пользовательского элемента.

Категории потоков задач элемента

Определяет категории ваших элементов для интеграции с Платформой потоков задач Fabric .

• itemJobTypes (array): указывает категории, назначенные элементу в платформе потока задач. Каждый элемент может иметь до двух категорий. Поддерживаемые категории:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

Если категория не указана, "others" используется в качестве значения по умолчанию.