Exporting the Project tree

You can export the Project tree either in full or in part. The exported file includes key details such as the component IDs and their statuses, among other information.

In addition to selecting the export format, you can configure other export settings, including:

• Whether to export the entire Project tree, its specific section, or an individual component.
• Whether to include version information, and if so, whether to export only the latest version or all versions.
• Whether to include master data for the components.
• Whether to represent the project directory structure as an XML node.

If you export the complete Project tree, include all version information (WithVersions=Y), or select JSON as the export format, the resulting data volume may be very large. If this is the case, it is recommended to export only a specific path of the Project tree and no information on the versions or to select export to an XML file.

Settings for the ExportModule

In addition to the keys described in the Parameter file page, the parameter file can also contain the following keys specifically for this export.

Section Common

In the [Common] section, the following keys can be configurated:

Example call

VDogAutoExport.exe "/rd:D:\vdClientArchive" "/CFile:D:\Test\exportComponentTree.ini"

Parameter file exportComponentTree.ini

[Common]
ReportType=ComponentTree
ExportFile=D:\Test\myComponentTree.xml
WithVersions=N
WithMasterData=Y
EnableNodeTree=N

[User]
Account={User}
Password={Password}

Output file

The export can be generated in either XML or JSON format, depending on the selected output option.

The XML output file contains the following elements:

root:

The <root> element is the starting point of the Project tree.

node:

The <note> element represents a directory in the Project tree. This element is only output if the project directory hierarchy was created as an XML node.

component:

The <component> element contains information about the component.

data:

The <data> element contains a list of the component's master data.

This element is only output if master data has been exported.

Versions:

The <Versions> element contains information on the versions of a component.

This element is only output if information on the versions has been exported.

Version:

The <Versions> element contains the following attributes:

Tags:

The <Tag> element contains information on the tags assigned to each version.

This element is only output if at least one tag is assigned.

Tag:

The <Tag> element contains information on the content of a tag.

LockState:

The <LockState> element contains information on the lock status of a component.

This element is included in the output only if at least one component has a lock status.

Related topics

• How to use the ExportModule