Once you have a report that works well in RPE and produces a great document the next question for a report designer is how to make that template available to the end users. This is especially important for users of Web based tools like DNG/QM/RTC .
The solution is to deploy the RPE template in the point product and have it generated using RRDG. See RRDGvsRPE for an introduction of RRDG and how it relates to RPE.
The main advantage of deploying RPE templates in point products is that end users do not need to know about RPE, templates, data sources, URI and other technical details. Instead they will use the point product’s reporting UI for docgen, UI that should be more user friendly and use a terminology that is specific to the point product.
NOTE: you do not need to have RPE installed to deploy or use a template in DNG.
This article documents how to deploy an RRDG template that prints the content of a DNG module. The configuration used is RPE 22.214.171.124 with DNG 4.0.6
All the steps of this procedure are also described on RRCtemplatesConfigurationFilesForReportWizard but I wanted to document the end to end scenario with all the steps in the logical order.
1. Design your template
Pay attention to the data source naming convention that you must follow. In my template I have 4 data sources:
- modules – the main data source that will be configured by DNG with the module URI
- _text – hidden data source that is configured dynamically. Note the “_” in the name
- _resources – hidden data source that is configured dynamically. Note the “_” in the name
- _uisketches – hidden data source that is configured dynamically. Note the “_” in the name
The template I used is available on the RPE DevWorks Wiki: moduleContentDC.dta
2. Copy the template in DNG’s RRDG folder
The RRDG template folder is server\conf\rm\reporting\initialization\templates\rrdg.
In my test environment this is: C:\Program Files\IBM\JazzTeamServer\server\conf\rm\reporting\initialization\templates\rrdg
NOTE: optionally you can also upload a stylesheet to be used with your template. The stylesheet must have the same name as your template but with doc extension and must be deployed in the server\conf\rm\reporting\initialization\templates\Word folder.
3. Register the new template with DNG
Next you need to make DNG aware of the new template. Edit the MANIFEST.MF file located in server\conf\rm\reporting\initialization\META-INF andcreatean entry for your template.
Make sure the path is correct and choose a label that is meaningful for the template’s intent.
Name: ModuleContent Location: templates/rrdg/moduleContentDC.dta Label: Module Content DC Description: ModuleContent Content-Type: application/octet-stream Is-Report: true Context: view, module, collection
NOTE: the Word stylesheet does not need to be registered in the manifest file
4. Reinitialize the publish service
This is done simply by accessing the following URL: https://clmserver9443/rm/publish/initialize
NOTE: this is needed even if the template existed and you just copied a new version on top of it.
5. Refresh the DNG Web UI
This step should be needed only the first time you add the template or if you make changes to the manifest file but I always do it to be on the safe side.
6. Publish the document using DNG’s wizard
6.1 Start the publish wizard from DNG
While in the context of a module select “Generate a document-style report” from the “Reports” menu.
6.2. Select the report from the list
6.3. Select the module
6.4 Choose the output
NOTE: If you use PDF make sure you choose “Sophisticated formatting”
6.5 Start the document generation
6.6 Verify the results
Once the report generation is complete you can close the window and you will be redirected to download the result.
The PDF generated from the JKE Banking example is attached : Test module