Udostępnij za pośrednictwem


Dokumentacja manifestów frontonu

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

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

  • Manifest produktu: zdefiniuj tożsamość i znakowanie obciążenia.
  • Manifest elementu: szczegóły konfiguracji poszczególnych elementów w obciążeniu, 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 favicon 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 wyświetlanych 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 środowiska

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ą.

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 do obrazu.
    • slideMedia (tablica): lista plików multimedialnych używanych w slajdach strony szczegółów produktu.

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 obciążenia Sieć szkieletowa.
    • path (ciąg): ś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 (ciąg): nazwa wyzwolonej akcji.
    • etykietka narzędzia (ciąg): opcjonalny tekst etykietki narzędzia 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 (wartość logiczna): określa, czy element może być wyświetlany lub filtrowany w usłudze DataHub L1.

Konfiguracja akcji zadania elementu

Konfiguracje akcji związanych z zadaniami skojarzonymi z wystąpieniem zadania.

  • 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 być zaplanowany z udostępnionego interfejsu użytkownika sieci szkieletowej.
      • 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 sieci szkieletowej.
    • getItemSettings (obiekt): konfiguracja niestandardowych ustawień elementu.
      • akcja (ciąg znaków): nazwa odpowiedniej akcji, która zwróci listę ustawień niestandardowego elementu.

Kategorie przepływu zadań elementu

Definiuje kategorie elementów do integracji z strukturą przepływu zadań sieci szkieletowej.

  • 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", i ."others" Jeśli żadna kategoria nie zostanie określona, jako domyślną zostanie użyta wartość "inne".

Uwaga

Podczas opracowywania i testowania nowych atrybutów dodanych do manifestu upewnij się, że zsynchronizowano najnowsze skrypty i narzędzia walidacji z naszego przykładowego repozytorium.

Ten krok jest niezbędny tylko do programowania lokalnego i nie jest wymagany w trybie chmury.