The best practices compiled here can be used when configuring dataspot.
Table of Contents YAML
Best practice guidance on organising YAML. This helps to organize and structure content more effectively.
# 000 - Cross-cutting changes
# 010 - Collection / Collection
# 020 - Derivation / Derivation
# 030 - Dependency / Dependency
# 040 - Transformation / Transformation
# 050 - Rule / Rule
# 060 - Attribution / Attribution
# 100 - Business data model / Business data model
# 110 - Business object / Business object
# 120 - Business attribute / Business attribute
# 130 - Relationship / Relationship
# 200 - Reference data model / Reference data model
# 210 - Reference object / Reference object
# 220 - Reference value / Reference value
# 230 - Mapping / Mapping
# 240 - Translation / Translation
# 300 - Measures catalog / Measures catalog
# 310 - Measure / Measure
# 320 - Dimension / Dimension
# 400 - Data catalog / Data catalog
# 410 - Dataset / Dataset
# 420 - Composition / Composition
# 430 - Distribution / Distributions
# 440 - Subdatenset / Subdataset
# 500 - Quality model / Quality model
# 510 - Indicator / Indicator
# 600 - Project directory / Project directory
# 610 - Project / Project
# 700 - Processing records / Processing records
# 710 - Processing / Processing
# 800 - Data model / Data model
# 810 - Data object / Data object
# 820 - Attribute / Attribute
# 830 - Relationship / Relationship
# 840 - Enumeration / Enumeration
# 850 - Literal / Literal
# 860 - Data type / Data type
# 870 - Operation / Operation
# 880 - Parameter / Parameter
# 900 - System catalog / System catalog
# 910 - System / System
# 920 - Deployment / Deployment
# 1100 - Organization
# 1110 - Post / Post
# 1120 - Group / Group
# 1130 - Person / Person
# 1140 - Role / Role
# 1150 - Task / Task
Cross-cutting changes
Derivation (Origin)
Derivation represents the origin in the accordion of various elements. It can therefore be used to identify the origin in different contexts. Different values can be defined for derivation depending on how it is used.
Defining the meaning of derivation
If derivation is used primarily to represent business lineage, it can be useful to define different meanings.
# 020 - Derivation
Derivation:
properties:
qualifier:
literals:
FILTER:
label:
de: Filter
en: Filter
order: 10
BER:
label:
de: Berechnungsbasis
en: Calculation basis
order: 20
EXCLUDE:
label:
de: Schließt aus
en: Exclude
order: 30
Dependency
Labels for dependencies
Dependencies can be defined between collections, projects, processes, and systems. Labels can be assigned to these dependencies.
Dependency:
properties:
stereotype:
literals:
SUCCESSOR:
label:
de: Nachfolger
en: Successor
SUCCESSORCOND:
label:
de: Nachfolger mit Bedingung
en: Successor under condition
Rule (Transformation rule)
Changes to transformation rules
It can be useful to distinguish between different transformation types. Various transformation types are defined for this purpose. The main benefit is that technical transformations in data processing can be described and represented in a traceable manner. Using different symbols improves clarity.
Selection of transformation types
Transformation standard #1
This is a limited standard that covers a smaller set of transformation types.
# 050 - Rule
Rule:
properties:
stereotype:
label:
de: Transformationstyp
en: Transformationtype
literals:
ONE2ONE:
label:
de: 1:1-Mapping
en: 1:1-Mapping
order: 10
icon: clone
title:
de: Beschreibt die direkte 1:1 Beziehung von Attributen/Objekten.
en: Describes the direct 1:1 Mapping between attributes or objects.
DESCRIBED:
label:
de: wie beschrieben
en: as described
order: 30
icon: angry
title:
de: Eine detaillierte Beschreibung der Transformation ist enthalten.
en: A detailed description of the transformation is provided.
FIX:
label:
de: Fixwert
en: fixed value
order: 40
icon: lock
title:
de: Für die Transformation wird eine feste Ausprägung gewählt.
en: A fixed value is provided for the transformation.
SELECTION:
label:
de: Datenselektion
en: data selection
order: 50
icon: cut
title:
de: Für die Transformation ist nur eine Selektion an Elementen relevant. (BSP: Transformation soll nur für einen ausgewählten Buchungskreis relevant sein)
en: Only a selection of elements is relevant for the transformation. (Example: The transformation should only apply to a selected company code)
RELATION:
label:
de: Beziehung
en: relationship
order: 60
icon: heart
title:
de: Mit der Beziehung soll Logik wie z.B.: "JOINS" beschrieben werden. TabelleA Attribut1 wird mit TabelleB Attribut2 gejoint.
en: This relationship is intended to describe logical operations such as ‘JOINS’. TableA Attribute1 is joined with TableB Attribute2.
Transformation standard #2
Extensive set of transformation types
# 050 - Rule
Rule:
properties:
stereotype:
label:
de: Transformationstyp
en: Transformationtype
literals:
ONE2ONE:
label:
de: 1:1-Mapping (MAP)
en: 1:1-Mapping
order: 10
icon: clone
ONE2ONEDEFAULT:
label:
de: 1:1-Beladung (BEL)
en: 1:1-Load
order: 20
icon: angle-double-down
CALCULATION:
label:
de: Berechnung (CALC)
en: calculation
order: 30
icon: calculator
MAPPING:
label:
de: Umschlüsselung (KEY)
en: recoding
order: 40
icon: key
DESCRIBED:
label:
de: wie beschrieben (DESC)
en: as described
order: 50
icon: keyboard
FIX:
label:
de: Fixwert (FIX)
en: fixed value
order: 60
icon: lock
SELEKTION:
label:
de: Datenselektion (SEL)
en: data selection
order: 70
icon: check
RELATION:
label:
de: Beziehung (REL)
en: relationship
order: 80
icon: heart
MODIFICATION:
label:
de: applikationsinduzierte Modifizierung (MOD)
en: application induced modification
order: 90
icon: exchange-alt
LOGMOD:
label:
de: logisches Datenmodell (LDM)
en: logical datamodel
order: 100
icon: code-branch
CONNECTION:
label:
de: Konnexion (KONX)
en: connection
order: 110
icon: plug
CORRESPONDS:
label:
de: Entspricht (ENTSP)
en: corresponds to
icon: equals
order: 120
Status
Statuses are defined centrally for dataspot. The statuses used can then be specified in the workflow for each model.
Status values for technical data models
It is often advisable to define specific statuses for technical data models, especially those delivered automatically, for example through the JdbcMetadataConnector. These are defined in addition to the standard statuses.
Asset:
properties:
status:
literals:
# Additional statuses for technical data models
NEW:
label:
de: Neu
en: New
icon: file-plus
order: 7
group: DRAFT
CHANGED:
label:
de: Geändert
en: Changed
icon: arrow-right-arrow-left
group: DRAFT
order: 8
DELETED:
label:
de: Gelöscht
en: Deleted
icon: trash-can
group: PUBLIC
order: 9
Stereotyping models
In dataspot., models themselves can also be stereotyped to distinguish specific model variants more clearly. This configuration can be implemented in two ways.
Stereotyping all model types
When stereotyping all model types, the desired stereotype is defined centrally and can therefore be selected for all model types. This is useful, for example, when models of different types should use the same representation because they belong together in terms of content.
Scheme:
properties:
stereotype:
label:
de: Modellvariante
en: Model type
literals:
DQM:
label:
de: Datenqualitätsrelevantes Modell
en: Model relevant to data quality
icon: badge-check
Stereotyping one model type
A specific model type, such as a technical data model, can also be stereotyped on its own. This allows further subdivision into subtypes within the model type. This is useful, for example, when different technical data models such as interfaces, databases, or Excel files require different representations.
UmlModel:
properties:
stereotype:
label:
de: Art des technischen Modells
en: Type of technical model
literals:
INTERFACE:
label:
de: Schnittstelle
en: Interface
icon: arrows-split-up-and-left
EXCEL:
label:
de: Excel-File
en: Excel file
icon: file-excel
Business data model
BusinessObject
Data protection categories
To comply with the GDPR, personal data must be classified according to its type.
# 110 - Business object
BusinessObject:
properties:
dataProtectionCategory:
literals:
PERSONAL:
label:
de: personenbezogen
en: personal data
IDENTIFYING:
label:
de: personenidentifizierend
en: identifying data
SENSITIVE:
label:
de: sensibel
en: sensitive
RACIAL:
label:
de: rassische und ethnische Herkunft
en: racial and ethnic origin
BIOMETRIC:
label:
de: biometrische Daten
en: biometric data
GENETIC:
label:
de: genetische Daten
en: genetic data
HEALTH:
label:
de: Gesundheit oder Sexualleben
en: health or sexual orientation
RELIGIOUS:
label:
de: religiöse oder philosophische Überzeugungen
en: religious or philosophical beliefs
Data category - master data and transaction data
Classifying data by data category facilitates analysis and categorization.
# 110 - Business object
BusinessObject:
customProperties:
dataCategory:
label: Datenkategorie
labelEn: Data category
literals:
master:
label:
de: Stammdaten
en: master data
transactional:
label:
de: Transaktionsdaten
en: transactional data
retentionPeriod:
label:
de: Behaltedauer (in Monaten)
en: retention period (in months)
baseType: DECIMAL
Business object confidentiality class
Many organizations need to categorize data by confidentiality and protection requirements. Several variants are provided as templates for defining such fields:
Business object confidentiality class I
Classification according to the Traffic Light Protocol
BusinessObject:
customProperties:
confidentialityClass:
label:
de: Vertraulichkeit (Vt) nach TLP
en: Confidentiality TLP
literals:
WHITE:
label:
de: TLP White - Ohne Beschränkung
en: TLP White - No restrictions
order: 10
GREEN:
label:
de: TLP Green - intern
en: TLP Green - Internal
order: 20
AMBER:
label:
de: TLP Amber - "Need to know" - Kenntnis erforderlich
en: TLP Amber - Need to know
order: 30
RED:
label:
de: TLP Red - Ausschließlich persönlich
en: TLP Red - Recipient only
order: 40
Business object confidentiality class II
Classification according to protection classes
BusinessObject:
customProperties:
securityClass:
label:
de: Sicherheitsklasse
en: Security category
literals:
SK0:
label:
de: SK 0 - frei verfügbar
en: SC 0 - unrestricted
order: 10
SK1:
label:
de: SK 1 - eingeschränkt
en: SC 1 - restricted
order: 20
SK2:
label:
de: SK 2 - vertraulich
en: SC 2 - confidential
order: 30
SK3:
label:
de: SK 3 - geheim
en: SC 3 - secret
order: 40
SK4:
label:
de: SK 4 - streng geheim
en: SC 4 - top secret
order: 50
Availability - business object
Classifying data by availability clearly shows the availability requirement and the infrastructure needed to meet it. The template is provided in two variants.
Availability for business objects I - requirements and impact
BusinessObject:
customProperties:
availabilityClass:
label:
de: Verfügbarkeit (Vf)
en: Availability
literals:
LOW:
label:
de: 1 = Anspruch niedrig (ein Ausfall wäre nicht kritisch)
en: 1 = low requirement (downtime not critical)
order: 10
MEDIUM:
label:
de: 2 = Anspruch mittel (ein Ausfall wäre wenig kritisch)
en: 2 = medium requirement (downtime not very critical)
order: 20
HIGH:
label:
de: 3 = Anspruch hoch (ein Ausfall wäre kritisch)
en: 3 = high requirement (downtime critical)
order: 30
VERYHIGH:
label:
de: 4 = Anspruch sehr hoch (ein Ausfall wäre sehr kritisch)
en: 4 = very high requirement (downtime highly critical)
order: 40
Availability for business objects II - backup type
BusinessObject:
customProperties:
availablilityClass:
label:
de: Verfügbarkeit
en: Availability
literals:
UNCRITICAL:
label:
de: Unkritisch (Offline Sicherung)
en: non-critical (offline backup)
order: 10
CRITICAL:
label:
de: Kritisch (Redundante Infrastruktur)
en: critical (redundand infrastructure)
order: 20
HIGHLYCRITICAL:
label:
de: Hoch kritisch (Redundanter Standort)
en: highly critical (redundant location)
order: 30
GDPR data usage - type of processing
BusinessObject:
customProperties:
dataUsage:
label:
de: Datennutzung
en: Data usage
literals:
UNRESTRICTED:
label:
de: uneingeschränkt
en: unrestricted
order: 10
RESTRICTED:
label:
de: eingeschränkt
en: restricted
order: 20
NOTPERMITTED:
label:
de: nicht erlaubt (nur mit Rechtsgrundlage erlaubt)
en: not permitted (only with lawful basis)
order: 30
Object types for the data map
When a data map is modeled in the dataspot. business data model, documents that are not actual business objects often also need to be represented. To provide a quick overview in the data map, specific object types are stereotyped here.
BusinessObject:
properties:
stereotype:
label:
de: Objekttyp für Datenlandkarte
en: Object type for data map
literals:
FOREIGN:
label:
de: Fremdobjekt | Fremdobjekte
en: Foreign Object | Foreign Objects
icon: arrows-up-down-left-right
order: 10
DOMESTIC:
label:
de: Eigenobjekt | Eigenobjekte
en: Domestic Object | Domestic Objects
icon: arrows-to-dot
order: 20
PARTICIPANT:
label:
de: Beteiligte Rolle | Beteiligte Rollen
en: Participating Role | Participating Roles
icon: users
order: 30
DOCUMENT:
label:
de: Dokument | Dokumente
en: Document | Documents
icon: file
order: 40
BusinessAttribute
Data protection categories
To comply with the GDPR, personal data must be classified according to its type.
BusinessAttribute:
properties:
dataProtectionCategory:
literals:
PERSONAL:
label:
de: personenbezogen
en: personal data
order: 10
IDENTIFYING:
label:
de: personenidentifizierend
en: identifying data
order: 20
SENSITIVE:
label:
de: sensibel
en: sensitive
order: 30
RACIAL:
label:
de: rassische und ethnische Herkunft
en: racial and ethnic origin
order: 40
BIOMETRIC:
label:
de: biometrische Daten
en: biometric data
order: 50
GENETIC:
label:
de: genetische Daten
en: genetic data
order: 60
HEALTH:
label:
de: Gesundheit oder Sexualleben
en: health or sexual orientation
order: 70
RELIGIOUS:
label:
de: religiöse oder philosophische Überzeugungen
en: religious or philosophical beliefs
order: 80
Data category - master data and transaction data
Classifying data by data category facilitates analysis and categorization.
BusinessAttribute:
customProperties:
dataCategory:
label:
de: Datenkategorie
en: Data category
literals:
MASTER:
label:
de: Stammdaten
en: master data
TRANSACTIONAL:
label:
de: Bewegungsdaten
en: transactional data
Confidentiality class - attribute
Many organizations need to categorize data by confidentiality and protection requirements. Several variants are provided as templates for defining such fields:
Confidentiality class - attribute I
BusinessAttribute:
customProperties:
confidentialityClass:
label:
de: Vertraulichkeit (Vt) nach TLP
en: Confidentiality TLP
literals:
WHITE:
label:
de: TLP White - Ohne Beschränkung
en: TLP White - No restrictions
order: 10
GREEN:
label:
de: TLP Green - intern
en: TLP Green - Internal
order: 20
AMBER:
label:
de: TLP Amber - "Need to know" - Kenntnis erforderlich
en: TLP Amber - Need to know
order: 30
RED:
label:
de: TLP Red - Ausschließlich persönlich
en: TLP Red - Recipient only
order: 40
Confidentiality class - attribute II
BusinessAttribute:
customProperties:
securityClass:
label:
de: Sicherheitsklasse
en: Security category
literals:
SK0:
label:
de: SK 0 - frei verfügbar
en: SC 0 - unrestricted
order: 10
SK1:
label:
de: SK 1 - eingeschränkt
en: SC 1 - restricted
order: 20
SK2:
label:
de: SK 2 - vertraulich
en: SC 2 - confidential
order: 30
SK3:
label:
de: SK 3 - geheim
en: SC 3 - secret
order: 40
SK4:
label:
de: SK 4 - streng geheim
en: SC 4 - top secret
order: 50
Availability - attribute
Classifying data by availability clearly shows the availability requirement and the infrastructure needed to meet it. The template is provided in two variants.
Attribute availability I - requirements and impact
BusinessAttribute:
customProperties:
availabilityClass:
label: Verfügbarkeit (Vf)
labelEn: Availability
literals:
LOW:
label:
de: 1 = Anspruch niedrig (ein Ausfall wäre nicht kritisch)
en: 1 = low requirement (downtime not critical)
order: 10
MEDIUM:
label:
de: 2 = Anspruch mittel (ein Ausfall wäre wenig kritisch)
en: 2 = medium requirement (downtime not very critical)
order: 20
HIGH:
label:
de: 3 = Anspruch hoch (ein Ausfall wäre kritisch)
en: 3 = high requirement (downtime critical)
order: 30
VERYHIGH:
label:
de: 4 = Anspruch sehr hoch (ein Ausfall wäre sehr kritisch)
en: 4 = very high requirement (downtime highly critical)
order: 40
Attribute availability II - backup type
BusinessAttribute:
customProperties:
availablilityClass:
label:
de: Verfügbarkeit
en: Availability
literals:
UNRESTRICTED:
label:
de: uneingeschränkt
en: unrestricted
order: 10
RESTRICTED:
label:
de: eingeschränkt
en: restricted
order: 20
NOTPERMITTED:
label:
de: nicht erlaubt (nur mit Rechtsgrundlage erlaubt)
en: not permitted (only with lawful basis)
order: 30
Relationship
Relationship data protection category
To comply with the GDPR, personal data must be classified according to its type.
Relationship:
properties:
dataProtectionCategory:
label:
de: Datenschutzkategorie
en: Data procection category
literals:
DK0:
label:
de: personenbezogen
en: personal data
DK1:
label:
de: personenidentifizierend
en: identifying data
DK2:
label:
de: sensibel
en: sensitive
Relationship security class
Relationship:
customProperties:
securityClass:
label:
de: Sicherheitsklasse
en: Security class
literals:
SK0:
label:
de: SK 0 - frei verfügbar
en: SC 0 - unrestricted
order: 10
SK1:
label:
de: SK 1 - eingeschränkt
en: SC 1 - restricted
order: 20
SK2:
label:
de: SK 2 - vertraulich
en: SC 2 - confidential
order: 30
SK3:
label:
de: SK 3 - geheim
en: SC 3 - secret
order: 40
SK4:
label:
de: SK 4 - streng geheim
en: SC 4 - top secret
order: 50
Measures catalog
Measure
Calculation dates for measures
List of values available in the standard.
Measure:
properties:
calculationDate:
literals:
EOD:
label:
de: Ende des Tages
en: End of day
order: 10
EOM:
label:
de: Ende des Monats
en: End of month
order: 20
REPDATE:
label:
de: Stichtag
en: Reporting date
order: 30
Units of measure for measures
List of available units of measure, extended to include tonnes.
Measure:
properties:
unitMeasure:
literals:
PC:
label:
de: Prozent
en: Percentage
order: 10
EUR:
label:
de: Euro
en: Euro
order: 20
YEAR:
label:
de: Jahre
en: Years
order: 30
NUM:
label:
de: Anzahl
en: Count
order: 40
TON:
label:
de: Tonne
en: Ton
order: 50
Data catalog
Dataset
Identifying the target group by organizational hierarchy
This template provides guidance for identifying the target group of a data usage.
Dataset:
customProperties:
targetGroup:
label:
de: Zielgruppe
en: Target Group
cardinality: MANY
literals:
BOARD:
label:
de: Vorstand
en: Board of Directors
order: 10
AREAMGMT:
label:
de: Bereichsleitung
en: Area Management
order: 20
MANAGINGDIRECTOR:
label:
de: Geschäftsführung
en: Managing Director
order: 30
HEADOFDEPARTMENT:
label:
de: Abteilungsleitung
en: Head of Department
order: 40
TEAMLEAD:
label:
de: Teamleitung
en: Team Lead
order: 50
EXTERNAL:
label:
de: Externe Abnehmer
en: external
order: 60
Identifying the target group by function
This template identifies the target group of a data usage according to the function or position of the recipient group.
Dataset:
customProperties:
localFunctions:
label:
de: Funktionen
en: Functions
cardinality: MANY
literals:
clusterMD:
label:
de: Geschäftsführung
en: Managing Director
order: 10
BusinessController:
label:
de: Business & Controller
en: Business & Controller
order: 20
FirstLine:
label:
de: Abteilungsleitung
en: First Line Managers
order: 30
SalesDirector:
label:
de: Vertriebsdirektor
en: Sales Director
order: 40
KeyAccount:
label:
de: Kundenbetreuer
en: Account Manager
order: 50
other:
label:
de: Andere
en: other
order: 60
other:
label:
de: Andere
en: Others
baseType: STRING
Defining different report types with custom fields by stereotype
Organizations often have data usages from different sources or analytical processes. This template provides guidance for adapting metadata fields to the data usages available and used within the organization.
Dataset:
properties:
stereotype:
label:
de: Reporttyp
en: Report type
literals:
dashboard:
label:
de: Dashboard | Dashboards
en: Dashboard | Dashboards
icon: columns
properties:
description:
label:
de: Beschreibung
en: Description
customProperties:
purpose:
label:
de: Zweck
en: Purpose
baseType: TEXT
query:
label:
de: Query | Queries
en: Query | Queries
icon: share-alt-square
properties:
description:
label:
de: Beschreibung
en: General information
customProperties:
purpose:
label:
de: Zweck
en: Purpose
baseType: TEXT
techDesc:
label:
de: Technische Beschreibung
en: Technical description
baseType: TEXT
infoProvider:
label:
de: Info Provider
en: Info provider
baseType: STRING
techName:
label:
de: Technischer Name
en: Technical Name
baseType: STRING
UID:
label:
de: UID
en: UID
baseType: STRING
SID:
label:
de: SID
en: SID
baseType: STRING
lastChanged:
label:
de: Letzte Änderung
en: Last Changed
baseType: DATE
lastChangedBy:
label:
de: Letzte Änderung durch
en: Last Changed By
baseType: STRING
BIReport:
label:
de: BI-Tool Report | BI-Tool Reports
en: BI-Tool Report | BI-Tool Reports
icon: border-all
customProperties:
dataPresentation:
label:
de: Format des Berichts
en: Data Presentation
literals:
LIST:
label:
de: Liste
en: List Report
EXPLORATIVE:
label:
de: Explorative Visualisierung
en: Explorative Visualization
DASHBOARD:
label:
de: Dashboard
en: Dashboard
SAPReport:
label:
de: SAP Bericht | SAP Berichte
en: SAP Report | SAP Reports
icon: dice-four
externProv:
label:
de: Externer Anbieter
en: External Provider
icon: file-alt
Distribution
Distribution - time dimension
For distributions, time-related aspects such as the publication date are often important or the modification date are important additional information. This template serves as guidance for defining the corresponding fields.
Distribution:
customProperties:
resourceCreated:
label:
de: Veröffentlichungsdatum
en: publication date
baseType: DATE
resourceLastModified:
label:
de: Änderungsdatum
en: modification date
baseType: DATE
Distribution - language and character set
This template is used to define the language and character set of distributions.
Distribution:
customProperties:
resourceLanguage:
label:
de: Sprache
en: Language
baseType: STRING
resourceCharacterSet:
label:
de: Characterset
en: Character Set Code
baseType: STRING
Data quality model
Indicator (Data quality indicators)
Technical and business DQIs
It can be useful to distinguish between technical and business DQIs. Technical DQIs are created against technical data models based on standardized rule types. Business DQIs are created against the business data model. Using different symbols for them improves clarity. This distinction can also support the automation of checks.
Indicator:
properties:
stereotype:
label:
de: DQI-Typ
en: DQI type
literals:
TDQI:
label:
de: Technischer DQI
en: Technical DQI
icon: search-plus
customProperties:
technicalRuleType:
label:
de: Technischer Regeltyp
en: Technical rule type
literals:
NULL:
label:
de: NULL CHECK
en: NULL CHECK
order: 10
EMPTY:
label:
de: LEER CHECK
en: EMPTY CHECK
order: 20
UNIQUE:
label:
de: UNIQUE CHECK
en: UNIQUE CHECK
order: 30
RANGEBETWEEN:
label:
de: RANGE/BETWEEN CHECK
en: RANGE/BETWEEN CHECK
order: 40
RANGEVALUE:
label:
de: RANGE VALUES CHECK
en: RANGE VALUES CHECK
order: 50
FORMAT:
label:
de: FORMAT CHECK
en: FORMAT CHECK
order: 60
INTEGRITY:
label:
de: INTEGRITY CHECK
en: INTEGRITY CHECK
order: 70
CONTINUITY:
label:
de: CONTINUITY CHECK
en: CONTINUITY CHECK
order: 80
GENERAL:
label:
de: GENERAL CHECK
en: GENERAL CHECK
order: 90
technicalRuleParameter:
label:
de: Technischer Regel-Parameter
en: Technical rule parameter
baseType: STRING
FDQI:
label:
de: Fachlicher DQI | Fachliche DQIs
en: Functional DQI | FUnctional DQIs
icon: thermometer
Quality dimensions
To optimally assess and measure data quality and derive targeted improvement measures, the relevant data quality dimensions must first be defined. Experience shows that the 11 data quality dimensions listed below are commonly used. Only rarely are all of them applied at the same time. Instead, a selection is made from the 11 criteria based on relevance and purpose. When defining data quality criteria for the first time, we recommend applying the two or three most obvious ones. Experience shows that these are usually among the first six in the list. Over time, additional criteria can be added through an iterative process and an increasing learning curve.
Indicator:
properties:
qualityDimension:
label:
de: Qualitätsdimensionen
en: Quality dimension
literals:
COMPLETENESS:
label:
de: Vollständigkeit
en: Completeness
order: 10
UNIQUENESS:
label:
de: Eindeutigkeit
en: Uniqueness
order: 20
CORRECTNESS:
label:
de: Korrektheit
en: Correctness
order: 30
TIMELINESS:
label:
de: Aktualität
en: Timeliness
order: 40
ACCURACY:
label:
de: Genauigkeit
en: Accuracy
order: 50
CONSISTENCY:
label:
de: Konsistenz
en: Consistency
order: 60
NONREDUNDANT:
label:
de: Redundanzfreiheit
en: Nonredundant
order: 70
RELEVANCY:
label:
de: Relevanz
en: Relevancy
order: 80
UNIFORMITY:
label:
de: Einheitlichkeit
en: Uniformity
order: 90
RELIABILITY:
label:
de: Zuverlässigkeit
en: Reliability
order: 100
UNDERSTANDABILITY:
label:
de: Verständlichkeit
en: Understandability
order: 110
Useful additional attributes
For DQIs, it is useful to record the potential impact or criticality of errors. It can also be helpful to specify directly on the DQI which information should be included for erroneous records so that analysis and corrective actions can be performed efficiently. As with measures, it is beneficial to store the measurement frequency directly on the DQI.
Indicator:
customProperties:
impact:
label:
de: Auswirkung
en: Impact
literals:
LOW:
label:
de: gering
en: low
order: 10
MEDIUM:
label:
de: mittel
en: medium
order: 20
HIGH:
label:
de: hoch
en: high
order: 30
VERYHIGH:
label:
de: sehr hoch
en: very high
order: 40
impactDescription:
label:
de: Auswirkungsbeschreibung
en: Impact description
baseType: TEXT
errorDefinition:
label:
de: Fehlerfall
en: Error definition
baseType: TEXT
errorListFields:
label:
de: Felder für DQ-Fehler-Reports
en: Error list fields
baseType: STRING
cardinality: MANY
frequency:
label:
de: Messfrequenz
en: Measure frequency
literals:
DAILY:
label:
de: täglich
en: daily
order: 10
WEEKLY:
label:
de: wöchentlich
en: weekly
order: 20
MONTHLY:
label:
de: monatlich
en: monthly
order: 30
QUARTERLY:
label:
de: quartalsweise
en: quarterly
order: 40
YEARLY:
label:
de: jährlich
en: yearly
order: 50
Project directory
Project
Requirement categories
It is useful to distinguish between different requirement categories because they can be handled differently in the process. Dedicated symbols for each requirement category improve clarity in the project list.
Project:
properties:
stereotype:
label:
de: Bedarfskategorie
en: Requirement category
literals:
#Case 1: Data requirements for the DWH (master data, reference data, and measures)
DATAREQU:
label:
de: Datenbedarf | Datenbedarfe
en: Data requirement | Data Requirements
icon: shopping-cart
customProperties:
#Select data category
dataCategory:
label:
de: Datenkategorie
en: Data category
literals:
MASTER:
label:
de: Grunddaten
en: Basic data
order: 10
REFERENCE:
label:
de: Referenzdaten
en: Reference data
order: 20
MEASURE:
label:
de: Kennzahl
en: Measure
order: 30
#Case 2: DQ requirements (DQIs, DQ checks, DQ reports)
DQREQU:
label:
de: DQ-Anforderung | DQ-Anforderungen
en: DQ requirement | DQ Requirements
icon: trophy
customProperties:
#Select the DQ requirement type
dataQualityRequirementType:
label:
de: DQ-Anforderungs-Typ
en: DQ requirement type
literals:
DQIND:
label:
de: Datenqualitätsindikator
en: Data quality indicator
order: 10
DQCHECK:
label:
de: DQ-Prüfung
en: Data quality check
order: 20
DQREPORT:
label:
de: DQ-Report
en: Data quality report
order: 30
#Case 3: Data usages from the DWH (reports, datasets, interfaces, queries/files)
DATAUSAGE:
label:
de: Datennutzung | Datennutzungen
en: Data Usage | Data Usages
icon: gem
customProperties:
#Auswahl der Datennutzungsart
datasetType:
label:
de: Datennutzungsart
en: Data usage type
literals:
REPORT:
label:
de: Bericht / Report
en: Report
order: 10
DATASET:
label:
de: Datenset
en: Data set
order: 20
INTERFACE:
label:
de: Schnittstelle
en: Interface
order: 30
QUERY:
label:
de: Abfrage
en: Query
order: 40
FILE:
label:
de: Datei
en: File
order: 50
Useful additional attributes
Information about the project start, project end, initial and target situations, target groups, and project costs can be useful additions to projects.
Project:
customProperties:
projectStart:
label:
de: Projektstart
en: Project start
baseType: DATE
projectEnd:
label:
de: Projektende
en: Project end
baseType: DATE
projectActSituation:
label:
de: Ist-Situation
en: Project starting point
baseType: TEXT
projectTargetSituation:
label:
de: Soll-Situation
en: Project target situation
baseType: TEXT
projectTargetGroup:
label:
de: Zielgruppe
en: Target group
baseType: STRING
projectCost:
label:
de: Projektkosten
en: Project cost
baseType: STRING
Processing
Customization of a short recipient list
A standard for using recipients of processing results.
Processing:
properties:
recipients:
literals:
Aufsicht:
label:
de: Aufsichtsbehörden
en: Supervisory authorities
Wirtschaftspruefer:
label:
de: Wirtschaftsprüfer
en: Auditors
Sonstige:
label:
de: Sonstige
en: Others
Long list of potential recipients
In other cases, it is necessary to define many different recipients.
Processing:
properties:
recipients:
literals:
LAWYERS:
label:
de: Anwälte, Notare
en: lawyers, notaries
SUPERVISORY:
label:
de: Aufsichtsbehörden
en: Supervisory authorities
CREDITWORTHINESS:
label:
de: Bonitätsdatenbanken
en: databases for creditworthiness
COURT:
label:
de: Gerichte und Staatsanwaltschaften
en: court and public prosecutors
BUSINESSPARTNERS:
label:
de: Geschäftspartner vermittelter Produkte
en: Business Partners of conveyed products
SERVICEPROVIDER:
label:
de: IT-Dienstleister
en: IT-Service Provider
CREDITINSTITUTIONS:
label:
de: Kredit- und Finanzinstitute
en: Credit and Financial institutions
SUPPLIER:
label:
de: Lieferanten
en: Supplier
BROKER:
label:
de: Makler, Vermittler, Finanzdienstleister
en: Broker, Intermediary, Financial service providers
OTHER:
label:
de: Sonstige
en: Other
TAX:
label:
de: Steuerberater und Wirtschaftsprüfer
en: Tax Consultants and Auditors
INSURANCE:
label:
de: Versicherungen
en: Insurances
ADMINISTRATIVE:
label:
de: Verwaltungsbehörden
en: Administrative Authorities
EXTERNALAUDIT:
label:
de: externe Revision
en: external Audit
LEGALREPRESENTATIVE:
label:
de: gesetzlicher Vertreter oder Bevollmächtigter
en: legal or authorative representative
OTHERPROCESSOREU:
label:
de: sonstige Auftragsverarbeiter EU
en: other Processor in EU
OTHERPROCESSOROUTSIDEEU:
label:
de: sonstige Auftragsverarbeiter außerhalb EU
en: other processor outside EU
SUPERVISORYBOARD:
label:
de: Aufsichtsrat
en: Supervisory Board
INTERNALAUDIT:
label:
de: Innenrevision
en: Internal Audit
MARKETING:
label:
de: Marketing
en: Marketing
HR:
label:
de: Personalmanagement
en: Human Resource Management
ACCOUNTING:
label:
de: Rechnungswesen & Controlling
en: Accounting and Controlling
LEGAL:
label:
de: Recht-/Geldwäsche- und Compliance
en: Legal, Money Laundering anc Compliance
RISKMANAGEMENT:
label:
de: Risikomanagement
en: Riskmanagement
TREASURY:
label:
de: Treasury
en: Treasury
MANAGINGDIRECTOR:
label:
de: Vorstand/Geschäftsführung
en: Board of Directors/ Managing Directors
List of data subjects
Data subjects can be defined at different levels of detail. The people affected by the data processing are listed.
Processing:
properties:
dataSubjects:
literals:
CUSTOMER:
label:
de: Kunden
en: Customers
RELATIVES:
label:
de: Angehörige von Mitarbeitern
en: Relatives of Employees
VISITORS:
label:
de: Besucher und sonstige Zutrittsberechtigte
en: Visitors and other authorized access
APPLICANT:
label:
de: Bewerber
en: Applicant
PROPRIETOR:
label:
de: Eigentümer des Verantwortlichen
en: Proprietor
EMPLOYEES:
label:
de: Mitarbeiter
en: Employee
COMMITTEES:
label:
de: Organe und Funktionäre des Verantwortlichen
en: Committees and officials
POTENTIAL:
label:
de: Potenzielle Kunden und Interessenten
en: Potential Customer and Prospect
COLLATERALPROVIDER:
label:
de: Sicherheitengeber
en: Collateral Provider
OTHER:
label:
de: Sonstige
en: Other
CONTRACTORS:
label:
de: Vertragspartner
en: Contractors
AFFECTEDBYIMAGEPROCESSING:
label:
de: Von Bildverarbeitung betroffene Personen
en: Person affected by Image Processing
Technical data model
UmlClass (Data object)
Stereotyping data objects, e.g. in SAP BW
Categorizing data objects by type enables analysis and classification. Fields for specific object types can also be added as needed.
UmlClass:
properties:
stereotype:
label:
de: Datenobjekttyp
en: Data object type
literals:
DIM:
label:
de: Dimension
en: Dimension
icon: cubes
NAV:
label:
de: Navigation
en: Navigation
icon: directions
MSR:
label:
de: Kennzahl
en: KPI
icon: weight
TAB:
label:
de: Tabelle
en: Table
icon: table
FCT:
label:
de: Tabellen Funktion
en: Table Function
icon: function
VIEW:
label:
de: View
en: View
icon: window
STORPROC:
label:
de: gespeicherte Prozedur
en: Stored Procedure
icon: procedures
PAR:
label:
de: Parameter
en: Parameter
icon: file-import
Categorizing data in data objects
Classifying data by data category facilitates analysis and categorization.
UmlClass:
customProperties:
UmlDataCategory:
label:
de: Datenkategorie
en: Data category
literals:
MASTER:
label:
de: Stammdaten
en: Master data
TRANSACTIONAL:
label:
de: Bewegungsdaten
en: Transaction data
GEODATA:
label:
de: Geodaten
en: Spatial data
UmlAttribute (Technical attribute)
Stereotyping attributes for data objects
UmlAttribute:
properties:
stereotype:
label:
de: Attributstyp
en: Attribute type
literals:
COL:
label:
de: Zeile
en: Column
icon: tag
PAR:
label:
de: Parameter
en: Parameter
icon: file-import
System catalog
System (Systems)
A system describes software or an environment in which data is stored, processed, or analyzed. A system can contain subsystems to structure the system landscape.
Criticality / maximum system downtime
This field provides an assessment of systems and their maximum permitted downtime.
System:
customProperties:
criticality:
label:
de: max. Ausfallszeit
en: maximum downtime
literals:
UPTOHALF:
label:
de: bis zu 1/2 Werktag
en: up to 1/2 workday
order: 1
UPTOONE:
label:
de: bis zu 1 Werktag
en: up to 1 workday
order: 2
UPTOTWO:
label:
de: bis zu 2 Werktage
en: up to 2 workdays
order: 3
UPTOTHREE:
label:
de: bis zu 3 Werktage
en: up to 3 workdays
order: 4
DX Organisation
Person
Direct link to a Teams chat option in the person menu
To enable direct communication through dataspot. when questions or discussion points arise, a direct link to the Microsoft Teams profile or other communication services can be integrated into dataspot. The direct link to a person in Teams always consists of "https://teams.microsoft.com/l/chat/0/0?users=" followed by the person’s email address.
# 1130 - Person
Person:
customProperties:
teamsChat:
label:
de: Kontakt in Teams
en: Contact in Teams
baseType: TEXT
Role
Additional required skills
The skills required for a role are often defined as part of the organizational definition. To make them transparent to everyone involved, they can be recorded for the respective role in dataspot.
# 1140 - Role
Role:
customProperties:
roleSkills:
label:
de: Fähigkeiten für die Rolle
en: Role Skills
baseType: TEXT