Générer la documentation HTML - Cloud - 8.0

Guide d'utilisation de Talend Data Fabric Studio

Version
Cloud
8.0
Language
Français (France)
EnrichDitaval
Data Fabric
Product
Talend Data Fabric
Module
Studio Talend
Content
Création et développement

Le Studio Talend vous permet de générer de la documentation détaillée au format HTML des Jobs ou des Routes sélectionné(e)s dans le Repository de votre Studio, dans la perspective Integration . Cette auto-documentation comprend :

  • Les propriétés du projet dans lequel les Jobs ou les Routes ont été créés,

  • Les propriétés et les paramètres des Jobs ou des Routes sélectionnés ainsi qu'une image de chaque Job ou Route,

  • La liste de tous les composants utilisés dans chaque Job ou Route sélectionné(e), ainsi que les paramètres de ces composants.

  • Si vous avez installé la mise à jour mensuelle 8.0 R2022-06 du Studio ou une mise à jour plus récente fournie par Talend et si votre Job ou Route contient des Joblets, Routelets et Jobs enfants, la documentation de ces Joblets, Routelets et Jobs enfants est générée avec la documentation du Job principal ou de la Route principale. Vous pouvez passer à la documentation du Job, du Joblet, de la Routelet, via le lien correspondant dans la documentation du Job principal ou de la Route principale.

Pour générer un document HTML pour un Job ou une Route, procédez comme suit :

Procédure

  1. Dans le Repository, cliquez-droit sur l'un de vos Jobs ou Route ou sélectionnez plusieurs éléments pour générer une documentation multiple.
  2. Sélectionnez Generate Doc as HTML dans le menu contextuel.
  3. Renseignez le répertoire dans lequel doit être enregistré la documentation générée.
  4. Dans le même champ, renseignez le nom de l'archive regroupant les documents générés.
  5. Si vous souhaitez utiliser un fichier CSS, cochez la case Use CSS file as a template to export afin d'activer le champ CSS File.
  6. Dans le champ CSS File, parcourez votre répertoire, ou saisissez le chemin d'accès au fichier CSS à utiliser.
  7. Cliquez sur Finish pour valider.

Résultats

Le fichier archive est généré dans le chemin défini. Il contient les fichiers HTML ainsi que les dossiers correspondants. Ouvrez le fichier HTML dans votre navigateur Web.