Overview #
Overview is the main tab used for all elements, except workflow folders. It is the first tab in the element detail view. Following sections exists in the view:
- Identification
- Objects
- Project metadata
- Business metadata
- Technical metadata
- Custom attributes
Identification #
Identification section contains key attributes:
| Attribute | Description |
|---|---|
| Name | Element name. The name should be descriptive to serve for quick orientation in metadata. |
| Code | Code is a shortened name of the element - See Code generation principles |
| Stereotype | Stereotype determines template selection and in some cases element behaviour as well. |
| Description | Free text field that contains the meaning of the element, or algorithms contained within it. It primarily serves users for their orientation in the data. |
| Comment | Comment on the object. Similar to description, it can contain, for example, a more technical explanation of the element. |
Description and Comment is descriptive metadata targeted to data user mostly. Semantics and content can be set as a development rule, e.g.:
- Description - business meaning of the element propagated to Data Catalog
- Comment - technical description used in DDL and stored in a database catalog
Code generation principles #
Code is generated as a shortened name using acronyms from Settings/Acronyms. There are several rules applied to the code:
- each word from the element name is shortened by acronym (if acronym exists)
- each space is replaced by underscore
- code is switched to lower case or uppercase based on settings on system level
- code generation can be switched on/off for each folder separately (these settings is inherited - it is not necessary to set it on subfolders again)
If a code generation is switched off, it is necessary to enter it manually.
Objects #
Each element metadata can be used for different outputs generated via templates. Objects serve as a list of those outputs. Combination of Stereotype and Object determines a template that will be used for a script preview or create.
Object types are defined in Settings/Object types
As an example of usage of Objects, users can add a new table object type Documentation and set templates as follows:
- a template assigned to Table object type generates DDL script
- a template assigned to documentation generates markdown files for a wiki site with a data catalog
More about templates is described in Settings/Templates.
Project metadata #
| Attribute | Description |
|---|---|
| Status | Development phase of the object. The status can be included in the script based on the settings of the script generation template, or used otherwise within output generation |
| Responsible person | Responsible person, selected from the list of users. |
| Responsible analyst | Responsible analyst, selected from the list of users |
Business metadata #
| Attribute name | Description |
|---|---|
| Business domain | Business domain of the entity that the table represents. Data Governance role for easier determination of the methodological owner. |
Technical metadata #
| Attribute name | Description |
|---|---|
| Owner | Element owner. The list of owners is defined at the System element level. |
Custom attributes #
If standard attributes are not enough for an element descriptions, it is possible to define custom attributes. Custom attributes are defined in Settings/Custom attributes.
It is possible to use following types of custom attributes:
| Type | Description |
|---|---|
| string | a single-line text field |
| script | a multi-line text |
| number | numerical value |
| boolean | logical value (checkbox) |
| LOV | a value selected from a list of values |
| array | multiple strings |
Attributes are defined for a combination of a system, element type and stereotype. If custom attributes are not set for the element, this section is not displayed.