Skip to main content
The Data Dictionary is a searchable catalog of the target tables Kodda loads: what each table is, where its data comes from, and what each column means. Entries are written in the Edit Mapping screen and published from there; the dictionary shows the latest published version of each table. Open the Data Dictionary from the book icon in the upper right corner of the screen, or from Data Dictionary in the left navigation menu on the Home screen.

​
Searching the dictionary

  1. Select the target Connection. Only connections that have at least one published table are listed.
  2. Select the Schema within that connection.
  3. Optionally enter one or more search terms, separated by spaces or commas, then click the search button or press Enter. A table matches when any term appears in its name, its keywords, or one of its column names. Leave the field blank to list every published table in the schema.
Each result shows the Connection, Schema, Table, the published Version number and the table Description. Click the eye icon in the Detail column to open the full entry.

​
Table detail

The detail view shows:
  • Connection, Schema and the table name.
  • Version — incremented each time the table’s documentation is published. Only the latest version is shown.
  • Created By / Created On — who published this version and when.
  • Description and Keywords for the table.
  • One row per column with its Name, Type (in the target connection’s syntax), whether it is part of the target table’s primary key as defined in Target Properties (PK), its Description and its business logic (Expr).

​
Publishing documentation

Documentation is written and published from the Edit Mapping screen of the mapping that loads the table.

​
Describe the table

In Mapping Elements, click the comment icon next to the target table name.
  • Description — what the table contains. Kodda fills in a default (Table is sourced from <schema>.<table>) that you can replace.
  • Keywords — words or phrases that should find this table in a dictionary search, for example the source table name or a business term.
Click Update to save.

​
Describe the columns

Click the comment icon next to any target column.
  • Description — what the column holds.
  • Business Logic — how the value is derived, for example a calculation or a rule. Shown in the dictionary’s Expr column.
Click Update to save. Table and column descriptions are stored with the mapping as soon as you click Update, but they are not visible in the dictionary until published.

​
Publish

In the right-hand panel, under Documentation, click Publish.
Publishing writes a new version of the table’s entry — its description, keywords and the current target columns with their descriptions — to the dictionary. You are asked to confirm, because publishing replaces the entry that is currently shown for the target table. The previous version is kept in the repository but is no longer displayed.
Re-publish after changing the target columns of a mapping so the dictionary reflects the current table structure.