Document Studio
Document Studio is an IBM tool that creates formatted document templates. This tool helps you preview and generate documents in several formats. It supports the following output formats:
• PDF
• HTML
• Word
• XSL
Using Codebeamer in Document Studio:
Schema
Codebeamer provides the result schema to Document Studio. This schema can be added as data source in Document Studio.
Using this schema, you can create queries to obtain data from aCodebeamer result.
For example, you can iterate over work items attributes.
Schema is available for reports and tracker types and can be downloaded from the following Codebeamer REST endpoints:
• Report schema URL - http://<Codebeamer-host>/cb/rest/rpe/schema/report.spr
• Tracker schema URL - http://<Codebeamer-host>/cb/rest/rpe/schema/item.spr?trackerId=<tracker-id>
| It is available from Codebeamer 9.4.0 version. |
• Reports schema URL - http://<Codebeamer-host>/cb/rest/rpe/schema/reports.spr
The schema is in JSON format.
Report Result
Codebeamer uses reports to provide data to RPE. You can create a report and the report result contains the selected data.
Codebeamer provides a REST endpoint to download report result. The result is in JSON format, and the schema is the Report schema.
Reports Result
| It is available from Codebeamer 9.4.0 version. |
If you want to generate a document from more than one report result, you can use the reports data source.
With this datasource, you can iterate over reports. You can use the url attribute in a dynamic data source to obtain report results.
Tracker Item Result
In templates, you can use dynamic data sources. With these, you can add additional data to your document. For example, you can add a tracker schema as a data source with a link attribute of the report schema. With this data source, you can obtain all field values of an item.
Requirement tracker schema:
Dynamic data source:
You can create a template (.DTA file) with Document Studio and generate documents. This file should be available for Codebeamer, so you can upload it to the documents folder or share it on the network.