Rational DOORS schema

The Rational® DOORS® schema closely matches the Rational DOORS module structure.

You can use a predefined schema which is generic and valid for all Rational DOORS formal modules. Use this predefined schema when you are working with either the entire view or with predefined attributes of the view that do not require extracted user-defined attributes. When user-defined attributes are required, use the schema discovery wizard in Document Studio to create a Rational DOORS schema.

Queries and attributes in the predefined schema

The following queries and attributes are in the predefined schema.
Table 1.
Query Results Attributes
Module A single entity, the module specified in the data source configuration.

Name: the module name
Description: the module description
Baseline: the module version

Module/Attribute The list of module-level attributes for the module.

Name: the attribute name
_value: the attribute value

Module/Discussion The list of discussions for the module. -
Module/Discussion/Attribute The list of attributes for a discussion.

Name: the attribute name
_value: the attribute value

Module/Discussion/Comment The list of comments for a discussion. Status, Text, Changed Status, Created On
Module/View A single result, the view defined for each Rational DOORS data source in the document specification. Name: the name of the view
Module/View/Column The list of column names for the selected view.
Note: This query provides a list without requiring you to iterate the module objects. The result does not contain column data.

Name: the name of the column  
_value: empty

Module/Object The list of all objects with the specified version of the modules that are filtered and sorted by the selected view. Any attribute elevated by the user in the schema discovery wizard.

Object Identifier
Object Text
Object Heading
Absolute Number
Object Level

Module/Object/Attribute The list of attributes for the object if the query is in the context of a module/object query. Otherwise, the list of all attributes for all objects in the module are included.

Name: the attribute name
_value: the attribute value

Module/Object/Column The list of columns in the selected view for the current object.

Name: the column name
_value: the column value for the current Object

Module/Object/Table A single result (the Rational DOORS table) if the object is a table header. No results are included if the current object is not a Rational DOORS table. -
Module/Object/Table/Row The table rows. -
Module/Object/Table/Row/object A collection of objects; the cells for the current row. Same attribute list available as for the module/object query.

Object Identifier
Object Text
Object Heading
Absolute Number
Object Level

Module/Object/External Link A collection of external links for the object. URL: the URL of the external linked entity and other attributes as defined in Rational DOORS
Module/Object/Link A list of Rational DOORS links for the object. -
Module/Object/Link/Attribute The attribute list for the link.

Name: the attribute name
_value: empty

Module/Object/Link/Linked Object The list of linked objects. -

Images

Images are extracted from a Rational DOORS module with the values for the attribute. You cannot query for the images only.

To configure the size of the extracted images, specify the image max width and the image max height properties. These properties can be specified in two places:
  • Element format information defines the size for the images contained in that template element. Available for text template elements only.
  • Document specification metadata defines the size for the images in all templates. The element format values override these global values.

OLE objects

You can extract embedded objects, such as Object linking and embedding (OLE objects), from a Rational DOORS data source. OLE objects are always rendered as images in HTML, PDF, and XSL-FO outputs, because those formats do not support OLE objects.

For Microsoft Word output, you must set the OLEs as static images property in the metadata section of the document specification.
  • If the OLEs as static images property is set to true, OLE objects are included in the output document as static images.
  • If the OLEs as static images property is set to false, a ref folder is generated in the same location as the Microsoft Word output document.
The ref folder contains .rtf files for the OLE objects. For each OLE object exported, the Microsoft Word output has one included field pointing to an .rtf file. Because IBM® Rational Publishing Engine cannot update Microsoft Word fields, the included fields are not visible when the Microsoft Word document is open. To make the fields visible, take one of the following actions:
Action Result
Select the entire document content and use the Update fields function in Word. The OLE objects are displayed in the document. The document is not self-contained.
Use the updateFields macro provided by Rational Publishing Engine. The OLE objects are displayed in the document. The document is not self-contained.
Use the insertOLEs macro provided by Rational Publishing Engine. The OLE objects are displayed in the document. The document is self-contained.
Use the rpe or insertOLEs macros provided by Rational Publishing Engine. The OLE objects are displayed in the document. The document is self-contained.
Note: If you move a document that is not self-contained to another computer, you cannot edit the OLE objects. To prevent this problem, run the rpe or insertOLEs macros.

Tables

Rational DOORS tables are not extracted automatically; you must explicitly query for them. This manual approach provides fine-grained control over the table format. The table is created only for Rational DOORS objects that start a table.

An example of a query that extracts a table:

Container DOORS 1 $1 Module/Object
Paragraph
Text
Module/Object/Object/Text
Table DOORS 1 $2 Module/Object/Table
Row DOORS 1 $3 Module/Object/Table/Row
Cell DOORS 1 $4 Module/Object/Table/Row/Object
Text
Module/Object/Table/Row/Object/Object Text

Note: The table cells do not have a dedicated type in the Rational DOORS schema. To retrieve the cell content use the Module/Object/Table/Row/Object query. Objects that are table cells have an Object Text attribute that combines the Object Heading and Object Text.

Rational DOORS external links

The Module/Object/External Link query retrieves information related to Rational DOORS links. The information consists of the URL of the external entity and a set of other attributes defined for the external link.

Rational DOORS links

Use queries to retrieve information related to Rational DOORS inner links. The inner links create a link between related information. For example, create a link from a user requirement to the design features. You can query on object links or linked objects.

Recursive retrieval

To follow Rational DOORS links recursively, set Recursive Level property to a non-zero value in the Properties view. This follows the links from the initial object and from all its linked objects up to the specified recursive level.

Note: Following links is a time-consuming process. Because each object typically has many links, the number of objects processed increases exponentially with each level. To save time, use the native filter to reduce the number of links that are followed.

Native filtering

You can define native filters on link queries. Using these filters reduces the number of links to be processed and thus reduces the time to generate the document.

Filtering by direction

The syntax for filtering all the in links or out links is:

Link direction in|out

Filtering by link module

The syntax for filtering all the links through a link module is: Link module link_module_path_and_name

The filter is case-sensitive.

The following example filters all links from a Link Module 1:

Link module /Demo/Car/Link Module 1

Filtering by target module

The syntax for filtering all links to or from a specified module is: Link analyze module target_module_path_and_name

The following example filters all links between the analyze module and system requirement module: Link analyze module /Demo/Car/System Requirements

Combining native link filtering

You can combine the filters in a native filter tab. Each filter must be on its own line.
For example, in the native filter tab, type the filter as:

Link direction out.
Link analyze module /Demo/Car/System Requirements.

What cannot be extracted

A Rational DOORS data source in Rational Publishing Engine is defined by module, baseline, view. You cannot query the baseline list or the list of views for the module. The Rational DOORS data source is defined by the module, baseline, view. Extracting data from more than one module, or baseline, or view can be done one of following ways:

Feedback