Book a Demo

Author Topic: Data Dictionary  (Read 3802 times)

Typia

  • EA User
  • **
  • Posts: 88
  • Karma: +1/-0
    • View Profile
Data Dictionary
« on: October 30, 2019, 03:51:04 am »
Hi guys,
I would like to know if it's possible to a data dictionary, not only for documentation or reporting but which could also be used as a central reference for structure in the project so we can control that modelers don't use a slightly different name for the same field across the whole project for example.

Many thanks

qwerty

  • EA Guru
  • *****
  • Posts: 13584
  • Karma: +397/-301
  • I'm no guru at all
    • View Profile
Re: Data Dictionary
« Reply #1 on: October 30, 2019, 04:28:21 am »
What is a "field" in your terminology?

q.

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Data Dictionary
« Reply #2 on: October 30, 2019, 05:46:19 pm »
There are two ways to approach this.

You can use the build-in Glossary, which is basically flat list of terms and definitions.
Advantage of the Glossary is that, if you use a known term from the glossary in a notes field, it gets underlined, and you can see the definition in the tooltip.

The other approach is to model a logical data model (or domain model). This can be much more then a flat list. I can become the very center of your complete model. It can be used to drive the database, drive the message definitions (XML or JSON Schema's), the reports, the backend code etc...

I personally prefer the logical data model approach.

Geert

Typia

  • EA User
  • **
  • Posts: 88
  • Karma: +1/-0
    • View Profile
Re: Data Dictionary
« Reply #3 on: October 31, 2019, 01:28:55 am »
Hi, thanks a lot for your answers

What is a "field" in your terminology?

q.

By field I mean database field.

I want a central repository where common database fields like client_name or so would be defined to avoid having the same notion referred by 2 differents fields (typo error in the name, or different string length ..) across the project

qwerty

  • EA Guru
  • *****
  • Posts: 13584
  • Karma: +397/-301
  • I'm no guru at all
    • View Profile
Re: Data Dictionary
« Reply #4 on: October 31, 2019, 02:05:13 am »
I guess the only way to go here is to write a script in helping to check consistency. An add-in would be even better as it can intervene on creation/editing of new class attributes (or what you call fields). It takes a bit more effort for setup, but then again it will save lots of time in the future (what one calls ROI).

q.