This page explains how to send out an asset you edited on the Data dictionary manager screen so that other connections and people can use it. For an account asset, connections use the saved content only after you publish it as a version. Assets on this device have no publishing or versions; you exchange them only as backup files and Excel. Which version a connection sees is explained in Data dictionary.
| Account asset (signed in) | Asset on this device | |
|---|---|---|
| Saving | Stays in your draft. Connections do not change yet | Stays on this device. There is nothing to publish |
| Publishing and versions | Available | None |
| Visibility and members | Available | None |
| Excel, backup files | Available | Available |
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Version mark | The latest published version. Assets that have never been published have none. |
| 2 | Export button | Downloads the asset as a backup file (.json) ('Moving with a backup file' below). |
| 3 | Discard Changes button | Throws away all unsaved edits and returns to the last saved state. |
| 4 | Save button | Saves your edits to your draft. |
| 5 | Publish button | Publishes the saved draft as a version. It cannot be clicked while you have unsaved edits. |
| 6 | Make Public button | Makes the asset public in the Store. On a public asset it is the Make Private button. Shown only to the owner. |
| 7 | Unpublished mark | The number of entries that differ from the published version, counted as added, updated and deleted. If the asset has never been published, a Never published mark appears instead. |
| 8 | Revert button | The button at the end of a row (Revert this row to the published version). Sets that row back to its published values. The revert, too, is kept only when you save. |
| 9 | Members tab, Versions tab | The people you edit with and the list of published versions. Account assets only. |
- In an asset that has been published at least once, rows that differ from the published version are marked by color. Added, edited and deleted rows have different colors.
- A dictionary has the same buttons in the same places.
Saving and publishing
An account asset has two states.
| Draft | Published version | |
|---|---|---|
| Button that makes it | The Save button | The Publish button |
| Whose it is | Yours alone. Each member of the same asset edits their own draft | The version everyone sees. It is numbered, such as v1 and v2 |
| Effect on connections | None | Connections assigned to that version use this content |
| Deleting | It changes when you go back to an earlier version | Cannot be deleted |
Drafts and published versions are kept apart so that a standard being edited does not change other people's columns. Even after you publish, connections stay at the version they were assigned and only show that a new version exists (Assigning to a connection).
Publishing
- Edit the entries and click the Save button (4).
- Click the Publish button (5). The Publish window opens.
- Check the changes in the window (the number of additions, updates and deletions) and the new version number.
- Click the Publish as new version button. To change a version you already published, click the Overwrite current version button instead.
- The sentence (1) tells you which asset is published as which version and what changes. If nothing differs from the published version, it warns that another version with the same content will be created.
- The current version notice (2) and the Overwrite current version button (3) appear only for assets published at least once.
- The Publish as new version button (4) raises the number by one. Connections assigned to the earlier version do not change.
- Overwriting changes the content of the latest version without raising the number. It reaches connections assigned to that version right away, and projects open on this device reload it on the spot.
- If another member published a new version while you were editing your draft, your draft is fitted onto that version and published as a new version. Even if you chose overwrite, it becomes a new version instead of overwriting the other person's version.
- Publishing fails if a dictionary word points to a domain that is not in the domain pack the dictionary uses. The same happens if the dictionary has no domain pack set but some word points to a domain.
Going back to an earlier version
The Versions tab shows the published versions, newest first. Published versions cannot be deleted, so going back means bringing in an earlier version's content again.
- The mark at the top (1) is the latest version. If your draft started from a different version, a current draft version mark appears with it.
- Version rows (2) carry the Latest and Current marks. The Current mark is the version your draft started from.
- In the Versions tab, find the row of the version to go back to.
- If you will edit it before publishing again, click the Restore to draft button (3). Your draft takes that version's content. Saved but unpublished changes and unsaved edits are all lost, so read the confirmation window before confirming. Then edit, save and publish.
- If you will publish that version again as it is, click the Republish as latest button (4). A new version with that version's content is published right away.
- To go back on a single row, use the revert button in the entry grid ('What's on the screen' above).
- A republished version also has a new number. To make a connection use that content, choose the new version in the connection settings.
Visibility and members
An account asset starts out private. Invite the people you edit with as members, and make it public to let anyone use it.
| Visibility | Who can see it | Where |
|---|---|---|
| Private | You and the members you invited | The default |
| Public | Every user. It also appears in the Store on desktops that are not signed in. Others cannot edit it; they take a copy | The Make Public button at the top of the details |
- In the Members tab, click the Invite member button.
- Enter a nickname or email address in the Search nickname or enter email field, and choose a role in the Role field.
- Click the Send invites button. Invitations not yet accepted stay in the Pending invites list, where you can cancel them.
| Role | What it can do |
|---|---|
| Owner | Everything. Changes visibility, changes members' roles or removes them, and deletes the asset |
| Maintainer | Edits and publishes. Invites with the Contributor and Viewer roles |
| Contributor | Edits and publishes |
| Viewer | Views. Cannot edit or publish. The details show the View only — you cannot save or publish mark, the Save button stays disabled and the Publish button is hidden |
- A sole owner cannot leave from the Members tab. To hand over the asset, change another member to owner, then leave.
Exchanging entries as Excel
Use Excel to fill in or change the entries of an existing asset in bulk. To move the asset itself, use a backup file, described below.
- The Excel download button above the entry grid downloads the entries shown on the screen as an
.xlsxfile. The sheet is namedDomainorDictionary, and the column headers are written in the display language. The type, Y/N, default value and domain columns have lists to choose from. - A dictionary's domain column is created only when that dictionary has a domain pack set.
- Click the Excel upload button above the entry grid.
- The first time, get a blank form with the Download blank template button and fill it in.
- Choose the filled-in file with the Choose file (.xlsx) button. A preview appears before anything is applied.
- Check the number of additions and updates, the entries that change and the rows left out because of errors. Clear the checkbox of any entry you do not want to change.
- Click the Apply n button at the bottom, then click the Save button on the details.
- The Choose file (.xlsx) button (1) and the Download blank template button (2) are at the top of the window.
- The summary (3) shows n added, n updated, n unchanged and n skipped (errors).
- The Changes (n) table (4) shows only the entries that will be updated. The View button on a row shows the before and after side by side.
- The rows in the Skipped with errors (n) table (5) are not applied. Fix the file and upload it again.
- The Apply n button (6) only puts the changes into the grid as edits. Until you save, you can undo them with the Discard Changes button.
| Rule | Details |
|---|---|
| How the same entry is found | By name (the domain name, the word). An entry with the same name is updated; a new name is added |
| Entries not in the file | Not deleted |
| Dictionary abbreviations | If the abbreviation is used by another word, the row is an error |
| Column headers | A file downloaded in Korean is still read on an English screen |
Moving with a backup file
A backup file is a .json file holding one whole asset. Use it to move an asset on this device to another device, to move an account asset to another account, or to keep a copy before deleting.
- Click the Export button at the top of the details and choose where to save. The file is named after the asset.
- Where you are moving it to, open the Data dictionary manager screen and click the Import button above the list.
- Choose the file with the Choose backup file (.json) button.
- Check the Kind, Name and Entries fields. You can change the name.
- For a dictionary, choose the domain pack this dictionary will use.
- Click the Create button. The new asset appears in the list and opens.
- The Choose backup file (.json) button (1) accepts only
.jsonfiles. - If the name in the Name field (2) already exists, a An asset with this name already exists notice appears. It does not stop you, so change the name to avoid confusion.
- The Domain pack field (3) appears only for dictionary backups. Create the pack contained in the backup, choose an existing pack whose domains match, or choose the No pack (clears every domain assignment) item. Each pack shows how many of the backup's domains it resolves, and account packs with no published version cannot be chosen.
- Words that pointed to a domain not in the chosen pack are created with their domain assignment cleared. The window shows that number in advance.
- The asset made with the Create button (4) becomes an asset on this device or an account asset depending on whether that screen is signed in. An account asset must be published before it can be assigned to a connection.
| What a backup file holds | Details |
|---|---|
| Asset details | Type, name, description, author, language, dictionary method |
| Entries | The entries shown on the screen at export time. Unsaved edits are included |
| The domain pack the dictionary uses | For a pack on this device, the pack's content as well. For official and account packs, only which pack it is |
- Versions, members, visibility and connection assignments are not included. The restored asset is a new asset and is not linked to the original.
- Files exported in the app's older format cannot be restored. Export again from the latest app.
Things to keep in mind
- Published versions cannot be deleted. Publishing when nothing has changed creates another version with the same content. Read the warning in the Publish window.
- Overwriting reaches every connection assigned to that version at once. If the version is used in other people's projects, their ERDs behave differently too. If you are not sure, publish as a new version.
- The Restore to draft button replaces your draft with that version's content. Changes you saved but did not publish and unsaved edits are lost together. If there is anything to keep, publish it or export a backup file first.
- A public asset can be taken from the Store even by users who are not signed in. Do not make public anything that must not be seen outside, such as company-internal standards; invite members instead. Making it private again does not remove copies already taken.
- When you edit and save an asset on this device, the connections assigned to it do not follow on their own. A connection sees the copy made when it was assigned. How to bring the changes in again is explained in Data dictionary.
Related screens
- Data dictionary manager: The screen where you create and open assets.
- Domains, Words: How to edit the entries you publish.
- Assigning to a connection: How to assign a published version to a connection and switch to a new version.
- Data dictionary: Why connections stay at the point they were assigned, and how assets on this device behave.