Documentation des manifestes front-end

Ce document fournit un guide détaillé de la structure et de la configuration des manifestes front-end dans les charges de travail Fabric. Ces manifestes JSON permettent aux partenaires de définir l’apparence, l’identité et le comportement de la charge de travail, essentiels pour fournir aux utilisateurs une expérience personnalisée et cohérente dans Fabric.

Les manifestes front-end se composent de deux composants principaux :

Manifeste de produit : définit l’identité de charge de travail et la personnalisation.
Manifeste Élément : il détaille la configuration des éléments individuels dans la charge de travail, y compris les éléments d’interaction utilisateur.

Manifeste de Produit

Le manifeste Produit définit les attributs principaux du produit de la charge de travail, en spécifiant son identité, sa personnalisation et sa configuration pour l’interaction utilisateur.

Attributs

name (chaîne) : nom de système unique pour le produit.
displayName (chaîne) : nom d’affichage convivial.
fullDisplayName (chaîne) : nom descriptif du produit.
favicon (chaîne) : chemin d’accès au favicon du produit.
icon (objet) : chemin d’accès à l’icône du produit, stocké dans le dossier de ressources (par exemple, « assets/icon.png »).

Configuration de la page d’accueil

Définit la disposition et le contenu de la page d’accueil de la charge de travail.

homePage (objet) : paramètres de configuration de la page d’accueil.
- learningMaterials (tableau) : liste des supports d’apprentissage affichés sur la page de détails de la charge de travail.
  - title (chaîne) : titre du support d’apprentissage.
  - introduction (chaîne) : présentation brève du matériel.
  - description (chaîne) : description détaillée du matériel.
  - onClick (objet) : action déclenchée lorsqu'on clique sur l'élément.
  - image (chaîne) : chemin d’accès à l’image associée au matériel.
- recommendedItemTypes (tableau) : liste des types d’éléments recommandés affichés dans la page de détails de la charge de travail.

Expérience de création

Configurations pour la création d’éléments dans le produit, en spécifiant les options d’interaction utilisateur.

createExperience (objet) : configuration pour la création d’éléments de charge de travail.
- description (chaîne) : description générale de l’expérience de création.
- cards (tableau) : liste des cartes affichées pendant le processus de création.
  - title (chaîne) : titre de la carte.
  - description (chaîne) : brève description de la carte.
  - icon (objet) : chemin d’accès à l’icône utilisée dans la carte.
  - onClick (objet) : action déclenchée après avoir cliqué sur la carte.
  - availableIn (tableau) : emplacements où la carte est disponible.
  - itemType (chaîne) : type d’élément lié à la carte créée.
  - createItemDialogConfig (objet) : configuration de la boîte de dialogue Créer un élément.
    - onCreationFailure (objet) : action déclenchée lors de l’échec de la création de l’élément.
    - onCreationSuccess (objet) : action déclenchée lorsque la création de l'élément réussit.

Remarque

createItemDialogConfig l’utilisation nécessite l’ajout onCreationFailure et onCreationSuccess l’action de gestionnaires dans index.worker.ts. Vous trouverez un exemple dans notre exemple de référentiel.

Paramètres de l’espace de travail et détails du produit

workspaceSettings (objet) : paramètres spécifiques à la fonctionnalité de l’espace de travail.
- getWorkspaceSettings (objet) : contient une action pour récupérer les paramètres de l’espace de travail.
productDetail (objet) : détails supplémentaires pour la personnalisation et les informations du produit.
- publisher (chaîne) : éditeur du produit.
- slogan (chaîne) : slogan du produit.
- description (chaîne) : brève description du produit.
- image (objet) : configuration des images du produit.
  - mediaType (entier) : type de média de l’image.
  - source (chaîne) : chemin d’accès à l’image.
- slideMedia (tableau) : liste des fichiers multimédias utilisés dans les diapositives de la page des détails du produit.
  - Limite : 10 éléments au maximum sont autorisés dans le tableau slideMedia.
  - Chaque élément (objet) :
    - mediaType (entier) : type de média de la diapositive. Utilisez 0 pour les images et les 1 pour les vidéos.
    - source (chaîne) : chemin d’accès à l’image ou à la source vidéo.
    - Remarque: pour les vidéos : fournissez une URL à la vidéo. Les formats pris en charge sont les suivants :
      - https://youtube.com/embed/<id> ou https://www.youtube.com/embed/<id>
        
        Exemple : 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
      - https://player.vimeo.com/video/<number>
        
        Remarque : n’incluez paswww. dans l’URL vimeo.

Exemple de configuration de `slideMedia` :

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

Manifeste d’élément

Le manifeste Élément définit les détails de configuration des éléments individuels dans la charge de travail, notamment les attributs, les icônes, les chemins d’accès à l’éditeur et les paramètres liés à la tâche.

Attributs

name (chaîne) : nom de système unique de l’élément.
displayName (chaîne) : nom convivial affiché pour l’élément.
displayNamePlural (chaîne) : forme plurielle du nom d’affichage à des fins d’affichage.

Configuration de l’éditeur et de l’icône

editor (objet) : configuration du chemin d’accès à l’éditeur de l’élément dans l’application de charge de travail Fabric.
- path (chaîne) : chemin d’accès relatif à l’éditeur.
icon (objet) : spécifie l’icône représentant l’élément.
- name (chaîne) : chemin d’accès au fichier d’icône dans le dossier de ressources (par exemple, « assets/icon.svg »).

Définit les actions disponibles dans le menu contextuel de l’élément, fournissant aux utilisateurs des options d’interaction.

contextMenuItems (tableau) : liste d’actions dans le menu contextuel.
- name (chaîne) : nom système de l’action.
- displayName (chaîne) : nom d’affichage de l’action.
- icon (objet) : icône pour l’action.
  - name (chaîne) : chemin d’accès au fichier d’icône (par exemple, « assets/icon.svg »).
- gestionnaire (objet) : gestionnaire d’actions pour l’élément de menu.
  - action (chaîne) : nom de l’action déclenchée.
- tooltip (chaîne) : texte d’info-bulle facultatif pour l’action.

Surveillance et configuration de DataHub

supportedInMonitoringHub (booléen) : spécifie si l’élément peut être affiché ou filtré dans le hub de surveillance.
supportedInDatahubL1 (booléen) : spécifie si l’élément peut être affiché ou filtré dans DataHub L1.

Configurations des actions de travail d’un élément

Configurations des actions de travail associées à l’instance de travail d’un élément.

itemJobActionConfig (objet) : définit des actions liées aux tâches de l’élément.
- registeredActions (objet) : contient des actions de tâche telles que les détails, l’annulation et la nouvelle tentative.
  - detail (objet) : action pour afficher les détails de la tâche.
  - cancel (objet) : action pour l’annulation d’une tâche.
  - retry (objet) : action pour réessayer une tâche.

Paramètres de l’élément

Options de configuration pour les paramètres des éléments.

itemSettings (objet) : paramètres supplémentaires pour l’élément.
- schedule (objet) : contient des informations de planification.
  - itemJobType (chaîne) : type de tâche à planifier depuis l’interface utilisateur partagée de Fabric.
  - refreshType (chaîne) : spécifie la fonctionnalité d’actualisation de l’élément. Les valeurs possibles incluent "None", "Refresh" et "Run".
- recentRun (objet) : configuration des exécutions de tâches récentes.
  - useRecentRunsComponent (booléen) : Indique s’il faut utiliser le composant partagé des exécutions récentes de Fabric.
- getItemSettings (objet) : configuration des paramètres d’élément personnalisés.
  - action (chaîne) : nom de l’action correspondante qui retourne la liste des paramètres d’élément personnalisé.

Catégories de flux de tâches d’éléments

Définit vos catégories d’éléments à intégrer à l’infrastructure de flux de tâches de Fabric.

itemJobTypes (tableau) : spécifie les catégories attribuées à un élément dans le cadre du flux de tâches. Chaque élément peut avoir jusqu'à deux catégories. Les catégories prises en charge sont les suivantes :
- "getData"
- "storeData"
- "prepareData"
- "analyzeAndTrainData"
- "trackData"
- "visualizeData"
- "develop"
- "generalTask"
- "others"

Si aucune catégorie n’est spécifiée, "others" est utilisée comme valeur par défaut.

Catégories d'éléments du catalogue OneLake

Définit les catégories dans lesquelles votre élément est affiché dans le catalogue OneLake.

oneLakeCatalogCategory (tableau) : spécifie les catégories dans lesquelles l’élément est affiché dans le catalogue OneLake. Chaque élément peut avoir jusqu'à deux catégories. Les catégories prises en charge sont les suivantes :
- "Data"
- "Insight"
- "Process"
- "Solution"
- "Configuration"
- "Other"

Si aucune catégorie n’est spécifiée, l’élément n’est pas affiché dans le catalogue OneLake.

Configuration de la boîte de dialogue Créer un élément

Définit la configuration de la boîte de dialogue Créer un élément, qui est utilisée pour afficher la boîte de dialogue depuis le hub de gestion des charges de travail lors d'un clic sur le type d'élément.

createItemDialogConfig (objet) : configuration de la boîte de dialogue Créer un élément.
- onCreationFailure (objet) : action déclenchée lors de l’échec de la création de l’élément.
- onCreationSuccess (objet) : action déclenchée une fois que la création de l'élément a réussi.

Remarque

createItemDialogConfig l’utilisation nécessite l’ajout de gestionnaires d'action onCreationFailure et onCreationSuccess dans index.worker.ts. Vous trouverez un exemple dans notre exemple de référentiel.

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2025-09-10

Partager via

Documentation des manifestes front-end

Manifeste de Produit

Attributs

Configuration de la page d’accueil

Expérience de création

Paramètres de l’espace de travail et détails du produit

Exemple de configuration de slideMedia :

Manifeste d’élément

Attributs

Configuration de l’éditeur et de l’icône

Éléments de menu contextuel

Surveillance et configuration de DataHub

Configurations des actions de travail d’un élément

Paramètres de l’élément

Catégories de flux de tâches d’éléments

Catégories d'éléments du catalogue OneLake

Configuration de la boîte de dialogue Créer un élément

Commentaires

Ressources supplémentaires

Exemple de configuration de `slideMedia` :