Del via

Dokumentation til Frontend Manifests

Dette dokument indeholder en detaljeret vejledning i strukturen og konfigurationen af frontendmanifester i Fabric-arbejdsbelastninger. Disse JSON-baserede manifester giver partnere mulighed for at definere arbejdsbelastningsudseende, identitet og funktionsmåde, hvilket er vigtigt for at give brugerne en skræddersyet og ensartet oplevelse i Fabric.

Frontendmanifester består af to hovedkomponenter:

  • Produktmanifest: Definerer arbejdsbelastningens identitet og branding.
  • Elementmanifest: Detaljer om konfiguration af individuelle elementer i arbejdsbelastningen, herunder elementer til brugerinteraktion.

Produktmanifest

Produktmanifestet definerer kerneattributterne for arbejdsbelastningens produkt og angiver dets identitet, branding og konfiguration for brugerinteraktion.

Attributter

  • name (string): Et entydigt systemnavn for produktet.
  • displayName (streng): Et brugervenligt vist navn.
  • fullDisplayName (streng): Et beskrivende navn for produktet.
  • favicon (streng): Sti til produktets favicon.
  • ikon (objekt): Sti til produktets ikon, der er gemt i mappen assets (f.eks. "assets/icon.png").

Konfiguration af startside

Definerer layoutet og indholdet af arbejdsbelastningens startside.

  • homePage (objekt): Konfigurationsindstillinger for startsiden.
    • learningMaterials (matrix): Liste over læringsmateriale, der vises på siden med oplysninger om arbejdsbelastning.
      • title (string): Titel på læringsmaterialet.
      • introduction (streng): Kort introduktion til materialet.
      • description (streng): Detaljeret beskrivelse af materialet.
      • onClick (objekt): Handling udløst, når der klikkes på materialet.
      • image (string): Sti til det billede, der er knyttet til materialet.
    • recommendedItemTypes (matrix): Liste over anbefalede elementtyper, der vises på siden med oplysninger om arbejdsbelastning.

Opret oplevelse

Konfigurationer til oprettelse af nye elementer i produktet, der angiver indstillinger for brugerinteraktion.

  • createExperience (objekt): Konfiguration til oprettelse af arbejdsbelastningselementer.
    • description (string): Generel beskrivelse af oprettelsesoplevelsen.
    • kort (matrix): Liste over kort, der vises under oprettelsesprocessen.
      • title (string): Kortets titel.
      • description (string): Kort beskrivelse af kortet.
      • ikon (objekt): Sti til det ikon, der bruges på kortet.
      • onClick (objekt): Handling udløst, når der klikkes på kortet.
      • availableIn (matrix): Placeringer, hvor kortet er tilgængeligt.
      • itemType (streng): Type af element, der er knyttet til det oprettede kort.
      • createItemDialogConfig (objekt): Opret konfiguration af elementdialogboks.
        • onCreationFailure (objekt): Handling, der udløses, når oprettelse af element mislykkedes.
        • onCreationSuccess (objekt): Handling, der udløses, når elementet blev oprettet.

Bemærk

createItemDialogConfig Brug kræver tilføjelse onCreationFailure og onCreationSuccess handlingshandlere i index.worker.ts. Eksemplet kan findes i vores prøvelager.

Indstillinger for arbejdsområde og produktoplysninger

  • workspaceSettings (objekt): Indstillinger, der er specifikke for arbejdsområdefunktioner.
    • getWorkspaceSettings (objekt): Indeholder en handling til at hente indstillinger for arbejdsområdet.
  • productDetail (objekt): Flere oplysninger om produktbranding og -oplysninger.
    • publisher (streng): Udgiver af produktet.
    • slogan (streng): Produktslogan.
    • description (streng): Kort beskrivelse af produktet.
    • image (objekt): Konfiguration af produktafbildninger.
      • mediaType (heltal): Billedets medietype.
      • source (string): Sti til billedet.
    • slideMedia (matrix): Liste over mediefiler, der bruges i sideslides med produktoplysninger.
      • grænse: Der må ikke være mere end 10 elementer i matrixen slideMedia.
      • Hvert element (objekt):
        • mediaType (heltal): Slidens medietype. Brug 0 til billeder og 1 til videoer.
        • kilde (streng): Sti til billedet eller videokilden.
        • Note: For videoer: Angiv en URL-adresse til videoen. Understøttede formater er:
          • https://youtube.com/embed/<id> eller https://www.youtube.com/embed/<id>
            • Eksempel: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
          • https://player.vimeo.com/video/<number>
            • Bemærk! Medtag ikkewww. i URL-adressen til vimeo.

Eksempel på slideMedia konfiguration:

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

Elementmanifest

Elementmanifestet definerer konfigurationsdetaljer for individuelle elementer i arbejdsbelastningen, herunder attributter, ikoner, editorstier og jobrelaterede indstillinger.

Attributter

  • name (string): Et entydigt systemnavn for elementet.
  • displayName (streng): Brugervenligt navn, der vises for elementet.
  • displayNamePlural (streng): Flertalsform af det viste navn til visningsformål.

Konfiguration af editor og ikon

  • editor (objekt): Stikonfiguration for elementets editor i Fabric-arbejdsbelastningsappen.
    • path (string): Relativ sti til editoren.
  • ikon (objekt): Angiver det ikon, der repræsenterer elementet.
    • name (string): Sti til ikonfilen i mappen assets (f.eks. "assets/icon.svg").

Genvejsmenuelementer

Definerer de handlinger, der er tilgængelige i elementets genvejsmenu, og giver brugerne interaktionsindstillinger.

  • contextMenuItems (matrix): Liste over handlinger i genvejsmenuen.
    • name (string): Systemnavn på handlingen.
    • displayName (streng): Vist navn for handlingen.
    • ikon (objekt): Ikon for handlingen.
      • name (string): Sti til ikonfilen (f.eks. "assets/icon.svg").
    • handler (objekt): Handlingshandler for menupunktet.
      • action (string): Navnet på den handling, der blev udløst.
    • værktøjstip (streng): Valgfrit værktøjstiptekst til handlingen.

Konfiguration af overvågning og DataHub

  • supportedInMonitoringHub (boolesk): Angiver, om elementet kan vises eller filtreres i Overvågningshubben.
  • supportedInDatahubL1 (boolesk): Angiver, om elementet kan vises eller filtreres i DataHub L1.

Konfiguration af elementjobhandling

Konfigurationer for jobrelaterede handlinger, der er knyttet til elementjobforekomsten.

  • itemJobActionConfig (objekt): Definerer handlinger, der er relateret til elementets job.
    • registeredActions (objekt): Indeholder jobhandlinger, f.eks. detaljer, annuller og forsøg igen.
      • detail (objekt): Handling til visning af joboplysninger.
      • cancel (objekt): Handling til annullering af et job.
      • forsøg igen (objekt): Handling til forsøg på et job igen.

Elementindstillinger

Konfigurationsindstillinger for elementindstillinger.

  • itemSettings (objekt): Ekstra indstillinger for elementet.
    • schedule (objekt): Indeholder planlægningsoplysninger.
      • itemJobType (streng): Jobtype, der skal planlægges fra fabric-delt brugergrænseflade.
      • refreshType (streng): Angiver elementets opdateringsfunktion. De mulige værdier omfatter "None", "Refresh"og "Run".
    • recentRun (objekt): Konfiguration af seneste jobkørsler.
      • useRecentRunsComponent (boolesk): Om du vil bruge fabric-komponenten til delte seneste kørsler.
    • getItemSettings (objekt): Konfiguration af brugerdefinerede elementindstillinger.
      • handling (streng): Navnet på den tilsvarende handling, der returnerer listen over brugerdefinerede elementindstillinger.

Kategorier for elementopgaveforløb

Definerer dine elementkategorier til integration med Fabric Task Flow Framework.

  • itemJobTypes (matrix): Angiver de kategorier, der er tildelt et element i opgaveflowstrukturen. Hvert element kan have op til to kategorier. Understøttede kategorier er:
    • "getData"
    • "storeData"
    • "prepareData"
    • "analyzeAndTrainData"
    • "trackData"
    • "visualizeData"
    • "develop"
    • "generalTask"
    • "others"

Hvis der ikke er angivet en kategori, bruges "others" som standard.

Vare OneLake Katalog Kategorier

Definerer kategorier, hvor din vare vises i OneLake-kataloget.

  • oneLakeCatalogCategory (matrix): Angiver de kategorier, som elementet vises i i OneLake-kataloget. Hvert element kan have op til to kategorier. Understøttede kategorier er:
    • "Data"
    • "Insight"
    • "Process"
    • "Solution"
    • "Configuration"
    • "Other"

Hvis der ikke er angivet en kategori, vises varen ikke i OneLake-kataloget.

Konfiguration af dialogboksen Opret element

Definerer konfiguration af dialogboksen Opret element, som bruges til at vise dialogboksen fra arbejdsbelastningshubben, når der klikkes på elementtype.

  • createItemDialogConfig (objekt): Opret konfiguration af elementdialogboks.
    • onCreationFailure (objekt): Handling, der udløses, når oprettelse af element mislykkedes.
    • onCreationSuccess (objekt): Handling, der udløses, når elementet blev oprettet.

Bemærk

createItemDialogConfig Brug kræver tilføjelse onCreationFailure og onCreationSuccess handlingshandlere i index.worker.ts. Eksemplet kan findes i vores prøvelager.

  • Last updated on