Dokumentace k manifestům Frontendu

Tento dokument poskytuje podrobný průvodce strukturou a konfigurací frontendových manifestů v úlohách Fabricu. Tyto manifesty založené na JSON umožňují partnerům definovat vzhled úloh, identitu a chování, které jsou nezbytné pro poskytování přizpůsobených a konzistentních prostředí v prostředcích Fabric.

Front-endové manifesty se skládají ze dvou hlavních komponent:

• manifest produktu: Definuje identitu a značku pracovní zátěže.
• Manifest položek: Podrobnosti konfigurace jednotlivých položek v rámci úlohy, včetně prvků určených k interakci s uživatelem.

Manifest produktu

Manifest produktu definuje základní atributy produktu úlohy a určuje jeho identitu, branding a konfiguraci pro interakci uživatele.

Atributy

• name (string): Jedinečný systémový název produktu.
• displayName (řetězec): Uživatelsky přívětivý zobrazovaný název.
• fullDisplayName (řetězec): Popisný název pro produkt.
• favicon (řetězec): Cesta k faviconu produktu.
• icon (objekt): Cesta k ikoně produktu uložená ve složce assets (např. "assets/icon.png").

Konfigurace domovské stránky

Definuje rozložení a obsah domovské stránky úlohy.

• homePage (objekt): Nastavení konfigurace domovské stránky.
  • learningMaterials (pole): Seznam výukových materiálů zobrazených na stránce podrobností o úloze
    • title (řetězec): Název výukového materiálu.
    • úvod (řetězec): Stručný úvod do materiálu.
    • description (string): Podrobný popis materiálu.
    • onClick (object): Akce se aktivovala po kliknutí na materiál.
    • image (řetězec): Cesta k obrázku přidruženému k materiálu.
  • recommendedItemTypes (array): Seznam doporučených typů položek zobrazených na stránce podrobností úlohy

Vytvořit zážitek

Konfigurace pro vytváření nových položek v produktu, určení možností pro interakci uživatele.

• createExperience (object): Konfigurace pro vytváření položek úloh.
  • description (string): Obecný popis prostředí pro vytváření
  • cards (pole): Seznam karet zobrazených během procesu vytváření.
    • title (string): Název karty.
    • popis (řetězec): Stručný popis karty.
    • icon (object): Cesta k ikoně použité na kartě.
    • onClick (object): Akce se aktivovala po kliknutí na kartu.
    • availableIn (pole): Lokace, kde je karta k dispozici.
    • itemType (řetězec): Typ položky propojené s vytvořenou kartou
    • createItemDialogConfig (objekt): Konfigurace dialogu pro vytvoření položky
      • onCreationFailure (objekt): Akce se aktivovala při selhání vytváření položky.
      • onCreationSuccess (objekt): Akce se aktivovala při úspěšném vytvoření položky.

Poznámka:

createItemDialogConfig použití vyžaduje přidání obslužných rutin onCreationFailure a onCreationSuccess v rámci akcí index.worker.ts. Příklad najdete v našem ukázkovém úložišti.

Nastavení pracovního prostoru a podrobnosti o produktu

• workspaceSettings (object): Nastavení specifická pro funkce pracovního prostoru.
  • getWorkspaceSettings (objekt): Obsahuje akci pro načtení nastavení pracovního prostoru.
• productDetail (objekt): Další podrobnosti o značce a informacích o produktu.
  • Vydavatel (textový řetězec): Vydavatel produktu.
  • heslo (řetězec): Heslo výrobku.
  • popis (řetězec): Krátký popis produktu.
  • image (objekt): Konfigurace imagí produktu.
    • mediaType (celé číslo): Typ média obrázku.
    • source (string): Cesta k obrázku.
  • slideMedia (pole): Seznam mediálních souborů použitých na snímcích s podrobnostmi o produktu
    • Limit: V poli nejsou povoleny více než slideMedia položek.
    • jednotlivé položky (objekt):
      • mediaType (celé číslo): Typ média snímku. Použijte 0 pro obrázky a 1 pro videa.
      • zdroj (řetězec): Cesta ke zdroji obrázků nebo videí.
      • Poznámka: Pro videa: Zadejte adresu URL videa. Podporované formáty jsou:
        • https://youtube.com/embed/<id> nebo https://www.youtube.com/embed/<id>
          • Příklad: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
        • https://player.vimeo.com/video/<number>
          • Poznámka: Nezahrnujte do adresy URL vimeo zahrnout www..

Příklad konfigurace slideMedia:

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

Manifest položek

Manifest položky definuje podrobnosti konfigurace jednotlivých položek v rámci úlohy, včetně atributů, ikon, cest editoru a nastavení souvisejících s úlohami.

Atributy

• name (string): Jedinečný systémový název položky.
• displayName (řetězec): Uživatelsky přívětivý název zobrazený pro položku.
• displayNamePlural (řetězec): Množné číslo názvu pro zobrazení.

Konfigurace editoru a ikon

• editor (objekt): Konfigurace cesty pro editor pro danou položku v aplikaci typu Fabric workload.
  • path (string): Relativní cesta k editoru.
• icon (object): Určuje ikonu představující položku.
  • name (string): Cesta k souboru ikony ve složce assets (např. "assets/icon.svg").

Položky místní nabídky

Definuje akce dostupné v místní nabídce položky a poskytuje uživatelům možnosti interakce.

• contextMenuItems (pole): Seznam akcí v kontextové nabídce.
  • name (string): Název systému akce.
  • displayName (řetězec): Zobrazovaný název akce.
  • ikona (objekt): Ikona pro akci.
    • name (string): Cesta k souboru ikony (např. "assets/icon.svg").
  • obslužná rutina (objekt): Zpracovává akci pro položku nabídky.
    • action (string): Název aktivované akce.
  • nápověda (řetězec): Volitelný text nápovědy pro akci

Monitorování a konfigurace DataHubu

• supportedInMonitoringHub (boolean): Určuje, jestli je možné položku zobrazit nebo filtrovat v centru monitorování.
• supportedInDatahubL1 (boolean): Určuje, jestli je možné položku zobrazit nebo filtrovat v DataHubU L1.

Konfigurace položky akce úlohy

Konfigurace pro akce související s pracovním úkolem přidruženým k instanci položky.

• itemJobActionConfig (objekt): Definuje akce související s úlohami položky.
  • registeredActions (objekt): Obsahuje akce úlohy, jako jsou podrobnosti, zrušení a opakování.
    • detail (objekt): Akce pro zobrazení podrobností úlohy
    • zrušit (objekt): Akce pro zrušení úlohy.
    • retry (objekt): Akce pro opakování úlohy.

Nastavení položky

Možnosti konfigurace pro nastavení položek

• itemSettings (objekt): Extra nastavení položky.
  • schedule (object): Obsahuje informace o plánování.
    • itemJobType (řetězec): Typ úlohy, který se má naplánovat ze sdíleného uživatelského rozhraní Fabric.
    • refreshType (řetězec): Určuje schopnost aktualizace položky. Možné hodnoty zahrnují "None", "Refresh"a "Run".
  • recentRun (object): Konfigurace pro poslední spuštění úlohy.
    • useRecentRunsComponent (logická hodnota): Určuje, zda má být použita sdílená komponenta nedávných spuštění Fabric.
  • getItemSettings (objekt): Konfigurace pro nastavení vlastních položek.
    • akci (řetězec): Název odpovídající akce, která vrátí seznam nastavení vlastních položek.

Kategorie toku úkolů položky

Definuje kategorie položek pro integraci s rámcem Fabric Task Flow Framework.

• itemJobTypes (pole): Určuje kategorie přiřazené k položce v rámci architektury toku úloh. Každá položka může mít až dvě kategorie. Podporované kategorie:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

Pokud není zadána žádná kategorie, "others" se použije jako výchozí.

Kategorie katalogu Item OneLake

Definuje kategorie, ve kterých se položka zobrazuje v katalogu OneLake.

• oneLakeCatalogCategory (matice): Určuje kategorie, ve kterých je položka zobrazena v katalogu OneLake. Každá položka může mít až dvě kategorie. Podporované kategorie:
  • "Data"
  • "Insight"
  • "Process"
  • "Solution"
  • "Configuration"
  • "Other"

Pokud není zadána žádná kategorie, položka se nezobrazí v katalogu OneLake.

Konfigurace dialogového okna pro vytvoření položky

Stanovuje konfiguraci dialogového okna pro vytvoření položky, která umožňuje zobrazení dialogu z centra pracovních úloh při kliknutí na typ položky.

• createItemDialogConfig (objekt): Konfigurace dialogového okna pro vytvoření položky
  • onCreationFailure (objekt): Akce se aktivovala při selhání vytváření položky.
  • onCreationSuccess (objekt): Akce se aktivovala při úspěšném vytvoření položky.

Poznámka:

createItemDialogConfig použití vyžaduje přidání onCreationFailure obslužných rutin a onCreationSuccess obslužné rutiny akcí v index.worker.ts. Příklad najdete v našem ukázkovém úložišti.