Storing Word and Excel Report Templates
You can create and add new and customized Word and Excel Templates for Codebeamer, and the Word or Excel export GUI will show such custom templates. These templates can be stored in two locations:
• The Document Management: each project has several folders under the .Codebeamer/Templates directory in the Document Management.
• From a directory in the file system: under $CB_HOME/tomcat/webapps/cb/exporttemplates this can contain templates.
Each kind of export needs different export templates: for example a TestRun export needs a different template than a simple Tracker Item export.
To separate the templates tailored for certain kinds of export, (a TestRun export for example) each type of export has its own subfolder in the main template directory. For example, when exporting TestRuns the templates are shown from the ../exporttemplates/TestRuns directory in the file system and similarly from the .codeBeamer/Templates/TestRuns directory in the Document Management.
The template directories for different kinds of exports are:
|
Directory
|
What kind of templates?
|
|---|---|
|
Trackers
|
Templates for exporting non-categorized Work Items, like Bugs or Tasks
|
|
TestCases
|
exporting Test Cases
|
|
TestRuns
|
exporting Test Runs
|
|
Coverage
|
exporting Coverages
|
|
Traceability
|
exporting Traceability reports
|
|
Wiki
|
exporting Wiki pages
|
|
Review
|
exporting Reviews
|
|
ReleaseNotes
|
exporting Release Notes
|
|
TrackerHistory
|
exporting Trackers' change history (audit)
|
Where should I store the new templates then?
If your template is specific to a certain project, then you can add your template to the Document Management directory, note however that this template will be only shown for the project where the template is.
 |
For security reasons the Excel templates in the Document Management can only be used for export if these are uploaded by a System Administrator. The System Administrator must review the Excel template's content to avoid potential security problems or misuses by the scripts in the templates! As for Word templates, any user's upload can be used for export.
|
However, if the template needs to appear in all projects, the template should be put into the file system. The limitations are that you need to be System Administrator to access the file system. Also these templates cannot be limited: they will appear for all users who can do exports.