Designing templates with Engineering Requirements Management DOORS as a data source

Report designers can use Document Studio to import data source schemas and build report templates.

1. Review Designing document templates for an overview of the template development process.
   Start planning the structure of your document-style report and the data that might be included.
   For example, decide whether the final document-style report will be generated from one template or from multiple template files that each contain reusable pieces of content.
2. In Create a document template.
3. Identify a data source schema from your data source.
   There are two ways to add a data source: through the DOORS Schema Discovery wizard or the Data Source Schema wizard. To add a data source using the Data Source Schema wizard:
   1. In Document Studio, click Data > Add Data Source .
   2. In the Predefined field, select the DOORS database schema.
   3. In Type, select the type of the schema from the list.
      For DOORS , select DOORS.
   4. Edit the Schema field if needed or click Browse to select the path for the schema file.
   5. If the resource is on a secured server, specify the Username.
   6. If the resource is on a secured server, specify the Password.
   7. Select the Authentication Type from the list.
      For DOORS , the authentication type is OAuth-OSLC. If you do not select OAuth-OSLC, each authentication type is tested until the correct type is found, which might increase document-style report generation time.

   To add a data source using the DOORS Schema Discovery wizard:

   1. In Document Studio, click Data > Schema Discovery > DOORS Schema Discovery.
   2. Specify the connection details:
      • To use a running instance of DOORS , select Use running DOORS instance.
      • To run DOORS in the background, select Run a new background DOORS process. Specify the username, password, database, and path to doors.exe.
   3. Select a view:
      • Database view
      • Project view
   4. Click Next.
   5. Select the attribute type:
      • To add attributes to the main objects, Module/Object schema elements, select Module and objects attributes.
      • To add attributes for linked objects, Module/Object/Link/Linked schema element, select Attributes of linked objects.
   6. In the DOORS Module Selection window, select a module from the DOORS database structure and click Next.
   7. In the DOORS Baseline window, select a baseline for the module. The baseline that you select determines which attribute set to use.
   8. In the DOORS Attributes window, the following attribute information is displayed:
      • Attribute name: Lists attributes available in the selected baseline.
      • Scope: Displays the scope of the attribute as a module or an object.
      • Elevation name: The elevated name of the attribute is the name that is used in script expressions. A valid name is generated from the DOORS attribute name to prevent entering an invalid value. An elevated attribute allows direct access to that attribute value from a Module/Object context. Nonelevated attribute values are available only from a Module/Object/Attribute context.

      Select a checkbox to specify an attribute or Select All to select all attributes. The Deselect All clears all attributes. Click Next.

   9. In the DOORS Views and Columns window, select the view. Then select the checkbox for a column name to select the column or Select All to select all column names. Click Next.
      Note: An elevation name of the column displays in the Elevation Name column. You can elevate columns from any number of views. You can elevate the attributes later while designing the template. Attributes add declarative information to elements beyond the usual predefined keywords. User-defined DOORS attributes are only accessible through the Attribute nodes in the standard DOORS schema file. To use these attributes, the attribute values can be elevated as XML attributes by using the XML schema discovery wizard. An attribute might have a single occurrence, for example, Module Name, and the Last Modified On property. Attributes might apply to an object, but have multiple occurrences, such as the Object Heading and Object Text.
   10. In the Select Schema Options window, enter the details for the following fields:
       • Select Schema Location: Click Browse to select the location to save the data source schema.
       • Data Source Schema ID: Enter the ID for the data source schema.
       • Select the Add Data Source Schema to the current Template check box to add this schema to the open template. Click Next.
       • Save the schemas to reuse them in other templates without running the Schema Discovery Wizard again.
   11. Review the information in the summary window and click Finish.
4. Work with attributes.
   You can discover which object attributes are present in the DOORS Module, and then assess whether they must appear in your IBM Engineering Lifecycle Optimization - Publishing report. Use the Edit > Attributes menu selection to access the list of attributes included in the module.
5. Add elements to the template.
   The product includes a comprehensive set of template elements that you can use to structure your document-style report. You can drag elements into the template content editor. For example, you can add a Container element to hold several paragraphs. Each paragraph might be controlled by a test condition that associates it only with specific data. For more information, see Template elements in the Palette view and Adding elements to a template.

   Container elements

   You can use container elements instead of tables for DOORS Analyst diagrams that are contained in a 1x1 table.

   Image elements

   Images are extracted from a 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.

   Table elements

   You might not be able to reproduce a DOORS table in Engineering Publishing exactly as it looks like in DOORS ; you can use available DOORS table attributes and generate a new table.

   Learn More: Use DOORS schema wizard to extract information about the DOORS tables. Example: TableCellWidth – Width of Cell in screen pixels. There are 2 ways to extract column information from DOORS :

   • Using module/object/column to get the column names and values in an object query. This is useful when the DOORS data is iterated by object.
   • Using module/view/column to get the column names from the DOORS view used for document-style report generation. Iterating by View is useful when the columns defined in the current view, and their properties, are needed. You can use PUB sample templates to test these methods.
     Draft comment:
     Is Iterating by View a specific option you can select somewhere? KK 1/16/12
     Note: To access column data use module/object/column/(@Column Text) in the query.

   Draft comment:
   What is this saying? You can’t recreate a table in RPE to look exactly as it did in DOORS but you can go back to DOORS and change some things to make your DOORS table look more like what comes out of RPE? 1/16/12

   If you have cells in DOORS tables that span multiple rows, PUB generates the first cell and the remaining cells in the span are removed.

   See Adding a table element for more information about tables.

6. Use queries, attributes, and variables to add data to a template. These items specify which pieces of information are generated in the report.
   Queries in DOORS start with the root element (module), continues with its child element (Object), then with the child attribute of the object. For example, Module/Object/Attribute/Name. See Engineering Requirements Management DOORS schema for more information.
7. Add formatting and styling to the elements to control how they display in the output.
8. Create filters to narrow the data that is pulled into the report.
   You can use filters, which are detailed versions of the general data source URI, to point to specific subsets of data so that Engineering Publishing ( PUB) does not try to retrieve more information than necessary from the data source during report generation. These filters must be broad enough to retrieve all necessary data referenced by the template or the generated report cannot include complete data.
   You can define native filters on link queries. See Example of Engineering Requirements Management DOORS native filters for more information.
9. Create sorts to organize the data in your report.
   For DOORS , native sort text must be in the format of the DOORS sort. See Example: Native sorts in Engineering Requirements Management DOORS for more information.