Creating configuration files for exporting Word and Excel test artifacts

When you export Word or Excel test artifacts, you must have a configuration file to define how to map the Word or Excel content to XML that can create quality management artifacts.

About this task

The configuration file describes the content of the exported documents to be imported into quality management enabling correct mapping of the document content to the fields in quality management records. That mapping enables the generation of coherent XML files for importing to quality management.

Sample configuration files are available with the installed product along with the Excel or Word documents that they map from. These configurations are developed from customer-submitted specifications and tested with each release to ensure that they function as designed. Although configuration files can be saved anywhere on the file system, it is a good practice to align them with the documents that they describe. The sample configuration files and associated documents are located in these locations:

  • Excel export utility samples: RQM Excel Import Utility installation directory\Samples By default, the Excel export utility is installed in C:\Program Files\IBM\RQMExcelImporter.
  • Word export utility samples: RQM Excel Import Utility installation directory\Samples. By default, the Word export utility is installed in C:\Program Files\IBM\RQMWordImporter.
Assumptions
The quality management Excel and Word export utility is built on the Engineering Test Management Reportable REST API. The configuration file is constructed according to assumptions about the source files in Excel or Word:
  1. Each line is a separate entity: Previous lines do not modify subsequent lines, and each line is significant only to itself.
  2. The left side of an equal sign (=) contains a combination of keywords and quality management artifact names and fields that are separated with periods.
  3. The right side of the equal sign indicates the location of the data that goes into the fields on the left of the equal sign.
  4. Blank lines and lines that start with two forward slashes (//) are ignored. Comments can be inserted after // on an otherwise blank line.
  5. External IDs can be specified for a resource in the configuration file that uses the XLSArtifactID keyword (in Excel only)
  6. Date and time values are represented in XML as dateTime values.
Supported resources
The Word and Excel export utility supports these resources:
  • category
  • category type
  • configuration
  • executionresult
  • executionworkitem
  • iteration
  • keyword
  • labresource
  • remotescript
  • requirement 1
  • resourcegroup
  • testcase
  • testphase
  • testplan
  • testscript
  • testsuite
See the Quality Management Schema Documentation for the resource properties. See this Tip to determine the XML representation of a resource.
1 When Quality Management requirements reference resources in Requirements management, the following configuration is required:
  1. The Quality Management project area in Engineering Test Management must have a "uses and requirements" association to a Requirements Management project area in Rational® Requirement Composer. Multiple Quality Management project areas can be associated with a single Requirements Management project area.
  2. Set the following Requirement (com.ibm.rqm.requirement.service.internal.RequirementService) advanced server configuration properties (see Configuring advanced properties):
    • Requirements Composer User Name
    • Requirements Composer User Password

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki