Projektbaum exportieren
Sie können den Projektbaum entweder vollständig oder in Teilen exportieren. Die exportierte Datei enthält u. a. Schlüsseldetails wie die Komponenten-IDs und deren Status.
Neben der Auswahl des Exportformats können Sie auch andere Exporteinstellungen konfigurieren, z. B:
- Ob der gesamte Projektbaum , ein bestimmter Abschnitt davon oder eine einzelne Komponente exportiert werden soll.
- Ob Versionsinformationen enthalten sein sollen, und wenn ja, ob nur die letzte Version oder alle Versionen exportiert werden sollen.
- Ob Stammdaten für die Komponenten enthalten sein sollen.
- Ob die Verzeichnisstruktur des Projekts als XML-Knoten dargestellt werden soll.
Wenn Sie den gesamten Projektbaum exportieren, alle Informationen zu den Versionen einschließen (WithVersions=Y) oder JSON als Exportformat wählen, kann die resultierende Datenmenge sehr groß sein. In diesem Fall empfiehlt es sich, nur einen bestimmten Pfad des Projektbaums und keine Informationen zu den Versionen zu exportieren oder den Export in eine XML-Datei zu wählen.
Einstellungen für das ExportModule
Neben den im Abschnitt Parameterdatei beschriebenen Schlüsseln, kann die Parameterdatei speziell für diesen Export zusätzlich folgende Schlüssel enthalten.
Sektion Common
In der Sektion [Common] können folgende 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}
Ausgabedatei
Der Export kann je nach ausgewählter Ausgabeoption entweder im XML- oder JSON-Format erfolgen.
Die XML-Ausgabedatei enthält die folgenden Elemente:
root:
Das Element <root>
ist der Ausgangspunkt des Projektbaums.
node:
Das Element <node>
stellt ein Verzeichnis im Projektbaum dar. Dieses Element wird nur ausgegeben, wenn die Projekt-Verzeichnishierarchie als XML-Knoten erstellt wurde.
Attribut | Beschreibung |
---|---|
Name="..." | Name des Verzeichnisses |
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. |
data:
Das Element <data>
enthält eine Liste mit den Stammdaten der Komponente.
Dieses Element wird nur ausgegeben, wenn die Stammdaten exportiert wurden.
Attribut | Beschreibung |
---|---|
D1="..." D2="..." ... D10="..." | Stammdaten der Komponenten |
Versions:
Das Element <Versions>
enthält Informationen zu den Versionen einer Komponente.
Dieses Element wird nur ausgegeben, wenn Informationen zu den Versionen exportiert wurden.
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 |
Tags:
Das Element <Tag>
enthält Informationen zu den Tags, die jeder Version zugeordnet sind.
Dieses Element wird nur ausgegeben, wenn mindestens ein Tag zugewiesen ist.
Tag:
Das Element <Tag>
enthält Informationen über den Inhalt eines Tags.
Attribut | Beschreibung |
---|---|
Name="..." | Name des Tags |
LockState:
Das Element <LockState>
enthält Informationen über den Sperrstatus einer Komponente.
Dieses Element wird nur dann in die Ausgabe aufgenommen, wenn mindestens eine Komponente einen Sperrstatus hat.
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 |
Verwandte Themen