Documentation

While a Data Warehouse is created, the documentation of resources created is very important.

To meet this need, SIGADW has the functionality of Documentation of Queries, that can be used in different system points and mainly in queries. In this case, you can create a document that is visible to the final user and that can either clarify the query objective or have some other type of important information.

Important:

Documentation can be viewed only in reading mode by user or administrator during query execution (Table), that is, documentation cannot be changed during query execution.

Procedures

1. Access the menu Queries.
2. In any query, go to the option More... and then select Documentation.
3. Type the Documentation of Query by using Structured Text.
4. In Table format, access the query for which documentation was created.
5. The Documentation option, when activated, displays the document concerning the query.