Konfiguration erstellen
Eine XML-Konfigurationsdatei enthält die Zuordnung von Objekten aus der Excel-Datei zum ADOIT Metamodell.
<config>
Die XML-Datei startet und endet mit einem <config>-Tag:
XML-Beispiel
<config>
...
</config>
<sheet>
In der XML-Datei wird jedes aus der Excel-Datei zu importierende Tabellenblatt in einem
eigenständigen Tag <sheet> beschrieben. Folgende Attribute müssen je <sheet> definiert werden:
| Attributname | Beschreibung | Beispielwerte |
|---|---|---|
name | Name des Tabellenblatts in Excel | Anwendungen |
class_name | Sprachunabhängiger Name des Objekttyps | [C_APPLICATION] |
id | Legt die Nummer der Spalte fest, die das Objekt eindeutig identifiziert. [Optional] Kommaseparierte Liste von Spaltennummern zur eindeutigen Identifizierung des Objekts. | 1 |
data_row | Gibt die erste Zeile an, die ein Objekt enthält | 1 |
unique_name [Optional] | Auf true setzen, damit es nicht möglich ist, zwei Objekte desselben Typs mit demselben Namen im gleichen Sprachkontext zu erstellen | `[true |
Eindeutige Objektidentifizierung mittels ID
Das Feld id definiert, welches Objektattribut in der Excel-Datei ein Objekt eindeutig
identifiziert.
Typische Attribute für die eindeutige Objektidentifikation sind das Attribut „Name“ oder dedizierte „ID“-Attribute. Die Verwendung eines dedizierten „ID“-Attributs bietet den Vorteil, dass Objekte im Lauf der Zeit in Drittsystemen umbenannt werden können, beim Import jedoch weiter als identische Objekte identifiziert werden.
Beispiel
Sie wollen drei Tabellenblätter importieren, die Objekte vom Typ Anwendung, Schnittstelle und Dokument enthalten:
Hier ist ein Auszug aus der XML-Datei mit den Abschnitten zum Import der Tabellenblätter:
XML- Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
</sheet>
<sheet name="Schnittstellen" class_name="C_INTERFACE" id="1" data_row="1">
...
</sheet>
<sheet name="Dokumente" class_name="C_DOCUMENT" id="1" data_row="1">
...
</sheet>
</config>
<attribute>
In der XML-Konfigurationsdatei wird jedes aus der Excel-Datei zu importierende Objektattribut in
einem eigenständigen Tag <attribute> beschrieben.
Folgende Attributtypen können importiert werden:
| Attributtyp | Beschreibung |
|---|---|
simple | Erhebung von Text- und Zahlenwerten |
date | Erhebung von Datumsangaben |
enum | Übertragung eines Wertes auf ein Element einer Liste |
enum_list | Übertragung von Werten auf die Elemente einer Liste |
treeenumlist | Übertragung von Werten auf die Knoten eines Baums |
bool | Erhebung von booleschen Werten |
relation | Erhebung von Beziehungen zu anderen Objekten |
file_pointer | Erhebung zu Links auf externe Dateien |
<attribute type="simple">
Über den Attributtyp simple können Text- und Zahlenwerte importiert werden. Die importierten Werte
können im ADOIT Metamodell folgenden Attributtypen zugeordnet werden:
ADONIS Text (ADOSTRING)
Ganzzahl (INTEGER)
Gleitkommazahl (DOUBLE)
Kurztext (SHORTSTRING)
Langtext (LONGSTRING)
Positive Ganzzahl (UNSIGNED INTEGER)
Text (STRING)
Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier simple |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
Beispiel
Sie wollen das Objektattribut Name von Objekten des Typs Anwendung importieren:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML- Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
<attribute name="NAME" type="simple" context="de" column="1"/>
...
</sheet>
...
</config>
<attribute type="date">
Über den Attributtyp date können Datumswerte importiert werden. Die importierten Werte können im
ADOIT Metamodell folgenden Attributtypen zugeordnet werden:
Date (DATE)
Coordinated Universal Time (UTC)
Datumswerte werden alle als 00:00 UTC importiert. Um sicherzustellen, dass alle kundenspezifischen geplanten Jobs auf Basis der Ortszeit ausgeführt werden, können Sie eine Differenz zur UTC konfigurieren.
Folgende Attribute müssen für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier date |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei. Diese Spalte sollte in der Excel-Datei als Datum formatiert sein. |
utc_offset_hours [Optional] | Angabe der Differenz in Stunden der Ortszeit zur koordinierten Weltzeit (UTC), z.B. "1" für die mitteleuropäische Zeit (MEZ) oder "-5" für die Eastern Standard Time (EST). |
utc_offset_minutes [Optional] | Angabe der Differenz in Minuten der Ortszeit zur koordinierten Weltzeit (UTC), z.B. "30" für die Indian Standard Time (IST) für eine Gesamtdifferenz von +05:30 (wenn utc_offset_hours auf "5" eingestellt ist). |
Beispiel
Sie wollen das Objektattribut Datum Produktivsetzung von Objekten des Typs Anwendung importieren:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML-Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="A_VALID_FROM" type="date" context="de" column="2"/>
...
</sheet>
...
</config>
<attribute type="enum">
Über den Attributtyp enum können Attributwerte importiert und den Elementen einer Liste zugewiesen
werden. Die importierten Werte können im ADOIT Metamodell folgendem Attributtyp zugeordnet werden:
- Enumeration (ENUM)
Ein ENUM-Attribut ist eine Liste mit vordefinierten Werten (z.B. "Niedrig", "Mittel" und "Hoch"). Nur ein Wert kann aus der Liste ausgewählt werden.
Sie können frei definieren, welcher Wert aus der Excel-Datei auf welchen Wert in der Liste
übertragen wird. Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier enum |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
domain_mapping | Definition des Mappings zwischen den Werten in der Excel-Datei und den Elementen der Liste (genauere Informationen finden Sie unterhalb dieser Tabelle). |
separator_domain_mapping [Optional] | Definiert das Trennzeichen zwischen mehreren Werten im Attribut domain_mapping. Wenn die Werte in der Excel-Datei z.B. als "Kein Eintrag\@v0,..." erfasst sind, ist der Wert des Trennzeichens "@". |
domain_mapping
Jedes Element einer Liste in ADOIT hat einen sprachunabhängigen Namen – z.B. v0, v1, v2 etc. Die
Werte in der Excel-Datei müssen den sprachunabhängigen Namen der Elemente der Liste zugeordnet
werden. Dies erfolgt über das Attribut domain_mapping. Hierbei wird kommasepariert jedem Wert aus
der Excel-Datei ein zugehöriger Wert der Liste zugeordnet:
Domain_mapping="<Excel-Wert 0>,v0,<Excel-Wert 1>,v1,<Excel-Wert 2>,v2,…"
Die Werte aus der Excel-Datei und die sprachabhängigen Werte des ENUM-Attributs müssen nicht gleich sein. Sie können z.B. den Excel-Wert "Rosarot" in der Liste dem vordefinierten Wert "Rot" zuordnen.
Beispiel
Sie wollen das Objektattribut Lebenszyklusstatus von Objekten des Typs Anwendung importieren:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML-Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="A_LIFECYCLE_STATE" type="enum" context="de" column="3" domain_mapping="Kein Eintrag,v0,Entwurf,v1,In Entwicklung,v2,In Produktion,v3,Stillgelegt,v4"/>
...
</sheet>
...
</config>
<attribute type="enum_list">
Über den Attributtyp enum_list können Attributwerte importiert und den Elementen einer Liste
zugewiesen werden. Die importierten Werte können im ADOIT Metamodell folgendem Attributtyp
zugeordnet werden:
- Aufzählungsliste (ENUMLIST)
Ein ENUMLIST ist eine Liste mit vordefinierten Werten (z.B. "Niedrig", "Mittel" und "Hoch"). Im Gegensatz zu Attributen vom Typ ENUM können gleichzeitig mehrere Werte aus der Liste ausgewählt werden.
Sie können frei definieren, welcher Wert aus der Excel-Datei auf welchen Wert in der Liste
übertragen wird. Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier enum_list |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
separator | Definiert das Trennzeichen zwischen mehreren Werten in der Excel-Datei, die der Liste zugeordnet werden sollen. So können Sie dem ENUMLIST-Attribut gleichzeitig mehrere Werte zuordnen. Wenn die Werte in der Excel-Datei z.B. als "Variante 1;Variante 2" erfasst sind, ist der Wert des Trennzeichens ";". |
domain_mapping | Definition des Mappings zwischen den Werten in der Excel-Datei und den Elementen der Liste (siehe <attribute type='enum'> für genauere Informationen). |
separator_domain_mapping [Optional] | Definiert das Trennzeichen zwischen mehreren Werten im Attribut domain_mapping. Wenn die Werte in der Excel-Datei z.B. als "Kein Eintrag\@v0,..." erfasst sind, ist der Wert des Trennzeichens "@". |
<attribute type="treeenumlist">
Über den Attributtyp treeenumlist können Attributwerte importiert und den Knoten eines Baumes
zugewiesen werden. Die importierten Werte können im ADOIT Metamodell folgendem Attributtyp
zugeordnet werden:
- ENUMLIST_TREE
Attribute vom Typ ENUMLIST_TREE sind Bäume mit vordefinierten Werten (z.B. "Variante 1", "Variante 2" und "Variante 3"). Es können gleichzeitig mehrere Werte aus dem Baum ausgewählt werden. Der Kategorienfilter in ADOIT ermöglicht das Filtern von Objekten nach diesen Werten (= Kategorien).
Sie können frei definieren, welcher Wert aus der Excel-Datei auf welchen Knoten übertragen wird.
Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier treeenumlist |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
separator | Definiert das Trennzeichen zwischen mehreren sprachunabhängigen Namen der Baumknoten in einer Zelle der Excel-Datei. So können Sie dem „ENUMLIST_TREE"-Attribut gleichzeitig mehrere Werte zuordnen. Wenn die Werte in der Excel-Datei z.B. als "PLAN;TO-BE" erfasst sind, ist der Wert des Trennzeichens ";". |
Beispiel
Sie wollen das Objektattribut Varianten von Objekten des Typs Anwendung importieren:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML-Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="A_ARCHITECTURE_TREE" type="treeenumlist" context="de" column="4" separator=";"/>
...
</sheet>
...
</config>
<attribute type="bool">
Über den Attributtyp bool können boolesche Werte importiert werden ("TRUE" (wahr) und "FALSE"
(falsch). Die importierten Werte können im ADOIT Metamodell folgendem Attributtyp zugeordnet werden:
- Bool (BOOL)
Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier bool |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
bool_mapping | Definition des Mappings zwischen den Werten der Excel-Datei und den Werten des Objektattributs "TRUE" und "FALSE". Das Attribut enthält zwei Werte, die durch ein Komma getrennt sind. Der erste Wert wird auf den booleschen Wert "TRUE", der zweite auf "FALSE" gemappt. |
Beispiel
Sie wollen das Objektattribut Handlungsbedarf von Objekten des Typs Anwendung importieren:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML-Beispiel
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="A_NEED_FOR_ACTION" type="bool" context="de" column="5" bool_mapping="ja,nein"/>
...
</sheet>
...
</config>
<attribute type="relation">
Über den Attributtyp relation können Beziehungen zwischen Objekten hergestellt werden. Im ADOIT
Metamodell werden diese Beziehungen durch Relationsklassen repräsentiert.
Folgende Attribute müssen für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name der Relationsklasse, denen die referenzierten Objekte zugeordnet werden sollen. |
type | Angabe des Attributtyps – hier relation |
context | Angabe der Sprache des Attributs, das dass referenzierte Objekt eindeutig identifiziert. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer der Relation in der Excel-Datei |
separator | Definieren Sie das Trennzeichen zwischen mehreren referenzierten Objekten in der Excel-Datei. Wenn die referenzierten Objekte z.B. als "interface1;interface2;interface3" erfasst sind, ist der Wert des Attributs ";". |
attr_separator [Optional] | Definieren Sie das Trennzeichen zwischen mehreren Attributwerten, die zur Identifizierung der referenzierten Objekte verwendet werden. Wenn die referenzierten Objekte z.B. als "interface1\@description1;interface2\@description2" erfasst sind, ist der Wert des Attributs "@". |
lookup_attr_name | Sprachunabhängiger Name des Attributs, das dass referenzierte Objekt eindeutig identifiziert. Dies muss nicht zwingend das Attribut „Name“ sein. [Optional] Kommaseparierte Liste von sprachunabhängigen Attributnamen zur eindeutigen Identifizierung des referenzierten Objekts. |
direction | Festlegung ob die Beziehung als eingehende oder ausgehende Beziehung interpretiert werden soll. Mögliche Werte sind „from“ (eingehende Beziehung) und „to“ (ausgehende Beziehung). |
target_class | Sprachunabhängiger Name des referenzierten Objekttyps |
strategy | Der Attributwert legt fest, wie die Konflikte bezüglich der Beziehungen während des Excelimports behandelt werden. Siehe Abschnitt Konfliktmanagement beim Import für mehr Informationen. Die Voreinstellung ist overwrite. |
Eingehende Beziehungen vs. ausgehende Beziehungen
Für jede Beziehung muss festgelegt werden, welches das Quellobjekt und welches das Zielobjekt ist.
Aus der Perspektive des Quellobjekts handelt es sich dann um eine ausgehende Beziehung (Symbol
), während es sich aus der
Perspektive des Zielobjekts um eine eingehende Beziehung (Symbol
) handelt.
Beispiel 1
Sie wollen Beziehungen anlegen im Attribut Bereitgestellte Schnittstellen von Objekten des Typs Anwendung:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML Example
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="RC_PROVIDED_INTERFACES" type="relation" context="de" column="6" separator=";" lookup_attr_name="NAME" direction="TO" target_class="C_INTERFACE"/>
...
</sheet>
...
</config>
Beispiel 2
Wie Beispiel 1 oben, allerdings sieht der Inhalt der Zelle in der Excel-Datei in der Spalte F folgendermaßen aus:
D.h. die referenzierten Objekte werden anhand von zwei Attributen eindeutig identifiziert.
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML Example
<config>
<sheet name="Anwendungen" class_name="C_APPLICATION" id="1" data_row="1">
...
<attribute name="RC_PROVIDED_INTERFACES" type="relation" context="de" column="6" separator=";" attr_separator="@"; lookup_attr_name="NAME,DESCRIPTION" direction="TO" target_class="C_INTERFACE"/>
...
</sheet>
...
</config>
<attribute type="file_pointer">
Über den Attributtyp file_pointer können Beziehungen zu externen Dokumenten oder Programmen
hergestellt werden. Die importierten Werte können im ADOIT Metamodell folgendem Attributtyp
zugeordnet werden:
- Dateiverweis (FILE_POINTER)
Dazu müssen folgende Attribute für das Tag <attribute> definiert werden:
| Attributtyp | Beschreibung |
|---|---|
name | Sprachunabhängiger Name des Objektattributs, in das der importierte Wert geschrieben werden soll. |
type | Angabe des Attributtyps – hier file_pointer |
context | Angabe der Sprache des Attributwerts. Mögliche Werte sind z.B. „de“ für Deutsch und „en“ für Englisch. Die verfügbaren Sprachen hängen von der Anwendungsbibliothek und der Lizenz ab. |
column | Angabe der Spaltennummer des Objektattributs in der Excel-Datei |
separator | Definiert das Trennzeichen zwischen Programmname und Dateireferenz in der Excel-Datei. Wenn das Trennzeichen leer ist, wird der Zelleninhalt nur als Dateireferenz importiert und der Programmname bleibt leer. |
Erreichbarkeit von Links zu Dateien
In modernen Browsern sind Links zu Dateien auf einer lokalen Festplatte, UNC-Pfade zu Dateien auf einem Server und Links zu Netzwerklaufwerken aus Sicherheitsgründen nicht erreichbar. Links zu Dateien auf anderen Websites sind normalerweise erreichbar.
Beispiel
Sie wollen Beziehungen zu externen Dokumenten anlegen im Attribut Referenziertes Dokument von Objekten des Typs Dokument:
Hier ist ein Auszug aus der XML-Datei mit dem relevanten Abschnitt:
XML Example
<config>
<sheet name="Dokumente" class_name="C_DOCUMENT" id="1" data_row="1">
...
<attribute name="A_REFERENCED_DOCUMENT" type="file_pointer" context="de" column="2"/>
...
</sheet>
...
</config>