Delen via

Documentatie voor frontendmanifesten

Dit document bevat een gedetailleerde handleiding voor de structuur en configuratie van de front-endmanifesten in Fabric-workloads. Met deze manifesten op basis van JSON kunnen partners het uiterlijk, de identiteit en het gedrag van workloads definiëren die essentieel zijn voor het bieden van gebruikers aan een aangepaste en consistente ervaring in Fabric.

Front-endmanifesten bestaan uit twee hoofdonderdelen:

  • productmanifest: definieert de identiteit en huisstijl van de workload.
  • Itemmanifest: Detailsconfiguratie voor afzonderlijke items binnen de workload, inclusief elementen van gebruikersinteractie.

Productmanifestatie

Het productmanifest definieert de kernkenmerken van het product van de workload, waarbij de identiteit, huisstijl en configuratie voor gebruikersinteractie worden opgegeven.

Kenmerken

  • name (tekenreeks): een unieke systeemnaam voor het product.
  • displayName (tekenreeks): een gebruiksvriendelijke weergavenaam.
  • fullDisplayName (tekenreeks): een beschrijvende naam voor het product.
  • favicon (tekenreeks): Pad naar het favicon van het product.
  • pictogram (object): Pad naar het pictogram van het product, opgeslagen in de map assets (bijvoorbeeld 'assets/icon.png').

Configuratie van startpagina

Hiermee definieert u de indeling en inhoud van de startpagina van de workload.

  • homePage (object): Configuratie-instellingen voor de startpagina.
    • learningMaterials (array): Lijst met leermaterialen die wordt weergegeven op de pagina met workloaddetails.
      • titel (tekenreeks): Titel van het leermateriaal.
      • inleiding (tekenreeks): Korte inleiding tot het materiaal.
      • description (string): Gedetailleerde beschrijving van het materiaal.
      • onClick (object): actie geactiveerd wanneer het materiaal wordt geklikt.
      • afbeelding (tekenreeks): Pad naar de afbeelding die is gekoppeld aan het materiaal.
    • recommendedItemTypes (array): Lijst met aanbevolen itemtypen die op de workloaddetailpagina worden weergegeven.

Ervaring maken

Configuraties voor het maken van nieuwe items in het product, waarbij opties voor gebruikersinteractie worden opgegeven.

  • createExperience (object): Configuratie voor het maken van workloaditems.
    • beschrijving (tekenreeks): Algemene beschrijving van de creatie-ervaring.
    • kaarten (matrix): Lijst met kaarten die worden weergegeven tijdens het aanmaakproces.
      • titel (tekenreeks): Titel van de kaart.
      • beschrijving (tekenreeks): Korte beschrijving van de kaart.
      • pictogram (object): Pad naar het pictogram dat in de kaart wordt gebruikt.
      • onClick (object): actie geactiveerd wanneer op de kaart wordt geklikt.
      • availableIn (array): Locaties waar de kaart beschikbaar is.
      • itemType (tekenreeks): Type item dat is gekoppeld aan de gemaakte kaart.
      • createItemDialogConfig (object): Configuratie voor het maken van een itemdialoogvenster.
        • onCreationFailure (object): actie geactiveerd wanneer het maken van het item is mislukt.
        • onCreationSuccess (object): actie geactiveerd wanneer het maken van het item is geslaagd.

Notitie

createItemDialogConfig gebruik vereist dat er onCreationFailure en onCreationSuccess actie-handlers worden toegevoegd in index.worker.ts. Voorbeeld vindt u in onze voorbeeldopslagplaats.

Werkruimte-instellingen en productdetails

  • workspaceSettings (object): Instellingen die specifiek zijn voor werkruimtefunctionaliteit.
    • getWorkspaceSettings (object): bevat actie om werkruimte-instellingen op te halen.
  • productDetail (object): Aanvullende details voor de huisstijl en informatie van het product.
    • uitgever (tekenreeks): Uitgever van het product.
    • slogan (tekenreeks): Productlogan.
    • beschrijving (tekenreeks): korte beschrijving van het product.
    • afbeelding (object): Configuratie van productafbeeldingen.
      • mediaType (integer): Mediatype van de afbeelding.
      • bron (tekenreeks): Pad naar de afbeelding.
    • slideMedia (array): Lijst van mediabestanden die worden gebruikt in dia's op de productdetailpagina's.
      • beperken: niet meer dan 10 items zijn toegestaan in de slideMedia matrix.
      • Elk item (object):
        • mediaType (geheel getal): Mediatype van de dia. Gebruik 0 voor afbeeldingen en 1 voor video's.
        • bron (tekenreeks): pad naar de afbeelding of videobron.
        • Opmerking: Voor video's: Geef een URL op voor de video. Ondersteunde indelingen zijn:
          • https://youtube.com/embed/<id> of https://www.youtube.com/embed/<id>
            • Voorbeeld: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
          • https://player.vimeo.com/video/<number>
            • Opmerking: Voeg nietwww. toe in de Vimeo-URL.

Voorbeeld van slideMedia-configuratie:

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

Itemmanifest

Het itemmanifest definieert configuratiedetails voor afzonderlijke items binnen de workload, waaronder kenmerken, pictogrammen, editorpaden en taakgerelateerde instellingen.

Kenmerken

  • name (tekenreeks): een unieke systeemnaam voor het item.
  • displayName (tekenreeks): Gebruiksvriendelijke naam weergegeven voor het item.
  • displayNamePlural: Meervoudsvorm van de naam voor weergavedoeleinden.

Configuratie van editor en pictogram

  • editor (object): Padconfiguratie voor de editor van het item in de workload-app Fabric.
    • pad (tekenreeks): relatief pad naar de editor.
  • pictogram (object): Hiermee geeft u het pictogram aan dat het item vertegenwoordigt.
    • name (tekenreeks): Pad naar het pictogrambestand in de map assets (bijvoorbeeld 'assets/icon.svg').

Onderdelen van het contextmenu

Hiermee definieert u acties die beschikbaar zijn in het contextmenu van het item, zodat gebruikers interactieopties hebben.

  • contextMenuItems (matrix): Lijst met acties in het contextmenu.
    • name (tekenreeks): systeemnaam van de actie.
    • displayName (tekenreeks): Weergavenaam voor de actie.
    • pictogram (object): pictogram voor de actie.
      • name (tekenreeks): Pad naar het pictogrambestand (bijvoorbeeld 'assets/icon.svg').
    • handler (object): Actie-handler voor het menu-item.
      • actie (tekenreeks): naam van de geactiveerde actie.
    • knopinfo (tekenreeks): Optionele knopinfotekst voor de actie.

Monitoring en DataHub-configuratie

  • supportedInMonitoringHub (booleaanse waarde): hiermee geeft u op of het item kan worden weergegeven of gefilterd in de Monitoring Hub.
  • supportedInDatahubL1 (boolean): Hiermee geeft u op of het item kan worden weergegeven of gefilterd in de DataHub L1.

Itemtaakactieconfiguratie

Configuraties voor taakgerelateerde acties die zijn gekoppeld aan het itemtaakexemplaar.

  • itemJobActionConfig (object): Definieert acties die betrekking hebben op de taken van het item.
    • registeredActions (object): bevat taakacties zoals details, annuleren en opnieuw proberen.
      • detail (object): actie voor het weergeven van taakdetails.
      • annuleren (object): actie voor het annuleren van een taak.
      • opnieuw proberen (object): actie voor het opnieuw proberen van een taak.

Iteminstellingen

Configuratieopties voor iteminstellingen.

  • itemSettings (object): Extra instellingen voor het item.
    • planning (object): bevat planningsgegevens.
      • itemJobType (tekenreeks): taaktype dat moet worden gepland vanuit de gedeelde gebruikersinterface van Fabric.
      • refreshType (tekenreeks): hiermee geeft u de vernieuwingsmogelijkheid van het item op. Mogelijke waarden zijn "None", "Refresh"en "Run".
    • recentRun (object): configuratie voor recente taakuitvoeringen.
      • useRecentRunsComponent (booleaanse waarde): of u het Fabric gedeelde component voor recente uitvoeringen wilt gebruiken.
    • getItemSettings (object): Configuratie voor aangepaste iteminstellingen.
      • actie (tekenreeks): naam van de bijbehorende actie die de lijst met aangepaste iteminstellingen retourneert.

Categorieën van itemtaakstromen

Definieert de itemcategorieën voor integratie met het Fabric Task Flow Framework.

  • itemJobTypes (matrix): Hiermee geeft u de categorieën op die zijn toegewezen aan een item binnen het taakstroomframework. Elk item kan uit maximaal twee categorieën bestaan. Ondersteunde categorieën zijn:
    • "getData"
    • "storeData"
    • "prepareData"
    • "analyzeAndTrainData"
    • "trackData"
    • "visualizeData"
    • "develop"
    • "generalTask"
    • "others"

Als er geen categorie is opgegeven, wordt "others" als de standaardwaarde gebruikt.

Onderdeel OneLake cataloguscategorieën

Hiermee definieert u categorieën waarin uw item wordt weergegeven in de OneLake-catalogus.

  • oneLakeCatalogCategory (matrix): Hiermee geeft u de categorieën op waarin het item wordt weergegeven in de OneLake-catalogus. Elk item kan uit maximaal twee categorieën bestaan. Ondersteunde categorieën zijn:
    • "Data"
    • "Insight"
    • "Process"
    • "Solution"
    • "Configuration"
    • "Other"

Als er geen categorie is opgegeven, wordt het item niet weergegeven in de OneLake-catalogus.

Configuratie voor het maken van een itemdialoogvenster

Hiermee definieert u de configuratie van het dialoogvenster voor het maken van een item, dat wordt gebruikt om het dialoogvenster vanuit de workloadhub weer te geven wanneer op een itemtype wordt geklikt.

  • createItemDialogConfig (object): Configuratie voor aanmaak dialoogvenster.
    • onCreationFailure (object): actie geactiveerd wanneer het maken van het item is mislukt.
    • onCreationSuccess (object): actie geactiveerd wanneer het maken van het item is geslaagd.

Notitie

createItemDialogConfighet gebruik vereist dat je onCreationFailure en onCreationSuccess actie handlers toevoegt in index.worker.ts. Voorbeeld vindt u in onze voorbeeldopslagplaats.

  • Last updated on