Поделиться через

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

  • Статья

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

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

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

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

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

Атрибуты

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

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

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

  • homePage (object): параметры конфигурации для домашней страницы.
    • learning Материалы (массив): список учебных материалов, отображаемых на странице сведений о рабочей нагрузке.
      • title (string): Title of the learning material.
      • введение (строка): краткое введение в материал.
      • 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 (массив): список файлов мультимедиа, используемых на слайдах страниц сведений о продукте.

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

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

Атрибуты

  • 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): тип задания для планирования из общего пользовательского интерфейса структуры.
      • refreshType (string): указывает возможность обновления элемента. Возможными значениями являются "None", "Refresh" и "Run".
    • recentRun (object): Конфигурация для последних запусков заданий.
      • useRecentRunsComponent (boolean): следует ли использовать общий компонент последних запусков fabric.
    • getItemSettings (object): Конфигурация для параметров пользовательского элемента.
      • действие (строка): имя соответствующего действия, возвращающего список параметров пользовательского элемента.

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

Определяет категории элементов для интеграции с Fabric Task Flow Framework..

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

Примечание.

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

Этот шаг необходим только для локальной разработки и не требуется для облачного режима.