Documentação de manifestos de front-end

Este documento fornece um guia detalhado sobre a estrutura e a configuração dos manifestos de front-end nas 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 de front-end consistem em dois componentes principais:

• Manifesto do produto: define a identidade de carga de trabalho e a identidade visual.
• 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 a identidade, identidade visual e configuração dele para interação do usuário.

Atributos

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

Configuração da Home Page

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

• homePage (objeto): configurações para a home page.
  • learningMaterials (matriz): lista de materiais de aprendizagem exibidos na página de detalhes da carga de trabalho.
    • title (cadeia de caracteres): o título do material de aprendizagem.
    • introduction (cadeia de caracteres): breve introdução ao material.
    • description (cadeia de caracteres): descrição detalhada do material.
    • onClick (objeto): a ação disparada quando o material é clicado.
    • image (cadeia de caracteres): caminho para a imagem associada ao material.
  • recommendedItemTypes (matriz): lista de tipos de item recomendados exibidos na página de detalhes da carga de trabalho.

Experiência de criação

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 (cadeia de caracteres): descrição geral da experiência de criação.
  • cards (matriz): lista de cartões exibidos durante o processo de criação.
    • title (cadeia de caracteres): título do cartão.
    • description (cadeia de caracteres): breve descrição do cartão.
    • icon (objeto): caminho para o ícone usado no cartão.
    • onClick (objeto): ação disparada quando o cartão é clicado.
    • availableIn (matriz): locais em que o cartão está disponível.
    • itemType (cadeia de caracteres): tipo de item vinculado ao cartão criado.
    • createItemDialogConfig (objeto): Criar configuração de diálogo de item.
      • onCreationFailure (objeto): ação disparada quando a criação do item falhou.
      • onCreationSuccess (objeto): ação disparada quando a criação do item foi bem-sucedida.

Configurações do workspace e detalhes do produto

• workspaceSettings (objeto): configurações específicas da funcionalidade do workspace.
  • getWorkspaceSettings (objeto): contém uma ação para recuperar as configurações do workspace.
• productDetail (objeto): detalhes adicionais para identidade visual e informações do produto.
  • publisher (cadeia de caracteres): o editor do produto.
  • slogan (cadeia de caracteres): o slogan do produto.
  • description (cadeia de caracteres): descrição curta do produto.
  • image (objeto): configuração de imagens do produto.
    • mediaType (inteiro): tipo de mídia da imagem.
    • source (cadeia de caracteres): caminho para a imagem.
  • slideMedia (matriz): lista de arquivos de mídia usados em slides de página de detalhes do produto.
    • Limite: não são permitidos mais de 10 itens na slideMedia matriz.
    • Cada item (objeto):
      • mediaType (inteiro): tipo de mídia do slide. Use 0 para imagens e 1 vídeos.
      • origem (cadeia de caracteres): caminho para a imagem ou fonte de vídeo.
      • Observação: Para vídeos: forneça uma URL para o vídeo. Os formatos com suporte 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>
          • Observação: não inclua www. na URL do Vimeo.

Exemplo de slideMedia configuração:

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

Manifesto do item

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 (cadeia de caracteres): um nome de sistema exclusivo para o item.
• displayName (cadeia de caracteres): um nome amigável exibido para o item.
• displayNamePlural (cadeia de caracteres): forma plural do nome de exibição para fins de exibição.

Configuração de editor e ícone

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

Itens de menu de contexto

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

• contextMenuItems (matriz): lista de ações no menu de contexto.
  • name (cadeia de caracteres): nome do sistema da ação.
  • displayName (cadeia de caracteres): nome de exibição para a ação.
  • icon (objeto): ícone para a ação.
    • name (cadeia de caracteres): caminho para o arquivo de ícone (por exemplo, "ativos/icon.svg").
  • handler (objeto): manipulador de ação para o item de menu.
    • action (cadeia de caracteres): nome da ação disparada.
  • tooltip (cadeia de caracteres): texto opcional da dica de ferramenta para a ação.

Monitoramento e configuração do DataHub

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

Configuração da ação do trabalho de item

Configurações para ações relacionadas ao trabalho associadas à instância do trabalho de item.

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

Configurações de item

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

• itemSettings (objeto): configurações extras para o item.
  • schedule (objeto): contém informações de agendamento.
    • itemJobType (string): tipo de trabalho a ser agendado da interface do usuário compartilhada do Fabric.
    • refreshType (cadeia de caracteres): especifica a funcionalidade de atualização do item. Os valores possíveis incluem "None", "Refresh" e "Run".
  • recentRun (objeto): configuração para execuções de trabalho recentes.
    • useRecentRunsComponent (booleano): Indica se deve usar o componente de execuções recentes compartilhado do Fabric.
  • getItemSettings (objeto): configuração de itens personalizados.
    • ação (cadeia de caracteres): nome da ação correspondente que retornará a lista de configurações de item personalizado.

Categorias de fluxo de tarefa de item

Define as categorias de itens 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 com suporte são:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

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

Categorias de catálogo do Item OneLake

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

• oneLakeCatalogCategory (matriz): especifica as categorias nas quais o item aparece no catálogo do OneLake. Cada item pode ter até duas categorias. As categorias com suporte 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 do diálogo de item

Defina a configuração da caixa de diálogo para criar item, que é usada para mostrar a caixa de diálogo do hub de trabalho no clique do tipo de item.

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