Report Data Source Reference

This topic provides reference information for IBM®Rational® Requirements Composer (RRC) data sources, the data source XML format, and additional information about RRC REST APIs that can be used for reporting.

RRC data sources

The IBMRational Requirements Composer (RRC) server provides REST APIs for accessing information about RRC artifacts for reporting. You can access each API via a standard web browser or by using Rational Publishing Engine. The following is a description of the URLs that you can use to access the resource data sources on the server:
Table 1. Resource REST APIs for accessing report information
URL Description
https://server:port/rdm/publish/resources/* Provides base resource information for all accessible resources on the server.
https://server:port/rdm/publish/resources?resourceURI=rrc1,rrc2,rrc3 Provides base resource information for a set of specified resources
https://server:port/rdm/publish/resources?collectionURI=rrc123 Provides base resource information for the resource revisions associated with a specific collection
https://server:port/rdm/publish/resources?projectURI=guid Provides base resource information for all resources belonging to the specified project.
https://server:port/rdm/publish/resources?snapshotId=guid Provides base resource information for all resources belong to the specified project snapshot. This argument can be used in conjunction with the ?resourceURI= argument.
https://server:port/rdm/publish/resources?modifiedSince=yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Provides base resource information for all resources modified since the specified date/time stamp in the specified format.
https://server:port/rdm/publish/resources?metadata=schema Provides the generated schema for the base resources REST API.
https://server:port/rdm/publish/resources?fields=xpath The ?fields= argument is tolerated but does not alter the content returned from the REST API
In addition to the resources REST APIs, the following APIs support the same arguments:
Table 2. APIs for accessing report information
URL Description
https://server:port/rdm/publish/actors Provides information restricted to actor artifacts. Includes a content section with information about the XHTML rendering of the contents of the artifact.
https://server:port/rdm/publish/documents Provides information restricted to document artifacts. Includes a content section with information about the XHTML rendering of the contents of the artifact.
https://server:port/rdm/publish/glossaries Provides information restricted to glossary artifacts. Includes a content section that includes the revision information for the glossary and an aggregated content section with information about XHTML rendering of the terms included in the glossary.
https://server:port/rdm/publish/screenflows Provides information restricted to screen flow artifacts. Includes a content section that includes revision information for the screen flow as well as a link to an image rendering of the artifact. It also includes an aggregated content section with information about the sketches referenced by the panels in the screen flow.
https://server:port/rdm/publish/storyboards Provides information restricted to storyboard artifacts. Includes a content section that includes the revision information about the storyboard as well as a link to an image rendering of the artifact. It also includes an aggregated content section with information about the frames of the storyboard.
https://server:port/rdm/publish/terms Provides information restricted to term artifacts. Includes a content section with information about the XHTML rendering of the contents of the artifact.
https://server:port/rdm/publish/uisketches Provides information restricted to UI sketch artifacts. Includes an aggregated content section that provides information about the sketch.
https://server:port/rdm/publish/processes Provides information restricted to process diagram artifacts. Includes a content section that includes the revision information for the process as well as a link to an image rendering of the artifact. It also provides information about the native content for the process diagram.
https://server:port/rdm/publish/usecases Provides information restricted to use case artifacts. Includes a content section that provides information about the XHTML rendering of the contents of the artifact
https://server:port/rdm/publish/usecasediagrams Provides information restricted to use case diagram artifacts. Includes a content section that includes the revision information for the use case diagram as well as a link to an image rendering of the artifact. It also includes an aggregated content section that provides information about the use cases and actors in the use case diagram.
https://server:port/rdm/publish/requirements Provides information restricted to requirement artifacts. Includes a content section that provides information about the XHTML rendering of the contents of the artifact.
https://server:port/rdm/publish/collections (Available only in RRC V2.0.0.2 and higher.) Provides information about the specified collections. This data source is in the same format as the resources data source.
There following are additional REST APIs that support only the ?resourceURI= and ?collectionURI= arguments:
  • https://server:port/rdm/publish/revisions
  • https://server:port/rdm/publish/comments

The REST API for reviews is: https://server:port/rdm/publish/reviews. This API supports only the ?resourceURI= argument.

Data source XML format

All RRC data sources have the same overall structure, but with some variations specific to the particular data source and based on the content type of the artifacts being rendered. Each data source returns XML that has the following basic structure, as shown in the following example for the resources data source:
<?xml version="1.0" encoding="UTF-8"?>
<ds:dataSource xmlns:attribute="http://jazz.net/xmlns/alm/rm/attribute/v0.1" xmlns:dc="http://purl.org/dc/terms"
 xmlns:ds="http://jazz.net/xmlns/alm/rm/datasource/v0.1" xmlns:h="http://www.w3.org/1999/xhtml">
<ds:artifact>
<dc:title>Shop for CD - View Current Items</dc:title>
<dc:description>Requirements details for view current items alternate flow</dc:description>
<dc:identifier>rrc86</dc:identifier>
<ds:about>https://server:port/rdm/resources/rrc86</ds:about>
<dc:format>application/x-com.ibm.rdm.requirement+xml</dc:format>
<ds:collaboration>
<dc:creator>https://server:port/jazz/users/Nick</dc:creator>
<dc:created datatype="http://www.w3.org/2001/XMLSchema#dateTime">2009-12-15T23:55:18.646Z</dc:created>
<dc:modified datatype="http://www.w3.org/2001/XMLSchema#dateTime">2009-12-15T23:56:02.286Z</dc:modified>
<ds:attributes>
<attribute:UC>
<attribute:Property_ID_string>Alternative Flow</attribute:Property_ID_string>
<attribute:AffectsArchitecture_ID_string>true</attribute:AffectsArchitecture_ID_string>
<attribute:Priority_ID_string>Must</attribute:Priority_ID_string>
<attribute:Status_ID_string>Incorporated</attribute:Status_ID_string>
<attribute:Difficulty_ID_string>High</attribute:Difficulty_ID_string>
<attribute:Contact_ID_string>George</attribute:Contact_ID_string>
</attribute:UC>
</ds:attributes>
<ds:comments>
<ds:href>https://server:port/rdm/publish/comments?resourceURI=rrc86</ds:href>
</ds:comments>
<ds:revisions>
<ds:href>https://server:port/rdm/publish/revisions?resourceURI=rrc86</ds:href>
</ds:revisions>
</ds:collaboration>
<ds:location>
<ds:project>
<dc:title>CD</dc:title>
<ds:about>https://server:port/jazz/process/project-areas/_NhEakOnVEd6Sl6Emj-e3Ow</ds:about>
</ds:project>
<ds:parentFolder>
<dc:title>Requirements</dc:title>
<ds:about>https://server:port/rdm/folders/_PCrXQOnVEd6Sl6Emj-e3Ow</ds:about>
</ds:parentFolder>
</ds:location>
<ds:traceability>
<ds:incoming>
<ds:reqArtifact type="application/x-com.ibm.rdm.requirement+xml">
<dc:title>Shop for CD - Search by selected criteria</dc:title>
<dc:relation>https://server:port/rdm/resources/rrc18?revision=_b5Wuw-nVEd6Sl6Emj-e3Ow</dc:relation>
<dc:alternative>https://server:port/rdm/publish/requirements?resourceURI=rrc18</dc:alternative>
</ds:reqArtifact>
<ds:link type="application/x-com.ibm.rdm.ba.usecase+xml">
<dc:title>Shop for CD</dc:title>
<dc:relation>https://server:port/rdm/resources/rrc20?revision=_c-o70enVEd6Sl6Emj-e3Ow</dc:relation>
<dc:alternative>https://server:port/rdm/publish/resources?resourceURI=rrc20</dc:alternative>
</ds:link>
</ds:incoming>
<ds:outgoing>
<ds:link type="application/x-com.ibm.rdm.ba.actor+xml">
<dc:title>Catalog </dc:title>
<dc:relation>https://server:port/rdm/resources/rrc116?revision=_cVqQROnVEd6Sl6Emj-e3Ow</dc:relation>
<dc:alternative>https://server:port/rdm/publish/resources?resourceURI=rrc116</dc:alternative>
</ds:link>
<ds:reqArtifact type="application/x-com.ibm.rdm.requirement+xml">
<dc:title>Shop for CD - No matching ids</dc:title>
<dc:relation>https://server:port/rdm/resources/rrc73?revision=_bkyM8-nVEd6Sl6Emj-e3Ow</dc:relation>
<dc:alternative>https://server:port/rdm/publish/requirements?resourceURI=rrc73</dc:alternative>
</ds:reqArtifact>
</ds:outgoing>
</ds:traceability>
</ds:artifact>
</ds:dataSource>

Specific data sources may also include sections for content and aggregatedContent whose schema is specific to the particular data source.

Additional RRC REST APIs for Reporting

In addition to the REST APIs providing data, there are additional REST APIs supported by the RRC server related to reporting:
Table 3. Additional REST APIs for Reporting
Header Header
https://server:port/rdm/publish/schema/ The schemas returned using the ?metadata=schema URIs on the above data sources often reference one or more imported static XML schemas. These are hosted by the publish services as sub-paths of /rdm/publish/schema.
https://server:port/rdm/publish/templateLibrary This URI returns the RPE template library for out-of-the-box reports hosted on the RRC server
https://server:port/rdm/publish/templateLibrary/ Sub-paths of the /rdm/publish/templateLibary path point to specific out-of-the-box report templates and word document templates used by reporting in RRC.

Adding/modifying report templates on the server

To add or modify a Word or RPE template, complete the following steps
  1. On the server machine, navigate to the following folder: <Install Dir>/server/conf/rdm/reporting/initialization/templates
  2. In this folder, there is a file calledtemplateLibrary.xml and two folders called rpe and word. Each subfolder contains the out of the box reporting templates for the server. The templateLibrary.xml file contains information used to populate the reporting wizard with the appropriate out-of-box templates. The templateLibrary.xml contains a series of entries similar to the one below, one for each out-of-box template:
    <resource 
    active="true"
    seedContentType="application/x-com.ibm.sid.sketch+xml"
    dataSource="uiSketches">
    <label>UI Specification (by UI Sketches)</label>	
    	<description>Detailed summary of User Interface elements</description> 
    	<url>___REPOSITORY_URL___publish/templateLibrary/uispec1</url>
    </resource>
    The following table provides further information about the attributes and elements of a template library entry:
    Table 4. Attributes and elements of a template library entry
    Name Required Description
    active no Determines whether or not the report template will be visible from the RRC Reports wizard. If present and set to "true", the template will appear in the RRC Reports wizard, otherwise it will not.
    seedContentType no Determines the report template's seed content type, if present. Format is the mime type for the seed content type. If present, the selected artifacts in the RRC Reports wizard will be filtered based on this mime type.
    dataSource no Specifies the data source to be used for the report template. Takes the form of the last segment of the data source URL (eg: "uiSketches" or "requirements"). If not present, the RRC Reports wizard will use the resources data source.
    label yes Textual label for the report template. This is the title of the report template shown in both the RRC and RPE wizards.
    description no Optional description for the report template. Currently only shown in the RPE wizard.
    url yes The URL to access the report. In the template library on disk this must be of the form :
    REPOSITORY_URL___publish/templateLibrary/<filename of the RPE template without the .dta extension>
    Additional templates can be added to this template library by placing the necessary RPE template in the rpe subfolder, with a corresponding Word template based on one of the existing .dot templates in the word subfolder and then adding a resource element to the templateLibrary.xml file following the rules above. Both the RPE template and the Word template must have the same name aside from the file extension.
  3. Navigate to the appropriate subfolder, and make the necessary changes to either the RPE or word template using the appropriate tool. For RPE templates, you will need a licensed copy of the RPE Document Studio tool. For Word templates, you can use Microsoft Word or a similar compatible tool. Note that for RPE to function correctly, you must save Word templates using the Word 2003 format
  4. After the changes have been made, you will need to reinitialize the publish service on the server. To do this without bringing the server down, navigate to: https://server:port/rdm/publish/initialize

Feedback