Exportvorgang für den Projektbaum¶
Beim Export vom Typ ComponentTree wird der Projektbaum vollständig oder teilweise exportiert. Der resultierenden Datei können, unter Anderem, die ID und der Status der Komponenten entnommen werden.
Der Export kann wahlweise als XML-oder JSON-Datei ausgegeben werden.
Info
Wenn der komplette Projektbaum exportiert wird, beim Export die Informationen zu allen Versionen berücksichtigt werden (WithVersions=Y) oder als Exportformat JSON gewählt wird, kann unter Umständen eine sehr große Datenmenge entstehen. In diesem Fall wird empfohlen, nur einen konkreten Pfad des Projektbaums und keine Informationen zu den Versionen zu exportieren oder den Export in eine XML-Datei auszuwählen.
Neben den im Abschnitt Parameterdatei beschriebenen Schlüsseln, kann die Parameterdatei speziell für diesen Export zusätzlich die folgenden Schlüssel enthalten.
Sektion Common¶
In der Sektion [Common] können die folgenden Schlüssel konfiguriert werden:
| Schlüssel | Beschreibung | Werte |
|---|---|---|
| Dir | Relativer Pfad des Teils des Projektbaums, der exportiert werden soll. Dieser Schlüssel wird ignoriert, wenn ein Wert für ComponentID angegeben ist. | Ist dieser Schlüssel leer (Standardwert), wird der gesamte Projektbaum exportiert. (Mit Ausnahme der Verzeichnisse und Komponenten, auf die der ausführende Benutzer keinen Zugriff hat.) |
| - Ist der Schlüssel nicht leer, muss dem Eintrag ein Backslash ("\") vorangestellt sein. | ||
| - Es kann auch der Pfad einer Komponente (mit Namen) eingegeben werden. | ||
| WithVersions | Legt fest, ob Informationen zu den Versionen ausgegeben werden sollen. | - Y: Die Informationen werden ausgegeben. - N: Die Informationen werden nicht ausgegeben (Standardwert). |
| OnlyLatestVersion | Legt fest, ob Informationen nur zur letzten Version oder zu allen Versionen ausgegeben werden sollen. Voraussetzung ist, dass der Parameter WithVersions den Wert Y hat. | - Y: Es werden nur Informationen über die letzte Versionierung ausgegeben. - N: Alle Informationen werden ausgegeben (Standardwert) |
| WithMasterData | Legt fest, ob Informationen zu den Stammdaten ausgegeben werden sollen. | - Y: Die Information wird ausgegeben (Standardwert). - N: Die Information wird nicht ausgegeben. |
| EnableNodeTree | Legt fest, ob die Hierarchie des Projektverzeichnisses als XML-Knoten erstellt werden soll. | - Y: Die XML-Knoten werden erstellt. - N: Die XML-Knoten werden nicht erstellt (Standardwert) |
Beispielaufruf¶
Parameterdatei exportComponentTree.ini¶
[Common]
ReportType=ComponentTree
ExportFile=D:\Test\myComponentTree.xml
WithVersions=N
WithMasterData=Y
EnableNodeTree=N
[User]
Account={User}
Password={Password}
Übersicht über die XML Attribute, die in der Ergebnisdatei vorkommen¶
Element root¶
Das Element <root> ist der Ausgangspunkt des Projektbaums.
Element node¶
Das Element <node>repräsentiert ein Verzeichnis im Projektbaum. Dieses Element wird nur ausgegeben, wenn der Schlüssel EnableNodeTree in der Parameterdatei mit dem Wert Y übergeben wurde.
| Attribut | Beschreibung |
|---|---|
| Name="..." | Name des Verzeichnisses |
Element component¶
Das Element <component> enthält Informationen über die Komponente.
| Attribut | Beschreibung |
|---|---|
| Name="..." | Name der Komponente |
| Path="..." | Relativer Pfad zum Arbeitsverzeichnis der Komponente |
| Id="..." | Eindeutige Komponenten-ID (im GUID-Format) |
| TypeId="..." | Komponententyp-ID der Komponente (im GUID-Format) |
| State="n" | Statusinformationen zur Komponente. Wenn der Wert als 32-Bit-Binärzahl betrachtet wird, können folgende Informationen ausgelesen werden: 0x00000010: Gesperrt für andere Benutzer 0x00000020: Markiert als In Bearbeitung |
| MultiEdit="..." | Gibt an, ob die Komponente die Eigenschaft Multi-User Editing hat oder nicht. Folgende Werte sind möglich Y und N. |
Element data¶
Das Element <data>enthält eine Liste der Stammdaten der Komponente. Dieses Element wird nur ausgegeben, wenn der Schlüssel WithMasterData in der Parameterdatei mit dem Wert Y übergeben wurde.
| Attribut | Beschreibung |
|---|---|
| D1="..." D2="..." ... D10="..." | Stammdaten der Komponenten |
Element Versions¶
Das Element <Versions>enthält Informationen zu den Versionen einer Komponente. Dieses Element wird nur ausgegeben, wenn der Schlüssel WithVersions in der Parameterdatei mit dem Wert Y übergeben wurde.
Element Version¶
Das Element <Versions> enthält die folgenden Attribute:
| Attribut | Beschreibung |
|---|---|
| Id="..." | Version-ID zu dem Datensatz |
| Number="n" | Versionsnummer zu dem Datensatz |
| TimeStampUTC="..." | Zeitpunkt der Versionierung (UTC) |
| TimeStampLocal="..." | Zeitpunkt der Versionierung (lokale Zeit) |
| UserDefined="..." | Benutzerdefinierte Versions-ID |
| UserId="..." | Eindeutige ID des Benutzers (im GUID-Format) , der die Version erstellt hat |
| UserName="..." | Benutzer, der die Version erstellt hat |
| ComputerName="..." | Rechner, auf dem die Version erstellt wurde |
| Comment="..." | Kommentar |
| ChangeReason="..." | Änderungsgrund |
| SubDirArchive="..." | Name des Ordners, in dem die entsprechenden Version der Komponente (als Datei Archive.zip) im Serverarchiv gespeichert ist |
| StateArchive="n" | Zusätzliche Informationen über die Version. Wenn der Wert als 32-Bit-Binärzahl betrachtet wird, können die folgenden Informationen ausgelesen werden: 0x00000002: Das Archiv wurde ausgecheckt. 0x00000020: Das Archiv wurde eingecheckt. 0x00000040: Das Archiv wurde gelöscht (durch den angegebenen Benutzer). |
| SizeUncompressed | Die Größe der Komponente |
| SizeCompressed | Die gepackte Größe der Komponente |
Element Tags¶
Das Element <Tag>enthält Informationen zu den Tags, die der jeweiligen Version zugewiesen sind. Dieses Element wird nur ausgegeben, wenn mindestens ein Tag zugewiesen ist.
Element Tag¶
Das Element <Tag> enthält Informationen über den Inhalt eines Tags.
| Attribut | Beschreibung |
|---|---|
| Name="..." | Name des Tags |
Element LockState¶
Das Element <LockState> enthält Informationen über den Sperrstatus einer Komponente. Dieses Element wird nur ausgegeben, wenn ein Sperrstatus vorliegt.
| Attribut | Beschreibung |
|---|---|
| State="n" | Gibt den Sperrstatus der Komponente an. Folgende Werte sind möglich:\1: Gesperrt\2: In Bearbeitung |
| UserId="..." | ID des Benutzers (im GUID-Format) , der den Sperrstatus vergeben hat |
| UserName="..." | Benutzer, der den Sperrstatus vergeben hat |
| EmailAddress="..." | E-Mail Adresse des Benutzers, der den Sperrstatus zugewiesen hat. Wird keine E-Mail-Adresse angegeben, wird eine leere Zeichenfolge ausgegeben. |
| TimeStampLocal="..." | Zeitpunkt, zu dem der Sperrstatus vergeben wurde (lokale Zeit) |
| TimeStampUTC="..." | Zeitpunkt, zu dem der Sperrstatus vergeben wurde (UTC) |
| Days="n" | Gibt an, wie lange die Komponente bereits gesperrt ist (in Tagen). |
| ComputerName="..." | Rechner, von dem aus der Sperrstatus vergeben wurde |
| Comment="..." | Kommentar, der beim Sperren eingegeben wurde |