Type | Value | Description |
---|---|---|
Type | Word | The type of output being generated. You cannot edit this field. |
Driver | Telelogic.Word.Driver | The name of the HTML driver that generates the output. You cannot edit this field. |
Path | File path | The path to save the generated output. You can use a path that is relative to the document specification. |
Stylesheet | Filepath | The path to the style sheet file.
You can use a path that is relative to the document specification. You
can use the following Microsoft Word
document types as style sheets:
|
Username | String | Optional. User name to login into
the data source application. If there are authentication errors
and the Ignore data source configuration errors property
is set to true, the document generation continues.
If there are authentication errors and the Ignore data
source configuration errors property is set to false,
the document generation cancels. See Run time metadata properties reference for
more information about the Ignore data source configuration
errors property. For more information about how user names and passwords are stored, see Security considerations for IBM® Rational Publishing Engine. |
Password | String | Optional. Password to login into the
data source application. If there are authentication errors and
the Ignore data source configuration errors property
is set to true, the document generation continues.
If there are authentication errors and the Ignore data
source configuration errors property is set to false,
the document generation cancels. See Run time metadata properties reference for
more information about the Ignore data source configuration
errors property. For more information about how user names and passwords are stored, see Security considerations for IBM Rational Publishing Engine. |
Authentication | basic, form, oauth, oauth-oslc | Optional. The authentication type for connecting to the data source. If no authentication type is specified, each type is tested until the correct type is found. If there are authentication errors and the Ignore data source configuration errors property is set to true, the document generation continues. If there are authentication errors and the Ignore data source configuration errors property is set to false, the document generation cancels. See Run time metadata properties reference for more information about the Ignore data source configuration errors property. |
Accept header | image/jpeg, text/html, application/xml, */* | Optional. A specific type of resource that is retrieved from the data source. |
Macro | Name | A tool that updates the data in a Microsoft Word output document. |
Bidi | true, false | Enter true when the language you are generating the output into is a bidirectional language, like Arabic. |
Update fields | true, false, progressive | Instead of opening the Microsoft Word
output after the document generation is complete and updating the
fields yourself, you can have Rational Publishing Engine update
the fields while the document is being generated. When set to true,
the fields are updated in the output at the end of the document generation
process. When set to false, the fields are
not updated in the output. When set to progressive,
the fields are updated as they are encountered during the document
generation process and the table of contents is updated at the end
of the document generation process. progressive generates
the document the most quickly, but is to be used when all of the fields
in the document come from the template itself rather than from a stylesheet
or another included file.
Note:
|
Exclude fields | field_code_1, field_code_2, ... | A list of field codes that are not to be updated when the Update fields property is set to true or progressive. Separate multiple field codes with commas. You might use the Exclude fields property when post-processing commands already include running macros that update the fields, such as table of contents fields. To prevent the unnecessary duplication of effort, you can exclude those fields from the Rational Publishing Engine update. |
Multipart | STATIC, DYNAMIC | Breaks Microsoft Word
documents into chunks to reduce the size of memory being used at one
time to generate the document. When set to STATIC, the output is built when it is serialized on the disk, which means that the output is converted into a storable format across a network. Large documents can be generated if the heap size is large enough to accommodate the memory usage. When set to DYNAMIC, the output is built as Rational Publishing Engine processes the input for each section divided by a section break element. Sections that contain region elements are serialized on the disk at the end of document generation. |
Fit tables to page | true, false | When set to true, tables that are
wider than the page are adjusted so that they fit within the page.
If you choose to set Fit tables to page to true,
you must also set these properties:
Important: Even with Fit tables to page set
to true, the property might be ignored. Microsoft
Word does not handle column widths in the same manner for all documents,
so Rational Publishing Engine settings
might not be applied as expected.
|