Les commentaires sont utiles pour documenter des types d'entités, des connexions ou Transformers, et ce particulièrement lors de traitements complexes.
Les annotations sont une méthode essentielle pour une bonne conception de traitement. Les annotations aident les autres utilisateurs à comprendre l'objectif et le flux de travail d'un traitement, et aident également l'auteur du traitement original à se souvenir des informations clés.
Afficher un résumé
Une annotation sommaire est un commentaire généré par FME qui fournit des informations sur n'importe quel objet du traitement. Cet élément peut être un type de données source ou destination, ou un Transformer. Les annotations récapitulatives sont automatiquement mises à jour si l'objet auquel elles sont rattachées est modifié. Les annotations récapitulatives sont utiles pour les Transformers basés sur l'assistant où la vérification des paramètres du Transformer peut prendre beaucoup de temps.
Pour créer un commentaire sur un objet, faire un clic droit et sélectionner Afficher un résumé.
De plus, ils sont toujours liés à un sujet bien précis et ne peuvent en être détachés.
Personnaliser un commentaire
Vous pouvez ajouter des commentaires n'importe où dans un traitement : attacher des commentaires aux objets ou en créer des indépendants.
Faire un clic droit sur l'espace de travail et sélectionner Insérer un commentaire (
).
Pour attacher un commentaire à un objet d'un Traitement (types d'entités ou Transformer), sélectionner l'objet, faire un clic droit et sélectionner Attacher un commentaire.
Lorsque vous ajoutez ou éditez un commentaire, vous pouvez utiliser les boutons de la mini barre d'outils pour le personnaliser :
- Formatage de texte et ajout de listes.
- Ajout de tables et insertion/suppression de colonnes/lignes.
- Insertion d'hyperliens.
Options des commentaires
Faire un clic droit dans n'importe quel commentaire pour voir les options du menu.
Pour afficher ou masquer les commentaires dans un traitement, faire un clic droit et sélectionner Afficher les commentaires.
Attacher, détacher ou déplacer les commentaires
Sélectionnez l'annotation, puis cliquez avec le bouton droit de la souris pour attacher l'annotation à n'importe quel objet ou connexion dans le traitement. Si l'annotation est déjà attachée, les options d'attachement déplaceront l'annotation. En outre, une option Détacher est disponible.
Attacher des commentaires à plusieurs objets
Le commentaire par défaut comporte le nom de l'objet (Transformer, types d'entités, etc...).
Pour les connexions, le nom par défaut reflète à la fois les informations d'entrée et de sortie. Par exemple, si vous sélectionnez une connexion de Transformer, le nom reflétera l'entrée du Transformer et la sortie du Transformer (PenColorSetter > AttributeCreator).
- Sélectionner plusieurs objets ou connexions.
- Clic droit et choisir Attacher un commentaire.
Les annotations sont ajoutées aux objets et aux connexions sélectionnés. Les objets afficheront le nom de l'objet comme chaîne par défaut, et les connexions afficheront <source> à <destination> comme chaîne par défaut.
Note: Cliquez avec le bouton droit de la souris sur une annotation et sélectionnez Suivre l'objet attaché. Vous pouvez déplacer un objet n'importe où dans le traitement et l'annotation se déplacera avec lui. Si vous décochez cette option (sélectionnez-la à nouveau pour l'activer ou la désactiver), une ligne de repère s'étire pour suivre un objet, mais le commentaire reste à son emplacement d'origine.
Note: Par défaut, les annotations apparaissent à l'avant de l'affichage et peuvent recouvrir d'autres parties du traitement. Pour déplacer les annotations vers l'arrière de l'affichage, cliquez avec le bouton droit de la souris sur une annotation et sélectionnez Passer au dernier plan. Cela fonctionne également pour les types d'entités et les Transformers.