Dokumentacja manifestów Frontend

Ten dokument zawiera szczegółowy przewodnik po strukturze i konfiguracji manifestów interfejsu frontend w obciążeniach Fabric. Te manifesty oparte na formacie JSON umożliwiają partnerom definiowanie wyglądu, tożsamości i zachowania obciążeń roboczych, co jest niezbędne do zapewnienia użytkownikom dostosowanego i spójnego środowiska w Fabric.

Manifesty frontend składają się z dwóch głównych składników:

• Manifest produktu: definiuje tożsamość i branding.
• Manifest elementów: Szczegóły konfiguracji poszczególnych elementów w ramach obciążenia, w tym elementów interakcji użytkownika.

Manifest produktu

Manifest produktu definiuje podstawowe atrybuty produktu obciążenia, określając jego tożsamość, znakowanie i konfigurację interakcji z użytkownikiem.

Atrybuty

• name (ciąg): unikatowa nazwa systemu produktu.
• displayName (ciąg): przyjazna dla użytkownika nazwa wyświetlana.
• fullDisplayName (ciąg): opisowa nazwa produktu.
• favicon (ciąg): ścieżka do faviconu produktu.
• icon (obiekt): Ścieżka do ikony produktu, przechowywana w folderze assets (np. "assets/icon.png").

Konfiguracja strony głównej

Definiuje układ i zawartość strony głównej obciążenia.

• homePage (obiekt): ustawienia konfiguracji strony głównej.
  • learningMaterials (tablica): Lista materiałów szkoleniowych, które są wyświetlane na stronie szczegółów obciążenia.
    • title (ciąg): tytuł materiału szkoleniowego.
    • wprowadzenie (ciąg): krótkie wprowadzenie do materiału.
    • description (ciąg): szczegółowy opis materiału.
    • onClick (obiekt): akcja wyzwalana po kliknięciu materiału.
    • image (ciąg): ścieżka do obrazu skojarzonego z materiałem.
  • recommendedItemTypes (tablica): lista zalecanych typów elementów wyświetlanych na stronie szczegółów obciążenia.

Tworzenie wrażeń

Konfiguracje tworzenia nowych elementów w produkcie, określając opcje interakcji użytkownika.

• createExperience (obiekt): konfiguracja tworzenia elementów obciążenia.
  • description (ciąg): ogólny opis środowiska tworzenia.
  • cards (tablica): lista kart wyświetlanych podczas procesu tworzenia.
    • title (ciąg): tytuł karty.
    • description (ciąg): krótki opis karty.
    • icon (obiekt): Ścieżka do ikony użytej na karcie.
    • onClick (obiekt): akcja wyzwalana po kliknięciu karty.
    • availableIn (tablica): lokalizacje, w których jest dostępna karta.
    • itemType (ciąg): typ elementu połączonego z utworzoną kartą.
    • createItemDialogConfig (obiekt): konfiguracja okna dialogowego Tworzenia elementu.
      • onCreationFailure (obiekt): akcja wyzwolona, gdy tworzenie elementu nie powiodło się.
      • onCreationSuccess (obiekt): akcja wyzwalana po pomyślnym utworzeniu elementu.

Uwaga

createItemDialogConfig użycie wymaga dodania procedur obsługi akcji onCreationFailure i onCreationSuccess w programie index.worker.ts. Przykład można znaleźć w naszym przykładowym repozytorium.

Ustawienia obszaru roboczego i szczegóły produktu

• workspaceSettings (obiekt): Ustawienia specyficzne dla funkcji obszaru roboczego.
  • getWorkspaceSettings (obiekt): zawiera akcję pobierania ustawień obszaru roboczego.
• productDetail (obiekt): dodatkowe szczegóły dotyczące znakowania i informacji o produkcie.
  • publisher (ciąg): Wydawca produktu.
  • slogan (ciąg): hasło produktu.
  • description (ciąg): krótki opis produktu.
  • image (obiekt): konfiguracja obrazów produktów.
    • mediaType (liczba całkowita): typ nośnika obrazu.
    • source (ciąg): ścieżka dostępu do obrazu.
  • slideMedia (tablica): lista plików multimedialnych używanych w slajdach strony z informacjami o produkcie.
    • Limit: w tablicy nie jest dozwolonych więcej niż slideMedia elementów.
    • każdy element (obiekt):
      • mediaType (liczba całkowita): typ nośnika slajdu. Użyj 0 dla obrazów i 1 dla wideo.
      • źródło (ciąg): ścieżka do obrazu lub źródła wideo.
      • Uwaga: w przypadku filmów wideo: podaj adres URL filmu wideo. Obsługiwane formaty to:
        • https://youtube.com/embed/<id> lub https://www.youtube.com/embed/<id>
          • Przykład: "https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
        • https://player.vimeo.com/video/<number>
          • Uwaga: nie należy uwzględniać www. w adresie URL usługi Vimeo.

Przykład konfiguracji slideMedia:

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

Manifest elementu

Manifest elementu definiuje szczegóły konfiguracji poszczególnych elementów w obciążeniu, w tym atrybuty, ikony, ścieżki edytora i ustawienia związane z zadaniem.

Atrybuty

• name (ciąg): unikatowa nazwa systemu dla elementu.
• displayName (ciąg): przyjazna dla użytkownika nazwa wyświetlana dla elementu.
• displayNamePlural (ciąg): postać mnogiej nazwy wyświetlanej na potrzeby wyświetlania.

Konfiguracja edytora i ikony

• editor (obiekt): konfiguracja ścieżki dla edytora elementu w aplikacji roboczej Fabric.
  • path (ciąg znaków): ścieżka względna do edytora.
• icon (obiekt): określa ikonę reprezentującą element.
  • name (ciąg): ścieżka do pliku ikony w folderze assets (np. "assets/icon.svg").

Elementy menu kontekstowego

Definiuje akcje dostępne w menu kontekstowym elementu, zapewniając użytkownikom opcje interakcji.

• contextMenuItems (tablica): lista akcji w menu kontekstowym.
  • name (ciąg): nazwa systemu akcji.
  • displayName (ciąg): nazwa wyświetlana akcji.
  • icon (obiekt): Ikona akcji.
    • name (ciąg): ścieżka do pliku ikony (np. "assets/icon.svg").
  • procedura obsługi (obiekt): procedura obsługi akcji dla elementu menu.
    • action (tekst): nazwa wyzwolonej akcji.
  • Podpowiedź (ciąg): Opcjonalny tekst podpowiedzi dla akcji.

Monitorowanie i konfiguracja usługi DataHub

• supportedInMonitoringHub (wartość logiczna): określa, czy element może być wyświetlany lub filtrowany w centrum monitorowania.
• supportedInDatahubL1 (boolowska): określa, czy element może być wyświetlany lub filtrowany w DataHub L1.

Konfiguracja akcji zadania elementu

Konfiguracje dla działań związanych z zadaniami skojarzonymi z instancją zadania przedmiotu.

• itemJobActionConfig (obiekt): definiuje akcje związane z zadaniami elementu.
  • registeredActions (obiekt): zawiera akcje zadań, takie jak szczegóły, anulowanie i ponawianie próby.
    • detail (obiekt): Akcja umożliwiająca wyświetlanie szczegółów zadania.
    • cancel (obiekt): akcja anulowania zadania.
    • ponów próbę (obiekt): akcja ponawiania próby zadania.

Ustawienia elementu

Opcje konfiguracji ustawień elementów.

• itemSettings (obiekt): dodatkowe ustawienia elementu.
  • schedule (obiekt): zawiera informacje o harmonogramie.
    • itemJobType (ciąg): typ zadania, który ma zostać zaplanowany z wspólnego interfejsu użytkownika Fabric.
    • refreshType (ciąg): określa możliwość odświeżania elementu. Możliwe wartości to "None", "Refresh"i "Run".
  • recentRun (obiekt): konfiguracja ostatnich uruchomień zadań.
    • useRecentRunsComponent (wartość logiczna): czy używać składnika współużytkowanych ostatnio używanych przebiegów Fabric.
  • getItemSettings (obiekt): konfiguracja niestandardowych ustawień elementu.
    • akcja (ciąg): Nazwa odpowiedniej akcji, która zwróci listę ustawień niestandardowego elementu.

Kategorie przepływu zadań elementu

Definiuje kategorie elementów do integracji z Szkieletowym Frameworkiem przepływu zadań Fabric Task Flow Framework.

• itemJobTypes (tablica): określa kategorie przypisane do elementu w ramach struktury przepływu zadań. Każdy element może mieć maksymalnie dwie kategorie. Obsługiwane kategorie to:
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

Jeśli nie określono żadnej kategorii, "others" jest używana jako domyślna.

Kategorie wykazu elementu OneLake

Definiuje kategorie, w których element jest wyświetlany w katalogu OneLake.

• oneLakeCatalogCategory (tablica): określa kategorie, w których element jest wyświetlany w katalogu OneLake. Każdy element może mieć maksymalnie dwie kategorie. Obsługiwane kategorie to:
  • "Data"
  • "Insight"
  • "Process"
  • "Solution"
  • "Configuration"
  • "Other"

Jeśli żadna kategoria nie zostanie określona, element nie będzie wyświetlany w wykazie usługi OneLake.

Konfiguracja okna dialogowego Tworzenie elementu

Definiuje konfigurację okna dialogowego tworzenia elementu, która służy do wyświetlania okna dialogowego z centrum obciążenia po kliknięciu typu elementu.

• createItemDialogConfig (obiekt): konfiguracja okna dialogowego Tworzenia elementu.
  • onCreationFailure (obiekt): akcja wyzwolona, gdy tworzenie elementu nie powiodło się.
  • onCreationSuccess (obiekt): akcja wyzwalana po pomyślnym utworzeniu elementu.

Uwaga

createItemDialogConfig użycie wymaga dodania procedur obsługi akcji onCreationFailure i onCreationSuccess w index.worker.ts. Przykład można znaleźć w naszym przykładowym repozytorium.