Dictionary general settings

The General step is the first of the six steps of the dictionary editor, ahead of Queries, Columns, Dependencies, RLS and Data Mapping, and the editor opens on it. Use it to name the dictionary, describe it, group it with logical models and permission groups, and set its refresh schedule. The full create flow is on Dictionaries.

Fill in the step

The step has three cards: Name and Description in the left column, above Refresh Settings, and Configuration in the right column.

  1. Type the dictionary's Name. It is required, and it locks once the dictionary is saved.
  2. Add a Description for optional notes.
  3. Pick at least one of Logical Models under Configuration.
  4. Add Permission Groups if roles beyond admin should read the dictionary.
  5. Fill Refresh Settings to set how often the dictionary refreshes.
  6. Click Apply to save the step, or Next to carry on.

Name and description

Warning

A dictionary cannot be renamed afterwards. The name you save here is the name it keeps, so check it before the first save.

Logical models and permission groups

The Configuration card fills the right column:

FieldWhat it doesRules
Logical ModelsThe business groups the dictionary belongs to.Required; up to 20
Permission GroupsThe roles that can read the dictionary.Up to 20; the admin group is applied by default and hidden

Set the refresh schedule

Refresh Settings holds the dictionary's refresh schedule:

FieldWhat it doesRules
Refresh IntervalHow often the dictionary refreshes, in the unit beside it.A whole number of 1 or more. A new dictionary starts at 1.
Refresh Interval UnitThe unit of the interval.Minute, Hour, Day, Week or Month. A new dictionary starts at Minute.
Refresh OffsetShifts each run inside its period, so a daily refresh can run at 03:00 instead of midnight.Optional; a number of 0 or more.
Offset UnitThe unit of the offset.Minute, Hour, Day, Week, Month or None. Picking None clears the offset number and its unit together.
RetriesHow many times a failed refresh is retried.-1 retries indefinitely; leave the field empty to use the default of 2.

The book icon beside the section title opens the refresh settings guide. The fields describe the schedule only; to start, stop or run a refresh, open the Settings tab: Dictionary settings.

Save the step

Questions, answered

What happens when I save the General step for the first time?

The dictionary is created. It joins the Warehouse tree, the popup title switches to its name, and the Name field locks, so the name can never change. The save reads Dictionary created successfully; every save after that reads General information updated successfully.

Which settings can I still change after the first save?

Everything on the step except the Name. The description, the logical models, the permission groups and the refresh fields stay editable on later saves; the name locks at the first one.

Who can read the dictionary by default?

The admin group, and only it, until you add others. Permission Groups starts with the admin group applied and hidden, so a dictionary left untouched is reachable by admins only. Add a group to let that role read it; see Warehouse permissions and row-level security.

Do I have to fill in General before the other steps?

Yes. General is the first of the six steps, and the first save creates the dictionary that the other steps build on. If you click Next with unsaved changes, Save & Continue saves them and carries you on.

Which refresh fields can I leave empty?

Refresh Offset and its unit are optional, and so is Retries: an empty Retries field uses the default of 2. Refresh Interval and Refresh Interval Unit make up the schedule itself; a new dictionary starts with 1 and Minute.

How do I clear the refresh offset?

Pick None in Offset Unit. The offset number and its unit clear together, so nothing is left behind.

What can I enter in Refresh Interval?

A whole number of 1 or more. Anything below 1 is ignored as you type, and a new dictionary starts at 1.

Where do logical models come from?

They are Warehouse objects, created once and reused across tables, and a dictionary needs at least one. Create or manage them from the Warehouse tree, as described in Semantic sources, source systems and logical models; the models window itself is on Logical models.