En complément de l'affichage des ressources, vous pouvez parfois être amené à documenter les applications que vous créez. WebSphere Integration Developer fournit un outil permettant de générer de la documentation pour les ressources de vos modules, de vos modules de médiation et de vos bibliothèques.
Pour lancer la génération de la documentation, vous appelez un assistant. Vous pouvez personnaliser le contenu de la documentation en sélectionnant plusieurs ressources provenant d'un ou de plusieurs modules et bibliothèques. Toutes les informations seront ainsi rédigées dans un seul rapport qui est un fichier PDF. Vous pouvez aussi préciser la disposition et les polices de la sortie. Consultez les tâches connexes pour obtenir des instructions détaillées sur la génération de la documentation.
Le générateur de documentation produit les informations suivantes pour ces ressources :
D'autres ressources ne seront pas documentées par le générateur de documentation.
Le générateur de documentation peut aussi produire de la documentation pour les ressources sélectionnées et les ressources qu'elles référencent. Par exemple, dans l'assistant Génération de documentation, vous pouvez sélectionner le processus métier et l'option Inclure les fichiers référencés. Par conséquent, le rapport PDF généré contient aussi des informations sur les ressources (par exemple les interfaces appelées par ses activités) que le processus référence.
Le rapport PDF généré a la structure suivante :
Comporte le titre du rapport, le nom de l'auteur et la date du rapport.
Répertorie les sections et les numéros de page du rapport.
Répertorie les propriétés des ressources. Excepté le module et la bibliothèque, toutes les ressources ont aussi des images de ressources ouvertes dans la vue Editeur.
Pour chaque ressource documentée, indique la ressource qui l'utilise (liste Fournisseurs) et l'emplacement où elle est utilisée (liste Récepteur).
Répertorie les paramètres de la génération de documentation indiqués dans l'assistant Génération de documentation et qui sont utilisés dans le rapport PDF.
La disposition et le style du rapport PDF généré peuvent être personnalisés à l'aide de l'assistant Génération de documentation. Si vous modifiez les paramètres de disposition et de style, ils sont sauvegardés en vue des générations de documentation suivantes jusqu'à ce que vous les modifiez de nouveau.
Vous pouvez modifier les paramètres de disposition suivants :
Définit le format de papier de la documentation générée.
Valeur par défaut : Letter
Définit le niveau maximum des rubriques à répertorier dans la table des matières du rapport.
Valeur par défaut : 7
Texte à plat
Titre de chapitre
Texte de code source
Texte de légende
Texte de définition
Texte d'en-tête
Table des matières
Un fichier principal est un profil de ressource définissant le contenu (pas les styles de polices) à inclure dans la documentation générée. Lorsque vous utilisez l'assistant de génération de la documentation, créez un fichier principal pour sauvegarder vos sélections de ressources. Lorsque vous utiliserez de nouveau l'assistant pour générer le même rapport, il vous suffira de sélectionner le fichier principal.
Le générateur de documentation fournit trois polices par défaut utilisables dans la documentation. Il s'agit des polices Helvetica, Courier et Times avec les styles suivants : normal, italiques, gras et italiques en gras.
Vous pouvez ajouter une nouvelle police qui est soit un fichier de police True Type (.ttf), soit un fichier de collection True Type (.ttc) en l'enregistrant. L'enregistrement des police s'effectue dans l'assistant Génération de documentation. Une fois une enregistrée, une police peut être utilisée dans tous les rapports ; vous pouvez aussi la supprimer. Les polices par défaut ne peuvent pas être supprimées. Voir "Génération de documentation" sous les tâches connexes pour savoir comment utiliser l'assistant Génération de documentation.
Le générateur de documentation peut écrire des messages de trace de génération de documentation dans un fichier de trace. Remarque : n'activez pas la fonction de trace sauf en cas d'incident lié au générateur de documentation, car le traçage affecte les performances du système et peut occuper un espace important sur le disque. La trace est définie dans la fenêtre Préférences et la sortie est écrite dans un fichier texte dans le répertoire de métadonnées (nom_espace_de_travail\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Les entrées de journal sont ajoutées et ne sont jamais effacées.
Information associée