Klientska dokumentácia k manifestom

Tento dokument obsahuje podrobnú príručku k štruktúre a konfigurácii predných manifestov vyťažení služby Fabric. Tieto manifesty založené na JSON umožňujú partnerom definovať vzhľad, identitu a správanie, ktoré sú nevyhnutné na poskytovanie používateľom prispôsobené a konzistentné používanie v službe Fabric.

Klientske manifesty sa skladajú z dvoch hlavných komponentov:

  • Product Manifest: Definuje identitu vyťaženia a značky.
  • Manifest položky: Konfigurácia podrobností pre jednotlivé položky v rámci vyťaženia vrátane prvkov interakcie používateľa.

Manifest produktu

Manifest produktu definuje hlavné atribúty produktu vyťaženia, určuje jeho identitu, značku a konfiguráciu na interakciu používateľa.

Atribúty

  • názov (reťazec): jedinečný systémový názov produktu.
  • displayName (reťazec): popisný zobrazovaný názov.
  • fullDisplayName (reťazec): Popisný názov produktu.
  • favicon (reťazec): Cesta k faviconu produktu.
  • icon (objekt): Cesta k ikone produktu uložená v priečinku položiek (napr. "assets/icon.png").

Konfigurácia domovskej stránky

Definuje rozloženie a obsah domovskej stránky vyťaženia.

  • homePage (objekt): nastavenia konfigurácie pre domovskú stránku.
    • learningMaterials (pole): Zoznam učebných materiálov zobrazený na stránke s podrobnosťami o vyťažení .
      • názov (reťazec): Názov vzdelávacieho materiálu.
      • úvod (reťazec): Stručný úvod do materiálu.
      • description (reťazec): Podrobný popis materiálu.
      • onClick (objekt): Akcia sa spustila po kliknutí na materiál.
      • image (reťazec): Cesta k obrázku súvisiacemu s materiálom.
    • recommendedItemTypes (pole): Zoznam odporúčaných typov položiek zobrazených na stránke s podrobnosťami o vyťažení .

Vytvoriť prostredie

Konfigurácie na vytváranie nových položiek v produkte a určenie možností interakcie používateľa.

  • createExperience (objekt): Konfigurácia na vytvorenie položiek vyťaženia.
    • description (reťazec): Všeobecný popis prostredia na vytváranie.
    • cards (pole): Zoznam kariet zobrazených počas procesu vytvárania.
      • title (reťazec): Názov karty.
      • description (reťazec): Stručný popis karty.
      • ikona (objekt): cesta k ikone použitej na karte.
      • onClick (objekt): Akcia sa spustila po kliknutí na kartu.
      • availableIn (pole): miesta, kde je karta k dispozícii.
      • itemType (reťazec): Typ položky prepojenej na vytvorenú kartu.
      • createItemDialogConfig (objekt): Konfigurácia dialógového okna Vytvorenie položky.
        • onCreationFailure (objekt): Akcia spustená pri zlyhaní vytvorenia položky.
        • onCreationSuccess (objekt): Akcia sa spustí po úspešnom vytvorení položky.

Poznámka

createItemDialogConfig Použitie vyžaduje pridanie onCreationFailure a onCreationSuccess akciu obslužných programov v index.worker.tsrozhraní . Príklad nájdete v našom vzorovom úložisku.

Nastavenia pracovného priestoru a podrobnosti o produkte

  • workspaceSettings (objekt): nastavenia špecifické pre funkciu pracovného priestoru.
    • getWorkspaceSettings (objekt): Obsahuje akciu na načítanie nastavení pracovného priestoru.
  • productDetail (objekt): Ďalšie podrobnosti o značke produktu a informácie.
    • vydavateľ (reťazec): Vydavateľ produktu.
    • slogan (reťazec): Slogan produktu.
    • description (reťazec): Krátky popis produktu.
    • image (objekt): Konfigurácia obrázkov produktov.
      • mediaType (celé číslo): Typ médií obrázka.
      • source (reťazec): Cesta k obrázku.
    • slideMedia (pole): Zoznam mediálnych súborov používaných na snímkach stránky s podrobnosťami o produkte.
      • Limit: V poli nie je povolených viac ako slideMedia položiek.
      • každú položku (objekt):
        • mediaType (celé číslo): Typ médií snímky. Použite 0 na obrázky a 1 videí.
        • zdrojový (reťazec): Cesta k obrázku alebo zdroju videa.
        • poznámka: V prípade videí: zadajte URL adresu videa. Podporované formáty sú:
          • https://youtube.com/embed/<id> alebo https://www.youtube.com/embed/<id>
            • Príklad: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
          • https://player.vimeo.com/video/<number>
            • Poznámka: Do URL adresy vimeo nezahrňte www..

Príklad konfigurácie slideMedia:

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

Manifest položky

Manifest položky definuje podrobnosti konfigurácie pre jednotlivé položky v rámci vyťaženia vrátane atribútov, ikon, ciest editora a nastavení súvisiacich s úlohou.

Atribúty

  • názov (reťazec): jedinečný názov systému pre položku.
  • displayName (reťazec): popisný názov zobrazený pre položku.
  • displayNamePlural (reťazec): Tvar v množnom čísle zobrazovaného názvu na účely zobrazenia.

Konfigurácia editora a ikon

  • editor (objekt): Konfigurácia cesty pre editor položky v aplikácii vyťaženia služby Fabric.
    • path (reťazec): Relatívna cesta k editoru.
  • ikona (objekt): určuje ikonu predstavujúcu položku.
    • názov (reťazec): Cesta k súboru ikony v priečinku položiek (napr. "assets/icon.svg").

Položky kontextovej ponuky

Definuje akcie, ktoré sú k dispozícii v kontextovej ponuke položky, čím používateľom poskytuje možnosti interakcie.

  • contextMenuItems (pole): Zoznam akcií v kontextovej ponuke.
    • názov (reťazec): Názov systému akcie.
    • displayName (reťazec): Zobrazovaný názov akcie.
    • ikona (objekt): ikona akcie.
      • názov (reťazec): Cesta k súboru ikony (napr. "assets/icon.svg").
    • obslužný program (objekt): obsluha akcií pre položku ponuky.
      • action (reťazec): Názov spustenej akcie.
    • tooltip (reťazec): Voliteľný text popisu pre akciu.

Monitorovanie a konfigurácia služby DataHub

  • supportedInMonitoringHub (boolean): Určuje, či sa položka môže zobraziť alebo filtrovať v centre monitorovania.
  • supportedInDatahubL1 (booleovská hodnota): Určuje, či sa položka môže zobraziť alebo filtrovať v službe DataHub L1.

Konfigurácia akcie úlohy položky

Konfigurácie pre akcie súvisiace s úlohou súvisiace s inštanciou úlohy položky.

  • itemJobActionConfig (objekt): Definuje akcie súvisiace s úlohami položky.
    • registeredActions (objekt): obsahuje akcie úlohy, ako sú podrobnosti, zrušenie a opakovanie.
      • podrobnosti (objekt): akcia na zobrazenie podrobností úlohy.
      • zrušiť (objekt): akcia na zrušenie úlohy.
      • opakovanie (objekt): akcia pre opakovanie úlohy.

Nastavenia položky

Možnosti konfigurácií pre nastavenia položiek.

  • itemSettings (objekt): Ďalšie nastavenia pre položku.
    • schedule (objekt): obsahuje informácie o plánovaní.
      • itemJobType (reťazec): Typ úlohy, ktorá sa má naplánovať zo zdieľaného používateľského rozhrania služby Fabric.
      • refreshType (reťazec): určuje možnosti obnovenia položky. Možné hodnoty zahŕňajú "None", "Refresh"a "Run".
    • recentRun (objekt): Konfigurácia pre spustenia nedávnych úloh.
      • použite funkciuRecentRunsComponent (booleovská hodnota): Použitie zdieľanej súčasti zdieľaných spustení služby Fabric.
    • getItemSettings (objekt): Konfigurácia pre nastavenia vlastných položiek.
      • akcie (reťazec): Názov zodpovedajúcej akcie, ktorá vráti zoznam nastavení vlastnej položky.

Kategórie postupu úloh položiek

Definuje kategórie položiek na integráciu s architektúrou služby Fabric Task Flow Framework.

  • itemJobTypes (pole): určuje kategórie priradené položke v rámci postupu úloh. Každá položka môže mať až dve kategórie. Podporované kategórie sú:
    • "getData"
    • "storeData"
    • "prepareData"
    • "analyzeAndTrainData"
    • "trackData"
    • "visualizeData"
    • "develop"
    • "generalTask"
    • "others"

Ak nie je zadaná žiadna kategória, použije sa "others" ako predvolená hodnota.

Kategórie katalógu položiek OneLake

Definuje kategórie, v ktorých sa vaša položka zobrazuje v katalógu OneLake.

  • oneLakeCatalogCategory (pole): Určuje kategórie, v ktorých sa položka zobrazuje v katalógu OneLake. Každá položka môže mať až dve kategórie. Podporované kategórie sú:
    • "Data"
    • "Insight"
    • "Process"
    • "Solution"
    • "Configuration"
    • "Other"

Ak nie je zadaná žiadna kategória, položka sa nezobrazí v katalógu OneLake.

Konfigurácia dialógového okna Vytvoriť položku

Definuje konfiguráciu dialógového okna vytvoriť položku, ktorá sa používa na zobrazenie dialógového okna z centra vyťaženia pri kliknutí typu položky.

  • createItemDialogConfig (objekt): Konfigurácia dialógového okna Vytvorenie položky.
    • onCreationFailure (objekt): Akcia spustená pri zlyhaní vytvorenia položky.
    • onCreationSuccess (objekt): Akcia sa spustí po úspešnom vytvorení položky.

Poznámka

createItemDialogConfig Použitie vyžaduje pridanie onCreationFailure a onCreationSuccess akciu obslužných programov v index.worker.tsrozhraní . Príklad nájdete v našom vzorovom úložisku.

  • Last updated on