Übersicht und Namenskonventionen im Demo Center
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
| Bestandteil | Beschreibung |
|---|---|
| Unternehmen | Name des Unternehmens, dem das Objekt zugeordnet ist. Standardmäßig noreja. Bei Partnerumgebungen wird stattdessen der jeweilige Partnername verwendet. |
| Umgebung | Kennzeichnet den Anwendungszweck: demo, training, pov oder production. |
| Sprache | Sprachkennzeichnung des Objekts: de für Deutsch oder en für Englisch. |
| Bezeichnung | Fachlicher Bereich bzw. konkreter End-to-End-Prozess, abhängig vom Objekttyp. |
| Spezifizierung | Individuelle Ergänzung zur genaueren Unterscheidung des Objekts. In den Beispielen durch xy dargestellt. |
| Version | Fortlaufende Versionsnummer, beispielsweise v1, v2 oder v3. |
2.1 Umgebungsarten
Die folgenden Umgebungskennzeichnungen werden verwendet:
| Kennzeichnung | Bedeutung |
|---|---|
demo | Demonstrationsumgebung zur Vorstellung von Funktionen oder Anwendungsfällen |
training | Trainingsumgebung für Schulungen und Übungen |
pov | Proof of Value – Umgebung zur Validierung des fachlichen und geschäftlichen Nutzens |
production | Produktivumgebung 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
| Beispielname | Beschreibung |
|---|---|
| noreja_demo_de_sales/purchasing_xy_v1 | Deutsche Demo-Entität für Sales und Purchasing |
| noreja_training_de_sales_xy_v1 | Deutsche Trainingsentität für Sales |
| noreja_pov_de_purchasing_xy_v1 | Deutsche PoV-Entität für Purchasing |
| noreja_demo_de_patientcare_xy_v1 | Deutsche Demo-Entität für Patient Care |
| noreja_demo_en_patientcare_xy_v1 | Englische Demo-Entität für Patient Care |
| noreja_production_de_sales_xy_v1 | Deutsche 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
| Beispielname | Beschreibung |
|---|---|
| noreja_demo_de_order_to_cash_xy_v1 | Deutsche Demo-Perspektive für den Order-to-Cash-Prozess |
| noreja_training_de_order_to_cash_xy_v1 | Deutsche Trainingsperspektive für Order-to-Cash |
| noreja_pov_de_order_to_cash_xy_v1 | Deutsche 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-Name | Beschreibung |
|---|---|
Demo Order-To-Cash | Demo-Workspace für den Order-to-Cash-Prozess |
PoV Purchase-To-Pay | PoV-Workspace für den Purchase-to-Pay-Prozess |
Demo Admission-To-Discharge | Demo-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
| Objekttyp | Namenskonvention | Beispiel |
|---|---|---|
| Entity | Unternehmen + Umgebung + Sprache + Unit + Spezifizierung + Version | noreja_demo_de_sales_xy_v1 |
| Perspective | Unternehmen + Umgebung + Sprache + End-to-End-Prozess + Spezifizierung + Version | noreja_demo_de_order_to_cash _xy_v1 |
| Source | Exakter Name der zugrunde liegenden Datenbank | Identisch mit Datenbankname |
| Workspace | Umgebung + lesbare Prozessbezeichnung | Demo 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.