A dictionary is a list of standard words and their abbreviations used to build column names. This page covers the screen where you create and edit the words in a dictionary, and the tab where you edit words for a single connection only. How words read a logical name to build a physical name is explained in Data dictionary, and how to create or download a dictionary in Data dictionary manager.
Select a dictionary in the list on the left of the screen and this screen opens on the right. The header and the pack buttons (Delete Dictionary, Export, Discard Changes, Save, Publish) are the same as on the Domains screen.
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Match Type field | Either the Combination type or the Exact type. It is set at creation and cannot be changed. See "Rules for reading a logical name" below. |
| 2 | Domain Pack field | The domain pack whose domains you link to words. See "Linking a domain pack" below. |
| 3 | List toolbar | The Add button for a new word, the word count, the number of entries that differ from the published version, the Excel buttons and the search box. The search looks in words, abbreviations and descriptions. |
| 4 | Word list | One row per word. The columns are those in "Word fields" below. Click a cell to edit it in place, or click a word to open the details window. |
| 5 | Row buttons | A button that opens the details window, a button that reverts this row's changes (only on changed rows) and a delete button. |
- The Name, Author and Description fields and the Language field work as in a domain pack. A dictionary stored on this device has no Publish button, Members tab or Versions tab.
Word fields
| Field | Meaning |
|---|---|
| Word | The spelling to read in a logical name (for example Order, Datetime). Words must be unique within a dictionary. |
| Abbreviation | The abbreviation used in physical names (for example ORD, DTM). It is stored in upper case, and when a physical name is built it follows the DBMS's letter-case rules. |
| Domain | The domain to use for a column when this word comes last. You pick from the domains of the pack chosen in the Domain Pack field. It can be left empty. |
| Synonyms | Other spellings read with the same abbreviation (for example Date, Timestamp). Add them one at a time in the cell or the details window. |
| Antonyms | Another word that forms a pair (for example Start ↔ End). Pick registered words in the details window. |
| Related Words | Other words with a similar meaning. Pick registered words in the details window. |
| Forbidden Words | Spellings that must not be used in place of the word. When one appears in a logical name, a notice appears and it is read with the word's abbreviation. Add them one at a time in the details window. |
| Similar Words | Spellings close in meaning or form. Used for search and hints in the right panel. Add them one at a time in the details window. |
| Description | A note. |
- Antonyms and related words are recorded on both sides. Choosing B as an antonym of A also adds A as an antonym of B. Removing one removes both.
Adding a word
- Click the Add button (3) on the list toolbar. The Add Word window opens.
- Fill in the Word and Abbreviation fields. The abbreviation turns upper case as you type.
- To link a domain, pick one in the Domain field, or open the domain list with the magnifier button next to it.
- Under Word Relationships, type a spelling in the Synonyms, Forbidden Words or Similar Words field and press Enter, or pick registered words with the magnifier buttons next to the Antonyms and Related Words lists.
- Click the Add button in the window, then click the Save button among the pack buttons to save.
- Editing and deleting words works as in "Editing and deleting domains" on Domains. Press
Ctrl+Enter(Cmd+Enteron macOS) while in a cell to add an empty row below it. - If the word already exists, the Add button in the window stays disabled, and editing it in a cell shows the Word name already exists. notice.
- An abbreviation is required, and one already used by another word cannot be used. In the window the Add button stays disabled and the reason appears under the field; editing a cell shows the Enter an abbreviation. A word without one is not used when converting logical names to physical names. or The abbreviation 'ORD' is already used by another word. notice.
Linking a domain pack
To link domains to words, first choose one domain pack for the dictionary. When this dictionary is assigned to a connection, this pack is assigned as the connection's domains too.
- Click the Select domain pack button in the Domain Pack field. Once a pack is chosen, it is the Change button.
- Pick a pack from the list. For a pack on the server, pick a version as well. Packs with no published version cannot be picked.
- When you change packs, you are told how many words point at domains the new pack does not have, and confirming clears those words' domains. Switching to another version of the same pack, or to a clone or restored copy of it, keeps the domains.
- Click the Save button.
- Which packs you can pick depends on where the dictionary lives. A dictionary on the server can use only packs on the server, and a dictionary on this device only official packs and packs on this device.
- The Unpin button clears the domain of every word. It asks for confirmation first.
- A dictionary with words pointing at domains the pack does not have cannot be published. When you publish, it asks whether to clear those assignments and publish.
Rules for reading a logical name
When you type a column's logical name in an ERD, the dictionary assigned to the connection reads it as words and builds the physical name.
| Rule | Example |
|---|---|
| From the start, the longest registered word is read first | "Order Datetime" → Order + Datetime |
The abbreviations of the words read are joined with _ to build the physical name. Letter case follows the connection DBMS's rules | ord_dtm (PostgreSQL), ORD_DTM (Oracle) |
| A synonym is read with the same abbreviation as its word | If Date is a synonym of Datetime, "Order Date" gives ord_dtm |
| The domain linked to the last word becomes the column's domain candidate. If the last word has no domain, the word before it is used | Datetime → the Datetime domain |
| Antonyms are not used to read names. They are used to suggest a paired column | Start Datetime → suggests an End Datetime column |
| Related words are not used to read names. They only appear as a hint that such words exist | |
| Characters not in the dictionary are left out of the physical name and marked in the logical name cell. Letters and digits are no exception | "Order ID" → ord, with ID marked |
- An Exact dictionary does not split names as above. It uses an abbreviation only when the whole logical name equals one registered word (or synonym).
- The physical name is built once, when you type the logical name. Changing an abbreviation later does not change column names already built.
- Columns already in the database keep their name and type when you type a logical name. See Data dictionary for details.
Editing words for one connection
You can edit the dictionary assigned to a connection for that connection only. The source dictionary does not change. Click the Data Dictionary › Dictionary node under a connection in the explorer to open the tab. The panel on the right rail shows the same edits (Assigning to a connection).
- In the explorer, expand the Data Dictionary node under the connection and click the Dictionary node.
- Edit cells, add a word with the Add word button (1), or select a row and click the Delete button.
- Click the Save (1) button to save. Unlike domains, words do not affect columns, so no confirmation window opens.
- In this tab and the right panel you also cannot leave an abbreviation empty or use one another word already uses (Abbreviation 'ORD' already exists.). The same applies to words entered through the details window.
- You can also register a word that is not in the dictionary straight from the logical name cell in an ERD. That word goes only into this connection's dictionary. See "Registering a word from an ERD" in Assigning to a connection.
Things to keep in mind
- Words without an abbreviation are not used when reading logical names. The screens do not let you leave an abbreviation empty, but a dictionary restored from a backup file can contain such words.
- The Match Type field cannot be changed after creation. If you need the other type, create a new dictionary.
- Editing words does not rename columns already built. To match names to the updated dictionary, click the marker in each ERD logical name cell one by one.
Related screens
- Data dictionary: how words decide names and domains decide types, and the difference between Combination and Exact.
- Domains: the screen for editing the domains linked to words.
- Data dictionary manager: the screen for creating and downloading dictionaries.
- Publishing, versions and backup: publishing a saved dictionary and moving it with Excel and backup files.
- Assigning to a connection: assigning a dictionary to a connection and using it in an ERD.
- Use standard names from a data dictionary: building columns with standard names from an official pack.