Exporting and Importing a Project as a Project Template
Exporting a Project as a Project Template
Prerequisites:
• The user performing the export must have the Project - Administer permission at the project level. Typically, a user with Project Admin project role performs this operation. For more information, see Administering Projects.
To export a project as a project template, follow these steps:
1. Click > > .
2. In the Quick export window, select from the following artifacts to be included in the template file:
◦ Documents
◦ Wiki pages
◦ Dashboards
◦ Work items—Exports all items from the trackers selected in the Trackers checkbox.
◦ Reports—Exports the public reports and traceability reports of the project from the Reports tab.
◦ Trackers—Exports the trackers and the tracker configurations of the project, including tracker views and the shared fields used in the trackers.
▪ To export all the trackers, leave this checkbox selected.
▪ To export specific trackers, clear this checkbox, and then select the trackers using the Trackers list.
3. Click EXPORT.
 |
Codebeamer X exports only the trackers where the user has the Item - Export permission at the tracker level.
|
Importing a Project Template
Prerequisites:
• The user performing the import must have the Create Project permission at the user group level. For more information, see Managing Groups.
To import a project template, follow these steps:
1. Click the Projects tab.
2. Click > .
3. Select the ZIP file of the project exported as a project template.
4. Click Next and provide the following:
◦ Project name—(Required) Enter a name for the project.
◦ Key—Enter an identifier key for the project.
◦ Include all work items and documents, Include wiki pages, Include dashboards—We recommend enabling these options.
5. Click FINISH to start the project import. The duration of the import depends on the size of the data, and it may take extended time.
|
|
The import process may stop because of the Codebeamer X default settings for file size and file types. To change these settings, refer to the following points:
• File size—Modify the "uploadFileSizeLimit" in the "interactive" application configuration. For details, see "interactive" section.
|
Encryption of the Project Export
You can enter a password on the export dialog box to securely encrypt the project contents. The user who uploads it to a Codebeamer instance must provide the same password in the target system, otherwise, loading its contents is not possible. Codebeamer also protects the exported files (encrypted or not) from modifications. If the contents of a project export file have been modified, Codebeamer does not allow it to be used for project import or project deployment.
List of General Restrictions for Import and Export
Importing or exporting a project has the following restrictions:
• Importing projects from templates created with higher Codebeamer X versions is not supported.
• Only the head versions of project artifacts and work or configuration items are exported, including comments, attachments, permissions, and associations, but without history.
• Project members are exported, but because users and user groups are not part of the project, they can only be re-imported if users and groups with the same names already exist in the target system upon import.
• Tracker configurations are exported completely, but the tracker inheritance information is lost, if the template tracker is not part of the exported project.
• References (interwiki links in wiki texts, associations, reference fields) to entities outside the current project are exported, but they can only be imported if entities with the same name and the same location already exist in the target system upon import. However, reused step references are not included in a cross-project import or export. Absolute URLs or wiki plugin parameters that refer to exported entities can be broken after a re-import.
• TestRun tracker configurations are exported, but TestRuns are not.
• Baselines are not exported, because they refer to historical information.
• Source-code related-data (such as repositories, commits, pull-requests) are not exported.
• Upon import, all imported entities have new ids and a version number of 1. The owner or submitter of all imported entities is the user that executed the import. The creation or submission date of all entities is the date of the import.
 |
During the export or import, all entities to be exported or imported, including comments and attachments, are loaded into memory. If there are many entities, or if the attachments are large, users might need several GB of free memory. If the memory is insufficient, the export or import fails and generates an OutOfMemoryException error.
|
• Project import does not support applying configurations that were exported. However, this restriction can be bypassed with an application configuration. For more information, see Application Configuration.
Reference Handling Restrictions
You can create reference fields in tracker configurations. The type of the reference can be project, tracker, or work item. For example, you can create a work item field where trackers can be set in field reference filters. You can download this reference list during the import process.
This is a CSV file, and you can click here to download it. You can open the file in Microsoft Excel, but you must import it because of the UTF-8 encoding.
Cross Reference CSV File
The CSV file contains the following three tables:
• Cross reference table.
The table contains the references to other project artifacts. It has the following columns:
◦ Reference—The reference to another project artifact.
◦ Type—The reference type (project, tracker, work item).
◦ Project—Project of reference or empty if it is a project.
◦ Tracker—Tracker of reference or empty if it is a tracker.
◦ Mapped target—The mapped target reference if it is found or unresolved.
◦ Path—The location of the reference in the tracker configuration.
• Item table
The item table contains work items that have invalid references to missing artifacts. This means that the artifact is not used in the tracker configuration, and it is not in the first cross reference table. The item table has the following columns:
◦ Reference—The reference to another project artifact.
◦ Type—The reference type (project, tracker, work item).
◦ Project—Project of reference or empty if it is a project.
◦ Tracker—Tracker of reference or empty if it is a tracker.
◦ Path—The item that contains the invalid reference.
• Field Table.
The field table contains fields that have a special computed formula. The formula contains a special function, such as hasSuspectedLink, hasReferringReview, or hasUpstreamSuspectedLink. The field table has the following columns:
◦ Field—The tracker field where the function is found.
◦ Function—The special function.