Skip to content

Upload Nomenclature

The Upload & Nomenclature Inputs tab (under System Configuration) sets the naming standards Nexa follows when it generates entities and artifacts. You provide a nomenclature file — a list of rules, each with a name, description, and configured value — and Nexa applies those conventions so generated names stay consistent with your database design standards.

You can upload a JSON file to seed the editor, adjust rules inline, and save. You can also download the current nomenclature to version or share it.

The file is a JSON array of rules. Each rule has:

Field Description
rule_name The rule identifier (required).
description What the rule governs.
options The rule’s value — a string, a number, or an object of key/value pairs.

The options value maps to a Data Type in the editor:

  • STRING — a single text value.
  • NUMBER — a single numeric value.
  • OBJECT — one or more key/value entries (configuration attribute → defined value / output token).

A minimal example:

[
{
"rule_name": "TABLE_PREFIX",
"description": "Prefix applied to all curated tables",
"options": "curated_"
},
{
"rule_name": "MAX_NAME_LENGTH",
"description": "Maximum length for generated names",
"options": 63
},
{
"rule_name": "LAYER_ABBREVIATIONS",
"description": "Short codes per layer",
"options": { "raw": "rw", "curated": "cur", "consumption": "con" }
}
]
  1. Open System Configuration → Upload & Nomenclature Inputs.

  2. Drag a .json file onto the Nomenclature Upload area, or click it to browse. Only a single .json file is accepted.

  3. The rules load into the editor below. Edit each rule’s name, description, and value, and change its Data Type (STRING, NUMBER, or OBJECT) as needed. For OBJECT rules, use Add row to add key/value pairs.

  4. Use Add rule to append a new rule, or the delete (trash) action to remove one.

  5. Select Save to persist the nomenclature.

Select Download the uploaded nomenclature to export the currently saved rules as nomenclature.json. Use this to back up the rules, review them, or move them between environments.