| [SE-585] Database Object documentation improvements | |
|---|---|
| Product Line: | Life |
| Component/s: | Other |
| Fix Version/s: | SICS 4.9.3 |
Aim of function
Improve the level of detail in the DBMS object descriptions stored in the SICS database. This will improve the general documentation of the system in 3 key areas:
1. Data Dictionary extracts: The extracted data dictionaries shipped with the system will have greatly improved descriptions of the columns & tables.
2. MTK documentation: Since the MTK documentation includes the data dictionary descriptions, these descriptions will now more accurately reflect the purpose of each column.
3. SICS Schema Browser: The included schema browser includes the object comments in its displayed information.
The main improvements are:
- Join tables indicate which tables are joined together
- Unnecessary data type information is removed, simplifying the comments
- Foreign keys are more specific to which reference table they refer, including subclass numbers when known
- The reference data foreign keys are more specific to which reference data table they refer
This work will be continued in future releases as DXC continues to refine the data model documentation.
System parameters affected
None.
Existing functionality affected
Manage Tables: Add comments