Screens: Data dictionary

Data dictionary manager

The App menuData Dictionary Management screen is where you create and edit domain packs and dictionaries in one place. Pick an asset in the list on the left, and its entries and details open on the right. What domains and dictionaries decide, and how they are assigned to a connection, is explained in Data dictionary.

Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects

What's on the screen

No.NameDescription
1New buttonOpens the window for creating a new domain pack or dictionary. You choose the type in the window.
2Import buttonCreates an asset from a backup file (.json). See Publishing, versions and backup.
3Store buttonBrowses public assets and official packs and imports them into your list. Choose domains or dictionaries to open it.
4Search by name... fieldKeeps only the assets whose name contains what you type. Korean names can also be found by their initial consonants. The headers of the two groups stay visible while searching.
5Domains group, Dictionaries groupThe list of your assets. The number in parentheses next to the header is the asset count; hovering over the header shows a + button that creates one of that type and a Store button.
6AssetA lock mark means private and a globe mark means public. Published account assets carry their latest version (v2 and so on), and on a signed-in desktop the assets on this device carry a Local mark. Click one to open it on the right.
7Button rowOn the left the Delete Pack button (the Leave button for co-editors), on the right the Export, Discard Changes and Save buttons. Account assets also have the Publish button and the Make Public button.
8Detail fieldsThe Name, Author and Description fields can be edited. The Language field is set when the asset is created and does not change. For a dictionary, the Match Type field (Combination · Exact) and the Domain Pack field are here.
9Entry tabThe domain grid for a domain pack, the word grid for a dictionary. Account assets also have the Members and Versions tabs.
  • How to edit entries in the grid is explained in Domains and Words.
  • Once you start editing, an Unsaved changes mark appears next to the name. Your edits are kept only when you save.

Where to open the screen

  • Open the App menuData Dictionary item in the app menu at the left end of the header and click the App menuData Dictionary Management item.
  • The App menuNew Data Dictionary... item of the same menu opens the create window directly, then opens this screen with the new asset selected.
  • You can also create and open assets from the data dictionary card and list on the home screen (Home).

On the desktop this screen opens as a single work tab (ScreenData Dictionary Management). It is the same tab whether you come in through domains or dictionaries, and moving to a project tab does not close the screen; it stays hidden. So you can leave an edit in progress, work in a project and come back to find it as you left it. If you have unsaved edits, you are asked when you close the tab. The web app has no tab bar, and moving to another screen leaves this one (Work tabs).

Creating an asset

  1. Click the New button (1). When opened from the + button on a group header, the type is already set.
  2. In the Type field, choose either the Domain item or the Dictionary item.
  3. For a dictionary, choose the Combination item or the Exact item in the Match Type field. The difference is explained in Data dictionary.
  4. Fill in the Name and Language fields. The language defaults to the current display language.
  5. On the desktop while signed in, check the Save on this device box if the asset is for local projects.
  6. Click the Save button. The new asset appears in the list and opens on the right.
  • The type cards (1) are not shown when the window opens with the type already set.
  • Hover over a dictionary method card (2) to see a description of that method. The dictionary method and the language (3) cannot be changed after creation.

Where a new asset is stored depends on whether you are signed in.

Desktop, not signed inSigned in (desktop, web)
A newly created assetAn asset on this deviceAn asset in your account. On the desktop, an asset on this device if you check the Save on this device box
An asset brought in from the StoreA copy of the published version downloaded to this deviceA copy cloned into your account
An asset created from a backup fileAn asset on this deviceAn asset in your account
Publishing, versions and membersNoneAvailable

Local projects can be assigned only official packs and assets on this device. Assets you create on this screen while signed in are account assets unless you check the Save on this device box, so they do not appear in a local project's assignment list. What to do in that case is explained under 'What local projects can assign' in Data dictionary.

Import from Store

  1. Click the Store button above the list and choose domains or dictionaries. Public assets and official packs appear as cards.
  2. Search by name, author or description, and sort by Popular, Recently changed or Name (A→Z).
  3. Click the button on the card you want. It is the Download button if you are not signed in, and the Clone button if you are.
  4. The copy appears in the list and opens on the right.
  • Cards with the Official mark (1) are official packs provided by NeoSQL. When packs with the same name exist for different languages, tell them apart by the language mark.
  • What you get from a card's button (2) is your own copy. It is not linked to the original, so the copy does not change when the original publishes a new version.
  • If you will use an official pack as it is without editing it, you do not need to bring it in. Assign the official pack directly in the connection settings (Assigning to a connection).

Deleting or leaving an asset

  1. Open the asset from the list.
  2. Click the Delete Pack button in the button row at the top of the details. For an account asset you were invited to co-edit, it is the Leave button.
  3. Read the confirmation window and confirm.
  • Assets on this device and account assets you own are deleted. Someone else's account asset cannot be deleted; you can only leave its members.
  • If any project has the asset assigned, the confirmation window lists the project names. Those projects keep using the assigned content after the deletion.
  • Deleting a public account asset shows a notice that other people's projects using it also keep working.

Things to keep in mind

  • Clicking another asset replaces the details on the right. If you have unsaved edits, you are first asked whether to save them. If you choose to discard, those edits are lost.
  • When you delete an account asset that a project has assigned, it disappears from the list and can no longer be edited. Those projects keep using the content as of the deletion. If you still have changes to make, do not delete it.
  • Assets on this device exist only on this device. Before removing the app or changing devices, make a backup file with the Export button (Publishing, versions and backup).
  • Everything you create or bring in on the web app is an account asset.
  • Signing out closes this screen's tab if it is open on the desktop. While not signed in, you see only the assets on this device.
  • Data dictionary: What domains and dictionaries do, where they are assigned and which assets a local project can use.
  • Domains: How to edit the entries of a domain pack.
  • Words: How to edit the words of a dictionary.
  • Publishing, versions and backup: How to publish account assets, work with versions, and exchange assets as backup files and Excel.
  • Assigning to a connection: How to assign the assets you made to a connection.
  • Work tabs: How to move between this screen and projects as tabs on the desktop.