The options for the reporter.exe commands are listed. These options also include Command-line example. The IBM® Rational® Rhapsody® ReporterPLUS CLI options include the following:
For some examples of how the "/scope" command is used, see the Command-line example section.
Any of these three parameters can be used with any of the options, listed previously.
/$param-name $param-value (for example, /ft HTML)
/$param-name=$param-value (for example, /ft=html)
/$param-name:$param-value (for example, /ft:HTML)
The following guidelines describe the preferred uses for the command-line options for Rational Rhapsody ReporterPLUS CLI:
With the /q=Yes (quiet=Yes) option,
the developer must also use /m, /l, /t, /fn,
and
/ft. If any option is not included
in the command, Rational Rhapsody ReporterPLUS terminates
and displays an error message. The use of /s is optional
in either case. If /s is not provided, the default
is the full scope.
The use of /d is optional when the developer runs the product CLI with a /q=no.
If the developer runs the product CLI with /q=Y, that option overrides /d and does not display generated document.
If the developer does not use /q, then the product CLI prompts the developer with a wizard asking for the following:
If the developer passes the scope indicator with /s along with a string to indicate the full path name to a package, then only that package, the model elements contained within, and sub packages are loaded, as shown in this example:
/s TopPkg:TargetPkg:Package
TopPkg is the start
of the path defining the scope.
TargetPkg is
the package within TopPkg.
Package is
the metatype.
If the scope is not passed, the full model is loaded.
If the developer does not use the /l command, then by default, the product license is checked, and if it is not available, the Rational Rhapsody ReporterPLUS CLI terminates and displays an error message.
The following example shows a full example of the reporter.exe command with the options and parameters:
reporter.exe/m
C:\Rhapsody\Benchmark\Sample1\Benchmark1\benchmark1.rpy\
/s Package:ATMTransactionCtrl:Subsystems:benchmark1\
/t C:\Rhapsody\Templates\Drawing.tpl\
/ft html\
/fn C:\Test.html\
/q yes
In this example, the model to be used is identified with the "/m" command.
The scope of the model to be loaded is defined with "/s" command.
The template file name to be used is identified with the "/t" command.
The type of the document to be generated is defined with the "/ft" command.
The output file to be generated is defined with the "/fn" command.
The CLI runs in silent mode and does not show the document generated because of this command: /q yes.