Domain packs and dictionaries are assigned to a connection, not to a project. On the ERDs and table tabs of that connection you can then build physical names from logical names and pick domains for columns. This page covers where you assign them, where you edit the assigned standard for this connection only, and how to turn the edited state into a new asset. Why assignment is per connection and how a connection follows an asset that changes is explained in Data dictionary.
You assign them in the Data Dictionary tab of the connection window. Right-click a connection in the explorer and click the menu to open this tab directly.
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Note | In a local project, the Local projects can only use official packs and assets stored on this device. note appears as well. |
| 2 | Domain slot | The name and version of the assigned domain pack. A pack on this device shows the This device badge instead of a version. If a version newer than the assigned one is published, the New version v2 badge appears. |
| 3 | Select Domain button | Picks a domain pack. Once one is assigned, it is the Change Domain button. It is disabled when the pack comes from the dictionary. |
| 4 | Data Dictionary slot | The name and version of the assigned dictionary. The Remove button on the card removes the assignment. |
| 5 | Select Dictionary button | Picks a dictionary. Once one is assigned, it is the Change Dictionary button. |
- The two slots are independent. An empty slot means it is not used, and you can assign just one.
- If the dictionary names a domain pack, that pack goes into the domain slot with the From dictionary badge. While it is there, the domain slot cannot be changed. To change it, change or remove the dictionary.
- The tab appears only for a saved connection that you have permission to edit. Save a new connection once before assigning.
Assigning to a connection
- In the explorer, right-click the connection and click the menu. The connection window opens on the Data Dictionary tab.
- Click the Select Dictionary button (5) or the Select Domain button (3) and pick an asset from the list.
- For an asset on the server (an official pack or an account asset), pick a version. There is no option that follows the latest version automatically. Assets with no published version cannot be picked. Assets on this device do not ask for a version.
- If the dictionary names a different domain pack, you are asked whether to replace the current domain with that pack.
- Click the Save button of the window. Choices in this tab take effect only when you save (Changes here take effect when you save.).
- Removing an assignment or switching to another asset asks for confirmation when you save. What you edited for this connection only in that slot (see "Editing for this connection only" below) is deleted, and if the domain pack goes away, the domains assigned to columns are removed too. The columns' types and lengths stay as they are.
- Changing only the version of the same asset keeps your edits.
- In an account project, if your role has the Domain restriction permission, the buttons of both slots are disabled.
Assets you can pick
| Local project | Account project | |
|---|---|---|
| Official packs | Can be picked | Can be picked |
| Account assets (ones you own or co-edit, and public ones) | Cannot be picked, even when signed in | Can be picked |
| Assets on this device | Can be picked | Cannot be picked |
| Where assignments and connection-only edits are stored | This device | Your account |
- A local project is not linked to an account, so an account asset assigned to it could not be read after signing out or on another device. That is why account assets are not listed.
- Assets created in the manager while signed in are account assets. If you need a device asset for a local project, check the Save on this device box when creating it, or assign an official pack and make a copy with "Cloning the current state" below. Copies made in a local project are stored on this device.
The data dictionary node in the explorer
Once anything is assigned, a Data Dictionary node appears at the end under the connection in the explorer.
| No. | Node | Clicking it |
|---|---|---|
| 1 | Data Dictionary | Opens the Data Dictionary tab of the connection window. |
| 2 | Domains | Opens the tab that edits the assigned domain pack for this connection. See Domains. |
| 3 | Dictionary | Opens the tab that edits the assigned dictionary for this connection. See Words. |
- The asset name and version (or the This device badge for an asset on this device) follow the node. An orange arrow appears when a newer version is published, and a link icon when the domain pack comes from the dictionary.
- Only assigned slots get a node. With both slots empty there is no Data Dictionary node, so assign through the context menu.
The data dictionary panel
The panel opened by the button on the right rail. It shows the domains and words assigned to the connection of the work tab you have selected (an ERD, a SQL editor, a table tab and so on). Keep it open beside you to look things up or edit them while you build columns.
| No. | Name | Description |
|---|---|---|
| 1 | Header buttons | The Show both stacked button (shows domains and dictionary stacked), the Clone current state button (only when something is assigned), the pin button and the Close button. |
| 2 | Tabs | The Domains tab and the Dictionary tab. With the Show both stacked button turned on, the two lists are stacked instead of tabbed. |
| 3 | Connection and asset | The connection the panel follows, the assigned asset name and its version badge. A marker appears here when a newer version exists or a domain pack on this device has changed. The refresh button next to it reads the list again. |
| 4 | Change counts | The total and the number of entries added, changed and deleted on this connection. Click one to show only that kind. |
| 5 | List | Name, type and description for domains; word, abbreviation and description for the dictionary. Domain types are shown in this connection database's types. Click a row to edit it in place. |
- With no work tab open, the No open tab message appears. With nothing assigned, the No domain selected. message and a button that opens the assignment window appear.
- The panel is available in local projects too.
Editing for this connection only
You can edit the assigned assets for this connection only. The edits apply only to this connection and the source asset does not change (Changes applied to this connection only, compared with the domain pack. The pack (Demo Domains) is left untouched.).
- Click a row in the panel's list. The row turns into input fields. For a fuller editor, click the Edit details button at the end of the row.
- Change the values and press Enter or click outside. Esc cancels. Add new entries with the Add domain button at the top of the domain list or the Add word button at the top of the dictionary list.
- A marker appears in front of the edited row, and the save bar at the bottom shows the 1 edited domains become available in ERD / table details after saving. note.
- Click the Save (1) button. Domains go through the Domain change impact window and also update the columns that use them (see "Editing domains for one connection" in Domains). Words are saved right away.
- Before saving, the Undo button at the end of a row discards that row's edits. The Discard all button on the save bar discards all unsaved edits.
- After saving, the Revert to pack original button at the end of a row returns it to the source asset's values. The revert also takes effect only after saving.
- When a domain pack or dictionary on this device is edited in the manager, a Source changed button appears next to the asset name in the panel. Click it to pull in the asset's current content. Edits made for this connection are kept, and unsaved edits are discarded.
- Assets on the server do not change by themselves when a new version is published. To use a new version, pick the same asset again in the connection window and choose the version.
Cloning the current state
Edits made for this connection exist only on this connection and cannot be used by other connections or projects. Turn the source plus your edits into a new asset, and you can assign it elsewhere too.
- Select a work tab of the connection to clone, then click the Clone current state button in the panel header.
- The window shows the assigned domain pack and dictionary as cards. Each card shows the entry count, the number of edits on this connection and a field for the new name.
- Adjust the new names. To switch this connection to the copies as well, turn on the Use in this connection right away checkbox.
- Click the Clone button.
- Where the copies are created depends on the project. In a local project, or when not signed in, they become assets on this device. In an account project while signed in, they become account assets and their first version is published right away.
- Cloning the dictionary also clones its domain pack, because the domains the dictionary's words point at only mean something inside that pack.
- Unsaved edits are not included in the clone (1 unsaved edits are not included in the clone. Save them first, then clone.). Save first.
- If any word points at a domain that no longer exists, cloning stops and lists those words.
- The Use in this connection right away checkbox is off by default. Turning it on switches this connection's assignment to the copies and clears its connection-only edits. It appears only when you have permission to edit the connection.
Registering a word from an ERD
When you type a column's logical name on an ERD or a table tab, the assigned dictionary builds the physical name and picks a domain from the assigned domain pack. The rules are explained in "Rules for reading a logical name" on Words and in Data dictionary. If a word is not in the dictionary, you can register it right from the logical name cell.
- Hover over the column's Logical Name cell and click the icon at its end (1). The Review needed menu opens.
- Words not in the dictionary are marked New. Click the Register word item (2).
- In the Add word window, enter an abbreviation, and pick a domain now or leave it empty. The abbreviation is required, and one already in use cannot be used.
- Click the Add button in the window. The word goes into this connection's dictionary, and the physical name of the column you clicked is built again. Other columns keep their names.
- A registered word is an edit for this connection only (Added only to the dictionary in use. The source dictionary is not changed.). To put it in the source dictionary, edit the source in the manager, or make a new asset with "Cloning the current state" above.
- The same menu also renames a column to match the dictionary, standardizes synonyms and forbidden words to the standard word, and adds an antonym pair column. Columns already in the database are not renamed just by typing a logical name, but choosing register word or a rename renames that column. Check before applying to the database.
Things to keep in mind
- Removing an assignment or switching to another asset deletes the edits made for this connection, and this cannot be undone. To keep them, make a copy with "Cloning the current state" first.
- Changing an assignment leaves the types and lengths copied into columns as they are. To match the new pack's values, pick the domain again on those columns.
- In a local project, account assets are not listed even when signed in. Assets on this device exist only on this device. To move them to another device, use a backup file (Publishing, versions and backup).
- Editing a dictionary on this device in the manager shows no source-changed marker in the panel. Only domain packs show one.
Related screens
- Data dictionary: why assignment is per connection and how a connection follows an asset that changes.
- Create and edit a connection: the other tabs of the connection window.
- Object explorer: the connection context menu and nodes.
- Domains, Words: the tabs that edit the assigned assets for this connection.
- Data dictionary manager: the screen for creating and downloading the assets you assign.
- Use standard names from a data dictionary: assigning an official pack and building columns with standard names in an ERD.