Dela via

Dokumentation om klientdelsmanifest

  • Artikel

Det här dokumentet innehåller en detaljerad guide till strukturen och konfigurationen av klientdelsmanifesten i Infrastrukturarbetsbelastningar. Dessa JSON-baserade manifest gör det möjligt för partner att definiera arbetsbelastningens utseende, identitet och beteende, vilket är viktigt för att ge användarna en skräddarsydd och konsekvent upplevelse i Fabric.

Klientdelsmanifest består av två huvudkomponenter:

  • Produktmanifest: Definiera arbetsbelastningens identitet och varumärke.
  • Objektmanifest: Informationskonfiguration för enskilda objekt i arbetsbelastningen, inklusive användarinteraktionselement.

Produktmanifest

Produktmanifestet definierar huvudattributen för arbetsbelastningens produkt och anger dess identitet, varumärke och konfiguration för användarinteraktion.

Attribut

  • name (string): Ett unikt systemnamn för produkten.
  • displayName (sträng): Ett användarvänligt visningsnamn.
  • fullDisplayName (sträng): Ett beskrivande namn för produkten.
  • favicon (sträng): Sökväg till produktens favicon.
  • ikon (objekt): Sökväg till produktens ikon som lagras i mappen assets (t.ex. "assets/icon.png").

Konfiguration av startsida

Definierar layouten och innehållet på arbetsbelastningens startsida.

  • homePage (objekt): Konfigurationsinställningar för startsidan.
    • learningMaterials (matris): Lista över utbildningsmaterial som visas på sidan med arbetsbelastningsinformation.
      • titel (sträng): Titel på inlärningsmaterialet.
      • introduktion (sträng): Kort introduktion till materialet.
      • beskrivning (sträng): Detaljerad beskrivning av materialet.
      • onClick (objekt): Åtgärd som utlöses när materialet klickas.
      • bild (sträng): Sökväg till den bild som är associerad med materialet.
    • recommendedItemTypes (matris): Lista över rekommenderade objekttyper som visas på sidan med arbetsbelastningsinformation.

Skapa upplevelse

Konfigurationer för att skapa nya objekt i produkten och ange alternativ för användarinteraktion.

  • createExperience (objekt): Konfiguration för att skapa arbetsbelastningsobjekt.
    • description (string): Allmän beskrivning av skapa-upplevelsen.
    • cards (array): Lista över kort som visas under skapandeprocessen.
      • title (sträng): Kortets rubrik.
      • beskrivning (sträng): Kort beskrivning av kortet.
      • ikon (objekt): Sökväg till ikonen som används i kortet.
      • onClick (objekt): Åtgärd som utlöses när kortet klickas.
      • availableIn (matris): Platser där kortet är tillgängligt.
      • itemType (sträng): Typ av objekt som är länkat till det skapade kortet.

Inställningar för arbetsyta och produktinformation

  • workspaceSettings (object): Inställningar som är specifika för arbetsytefunktioner.
    • getWorkspaceSettings (objekt): Innehåller åtgärd för att hämta arbetsyteinställningar.
  • productDetail (objekt): Ytterligare information för produktanpassning och information.
    • utgivare (sträng): Utgivare av produkten.
    • slogan (sträng): Produktslogan.
    • beskrivning (sträng): Kort beskrivning av produkten.
    • image (object): Konfiguration av produktbilder.
      • mediaType (heltal): Medietyp för bilden.
      • källa (sträng): Sökväg till bilden.
    • slideMedia (matris): Lista över mediefiler som används i produktinformationssidans bilder.

Objektmanifest

Objektmanifestet definierar konfigurationsinformation för enskilda objekt i arbetsbelastningen, inklusive attribut, ikoner, redigeringssökvägar och jobbrelaterade inställningar.

Attribut

  • name (string): Ett unikt systemnamn för objektet.
  • displayName (sträng): Användarvänligt namn som visas för objektet.
  • displayNamePlural (sträng): Pluralform av visningsnamnet i visningssyfte.

Konfiguration av redigerare och ikon

  • redigerare (objekt): Sökvägskonfiguration för objektets redigerare i arbetsbelastningsappen Infrastruktur.
    • path (string): Relativ sökväg till redigeraren.
  • icon (object): Anger ikonen som representerar objektet.
    • name (string): Sökväg till ikonfilen i mappen assets (t.ex. "assets/icon.svg").

Snabbmenyobjekt

Definierar åtgärder som är tillgängliga på objektets snabbmeny, vilket ger användarna interaktionsalternativ.

  • contextMenuItems (matris): Lista över åtgärder i snabbmenyn.
    • name (string): Systemnamn för åtgärden.
    • displayName (sträng): Visningsnamn för åtgärden.
    • ikon (objekt): Ikon för åtgärden.
      • name (string): Sökväg till ikonfilen (t.ex. "assets/icon.svg").
    • handler (object): Åtgärdshanterare för menyalternativet.
      • action (string): Namnet på åtgärden som utlöstes.
    • knappbeskrivning (sträng): Valfri knappbeskrivningstext för åtgärden.

Övervakning och DataHub-konfiguration

  • supportedInMonitoringHub (booleskt): Anger om objektet kan visas eller filtreras i övervakningshubben.
  • supportedInDatahubL1 (booleskt): Anger om objektet kan visas eller filtreras i DataHub L1.

Konfiguration av objektjobbsåtgärd

Konfigurationer för jobbrelaterade åtgärder som är associerade med objektjobbinstansen.

  • itemJobActionConfig (objekt): Definierar åtgärder relaterade till objektets jobb.
    • registeredActions (objekt): Innehåller jobbåtgärder som information, avbryt och försök igen.
      • detail (object): Åtgärd för att visa jobbinformation.
      • avbryt (objekt): Åtgärd för att avbryta ett jobb.
      • retry (object): Åtgärd för att försöka ett jobb igen.

Objektinställningar

Konfigurationsalternativ för objektinställningar.

  • itemSettings (objekt): Extra inställningar för objektet.
    • schema (objekt): Innehåller schemaläggningsinformation.
      • itemJobType (sträng): Jobbtyp som ska schemaläggas från delat användargränssnitt för infrastrukturresurser.
      • refreshType (sträng): Anger objektets uppdateringsfunktion. Möjliga värden är "None", "Refresh"och "Run".
    • recentRun (objekt): Konfiguration för de senaste jobbkörningarna.
      • useRecentRunsComponent (booleskt): Om du vill använda komponenten delade nyligen använda infrastrukturresurser.
    • getItemSettings (objekt): Konfiguration för anpassade objektinställningar.
      • åtgärd (sträng): namnet på motsvarande åtgärd som returnerar listan med anpassade objektinställningar.

Objektaktivitetsflödeskategorier

Definierar dina objektkategorier för integrering med Fabric Task Flow Framework..

  • itemJobTypes (matris): Anger de kategorier som tilldelats ett objekt i uppgiftsflödesramverket. Varje objekt kan ha upp till två kategorier. Kategorier som stöds är "getData", "storeData", "prepareData", "analyzeAndTrainData", "trackData", "visualizeData", "develop", "generalTask"och "others". Om ingen kategori anges används "andra" som standard.

Kommentar

När du utvecklar och testar nya attribut som läggs till i manifestet kontrollerar du att du har synkroniserat de senaste valideringsskripten och verktygen från vår exempellagringsplats.

Det här steget är bara nödvändigt för lokal utveckling och krävs inte för molnläge.