Each table has a set of associated documentation fields. These are used to store descriptive metadata about the tables and how they are used.
The contents of each field appear in the generated documentation. Their order and placement can be customized in the generated documentation using the Tools > Options menu.
The following fields are available to store additional informational metadata that will appear in the generated WhereScape RED documentation:
- Purpose
- Concept
- Grain
- Examples
- Usage
The names of these fields are completely arbitrary and can be changed in the generated documentation in the Tools > Options > Documentation menu. By default, these fields are not enabled for load and stage tables, but can be enabled using the Tools > Options > Documentation menu.
Up to 4000 characters of information can be stored in each field.
Some or all of these fields can be removed from the documentation via the Tools > Options > Documentation menu.
Documentation Fields Screen
