Merging the Global Templates from File System and Document Management
When performing the export the GUI will show templates from both the file system and Document Management. This screenshot illustrates how it works: the list contains templates from both places (file system, Document Management):
Adding templates to Document Management
Adding new templates to Document Management is simple: when executing a certain kind of export click on the Manage custom templates link: the directory, where the templates can be stored, is opened.
If you add a new template (or delete an existing) then this template will appear next time in the appropriate export dialog.
If you add some Wiki description to the template file, this will appear on the UI, instead of the file name. The files are appearing in alphabetical order of their names on the UI.
Adding Global Templates to file system
You can also add Global Templates to the file system. For this you need to be System Administrator with access to the file system of your Codebeamer server.
To add a new Test Run export file, called customTestRunExport.docx, navigate to the file system of Codebeamer and find the $CB_HOME/tomcat/webapps/cb/exporttemplates/TestRuns directory. This folder contains the Word and Excel export files for TestRuns.
If you upload your customTestRunExport.docx file here: the export UI of TestRuns will immediately show that (no restart needed).
Customizing the name and the order of new template files
If you upload a new template like customTestRunExport.docx then this filename appears in the template list.
To make filenames easier to comprehend in the template list:
• Transform/translate the filename to something more readable/user-friendly.
• Customize the order the templates appear on the UI, for example, move the new template to the beginning of the list.
Translating/transforming template's names
Each template file can have a more readable and user-friendly name, and these names can be also translated to German and other languages.
For this you can add the descriptive name of your template file to the following files:
This is implemented in such a way that exporttemplates directory contains configuration files where the filename transformations can be configured similarly to ApplicationResources.properties. The translations configured in the following files:
file | content |
|---|---|
templateNames.properties | The file-name->user-friendly mappings for English language |
templateNames_de.properties | The mappings for German language |
my-templateNames.properties | Users can/should put his own mappings/translations to this file. |
my-templateNames_de.properties | The Users' custom translations for German language |
These translation files contain the file name of the user-friendly name mapping: For example the exporttemplates/Trackers/template-items-all.docx template file will appear as English Trackers/template-items-all.docx on the UI if this is set in the templateNames.properties file.
exporttemplates/Trackers/template-items-all.docx=English Trackers/template-items-all.docx
 |  |
Ordering of the templates
The order of the template files is configured in the order.txt files on the file system. These files contain the file names in the desired order. So if you want to add their custom template and appear at the first place on the list, then the template file should be added to the folder and the file name at the first line of order.txt.
