Structure of Export XML
- Ashhad Alam
- Avinash Kumar
The following screenshot displays the structure of export XML:
Following is the description of tags used in export XML file:
<Configuration operation="export">
This is the root tag of the XML. It also specifies the type of operation. For example: Export or Import. You need not to change anything within this tag.
<TargetZipLoc>$SHARED_PATH$/migration/export/export-$TIMESTAMP$.zip</TargetZipLoc>
Enter the path along with the file name, where you want to store the exported zip file.Â
<ExportType>A</ExportType>
Specify A to export all activities or specific activities. Specify PR to export projects.Â
<Group>comment="Specify the group whose objects need to be exported" name="Group_1" activityRefId="001" projectRefId="001" />
<Projects
comment="List of all Project names that need to be exported"
projectRefId="001">
<Project export="yes">Project_11539093086054</Project>
<Project export="no" />
</Projects>
Define the list of projects that you want to export. You can create more than one Projects list.
Here:
projectRefId | Id of the project activities list and this should match with id of activity list. |
export | Whether you want to export the objects of this project or not. It values can be yes or no. |
Name of the project | Name of project that you want to export. For example, the 'Project_11539093086054' project. |
<Activities comment="List of all activity types that need to be exported">
<activity type="Database Target" />
</Activities>
Define the list of activities that you want to export for a particular group or project. You can create more than one Activities list.
Here:
activityId | Id of this activity list. This should match with the activityId defined in the <GroupName> or in <project>. |
activity name | Type of the activity that you want to export. For example if you define Database Target, all the database target activities that belong to the specified group or project, are exported |
If you want to export selective objects of a particular activity type,
then either specify their name(s) or id(s) or both as child element of activity
element. Please note that wild characters are supported when you specify
name(s) as child element of particular activity type. If you do not specify
any child element of activity element, then all activities of that particular
type are exported.
<Solution export="yes" tableId="001">
<DatabaseType><![CDATA[sql]]></DatabaseType>
<Server><![CDATA[192.168.1.17]]></Server>
<Port><![CDATA[1433]]></Port>
<DatabaseName><![CDATA[SqlDatabase]]></DatabaseName>
<UserName><![CDATA[sa]]></UserName>
<Password><![CDATA[p@ssw0rd]]></Password>
</Solution>
Define the list of parameters that you need to define to make connection with solution database from where you want to export a table. You can export more than one table from the same database.
Here:
export | Yes or no. Define yes if you want to export a table from a database. |
tableId | Id of the table that you want to export. For example, 001 |
Database Type | Type of database that you want to export. For example, ![CDATA[sql]] |
Server | IP address of the server where solution table exist. For example, ![CDATA[192.168.1.17]] |
Port | Port number. For example, ![CDATA[1433]] |
DatabaseName | Name of the database whose tables you want to export |
UserName | User name to access the database |
Password | Password to access the database |
<SolutionTables tableId="001">
<Table>
<name><![CDATA[employee]]></name>
<whereClause><![CDATA[empid =(select max(empId) from employee)]]></whereClause>
</Table>
<Table>
<name><![CDATA[Order]]></name>
<whereClause><![CDATA[orderid =1]]></whereClause>
</Table>
</SolutionTables>
Enter the value of parameters for the table that you want to export
Name and structure of the table that you want to export should be same at the source and target end.
Here:
tableID | Id of the table that you want to export |
Name | Name of the table that you want to export |
whereClause | Defines the where clause to specify the data to be fetched from the table |
You can define as many tables as you want.
Â
The below example explains how you can export the customClasses folders with include/exclude criteria.
<Folders>
<Folder includeSubFolders="" excludeSubFolders="" includeFiles="" excludeFiles="DataInterface*">customClasses</Folder>
</Folders>
The above example will export all the files and folders except the ones starting with DataInterface name.
Specify a criteria to include or exclude files and folders while exporting objects. The following table explains all the attributes of Folder tag.
Here:
Folder Attributes | You may use these attributes for including or excluding multiple files/sub-folders. All of the following attributes support wildcards. You may also use multiple wildcards separated by commas (,). If no values are specified for Folder attribute, it considers the whole folder by default. |
includeSubFolders | The specified folders will be exported including all sub-files |
excludeSubFolders | The specified subfolders will not be exported |
includeFiles | The specified files will be exported |
excludeFiles | The specified files will not be exported |
The below example explains how you can export the server-configure.properties file.
<Files>
File>etc/server-configure.properties</File>
</Files>