System Dictionary (SY_DICT_DESC)
Version 6.0
Overview
The system dictionary tables (Table: SY_DICT_XXXX), have historically been used to manage and maintain form descriptions in the Govern database.
There are four SY_DICT_XXXX tables in the Govern database. They are as follows:
- SY_DICT_DATANAMES – Legacy table from Govern for Windows; this table is still maintained during Verify DB process to keep track of structure and for indexing. (May be dropped in OpenForms Release 6.1)
- SY_DICT_DESC – Active table that is used to maintain descriptions. Refer to process to generate missing dictionary entries.
- SY_DICT_TABLES – Legacy table from Govern for Windows; this table is still maintained during Verify DB process to keep track of structure and for indexing. (May be dropped in OpenForms Release 6.1)
- SY_DICT_VIEW – Legacy table from Govern for Windows; table is still maintained during Verify DB process to keep track of structure and for indexing. (May be dropped in OpenForms Release 6.1)
Of the four (4) databases, there is only one table that is relevant to OpenForms, (Table: SY_DICT_DESC). The three remaining tables are only relevant to Govern for Windows, and may be, at some point eliminated in later version 6.1 releases.
Maintenance Process
As indicated above, in OpenForms, the SY_DICT_DESC table is used to manage and maintain form descriptions through the Verify Database process in the Govern New Administrator (GNA).
Verify Database
The following is a description of the DB Verification actions that directly impact the collection of SY_DICT_XXXX tables. The action is used to generate Missing Dictionary Entries. This is an explanation of the process.
During the Check Column process, Govern manages the description of the fields in the SY_DICT_DESC Table.
- The Database Verification file, MSGDatabaseStructMods.xml is read.
- The content of the SY_DICT_DESC table is read, the columns of each table are reviewed, and the SY_DICT_DESC.DESCRIPTION (ENG / FRA) is verified as to whether it exists.
- If an entry does not exist, it will need to be created, i.e. (ADD), or removed (DROP); in cases when a complete removal of a table is required, any description that is connected to it is also removed.
Only the following columns in (Table: SY_DICT_DESC) are updated:
- LANGUAGE
- TABLE_NAME
- FIELD_NAME
- DESCRIPTION – There is a 50 character limitation, i.e. all characters after the 50th are truncated.
- DETAIL – Uses the ‘DESCRIPTION’ property.
Generate Missing Dictionary Entries
Select this option to update the dictionary. This populates (Table: SY_DICT_DESC) with data from the user validation tables; i.e., the tables beginning with VT_USR.
Recommended Use
This process should be run under the following conditions:
- When configuring the system for the first time
- After updating the database
- Anytime that data is missing from user forms.
Modification of process starting from the following release:
- 6.0.1603.0410 / 6.0.1606.0010 / 6.0.1608.0006
- 6.1.1603.0481 / 6.1.1606.0021 / 6.1.1608.0016
Custom Entities
Users that create their own custom entities should note that the Verify Database process will not overwrite their descriptions. If there are two entities with the same table/column, the SY_DICT_DESC.DESCRIPTION will be taken from the last label entered. As long as modifications are only made to the custom entities that were created there will be no issues will descriptions being overwritten.
101-std-fea-038

