Annotations versus object description
Description/Annotations are used within BODS to add comments about the objects used.
to add description
to add annotations
In the project area or object library, right-click an object (e.g. workflow) and select Properties.
|In the tool palette, click the annotation icon (You can use annotations to describe any workspace such as a job, work flow, data flow, catch, conditional, or while loop)|
Enter your comments in the Description text box then click OK.
In the tool palette, click the annotation icon.
To display a description in the workspace:
In the project area, select an existing object (such as a job) that contains an object to which you have added a description (such as a work flow).
|Click a location in the workspace to place the annotation. You can add, edit, and delete text directly on the annotation.|
|4||From the View menu, select “Enabled Descriptions” OR Right-click the work flow and select “Enable Object Description”||Note:
User can resize and move the annotation by clicking and dragging. Also any number of annotations can be added to a diagram.
Now considering an example that the description and annotation is created for a workflow, what difference will it make in terms of usage or storing of the object:
In the workflow, rather than giving the object description as annotations, it is advisable to give the description in the properties of the individual objects. Annotations do not get stored in the metadata while the object properties get written in the metadata.This will be helpful in end-to-end metadata analysis.