Übersicht und Namenskonventionen im Demo Center

Diese Dokumentation definiert die einheitlichen Namenskonventionen für Datenobjekte innerhalb der Applikation. Sie beschreibt die verbindlichen Regeln zur Benennung von Entitäten, Perspektiven, Datenquellen und Workspaces und stellt sicher, dass alle Objekte konsistent, eindeutig und nachvollziehbar strukturiert sind. Die Standards erleichtern die Orientierung, Zusammenarbeit und langfristige Wartbarkeit über verschiedene Unternehmen, Umgebungen und Anwendungsfälle hinweg.

Namenskonventionen für Datenobjekte

1. Allgemeine Richtlinien

Um eine einheitliche, nachvollziehbare und übersichtliche Struktur innerhalb der Applikation sicherzustellen, gelten verbindliche Namenskonventionen für die verschiedenen Datenobjekte.

Diese Konventionen sind bei der Erstellung neuer Objekte konsequent einzuhalten. Sie ermöglichen eine eindeutige Zuordnung zu Unternehmen, Anwendungszweck, Sprache, fachlichem Bereich und Version.

Die Namenskonventionen gelten für folgende Objekttypen:

Entitäten (Entities)

Perspektiven (Perspectives)

Datenquellen (Sources)

Workspaces

2. Grundstruktur der Namenskonvention

Für Entitäten und Perspektiven gilt grundsätzlich die folgende Struktur:

unternehmen_umgebung_sprache_bezeichnung_spezifizierung_version

BestandteilBeschreibung
UnternehmenName des Unternehmens, dem das Objekt zugeordnet ist. Standardmäßig noreja. Bei Partnerumgebungen wird stattdessen der jeweilige Partnername verwendet.
UmgebungKennzeichnet den Anwendungszweck: demo, training, pov oder production.
SpracheSprachkennzeichnung des Objekts: de für Deutsch oder en für Englisch.
BezeichnungFachlicher Bereich bzw. konkreter End-to-End-Prozess, abhängig vom Objekttyp.
SpezifizierungIndividuelle Ergänzung zur genaueren Unterscheidung des Objekts. In den Beispielen durch xy dargestellt.
VersionFortlaufende Versionsnummer, beispielsweise v1, v2 oder v3.

2.1 Umgebungsarten

Die folgenden Umgebungskennzeichnungen werden verwendet:

KennzeichnungBedeutung
demoDemonstrationsumgebung zur Vorstellung von Funktionen oder Anwendungsfällen
trainingTrainingsumgebung für Schulungen und Übungen
povProof of Value – Umgebung zur Validierung des fachlichen und geschäftlichen Nutzens
productionProduktivumgebung für den tatsächlichen operativen Einsatz

2.2 Allgemeine Formatierungsregeln

Für die technische Benennung gelten folgende Grundsätze:

Alle Bestandteile werden in Kleinbuchstaben geschrieben.

Die einzelnen Namensbestandteile werden durch Unterstriche (_) getrennt.

Die definierte Reihenfolge der Bestandteile ist verbindlich.

Die Sprachkennzeichnung erfolgt einheitlich mit de oder en.

Die Spezifizierung kann individuell gewählt werden, sollte jedoch kurz, eindeutig und nachvollziehbar sein.

Die Versionsnummer steht immer am Ende und wird durch einen Unterstrich abgetrennt.

Für Sources und Workspaces gelten abweichende Regeln, die in den folgenden Abschnitten beschrieben werden.

3. Namenskonvention für Entitäten (Entities)

Entitäten werden anhand ihrer fachlichen Zugehörigkeit benannt. Hierfür werden fest definierte fachliche Units verwendet.

Namensschema:

unternehmen_umgebung_sprache_unit_spezifizierung_version

Als fachliche Units werden beispielsweise folgende Bezeichnungen verwendet:

sales

purchasing

patientcare

Wenn eine Entität mehrere fachliche Bereiche kombiniert, werden diese durch einen Schrägstrich (/) voneinander getrennt.

Beispiel: sales/purchasing

Die nachfolgende Spezifizierung (xy) bietet die Möglichkeit, unterschiedliche Anwendungsfälle, fachliche Besonderheiten oder Varianten innerhalb einer Unit zu unterscheiden.

Beispiele

BeispielnameBeschreibung
noreja_demo_de_sales/purchasing_xy_v1Deutsche Demo-Entität für Sales und Purchasing
noreja_training_de_sales_xy_v1Deutsche Trainingsentität für Sales
noreja_pov_de_purchasing_xy_v1Deutsche PoV-Entität für Purchasing
noreja_demo_de_patientcare_xy_v1Deutsche Demo-Entität für Patient Care
noreja_demo_en_patientcare_xy_v1Englische Demo-Entität für Patient Care
noreja_production_de_sales_xy_v1Deutsche Produktiventität für Sales

Wichtig: Die fachliche Unit muss konsistent benannt werden. Bei Kombinationen mehrerer Units ist immer die Trennung mit / zu verwenden.

4. Namenskonvention für Perspektiven (Perspectives)

Perspektiven folgen grundsätzlich derselben Namensstruktur wie Entitäten. Der entscheidende Unterschied liegt in der fachlichen Bezeichnung.

Während Entitäten anhand fest definierter Units benannt werden, orientieren sich Perspektiven an konkreten End-to-End-Prozessen.

Namensschema:

unternehmen_umgebung_sprache_end_to_end_prozess_spezifizierung_version

Die Prozessbezeichnung soll den vollständigen fachlichen Ablauf beschreiben und nicht nur einen einzelnen Funktionsbereich.

Typische End-to-End-Prozesse sind beispielsweise:

order_to_cash

purchase_to_pay

admission_to_discharge

Die einzelnen Wörter einer Prozessbezeichnung werden ebenfalls durch Unterstriche getrennt.

Beispiele

BeispielnameBeschreibung
noreja_demo_de_order_to_cash_xy_v1Deutsche Demo-Perspektive für den Order-to-Cash-Prozess
noreja_training_de_order_to_cash_xy_v1Deutsche Trainingsperspektive für Order-to-Cash
noreja_pov_de_order_to_cash_xy_v1Deutsche PoV-Perspektive für Order-to-Cash
noreja_demo_de_admission_to_discharge
_xy_v1
Deutsche Demo-Perspektive für Admission-to-Discharge
noreja_demo_en_purchase_to_pay
_xy_v1
Englische Demo-Perspektive für Purchase-to-Pay

Wichtig: Bei Perspektiven ist immer die konkrete End-to-End-Prozessbezeichnung zu verwenden. Allgemeine Unit-Bezeichnungen wie sales oder purchasing sind hierfür nicht vorgesehen.

5. Namenskonvention für Datenquellen (Sources)

Für Datenquellen gilt eine vereinfachte Namenskonvention.

Der Name einer Source wird immer 1:1 aus dem Namen der zugrunde liegenden Datenbank übernommen.

Es werden keine zusätzlichen Präfixe, Suffixe oder Versionskennzeichnungen ergänzt, sofern diese nicht bereits Bestandteil des Datenbanknamens sind.

Dadurch bleibt die Zuordnung zwischen der Source innerhalb der Applikation und der tatsächlichen Datenbank eindeutig nachvollziehbar.

6. Namenskonvention für Workspaces

Für Workspaces wird eine lesbare Bezeichnung verwendet. Im Unterschied zu Entitäten und Perspektiven erfolgt die Benennung nicht in Unterstrich-Notation.

Der Workspace-Name besteht in der Regel aus dem Anwendungszweck und der zugehörigen End-to-End-Prozessbezeichnung.

Namensschema:

Umgebung Prozessbezeichnung

Typische Umgebungskennzeichnungen sind Demo und PoV.

Die Prozessbezeichnung wird ausgeschrieben und die einzelnen Wörter werden durch Bindestriche verbunden.

Beispiele

Workspace-NameBeschreibung
Demo Order-To-CashDemo-Workspace für den Order-to-Cash-Prozess
PoV Purchase-To-PayPoV-Workspace für den Purchase-to-Pay-Prozess
Demo Admission-To-DischargeDemo-Workspace für den Admission-to-Discharge-Prozess

Wichtig: Workspace-Namen sollen für Anwender unmittelbar verständlich sein. Daher werden hier keine technischen Unterstrich-Bezeichnungen verwendet.

7. Zusammenfassung der Namenskonventionen

ObjekttypNamenskonventionBeispiel
EntityUnternehmen + Umgebung + Sprache + Unit + Spezifizierung + Versionnoreja_demo_de_sales_xy_v1
PerspectiveUnternehmen + Umgebung + Sprache + End-to-End-Prozess + Spezifizierung + Versionnoreja_demo_de_order_to_cash
_xy_v1
SourceExakter Name der zugrunde liegenden DatenbankIdentisch mit Datenbankname
WorkspaceUmgebung + lesbare ProzessbezeichnungDemo Order-To-Cash

Die konsequente Einhaltung dieser Namenskonventionen ist bei der Erstellung aller neuen Datenobjekte erforderlich. Bestehende Bezeichnungen sollten bei Anpassungen und Versionierungen ebenfalls an diesen Standards ausgerichtet werden, um eine konsistente und langfristig wartbare Struktur innerhalb der Applikation sicherzustellen.