Dokumentace k manifestům front-endu

Tento dokument obsahuje podrobný průvodce strukturou a konfigurací front-endových manifestů v úlohách Infrastruktury. 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: Definujte identitu a branding úloh.
• Manifest položky: Konfigurace podrobností pro jednotlivé položky v rámci úlohy, včetně prvků interakce uživatele.

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 produktu.
• 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 (string): Title of the learning material.
    • ú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ření prostředí

Konfigurace pro vytvářenínovýchch

• createExperience (object): Konfigurace pro vytváření položek úloh.
  • description (string): Obecný popis prostředí pro vytváření
  • cards (array): List of cards displayed during the creation process.
    • title (string): Title of the card.
    • 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): Umístění, kde je karta k dispozici.
    • itemType (řetězec): Typ položky propojené s vytvořenou kartou

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 (ř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

Manifest položky

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): V množném čísle zobrazovaného názvu pro účely zobrazení.

Konfigurace editoru a ikon

• editor (objekt): Konfigurace cesty pro editor položky v aplikaci úloh Infrastruktury
  • 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 místní nabídce.
  • name (string): Název systému akce.
  • displayName (řetězec): Zobrazovaný název akce.
  • icon (object): Icon for the action.
    • name (string): Cesta k souboru ikony (např. "assets/icon.svg").
  • obslužná rutina (objekt): Obslužná rutina akce pro položku nabídky.
    • action (string): Název aktivované akce.
  • popis (řetězec): Volitelný text popisu akce

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 akce úlohy položky

Konfigurace pro akce související s úlohou přidruženou k instanci úlohy 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
    • cancel (object): Action for canceling a job.
    • retry (object): Action for retrying a job.

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í prostředků infrastruktury.
    • 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 (boolean): Určuje, jestli se má použít komponenta naposledy sdíleného spuštění prostředků infrastruktury.
  • 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 architekturou toku úloh Fabric ..

• 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 jsou "getData", , "storeData", "prepareData", "analyzeAndTrainData""trackData""visualizeData""develop", "generalTask", a ."others" Pokud není zadána žádná kategorie, jako výchozí se použije "ostatní".

Poznámka:

Při vývoji a testování nových atributů přidaných do manifestu se ujistěte, že jste synchronizovali nejnovější ověřovací skripty a nástroje z našeho ukázkového úložiště.

Tento krok je nezbytný jenom pro místní vývoj a nevyžaduje se pro cloudový režim.