Dokumentasjon for Frontend-manifester

Dette dokumentet gir en detaljert veiledning for strukturen og konfigurasjonen av de frontede manifestene i stoffarbeidsbelastninger. Disse JSON-baserte manifestene gjør det mulig for partnere å definere arbeidsbelastningsutseende, identitet og atferd, avgjørende for å gi brukerne en skreddersydd og konsekvent opplevelse i Fabric.

Frontend-manifester består av to hovedkomponenter:

• Produktmanifest: Definer arbeidsbelastningens identitet og varemerking.
• Elementmanifest: Detaljerkonfigurasjon for individuelle elementer i arbeidsbelastningen, inkludert elementer for brukersamhandling.

Produktmanifest

Produktmanifestet definerer kjerneattributtene til arbeidsbelastningens produkt, og angir identitet, varemerking og konfigurasjon for brukersamhandling.

Attributter

• navn (streng): Et unikt systemnavn for produktet.
• displayName (streng): Et brukervennlig visningsnavn.
• fullDisplayName (streng): Et beskrivende navn for produktet.
• favicon (streng): Bane til produktets favicon.
• ikon (objekt): Bane til produktets ikon, lagret i aktivamappen (for eksempel «aktiva/icon.png»).

Startsidekonfigurasjon

Definerer oppsettet og innholdet på arbeidsmengdens hjemmeside.

• startside (objekt): Konfigurasjonsinnstillinger for hjemmesiden.
  • lærematerialer (matrise): Liste over læringsmateriell som vises på siden for arbeidsbelastningsdetaljer.
    • tittel (streng): Tittel på læringsmaterialet.
    • introduksjon (streng): Kort innføring i materialet.
    • beskrivelse (streng): Detaljert beskrivelse av materialet.
    • onClick (objekt): Handling utløses når materialet klikkes.
    • bilde (streng): Bane til bildet som er knyttet til materialet.
  • recommendedItemTypes (matrise): Liste over anbefalte elementtyper som vises på siden for arbeidsbelastningsdetaljer.

Opprett opplevelse

Konfigurasjoner for oppretting av nye elementer i produktet, som angir alternativer for brukersamhandling.

• createExperience (objekt): Konfigurasjon for oppretting av arbeidsbelastningselementer.
  • beskrivelse (streng): Generell beskrivelse av opprettingsopplevelsen.
  • kort (matrise): Liste over kort som vises under opprettingsprosessen.
    • tittel (streng): Tittel på kortet.
    • beskrivelse (streng): Kort beskrivelse av kortet.
    • ikon (objekt): Bane til ikonet som brukes på kortet.
    • onClick (objekt): Handling utløses når kortet klikkes.
    • availableIn (matrise): Plasseringer der kortet er tilgjengelig.
    • itemType (streng): Elementtype som er koblet til det opprettede kortet.

Innstillinger for arbeidsområde og produktdetaljer

• workspaceSettings (objekt): Innstillinger som er spesifikke for arbeidsområdefunksjonalitet.
  • getWorkspaceSettings (objekt): Inneholder handling for å hente innstillinger for arbeidsområdet.
• productDetail (objekt): Tilleggsdetaljer for produktmerking og informasjon.
  • utgiver (streng): Utgiver av produktet.
  • slagord (streng): Produktslagord.
  • beskrivelse (streng): Kort beskrivelse av produktet.
  • bilde (objekt): Konfigurasjon av produktbilder.
    • mediaType (heltall): Medietype for bildet.
    • kilde (streng): Bane til bildet.
  • slideMedia (matrise): Liste over mediefiler som brukes i sidelysbilder for produktdetaljer.

Elementmanifest

Elementmanifestet definerer konfigurasjonsdetaljer for individuelle elementer i arbeidsbelastningen, inkludert attributter, ikoner, redigeringsbaner og jobbrelaterte innstillinger.

Attributter

• navn (streng): Et unikt systemnavn for elementet.
• displayName (streng): Brukervennlig navn som vises for elementet.
• displayNamePlural (streng): Flertallsform for visningsnavnet for visningsformål.

Redigeringsprogram og ikonkonfigurasjon

• redigeringsprogram (objekt): Banekonfigurasjon for elementets redigeringsprogram i arbeidsbelastningsappen Fabric.
  • bane (streng): Relativ bane til redigeringsprogrammet.
• ikon ( objekt): Angir ikonet som representerer elementet.
  • navn (streng): Bane til ikonfilen i aktivamappen (for eksempel «aktiva/icon.svg»).

Hurtigmenyelementer

Definerer handlinger som er tilgjengelige i elementets hurtigmeny, og gir brukere samhandlingsalternativer.

• contextMenuItems (matrise): Liste over handlinger i hurtigmenyen.
  • navn (streng): Systemnavn for handlingen.
  • displayName (streng): Visningsnavn for handlingen.
  • ikon (objekt): Ikon for handlingen.
    • navn (streng): Bane til ikonfilen (for eksempel «aktiva/icon.svg»).
  • behandler (objekt): Handlingsbehandling for menyelementet.
    • handling (streng): Navnet på handlingen som ble utløst.
  • verktøytips (streng): Valgfri verktøytipstekst for handlingen.

Overvåking og DataHub-konfigurasjon

• supportedInMonitoringHub (boolsk): Angir om elementet kan vises eller filtreres i overvåkingshuben.
• supportedInDatahubL1 (boolsk): Angir om elementet kan vises eller filtreres i DataHub L1.

Handlingskonfigurasjon for elementjobb

Konfigurasjoner for jobbrelaterte handlinger som er knyttet til elementjobbforekomsten.

• itemJobActionConfig (objekt): Definerer handlinger relatert til elementjobbene.
  • registeredActions (objekt): Inneholder jobbhandlinger som detalj, avbryt og prøv på nytt.
    • detalj (objekt): Handling for å vise jobbdetaljer.
    • avbryt (objekt): Handling for å avbryte en jobb.
    • prøv på nytt (objekt): Handling for å prøve en jobb på nytt.

Elementinnstillinger

Konfigurasjonsalternativer for elementinnstillinger.

• itemSettings (objekt): Ekstra innstillinger for elementet.
  • tidsplan (objekt): Inneholder planleggingsinformasjon.
    • itemJobType (streng): Jobbtype som skal planlegges fra stoffdelt brukergrensesnitt.
    • refreshType (streng): Angir elementets oppdateringsfunksjonalitet. Mulige verdier inkluderer "None", "Refresh"og "Run".
  • recentRun (objekt): Konfigurasjon for nylige jobbkjøringer.
    • useRecentRunsComponent (boolsk): Om du vil bruke komponenten for nylig brukte kjøringer av stoff.

Kategorier for elementaktivitetsflyt

Definerer elementkategoriene for integrering med Fabric Task Flow Framework..

• itemJobTypes (matrise ): Angir kategoriene som er tilordnet et element i rammeverket for oppgaveflyten. Hvert element kan ha opptil to kategorier. Støttede kategorier er "getData", "storeData", , "prepareData""analyzeAndTrainData", "trackData", "visualizeData", "develop"og "generalTask""others". Hvis ingen kategori er angitt, brukes «andre» som standard.

Merk

Når du utvikler og tester nye attributter som er lagt til manifestet, må du kontrollere at du har synkronisert de nyeste valideringsskriptene og verktøyene fra eksempelrepositoriet vårt.

Dette trinnet er bare nødvendig for lokal utvikling og kreves ikke for skymodus.