Friday, March 12, 2010

Documenting my SSIS package Using Annotations

I use Annotation to document my SSIS packages.  In SSIS Designer, I can right-click anywhere on the design surface of the Control Flow, Data Flow, or Event Handler tab, and then click Add Annotation. A text block appears on the design surface of the tab.

Tip: 
The text block does not provide word wrap. I use the following two ways to create a nice and readable document:

1) Press Ctrl-Enter to add a new line to the text block.

2) I create the document/comment in my query editor in SQL Server Management Studio, then copy them to the package Annotation in SSIS package.

Here is an example what the annotation look like.

image

I also use Inline comments and standalone-line comments to document the logics in the package. The Native OLE DB driver does support Inline comments and standalone-line comments with SQL Server.

image

No comments:

Post a Comment