Launcher command-line options

Edit online

You can run the IBM Engineering Lifecycle Optimization - Publishing Launcher from a command-line prompt. You can also create a definitions file.

PUB_install_dir\launcher\rpe-launcher.exe

-option
parameter

About using the command line

When you are running the Engineering Publishing Launcher from a command-line prompt, remember that:

If the Launcher remains open while you run commands, you can view any errors that might occur in the Console view.
There is not any returned code to indicate the process result.
All errors, such as unconfigured data sources or output formats, are suppressed.
There is not any feedback or messages provided to the caller process.
The command line is configured through the .ini files, which means that:
- Log files are shared between multiple concurrent instances.
- All document generations have the same settings, including if the document generation is remote or local. You cannot specify local or remote document generation through a flag.
The command line is designed for local generation of single document generation launches.
No document specification changes can be made at run time.

Command-line options

Table 1. Valid options to use with the rpe-launcher command
Option	Description
`-err publish`	Be prompted during the publishing process if all of the data sources are not configured. When this parameter is omitted, the prompts are suppressed.
`-makedocspec definition_file.xml`	Include this parameter with a path to a file that definitions file to create a document specification.
`-noresult`	Hides both the Document specification configuration window that prompts you during publishing to specify details for the document specification and hides the Results window that displays the links to each output format.
`-path filepath_filename.dsx`	To open a file in the Launcher, include this parameter with the path to a document specification file.
`-publish filepath_filename.dsx` `-publish -makedocspec filpath_filename.dsx`	Include this parameter with the path to a document specification file to generate the report without using the Document Specification configuration wizard. You must also set the Launcher Use Publish Wizard preference to No. See Setting the document execution preferences. With the -makedocspec parameter, the document specification is created and published from the definition file.
`-wizard` `-wizard definitions_file.xml`	Minimizes the Launcher and starts the Configure and Generate Document wizard in the foreground. You can also add the path to a definition file, which preconfigures the data source in the template that is selected in the wizard.

Example definition file

You can specify a definition file with the -makedocspec option to generate a document specification from the command line.

A definition file is structured with three main sections:

The docspec section includes the file name and location that the document specification is created in.
Each datasource section includes the details for the data sources and their properties.
Each template section lists a template path to specify in the document specification.
Note: You cannot specify variables in a definition file. Consider using the Java™ API instead of a definitions file, where you can configure variables and properties for templates and document specifications.

The following example shows a sample definition file that can be used as a template for configuring IBM Engineering Requirements Management DOORS® data sources.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definition xmlns="http://www.ibm.com/rational/rpe/definitionFile" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

	<docspec>c:\temp\generatedDocSpec.dsx</docspec>

	<datasource name="DOORS 1" type="DOORS">
		<property name="URI">/demo/car/System requirements</property>
		<property name="baseline">Currentname="baseline">Current</property>
		<property name="view">Industrial</property>
	</datasource>

	<template>c:\temp\sampleTemplate.dta</template>
</definition>