Creating annotation groups

Annotation groups are useful when data sources, such as a weblog table, are reused in many transformations. Whenever this table is used, you can link to the shared annotation group to get model information on each table field. If the table were to ever change, then the annotations would only need to be updated in one place.

You can create multiple annotations based on the same annotation group by copying the group, and then saving it with a different name. You can do this as many times as you need to make a series of related annotation groups, such as annotations for time dimensions.

You must create a group to save your annotations. This group can be saved as just a local group or as a shared group. When the group is saved locally, it is saved to the transformation on your machine. When you select Shared, it will also be stored in the metastore and available to other users.

Create an annotation group for sharing with other users

This task assumes you are in the transformation canvas of the PDI client.

If you want to share your annotation group with other users, select Shared and ensure the annotation group has a unique name. Once you click Apply, the group will be available to other users for creating PDI jobs by selecting from the Shared menu in the Annotate Stream step.

1. Complete steps 1-3 in the Use the Annotate Stream step.

2. Select Shared, then click on the Add Annotation Group (Plus Sign) next to the drop-down field.

3. Enter a name for your annotation group in the Shared field, and then click Select Fields to begin creating annotations to populate the group. See steps 6-8 in Use the Annotate Stream Step for more information on selecting and annotating fields.

   

   Shared annotation group
4. When you are done, click Apply to save your annotations.

Create an annotation group locally

This task assumes you are in the transformation canvas of the PDI client.

You can create an annotation group and save it locally.

1. Complete steps 1-3 in the Use the Annotate Stream step.

2. Select Local. Your annotation group will only be saved into your transformation. Any user running this transformation can see and use the annotations group.

3. Click Select Fields to begin creating annotations to populate the group. See steps 6-8 in Use the Annotate Stream step for more information on selecting and annotating fields.

4. When you are done, click Apply to save your annotation group locally.

If you later decide that you want to share the annotation group, you can reopen it and select the Shared radio button, then click Apply. The group will then be shared to the metastore and be available to other users.