Run time metadata properties reference

The document specification contains non-editable data that is generated by Rational® Publishing Engine for informational purposes and editable data for configuring the document generation. The run time metadata properties can be set in the Document Specification view under Runtime by selecting Metadata.
Table 1. Run time properties
Property Value Description
Date Month Day, Year The date when the document specification was created. This field cannot be edited.
Time Hour:Minute:Second am or pm The time when the document specification was created. This field cannot be edited.
Client Application_name The application that is used to create the document specification. This field cannot be edited.

Example: Rational Publishing Engine

Machine Machine_name The name of the computer on which the document specification was created. This field cannot be edited.
Build YYYYMMDD_#### The build number of the application that is used to create the document specification. This field cannot be edited.
Version 1, 2 The template version that is used to design the template. This field cannot be edited.
Description String Description of the document specification.
Data formatting mixed, source, or template Controls how Rational Publishing Engine formats rich data from the data source:
  • Mixed: Mixes source and template formatting.
  • Source: Discards template formatting and preserves data source formatting only.
  • Template: Discards source formatting and preserves template formatting only.
Missing data text <data attribute not found> or a String Placeholder text that is used by Rational Publishing Engine when a data attribute is not found in the data source. You can use the default or customize your own text.
Date pattern YYYY-MM-DD HH:mm:ss, YYYY-DD-MM HH:mm:ss The format in which combination dates and times are to be rendered in the output.
Time pattern HH:MM:SS, HH:MM The format in which times are to be rendered in the output.
dateTime pattern YYYY-MM-DD HH:MM:SS, YYYY-DD-MM HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-DD-MM HH:MM The format in which combination dates and times are to be rendered in the output.
Output locale cs, en, es, fr, de, hu, it, ja, ko, pl, pt_BR, ru, zh_CN, zh_TW The output locale to be used for default date formats if the locale must be different from the system locale.
  • Czech (cs)
  • English (en)
  • Spanish (es)
  • French (fr)
  • German (de)
  • Hungarian (hu)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Polish (pl)
  • Portuguese (pt_BR)
  • Russian (ru)
  • Simplified Chinese (zh_CN)
  • Traditional Chinese (Taiwan) (zh_TW)
Image max width Number The maximum width in pixels of each image in the output documents. This property also controls the maximum width of OLEs in Microsoft Word documents.

If the width of an image exceeds the specified Image max width value, the image is proportionally resized in the generated document. If the specified Image max width or the actual width of the image exceeds the width of the page, the image is proportionally resized to fit the page in the generated document.

Image max height Number The maximum height in pixels of each image in the output documents. This property also controls the maximum height of OLEs in Microsoft Word documents.

If the height of an image exceeds the specified Image max height value, the image is proportionally resized in the generated document. If the specified Image max height or the actual height of the image exceeds the height of the page, the image is proportionally resized to fit the page in the generated document.

OLEs as static images true, false Controls how Rational Publishing Engine handles Rational DOORS® OLEs:
  • True: OLEs reach the output as static images
  • False: OLEs are preserved in the output. You can use this option for Microsoft Word output only.
Clean referenced files true, false When set to true, the reference files that are stored in the ref folder, which contain Rational DOORS OLEs, are deleted at the end of the document generation and are not included in the Microsoft Word documents. The size of the Microsoft Word document is smaller when this property is set to true.
Ignore data source configuration errors true, false When set to true, all errors that are generated from issues with the data source configuration element are ignored. When set to false, you are prompted to correct the errors.
Non Unicode fonts font_name For Rational DOORS data sources, you can specify fonts that are sent to Rational DOORS when data is being extracted. You can list more than one font name by separating them with commas.
Pre-command String The pre-command prepares the data before the publishing the document specification. Pre-commands must be a single line value.
Stop on pre-command failure true, false Specifies whether the document generation process is to be ended if the pre-command fails.
Post-command String The post-command runs commands after the document specification is published. Post-commands must be a single-line value.
Data read ahead true, false Default value: false

A property called Allow read ahead is available for each data source, which gives the generation permission to use the Data read ahead property. The Allow read ahead property is defined in the template and cannot be modified in the document specification. The Allow read ahead property must be set to true in the template to apply the Data read ahead property in the document specification.

Note: Data read ahead cannot be set to true if a template includes native filters that have variable calculations for a data source.
When this property is set to false, documents are generated by completing the process in this order without overlap:
  1. Document generation is starts
  2. Template 1 is processed
    1. Data for data source 1 is read
    2. Data from data source 1 is processed
    3. Data for data source 2 is read
    4. Data from data source 2 is processed
  3. Template 2, 3... is processed
  4. Document generation ends
When set to true, documents are generated by completing the process in this order:
  1. Document generation is starts
  2. Templates are processed as two parallel processes that happen concurrently:
    Process 1:
    1. Data source 1 data from template 1 is read
    2. Data source 2 data from template 1 is read
    3. Data source 1 data from template 2 is read
    4. Data source 2 data from template 2 is read
    5. ...
    Process 2:
    1. Data source 1 data from template 1 is processed
    2. As soon Rational Publishing Engine finishes processing data source 1 of template 1 and data source 2 is read in Process 1, data from data source 2 starts being processed
    3. Data source 1 data from template 2 is read
    4. As soon Rational Publishing Engine finishes processing data source 1 of template 2 and data source 2 is read in Process 1, data from data source 2 starts being processed
    5. ...
  3. Document generation ends
Data request retry count Number Default value: 0

The number of times the data request is attempted after the first failure.

Data request retry interval Number Default value: 3000 milliseconds

If a value 1 or higher is entered for the Data request retry count property, the amount of time in milliseconds between request attempts can be set for the Data request retry interval property. If the Data request retry count value is 0, then the Data request retry interval value is ignored.


Feedback