Runtime metadata properties reference

Edit online

The document specification contains noneditable data that is generated by IBM Engineering Lifecycle Optimization - Publishing (PUB) for informational purposes and editable data for configuring the document-style report generation. The runtime metadata properties can be set in the Document Specification view under Runtime by selecting Metadata.

Table 1. Runtime 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: Engineering Publishing
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 PUB 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 PUB 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`, `tr`	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) Turkish (tr)
Image max width	`Number`	The maximum width in pixels of each image in the output document-style reports. 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-style report. 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-style report.
Image max height	`Number`	The maximum height in pixels of each image in the output document-style reports. This property also controls the maximum height of OLEs in Microsoft Word document-style reports. If the height of an image exceeds the specified Image max height value, the image is proportionally resized in the generated document-style report. 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-style report.
OLEs as static images	`true`, `false`	Controls how PUB processes IBM Engineering Requirements Management 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 DOORS OLEs, are deleted at the end of document-style report 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.
Ignore invalid data errors	`true`, `false`	When set to true, ignores the invalid XML or JSON data that is returned from the point product and continues to generate the document-style report. When set to false, document-style report generation is aborted.
Non Unicode fonts	`font_name`	For DOORS data sources, you can specify fonts that are sent to 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-style report generation process is to be ended if the pre command fails.
Post-command	`String`	The postcommand runs commands after the document specification is published. Postcommands 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`, document-style reports are generated by completing the process in this order without overlap: Document-style report generation starts Template 1 is processed. Data for data source 1 is read. Data from data source 1 is processed. Data for data source 2 is read. Data from data source 2 is processed. Template 2, 3... is processed. Document-style report generation ends When set to `true`, document-style reports are generated by completing the process in this order: Document-style report generation starts Templates are processed as two parallel processes that happen concurrently: Process 1: Data source 1 data from template 1 is read. Data source 2 data from template 1 is read. Data source 1 data from template 2 is read. Data source 2 data from template 2 is read. ... Process 2: Data source 1 data from template 1 is processed. As soon PUB 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. Data source 1 data from template 2 is read. As soon PUB 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. ... Document-style report 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.