Documentação de manifestos de front-end

Este documento fornece um guia detalhado para a estrutura e configuração dos manifestos de frontend em cargas de trabalho do Fabric. Esses manifestos baseados em JSON permitem que os parceiros definam a aparência, a identidade e o comportamento da carga de trabalho, essenciais para fornecer aos usuários uma experiência personalizada e consistente no Fabric.

Os manifestos frontend consistem em dois componentes principais:

• Product Manifest: define a identidade da carga de trabalho e a marca.
• Manifesto do item: detalha a configuração de itens individuais dentro da carga de trabalho, incluindo elementos de interação do usuário.

Manifesto do produto

O Manifesto do Produto define os principais atributos do produto da carga de trabalho, especificando sua identidade, identidade visual e configuração para interação do usuário.

Atributos

• name (string): um nome de sistema exclusivo para o produto.
• displayName (string): Um nome de exibição amigável.
• fullDisplayName (string): um nome descritivo para o produto.
• favicon (string): Caminho para o favicon do produto.
• ícone (objeto): caminho para o ícone do produto, armazenado na pasta assets (por exemplo, "assets/icon.png").

Configuração da Página Inicial

Define o layout e o conteúdo da home page da carga de trabalho.

• homePage (objeto): Definições de configuração para a página inicial.
  • learningMaterials (array): Lista de materiais de aprendizagem exibidos na página de detalhes da carga de trabalho.
    • title (string): Título do material de aprendizagem.
    • introdução (string): Breve introdução ao material.
    • description (string): Descrição detalhada do material.
    • onClick (objeto): Ação acionada quando o material é clicado.
    • image (string): Caminho para a imagem associada ao material.
  • recommendedItemTypes (array): Lista de tipos de itens recomendados exibida na página de detalhes da carga de trabalho.

Criar Experiência

Configurações para criar novos itens no produto, especificando opções para interação do usuário.

• createExperience (objeto): Configuração para a criação de itens de carga de trabalho.
  • description (string): Descrição geral da experiência de criação.
  • cards (array): Lista de cartões exibidos durante o processo de criação.
    • title (string): Título do cartão.
    • description (string): Breve descrição do cartão.
    • ícone (objeto): caminho para o ícone usado no cartão.
    • onClick (objeto): Ação acionada quando o cartão é clicado.
    • availableIn (array): Locais onde o cartão está disponível.
    • itemType (string): Tipo de item vinculado ao cartão criado.
    • createItemDialogConfig (objeto): Criar configuração de caixa de diálogo de item.
      • onCreationFailure (objeto): Ação acionada quando a criação do item falhou.
      • onCreationSuccess (objeto): Ação acionada quando a criação do item foi bem-sucedida.

Configurações do espaço de trabalho e detalhes do produto

• workspaceSettings (object): Configurações específicas para a funcionalidade do espaço de trabalho.
  • getWorkspaceSettings (objeto): contém ação para recuperar configurações de espaço de trabalho.
• productDetail (objeto): detalhes adicionais para marca e informações do produto.
  • publisher (string): editor do produto.
  • slogan (string): Slogan do produto.
  • description (string): Breve descrição do produto.
  • image (object): Configuração de imagens de produtos.
    • mediaType (inteiro): Tipo de mídia da imagem.
    • source (string): Caminho para a imagem.
  • slideMedia (array): Lista de arquivos de mídia usados na página de detalhes do produto.
    • Limite: Não são permitidos mais de 10 itens na matriz slideMedia.
    • Cada item (objeto):
      • mediaType (inteiro): Tipo de mídia do slide. Use 0 para imagens e 1 para vídeos.
      • origem (string): caminho para a fonte de imagem ou vídeo.
      • Nota: Para vídeos: forneça um URL para o vídeo. Os formatos suportados são:
        • https://youtube.com/embed/<id> ou https://www.youtube.com/embed/<id>
          • Exemplo: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
        • https://player.vimeo.com/video/<number>
          • Nota: Não incluir www. na URL do Vimeo.

Exemplo de configuração de slideMedia:

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

Manifesto de Itens

O Manifesto do Item define detalhes de configuração para itens individuais dentro da carga de trabalho, incluindo atributos, ícones, caminhos do editor e configurações relacionadas ao trabalho.

Atributos

• name (string): um nome de sistema exclusivo para o item.
• displayName (string): Nome amigável exibido para o item.
• displayNamePlural (string): Forma plural do nome para fins de exibição.

Configuração do Editor e do Ícone

• editor (objeto): configuração de caminho para o editor do item no aplicativo de carga de trabalho Fabric.
  • path (string): caminho relativo para o editor.
• icon (object): especifica o ícone que representa o item.
  • name (string): caminho para o arquivo de ícone na pasta assets (por exemplo, "assets/icon.svg").

Itens do menu de contexto

Define ações disponíveis no menu de contexto do item, fornecendo aos usuários opções de interação.

• contextMenuItems (array): Lista de ações no menu de contexto.
  • name (string): Nome do sistema da ação.
  • displayName (string): Nome para exibição da ação.
  • icon (objeto): ícone da ação.
    • name (string): caminho para o arquivo de ícone (por exemplo, "assets/icon.svg").
  • handler (object): Manipulador de ação para o item de menu.
    • action (string): Nome da ação acionada.
  • tooltip (string): Texto opcional da dica de ferramenta para a ação.

Monitoramento e configuração do DataHub

• supportedInMonitoringHub (booleano): Especifica se o item pode ser mostrado ou filtrado no Hub de Monitoramento.
• supportedInDatahubL1 (booleano): Especifica se o item pode ser mostrado ou filtrado no DataHub L1.

Configuração de Ação de Trabalho do Item

Configurações para ações relacionadas com a instância de trabalho associada a um item.

• itemJobActionConfig (objeto): define ações relacionadas aos trabalhos do item.
  • registeredActions (objeto): contém ações de trabalho como detalhar, cancelar e tentar novamente.
    • detail (object): Ação para visualizar detalhes do trabalho.
    • cancel (object): Ação para cancelar um trabalho.
    • retry (object): Ação para tentar novamente um trabalho.

Configurações do item

Opções de configurações para configurações de itens.

• itemSettings (object): Configurações extras para o item.
  • schedule (object): Contém informações de agendamento.
    • itemJobType (string): Tipo de trabalho a ser agendado a partir da interface do usuário compartilhada do Fabric.
    • refreshType (string): Especifica a capacidade de atualização do item. Os valores possíveis incluem "None", "Refresh"e "Run".
  • recentRun (object): Configuração para execuções de trabalho recentes.
    • useRecentRunsComponent (booleano): Indica se o componente partilhado de execuções recentes do Fabric deve ser utilizado.
  • getItemSettings (objeto): Definição para configurações personalizadas de item.
    • ação (string): Nome da ação correspondente que retornará a lista de configurações de item personalizado.

Categorias de Fluxo de Tarefas para Itens

Define suas categorias de item para integração com o Fabric Task Flow Framework.

• itemJobTypes (matriz): Especifica as categorias atribuídas a um item dentro da estrutura de fluxo de tarefas. Cada item pode ter até duas categorias. As categorias suportadas são:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

Se nenhuma categoria for especificada, "others" será usada como padrão.

Item OneLake - Categorias do Catálogo

Define categorias nas quais seu item é mostrado no catálogo do OneLake.

• oneLakeCatalogCategory (matriz): especifica as categorias nas quais o item é mostrado no catálogo do OneLake. Cada item pode ter até duas categorias. As categorias suportadas são:
  • "Data"
  • "Insight"
  • "Process"
  • "Solution"
  • "Configuration"
  • "Other"

Se nenhuma categoria for especificada, o item não será mostrado no catálogo do OneLake.

Criar configuração de caixa de diálogo de item

Define a configuração da caixa de diálogo de criação de item, que é usada para mostrar a caixa de diálogo do hub de carga de trabalho ao clicar no tipo de item.

• createItemDialogConfig (objeto): Criar configuração de caixa de diálogo de item.
  • onCreationFailure (objeto): Ação acionada quando a criação do item falhou.
  • onCreationSuccess (objeto): Ação acionada quando a criação do item foi bem-sucedida.