Dokumentation zu Front-End-Manifesten

Dieses Dokument enthält eine detaillierte Anleitung zur Struktur und Konfiguration der Front-End-Manifeste in Fabric-Workloads. Mit diesen auf JSON basierenden Manifesten können Partner Workload, Identität und Verhalten definieren, die für die Bereitstellung einer maßgeschneiderten und konsistenten Oberfläche in Fabric für Benutzer unerlässlich sind.

Front-End-Manifeste bestehen aus zwei Hauptkomponenten:

• Produktmanifest: Definiert die Workloadidentität und das Branding.
• Elementmanifest: Beschreibt die Konfiguration für einzelne Elemente innerhalb der Workload, einschließlich Benutzerinteraktionselementen, ausführlich.

Produktmanifest

Das Produktmanifest definiert die Kernattribute des Produkts der Workload, wobei die Identität, das Branding und die Konfiguration für die Benutzerinteraktion angegeben werden.

Attribute

• name (Zeichenfolge): Ein eindeutiger Systemname für das Produkt.
• displayName (Zeichenfolge): Ein benutzerfreundlicher Anzeigename.
• fullDisplayName (Zeichenfolge): Ein beschreibender Name für das Produkt.
• favicon (Zeichenfolge): Pfad zum Favicon des Produkts.
• icon (Objekt): Pfad zum Symbol des Produkts, das im Ressourcenordner (z. B. „assets/icon.png“) gespeichert ist.

Konfiguration der Startseite

Definiert das Layout und den Inhalt der Startseite der Workload.

• homePage (Objekt): Konfigurationseinstellungen für die Startseite.
  • learningMaterials (Array): Liste der Lernmaterialien, die auf der Seite „Workloaddetails“ angezeigt werden.
    • title (Zeichenfolge): Titel des Lernmaterials.
    • introduction (Zeichenfolge): Kurze Einführung in das Material.
    • description (Zeichenfolge): Ausführliche Beschreibung des Materials.
    • onClick (Objekt): Aktion, die ausgelöst wird, wenn auf das Material geklickt wird.
    • image (Zeichenfolge): Pfad zum Bild, das dem Material zugeordnet ist.
  • recommendedItemTypes (Array): Liste der empfohlenen Elementtypen, die auf der Seite „Workloaddetails“ angezeigt werden.

Erlebnis schaffen

Konfigurationen zum Erstellen neuer Elemente im Produkt, wobei Optionen für die Benutzerinteraktion angegeben werden.

• createExperience (Objekt): Konfiguration für die Erstellung von Workloadelementen.
  • description (Zeichenfolge): Allgemeine Beschreibung des Kreativerlebnisses.
  • cards (Array): Liste der Karten, die während des Erstellungsprozesses angezeigt werden.
    • title (Zeichenfolge): Titel der Karte.
    • description (Zeichenfolge): Kurze Beschreibung der Karte.
    • icon (Objekt): Pfad zum Symbol, das auf der Karte verwendet wird.
    • onClick (Objekt): Aktion, die ausgelöst wird, wenn auf die Karte geklickt wird.
    • availableIn (Array): Speicherorte, an denen die Karte verfügbar ist.
    • itemType (Zeichenfolge): Typ des Elements, das mit der erstellten Karte verknüpft ist.

Arbeitsbereichseinstellungen und Produktdetails

• workspaceSettings (Objekt): Einstellungen, die für die Funktionalität des Arbeitsbereichs spezifisch sind.
  • getWorkspaceSettings (Objekt): Enthält eine Aktion zum Abrufen von Arbeitsbereichseinstellungen.
• productDetail (Objekt): Zusätzliche Details zu Produktbranding und -informationen.
  • publisher (Zeichenfolge): Herausgeber des Produkts.
  • slogan (Zeichenfolge): Produkt-Slogan.
  • description (Zeichenfolge):Kurze Beschreibung des Produkts.
  • image (Objekt): Konfiguration von Produktbildern.
    • mediaType (ganze Zahl): Medientyp des Bilds.
    • source (Zeichenfolge): Pfad zum Bild.
  • slideMedia (Array): Liste der Mediendateien, die auf den Folien der Produktdetailsseite verwendet werden.
    • Grenzwert: Im slideMedia Array sind nicht mehr als 10 Elemente zulässig.
    • Jedes Element (Objekt):
      • mediaType (ganze Zahl): Medientyp der Folie. Verwenden Sie 0 für Bilder und 1 für Videos.
      • Quelle (Zeichenfolge): Pfad zur Bild- oder Videoquelle.
      • Hinweis: Für Videos: Geben Sie eine URL zum Video an. Unterstützte Formate sind:
        • https://youtube.com/embed/<id> oder https://www.youtube.com/embed/<id>
          • Beispiel: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
        • https://player.vimeo.com/video/<number>
          • Hinweis: Fügen Sie nichtwww. in die Vimeo-URL ein.

Beispiel für slideMedia Konfiguration:

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

Elementmanifest

Das Elementmanifest definiert Konfigurationsdetails für einzelne Elemente innerhalb der Workload, einschließlich Attribute, Symbole, Editorpfade und auftragsbezogene Einstellungen.

Attribute

• name (Zeichenfolge): Ein eindeutiger Systemname für das Element.
• displayName (Zeichenfolge): Benutzerfreundlicher Name, der für das Element angezeigt wird.
• displayNamePlural (Zeichenfolge): Pluralform des Anzeigenamens für Anzeigezwecke.

Editor- und Symbolkonfiguration

• editor (Objekt): Pfadkonfiguration für den Editor des Elements in der Fabric-Workload-App.
  • path (Zeichenfolge): Relativer Pfad zum Editor.
• icon (Objekt): Gibt das Symbol an, das das Element darstellt.
  • name (Zeichenfolge): Pfad zur Symboldatei im Ressourcenordner (z. B. „assets/icon.svg“).

Elemente des Kontextmenüs

Definiert Aktionen, die im Kontextmenü des Elements verfügbar sind, und stellt Benutzern Interaktionsoptionen bereit.

• contextMenuItems (Array): Liste der Aktionen im Kontextmenü.
  • name (Zeichenfolge): Systemname der Aktion.
  • displayName (Zeichenfolge): Anzeigename für die Aktion.
  • icon (Objekt): Symbol für die Aktion.
    • name (Zeichenfolge): Pfad zur Symboldatei (z. B. „assets/icon.svg“).
  • handler (Objekt): Aktionshandler für das Menüelement.
    • action (Zeichenfolge): Name der ausgelösten Aktion.
  • tooltip (Zeichenfolge): Optionaler QuickInfo-Text für die Aktion.

Überwachung und DataHub-Konfiguration

• supportedInMonitoringHub (Boolesch): Gibt an, ob das Element im Überwachungshub angezeigt oder gefiltert werden kann.
• supportedInDatahubL1 (Boolesch): Gibt an, ob das Element im DataHub L1 angezeigt oder gefiltert werden kann.

Aktionskonfiguration für Elementauftrag

Konfigurationen für auftragsbezogene Aktionen, die der Elementauftragsinstanz zugeordnet sind.

• itemJobActionConfig (Objekt): Definiert Aktionen im Zusammenhang mit den Aufträgen des Elements.
  • registeredActions (Objekt): Enthält Auftragsaktionen wie Details, Abbrechen und Wiederholen.
    • detail (Objekt): Aktion zum Anzeigen von Auftragsdetails.
    • cancel (Objekt): Aktion zum Abbrechen eines Auftrags.
    • retry (Objekt): Aktion zum Wiederholen eines Jobs.

Elementeinstellungen

Konfigurationsoptionen für Elementeinstellungen.

• itemSettings (Objekt): Zusätzliche Einstellungen für das Element.
  • schedule (Objekt): Enthält Planungsinformationen.
    • itemJobType (Zeichenfolge): Auftragstyp, der über die freigegebene Fabric-Benutzeroberfläche geplant werden soll.
    • refreshType (Zeichenfolge): Gibt die Fähigkeit zum Aktualisieren des Elements an. Mögliche Werte: "None", "Refresh" und "Run".
  • recentRun (Objekt): Konfiguration für aktuelle Auftragsausführungen.
    • useRecentRunsComponent (boolean): Gibt an, ob fabric shared recent runs component verwendet werden soll.
  • getItemSettings (Objekt): Konfiguration für benutzerdefinierte Elementeinstellungen.
    • Aktion (Zeichenfolge): Name der entsprechenden Aktion, die die Liste der benutzerdefinierten Elementeinstellungen zurückgibt.

Kategorien von Aufgabenabläufen für Elemente

Definiert Ihre Elementkategorien für die Integration in das Fabric Task Flow Framework.

• itemJobTypes (Array): gibt die Kategorien an, die einem Element im Aufgabenflow-Framework zugewiesen sind. Jedes Element kann bis zu zwei Kategorien enthalten. Unterstützte Kategorien sind:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

Wenn keine Kategorie angegeben ist, wird "others" als Standard verwendet.