RPE: Modify quick print template for Module, which REST URI to use?

Dr. Markus A. Thies (32●11●13) | asked Oct 17 '13, 4:56 p.m.

I struggle in testing a modification of the existing printModuleBook.dta using the RPE.

I am not able to figure out how the URL for the data source has to look like.
The data source schema shows <artifacts>, <info> and <headers> but I am not able to produce that output from a REST call.

Please advise, which REST URL RRC is using for the quick print.

Accepted answer

permanent link

Jorge Flores (109●2) | answered Oct 18 '13, 6:43 p.m.
reverted Oct 18 '13, 6:47 p.m.

Look for the DSX on the server temp files or by looking to *.dsx then open the file with RPE, there you will find the datasource URL, paste that on a browser.

On the displayed XML file you will have something similar to this:

<rrm:headers rrm:totalCount="2">
     <field:name field:fieldId="1" field:width="45">ID</field:name>
     <field:name field:fieldId="2" field:width="507">Primary Text</field:name>
</rrm:headers>

<ds:artifact rdf:about="https://server:9443/rm/resources/_b5746163026a41d88eeb38eec2734820" rrm:format="Text">
     <rrm:fields>
          <rrm:field field:fieldId="1" field:isContent="false"><field:value field:type="text">363</field:value></rrm:field>
          <rrm:field field:fieldId="2" field:isContent="true"><field:value field:type="richtext"><div><div><p id="_1382116502749">   test before the baseline</p></div></div></field:value></rrm:field>
     </rrm:fields>
</ds:artifact>

So notice that the headers include the information of the name and number of fields for the module report and the artifacts contains the value for those fields for a given artifact. That information is dynamic and will change depending on what your do on your module ! so if you add more colums to your module the number of fields will increase.

Managing that information correctly and you will be able to create any report related to modules with the same information that is included on the modules on web.

Regards.

Dr. Markus A. Thies selected this answer as the correct answer

One other answer

Most liked answers ↑|Newest answers|Oldest answers

permanent link

Edgar Ignacio Velazquez Mar (722●5) | answered Oct 17 '13, 5:56 p.m.
JAZZ DEVELOPER

Hi Markus,

the printModuleBook URL is created by the server using some internal calls and cache of a view. You will not be able to create that one manually. Your best option to get something is to enable debug of the PublishServices on the RRC Server admin console, then print a module and after that check the URL on the generated DSX file which you could see on the log file where it was created.

That is a very specific report that works with an specific view, actually it makes not much sense to modify it, it only purpose is to display the elements as closely as possible to the book view for Modules. All the formatting is made on the server code

Comments

Dr. Markus A. Thies commented Oct 19 '13, 2:06 p.m.

Hi Edgar,
thanks for the answer.

Anyway, we produce Requirements Engineering documents for our customer. The Word format does not satisfy the requirements by our customer. So we have to adjust the document, otherwise we are not able to produce a documentation which achieves the requested quality.

We mainly need to extend elements to be included in the outcome.

Does your answer imply that there is currently no way to customize the document generation when Modules are used?

It's all about the answers!

Related questions

RPE: Modify quick print template for Module, which REST URI to use?

Accepted answer

One other answer

Your answer