Annotation is a key method for a clear and comprehensible design.
Annotation helps other users understand what is supposed to be happening in the translation and also helps the creator when returning to a workspace after a long interval (take it from me that this is especially important!)
There are a number of different types of annotation that can be applied to a workspace.
By default FME adds three annotations to a newly-created workspace. The annotations are basic comments that indicate the source data, the transformation, and the destination data. They can be deleted or, optionally, left ungenerated, and therefore may not appear in every workspace.
User annotation is a comment created by the user. It can be connected to a workspace object (transformer or feature type), can be connected to a workspace connection, or can float freely within the workspace.
To create floating user annotation, right-click the canvas and select Insert Annotation.
To create attached user annotation, right-click a workspace object and select Add Annotation, or use the shortcut Ctrl+K.
When you place an annotation you have the opportunity to change the font style, font size, and background color; plus you can also add hyperlinks, bullet points, and tables.
Summary annotation is an FME-generated comment that provides information about any object within the workspace. This item can be a source or destination feature type, or a transformer.
Summary annotation is always colored blue to distinguish it from other annotation. It's always connected to the item to which it relates and cannot be detached.
The nice thing about Summary Annotation is that it automatically updates in response to changes. That makes it very useful for checking transformer parameters (or reader/writer schemas) at a quick glance. It's particularly useful in situations where the parameters are set through a wizard and are more awkward to check (for example, the SchemaMapper or FMEServerJobSubmitter transformers).
A good idea is to use summary annotation to show what actions are taking place; but use user annotation to clarify why an action is being carried out.
However, in FME2017 you can convert a summary annotation to a user (attached) annotation by using this context menu option:
This allows you to extract the information from a summary annotation, but edit it as you would a user annotation. Note that a converted summary annotation no longer updates automatically!
Right-click on an annotation object and you will find its context menu includes a number of options to control and edit that object, such as:
- Set Background Color
- Word Wrap
- Follow Attached Object
- Attach to Feature Type
- Attach to Transformer
- Attach to Connection