Codebeamer
Codebeamer provides a new RPE tracker type to support document generation with IBM RPE. This tracker contains the report items. Each report item contains the template, the selected report, and additional information for generation. The report items can be grouped by folders, and the result will be one generated document.
The tracker uses predefined fields to provide additional information for generation. These fields are set in templates as variables. You can add new fields to this tracker and these fields will be set in the selected template also. If you want to generate documents from Codebeamer:
1. Create an RPE tracker.
2. Create a report item.
3. Set item fields: template, report and other custom fields.
4. Start the generation by right click on a report item and select the Generate selected RPE report menu item from the context menu.
If the generation starts, the status of the report item is updated to in Progress. Codebeamer checks the status of the generation process. If the generation is finished, then the status of the report item is updated to Finished and the generated documents are added as an attachment to this item. check the status of the generation process. If the generation is finished then the status of the report item is updated to Finished and the generated documents are added as attachment to this item.
Installation Guide
Use this step by step guide to configure RPE in Codebeamer.
Prerequisites
RPE is installed on theCodebeamer server or on a different server. If you use a different server, the two servers must connect to each other.
DGaaS is installed and runs on the RPE server.
You can check the DGaaS application using this URL: http://<dgaas-server>:<dgaas-port>/dgaas/debug
DGaaS debug screen:
RPE Home Directory
If RPE is installed on the Codebeamer server, skip this step.
1. Copy the home directory from the RPE server to the Codebeamer server.
The directory can be found at <RPE-installation-directory>\lib\ api\examples\com.ibm.rational.rpe.examples\src\home.
2. Copy this folder to the Codebeamer server.
Environment Variable
You need to create an environmental variable, RPE_HOME. This variable should contain the IBM RPE installation path. If you use different server, then this variable should contain the path of the RPE home directory, which is copied from the RPE installation.
Libraries
You need the following IBM JARs:
• com.ibm.icu_52.1.1.v201501240615.jar
• com.ibm.rational.rpe.core_6.0.6.v20180425_2102.jar
• com.ibm.rational.rrdg.core_6.0.6.v20180529_1851.jar
• org.eclipse.emf.common_2.10.1.v20150123-0348.jar
• org.eclipse.emf.ecore_2.10.2.v20150123-0348.jar
• org.eclipse.xsd_2.10.0.v20150123-0452.jar
• rcl_telelogic.jar
 | You must have the org.mozilla:rhino.jar is also needed which can be downloaded from the Maven Repository. |
Find these JARs at: <RPE-installation-directory>\lib
The com.ibm.rational.rrdg.core_6.0.6.v20180529_1851.jar file can be found at: <IMShared-installation-directory>\plugins
Copy the JAR files to Codebeamer tomcat: CB\tomacat\webapps\cb\WEB-INF\lib
General XML Configuration
Configure the following RPE settings in Application Configuration
• DGaaS application URL and credentials.
• Checker job.
A configuration example:
"rpe" : {
"checkerjob" : {
"timeInSec" : 60
},
"dgaas" : {
"authenticationMethod" : "",
"url" : "http://<dgaas-host>:<dgaas-port>/dgaas",
"username" : ""
}
}
"checkerjob" : {
"timeInSec" : 60
},
"dgaas" : {
"authenticationMethod" : "",
"url" : "http://<dgaas-host>:<dgaas-port>/dgaas",
"username" : ""
}
}
Old general.xml configuration example:
<rpe>
<dgaas url="http://<dgaas-host>:<dgaas-port>/dgaas" username="<user-name>" password="<password>" authenticationMethod="<auth-method>" />
<checkerjob timeInSec="<seconds>" />
</rpe>
<dgaas url="http://<dgaas-host>:<dgaas-port>/dgaas" username="<user-name>" password="<password>" authenticationMethod="<auth-method>" />
<checkerjob timeInSec="<seconds>" />
</rpe>
How to use RPE in Codebeamer
If RPE is configured in Codebeamer then we can start to work with RPE.
RPE Report Tracker
First of all, we need to create an RPE tracker.
Steps:
1. Go to trackers page.
2. Click on the 
.
.3. Select RPE Report in Type field.
4. Fill in the name field.
5. Fill the key (short name) field.
6. Fill the description field.
7. Click SAVE.
Report Items
Now we can create report items.
Steps:
1. Click on the plus sign
2. Fill name field
3. Fill description
4. Click on the Save icon
5. On details panel on the right side fill the following fields:
◦ Report - click into the field and select a report with artifact selector
◦ Template - click into the field and select document template or paste template file URL
◦ other fields - set custom fields, these fields are set in templates as variables
 | It is available from Codebeamer 9.4.0 version. |
• Word Sytle Sheet - click into the field and select a word template file
• Generated At - click into the field and set the generation time
• Output - click into the field and select the generated output types
Click on the Save button
| | We can create folders and folders can contain one or more report items. If we want to use two or more templates for document generation just use folders as report items container. |
Example for report folder:
| | It is available from Codebeamer 9.4.0 version. |
The folder field values are the default values for the generation, so if we do not set the fields on the report items then these values will be used. (except: report field).
Start Document Generation
To start generation process, click on the selected report item or folder, right click on it and select the Generate Selected RPE Report menu item from context menu. Once the report generation begins, we get an info message about it and the selected item status is updated to in progress.
Download Result
1. Refresh the page and if the status of the selected item is updated to Finish then the generation is finished.
2. Now we can find the generated documents as attachments at the report item.
3. Just click on the documents.zip file and the download is started.
