You can use the document generation wizard to configure
the report requirements.
Before you begin
The correct
Rational Rhapsody project
must be opened and the
Rational Rhapsody web server
must be running before you publish your document. When the
Rational Rhapsody project is
open and you generate a document from
Rational Publishing Engine, the
Rational Rhapsody
web server is started automatically. If you close the web server window, on subsequent document
generations,
Rational Publishing Engine cannot
restart the server. You can manually run a batch file to start the server again without restarting
Rational Publishing Engine:
Rational_Rhapsody_HOME/ApplicationServer/startserver.batNote: If you have a
long REST request URL, the request might not be passed to the Rational Rhapsody server,
which prevents document generation from a Rhapsody model with package nesting level higher than 3.
To work around this problem, on the Rational Rhapsody web server,
modify the web server configuration to increase the allowed URL length.
Procedure
- In either the Document Studio or the Launcher
application, open the document generation wizard by clicking .
- In the Templates section,
the templates already listed in the document specification display.
To add a template:
- Select the location of the templates to add:
- From the central library: To select templates stored in Document Builder
- From local or remote file: To select a
local or remote templates, you can either enter a URL to a template
or click Browse to select a template.
- Select one or more template to add.
- If you selected From the central library and selected templates from the
Document Builder,
click Add selected to add the templates to the document specification.
- If you selected From local or remote file and
entered a URL to an individual template, click Add URL to
add the template to the document specification.
- If you selected From local or remote file and
browsed to add templates, when you click Open,
the templates are added to the document specification.
- Optional: Repeat to add additional templates
from other locations.
- Optional: Reorder the templates in the document
specification by selecting a template and clicking Up or Down.
- Click Next. After
you add a template, the data sources and variables that are specified
in the template are also added to the wizard.
- In the Data sources section,
configure each data source.
Note: - If a default value exists for a data source or a default
URI value has already been entered, the data source displays
as configured and the default value is used in the output unless another
value is selected.
- If you move past the Data sources section and then click Back to
make additional changes to a data source, the section always opens
to the first data source in the list.
- Select a data source from one of
the following locations:
- Manual configuration: To select a local or remote data source because no
other configuration information exists for this data source in the configuration layer
- Load from Configuration Layer: To select
a value from the configuration metadata that was entered for the data
source in the template
- Depending on the selection you made in
the previous step, you can either select a value for the data source
by entering a URL, clicking Browse to select
one, or select a value from the configuration layer. Whether the value is a URL or is a value contains a URL, the
typical data source URL for Rational Rhapsody can
be determined by:
- Identify the data source schema URL, which was used to add the
schema to the template.
- From the data source schema URL, remove the ?metadata=schema suffix.
Example:
- Data source schema URL: https://server:port/Rational/Rhapsody/?metadata=schema
- Data source URL: https://server:port/Rational/Rhapsody/
You are not required to use the same URL as the data source
schema. You can point to a different Rational Rhapsody repository
to access the data contained within it, because Rational Rhapsody repositories
all use the same REST API.
- If the resource is in a secured server, specify
the User name.
- If the resource is in a secured server,
specify the Password.
- Select the Authentication
Type from the list. If you do not select a type, each type is tested until the correct
type is found, which might increase document generation time.
- Optional: Enter an accept
header. The default value is application/xml,
*/*.
- Optional: If you want to
apply the credentials you entered to each data source, select the Apply
these user name and password values to every configured and unconfigured
data source option.
- Click Next
- In the Variables section,
configure each variable.
Note: - If a default value exists for a variable, the variable displays
as configured and the default value is used in the output unless another
value is selected.
- If you move past the Variables section and then click Back to
make additional changes to a variable, the section always opens to
the first variable in the list.
- From the drop-down menu, select one of the following
options:
- Manual configuration: To enter any value for the variable because no
other configuration information exists for this variable in the configuration
layer
- From Configuration Layer: To select a value
from the configuration metadata you entered for the variable in your
template
- Enter or select a value for the configuration.
- Click Next.
- In the Output section,
select the output types to generate:
- Microsoft Word
- PDF
- HTML
- XSL-FO
- Optional: For the Save location,
click Browse to select a path to save the file
for each output type. You can edit the path to be a relative
path from the document specification. If a save location for the output
is not specified, the file is generated in a temporary location.
- Optional: For the Style sheet,
click Browse to select a style sheet to use
for each output type while generating the output.
- Optional: Microsoft Word
output only: For the Macro, enter the name
of the macro that is contained within the style sheet.
- Optional: To enter additional metadata or
configure other document properties that are not included in the wizard,
click Edit metadata properties.
- Click Next.
- Verify that the template and output information
in the summary window is correct.
- Select which action
to take when you click Finish:
- Run the document generation:
Generates the output types you specified.
- Run the document generation and
quit RPE: Generates the output types you specified and
closes the Rational Publishing Engine application
after you exit the Results window.
- Save and close this wizard
without generating the document: The document generation
wizard is closed and the Launcher application remains open.