Oracle Business Intelligence Publisher Report Designer's Guide

Setting Runtime Properties

The Runtime Configuration page enables you to set runtime properties at the server level. You can also set properties at the report level. If conflicting values are set for a property at each level, the report level will take precedence.

To set a property at the report level, select the report, and then select the Configure link. This will launch the Runtime Configuration page, displaying a column to enable update to the properties for the report and a column that displays the read-only values set for the server.

Note: In versions prior to 10.1.3.2 the Runtime Configuration properties administered through this page were set in a configuration file. This file is still used as a fallback if values are not set through this interface. However, please note that the file is not updated when you update the Runtime Configuration Properties page. For details about the file, see Configuration File Reference, Oracle Business Intelligence Publisher Administrator's and Developer's Guide.

Bursting Properties

If you are running BI Publisher on a multiprocessor machine or even a machine with a dual core single processor, you may be able to achieve even higher bursting throughput using the multithreading functionality for bursting.

To enable multithreading for bursting, set "Enable multithreading" to true and set "Thread count" to a number greater than one up to the number of processors or cores present on the machine.

Note that if the report delivery channel is File System, there will not be any considerable performance gain using multithreading. For delivery destinations other then file delivery, you should notice the performance gain.

Due to other processes that might be running on your system you may need to empirically determine what is the optimal setting for "Thread count." Try a series of tests by varying the setting "Thread count" to see what is optimal for your environment.

Important: Leave these settings at the defaults if your system does not have multicore processors or more than one processor. Setting "Enable multithreading" to True and "Thread count" to a number greater than the number of cores on the machine will lead to higher CPU usage without any gain in performance.


Property Name	Internal Name	Default Value	Description
Enable multithreading	bursting-multithreading-on	false	Set to "true" to enable multithreading during bursting. This property is for use only when running BI Publisher on a machine with multiprocessors or dual core single processors.
Thread count	bursting-thread-count	2	If Enable multithreading is set to "true", enter the number of concurrent threads you wish to have active during bursting. Do not exceed the number of processors or cores on the machine. Note that setting this value to the maximum may not necessarily achieve the best performance for your system.

PDF Output Properties

The following properties are available for PDF output:


Property Name	Internal Name	Default Value	Description
Compress PDF output	pdf-compression	True	Specify "True" or "False" to control compression of the output PDF file.
Hide PDF viewer's menu bars	pdf-hide-menubar	False	Specify "True" to hide the viewer application's menu bar when the document is active. The menu bar option is only effective when using the Export button, which displays the output in a standalone Acrobat Reader application outside of the browser.
Hide PDF viewer's tool bars	pdf-hide-toolbar	False	Specify "True" to hide the viewer application's toolbar when the document is active.
Replace smart quotes	pdf-replace-smartquotes	True	Set to "False" if you do not want curly quotes replaced with straight quotes in your PDF output.

PDF Security

Use the following properties to control the security settings for your output PDF documents:


Property Name	Internal Name	Default Value	Description
Enable PDF Security	pdf-security	False	If you specify "True," the output PDF file will be encrypted. You must also specify the following properties: Open document password Modify permissions password Encryption Level
Open document password	pdf-open-password	N/A	This password will be required for opening the document. It will enable users to open the document only. This property is enabled only when "Enable PDF Security" is set to "True".
Modify permissions password	pdf-permissions-password	N/A	This password enables users to override the security setting. This property is effective only when "Enable PDF Security" is set to "True".
Encryption level	pdf-encryption-level	0 - low	Specify the encryption level for the output PDF file. The possible values are: 0: Low (40-bit RC4, Acrobat 3.0 or later) 1: High (128-bit RC4, Acrobat 5.0 or later) This property is effective only when "Enable PDF Security" is set to "True". When Encryption level is set to 0, you can also set the following properties: Disable printing Disable document modification Disable context copying, extraction, and accessibility Disable adding or changing comments and form fields When Encryption level is set to 1, the following properties are available: Enable text access for screen readers Enable copying of text, images, and other content Allowed change level Allowed printing level
Disable document modification	pdf-no-changing-the-document	False	Permission available when "Encryption level" is set to 0. When set to "True", the PDF file cannot be edited.
Disable printing	pdf-no-printing	False	Permission available when "Encryption level" is set to 0. When set to "True", printing is disabled for the PDF file.
Disable adding or changing comments and form fields	pdf-no-accff	False	Permission available when "Encryption level" is set to 0. When set to "True", the ability to add or change comments and form fields is disabled.
Disable context copying, extraction, and accessibility	pdf-no-cceda	False	Permission available when "Encryption level" is set to 0. When set to "True", the context copying, extraction, and accessibility features are disabled.
Enable text access for screen readers	pdf-enable-accessibility	True	Permission available when "Encryption level" is set to 1. When set to "True", text access for screen reader devices is enabled.
Enable copying of text, images, and other content	pdf-enable-copying	False	Permission available when "Encryption level" is set to 1. When set to "True", copying of text, images, and other content is enabled.
Allowed change level	pdf-changes-allowed	0	Permission available when "Encryption level" is set to 1. Valid Values are: 0: none 1: Allows inserting, deleting, and rotating pages 2: Allows filling in form fields and signing 3: Allows commenting, filling in form fields, and signing 4: Allows all changes except extracting pages
Allowed printing level	pdf-printing-allowed	0	Permission available when "Encryption level" is set to 1. Valid values are: 0: None 1: Low resolution (150 dpi) 2: High resolution

PDF Digital Signature Properties

The following properties should only be set at the report level to enable digital signature for a report and to define the placement of the signature in the output PDF document. For more information on how to enable digital signature for your output PDF documents, see Implementing a Digital Signature, Oracle Business Intelligence Publisher Administrator's and Developer's Guide.

Note that to implement digital signature for a report based on a PDF layout template or an RTF layout template, you must set the property Enable Digital Signature to "True" for the report.

You also must set the appropriate properties to place the digital signature in the desired location on your output report. Your choices for placement of the digital signature depend on the template type. The choices are as follows:

(PDF only) Place the digital signature in a specific field by setting the Existing signature field name property.
(RTF and PDF) Place the digital signature in a general location of the page (top left, top center, or top right) by setting the Signature field location property.
(RTF and PDF) Place the digital signature in a specific location designated by x and y coordinates by setting the Signature field x coordinate and Signature field y coordinate properties.

If you choose this option, you can also set Signature field width and Signature field height to define the size of the field in your document.

Note that if you enable digital signature, but do not set any location properties, the digital signature placement will default to the top left of the document.


Property Name	Internal Name	Default Value	Description
Enable Digital Signature	signature-enable	False	Set this to "True" to enable digital signature for the report.
Existing signature field name	signature-field-name	N/A	This property applies to PDF layout templates only. If your report is based on a PDF template, you can enter a field from the PDF template in which to place the digital signature. For more information on defining a field for the signature in a PDF template, see Adding or Designating a Field for a Digital Signature.
Signature field location	signature-field-location	top-left	This property can apply to RTF or PDF layout templates. This property provides a list containing the following values: Top Left, Top Center, Top Right. Choose one of these general locations and BI Publisher will insert the digital signature to the output document, sized and positioned appropriately. If you choose to set this property, do not enter X and Y coordinates or width and height properties.
Signature field X coordinate	signature-field-pos-x	0	This property can apply to RTF or PDF layout templates. Using the left edge of the document as the zero point of the X axis, enter the position in points that you want the digital signature to be placed from the left. For example, if you want the digital signature to be placed horizontally in the middle of an 8.5 inch by 11 inch document (that is, 612 points in width and 792 points in height), enter 306.
Signature field Y coordinate	signature-field-pos-y	0	This property can apply to RTF or PDF layout templates. Using the bottom edge of the document as the zero point of the Y axis, enter the position in points that you want the digital signature to be placed from the bottom. For example, if you want the digital signature to be placed vertically in the middle of an 8.5 inch by 11 inch document (that is, 612 points in width and 792 points in height), enter 396.
Signature field width	signature-field-width	0	Enter in points (72 points equal one inch) the desired width of the inserted digital signature field. This applies only if you are also setting the properties Signature field x coordinate and Signature field Y coordinate.
Signature field height	signature-field-height	0	Enter in points (72 points equal one inch) the desired height of the inserted digital signature field. This applies only if you are also setting the properties Signature field x coordinate and Signature field Y coordinate.

RTF Output

The following properties can be set to govern RTF output files:


Property Name	Internal Name	Default Value	Description
Enable change tracking	rtf-track-changes	False	Set to "True" to enable change tracking in the output RTF document.
Protect document for tracked changes	rtf-protect-document-for-tracked-changes	False	Set to "True" to protect the document for tracked changes.
Default font	rtf-output-default-font	Arial:12	Use this property to define the font style and size in RTF output when no other font has been defined. This is particularly useful to control the sizing of empty table cells in generated reports. Enter the font name and size in the following format <FontName>:<size> for example: Arial:12. Note that the font you choose must be available to the BI Publisher processing engine at runtime. See Defining Font Mappings for information on installing fonts for the BI Publisher server and also for the list of fonts predefined for BI Publisher.

HTML Output

The following properties can be set to govern HTML output files:


Property Name	Internal Name	Default Value	Description
Show header	html-show-header	True	Set to "False" to suppress the template header in HTML output.
Show footer	html-show-footer	True	Set to "False" to suppress the template footer in HTML output.
Replace smart quotes	html-replace-smartquotes	True	Set to "False" if you do not want curly quotes replaced with straight quotes in your HTML output.
Character set	html-output-charset	UTF-8	Specify the output HTML character set.
Make HTML output accessible	make-accessible	False	Specify true if you want to make the HTML output accessible.
Use percentage width for table columns	html-output-width-in-percentage	True	Set this property to True to render table columns according to a percentage value of the total width of the table rather than as a value in points. This property is especially useful if your browser renders tables with extremely wide columns. Setting this property to True will improve readability of the tables.

FO Processing Properties

The following properties can be set to govern FO processing:


Property Name	Internal Name	Default Value	Description
Use BI Publisher's XSLT processor	xslt-xdoparser	True	Controls BI Publisher's parser usage. If set to False, XSLT will not be parsed.
Enable scalable feature of XSLT processor	xslt-scalable	False	Controls the scalable feature of the XDO parser. The property "Use BI Publisher's XSLT processor" must be set to "True" for this property to be effective.
Enable XSLT runtime optimization	xslt-runtime-optimization	True	When set to "True", the overall performance of the FO processor is increased and the size of the temporary FO files generated in the temp directory is significantly decreased. Note that for small reports (for example 1-2 pages) the increase in performance is not as marked. To further enhance performance when you set this property to True, it is recommended that you set the property Extract attribute sets to "False". See RTF Template Properties.
Pages cached during processing	system-cache-page-size	50	This property is enabled only when you have specified a Temporary Directory (under General properties). During table of contents generation, the FO Processor caches the pages until the number of pages exceeds the value specified for this property. It then writes the pages to a file in the Temporary Directory.
Bidi language digit substitution type	digit-substitution	None	Valid values are "None" and "National". When set to "None", Eastern European numbers will be used. When set to "National", Hindi format (Arabic-Indic digits) will be used. This setting is effective only when the locale is Arabic, otherwise it is ignored.
Disable variable header support	fo-prevent-variable-header	False	If "True", prevents variable header support. Variable header support automatically extends the size of the header to accommodate the contents.
Add prefix to IDs when merging FO	fo-merge-conflict-resolution	False	When merging multiple XSL-FO inputs, the FO Processor automatically adds random prefixes to resolve conflicting IDs. Setting this property to "True" disables this feature.
Enable multithreading	fo-multi-threads	False	If you have a multiprocessor machine or a machine with a dual-core single processor, you may be able to achieve faster document generation by setting this option to True. See
Disable external references	xdk-secure-io-mode	True	A "True" setting (default) disallows the importing of secondary files such as subtemplates or other XML documents during XSL processing and XML parsing. This increases the security of your system. Set this to "False" if your report or template calls external files. See Notes on Enabling Multithreading.
FO Parsing Buffer Size	fo-chunk-size	1000000	Sets the size of the buffer for the FO Processor. When the buffer is full, the elements from the buffer will be rendered in the report. Reports with large tables or crosstabs that require complex formatting and calculations may require a larger buffer to properly render those objects in the report. Increase the size of the buffer at the report level for these reports. Note that increasing this value will affect the memory consumption of your system.

Notes on "Enable Multithreading"

The amount of performance gain seen by enabling this setting will depend on how much the current system resources are utilized. On a system that has numerous users running and relatively high CPU utilizations, you will likely only see minor improvements after setting "Enable multithreading" to True. If the system is used by only a few users, or reports are scheduled sequentially one at a time, or the number of CPUs is more than the number of concurrent reports, then turning on multiple threads will speed up report generation.

Note that memory utilization is likely to increase once "Enable multithreading" is set to True.

Important: If you are running BI Publisher on a single-core, one processor machine, leave these multithreading configuration settings at the default value of False.

RTF Template Properties

The following properties can be set to govern RTF templates:


Property Name	Internal Name	Default Value	Description
Extract attribute sets	rtf-extract-attribute-sets	Auto	The RTF processor will automatically extract attribute sets within the generated XSL-FO. The extracted sets are placed in an extra FO block, which can be referenced. This improves processing performance and reduces file size. Valid values are: Enable - extract attribute sets for all templates and subtemplates Auto - extract attribute sets for templates, but not subtemplates Disable - do not extract attribute sets
Enable XPath rewriting	rtf-rewrite-path	True	When converting an RTF template to XSL-FO, the RTF processor will automatically rewrite the XML tag names to represent the full XPath notations. Set this property to "False" to disable this feature.
Characters used for checkbox	rtf-checkbox-glyph	Default value: Albany WT J;9746;9747/A	The BI Publisher default PDF output font does not include a glyph to represent a checkbox. If your template contains a checkbox, use this property to define a Unicode font for the representation of checkboxes in your PDF output. You must define the Unicode font number for the "checked" state and the Unicode font number for the "unchecked" state using the following syntax: fontname;<unicode font number for true value's glyph >;<unicode font number for false value's glyph> Example: Albany WT J;9746;9747/A Note that the font that you specify must be made available to BI Publisher at runtime.

PDF Form Template Properties

The following properties can be set to govern PDF templates:


Property Name	Internal Name	Default Value	Description
Remove PDF fields from output	remove-pdf-fields	False	Specify "true" to remove PDF fields from the output. When PDF fields are removed, data entered in the fields cannot be extracted. For more information, see Setting Fields as Updateable or Read Only.
Set all fields as read only in output	all-field-readonly	True	By default, BI Publisher sets all fields in the output PDF of a PDF template to be read only. If you want to set all fields to be updateable, set this property to "false". For more information, see Setting Fields as Updateable or Read Only.
Maintain each field's read only setting	all-fields-readonly-asis	False	Set this property to "true" if you want to maintain the "Read Only" setting of each field as defined in the PDF template. This property overrides the settings of "Set all fields as read only in output." For more information, see Setting Fields as Updateable or Read Only.

Flash Template Properties

The following properties can be set to govern Flash templates:


Property Name	Internal Name	Default Value	Description
Page width of wrapper document	flash-page-width	792	Specify in points the width of the output PDF document. The default is 792, or 11 inches.
Page height of wrapper document	flash-page-height	612	Specify in points the height of the output PDF document. The default is 612, or 8.5 inches
Start x position of Flash area in PDF	flash-startx	18	Using the left edge of the document as the 0 axis point, specify in points the beginning horizontal position of the Flash object in the PDF document. The default is 18, or .25 inch
Start y position of Flash area in PDF	flash-starty	18	Using the upper left corner of the document as the 0 axis point, specify in points the beginning vertical position of the Flash object in the PDF document. The default is 18, or .25 inch.
Width of Flash area	flash-width	Same as flash width in points in swf	Enter in points the width of the area in the document for the Flash object to occupy. The default is the width of the SWF object.
Height of Flash area	flash-height	Same as flash height in points in swf	Enter in points the height of the area in the document for the Flash object to occupy. The default is the height of the SWF object.

Defining Font Mappings

BI Publisher's Font Mapping feature enables you to map base fonts in RTF or PDF templates to target fonts to be used in the published document. Font Mappings can be specified at the site or report level. Font mapping is performed only for PDF PowerPoint output.

There are two types of font mappings:

RTF Templates - for mapping fonts from RTF templates and XSL-FO templates to PDF and PowerPoint output fonts
PDF Templates - for mapping fonts from PDF templates to different PDF output fonts.

Making Fonts Available to BI Publisher

BI Publisher provides a set of Type1 fonts and a set of TrueType fonts. You can select any of the fonts in these sets as a target font with no additional setup required. For a list of the predefined fonts see BI Publisher's Predefined Fonts.

The predefined fonts are located in $JAVA_HOME/jre/lib/fonts. If you wish to map to another font, you must place the font in this directory to make it available to BI Publisher at runtime. If your environment is clustered, you must place the font on every server.

Setting Font Mapping at the Site Level or Report Level

A font mapping can be defined at the site level or the report level:

To set a mapping at the site level, select the Font Mappings link from the Admin page.
To set a mapping at the report level, select the Configuration link for the report, then select the Font Mappings tab. These settings will apply to the selected report only.

The report-level settings will take precedence over the site-level settings.

Creating a Font Mapping

From the Admin page, under Runtime Configuration, select Font Mappings.

To create a Font Mapping

Under RTF Templates or PDF Templates, select Add Font Mapping.
Enter the following on the Add Font Mapping page:
- Base Font - enter the font family that will be mapped to a new font. Example: Arial
- Select the Style: Normal or Italic (Not applicable to PDF Template font mappings)
- Select the Weight: Normal or Bold (Not applicable to PDF Template font mappings)
- Select the Target Font Type: Type 1 or TrueType
- Enter the Target Font
  
  If you selected TrueType, you can enter a specific numbered font in the collection. Enter the TrueType Collection (TTC) Number of the desired font.
  
  For a list of the predefined fonts see BI Publisher's Predefined Fonts

BI Publisher's Predefined Fonts

BI Publisher provides a set of Type1 fonts and a set of TrueType fonts. You can select any of these fonts as a target font with no additional setup required.

The Type1 fonts are listed in the following table:

Type 1 Fonts
Number	Font Family	Style	Weight	Font Name
1	serif	normal	normal	Time-Roman
1	serif	normal	bold	Times-Bold
1	serif	italic	normal	Times-Italic
1	serif	italic	bold	Times-BoldItalic
2	sans-serif	normal	normal	Helvetica
2	sans-serif	normal	bold	Helvetica-Bold
2	sans-serif	italic	normal	Helvetica-Oblique
2	sans-serif	italic	bold	Helvetica-BoldOblique
3	monospace	normal	normal	Courier
3	monospace	normal	bold	Courier-Bold
3	monospace	italic	normal	Courier-Oblique
3	monospace	italic	bold	Courier-BoldOblique
4	Courier	normal	normal	Courier
4	Courier	normal	bold	Courier-Bold
4	Courier	italic	normal	Courier-Oblique
4	Courier	italic	bold	Courier-BoldOblique
5	Helvetica	normal	normal	Helvetica
5	Helvetica	normal	bold	Helvetica-Bold
5	Helvetica	italic	normal	Helvetica-Oblique
5	Helvetica	italic	bold	Helvetica-BoldOblique
6	Times	normal	normal	Times
6	Times	normal	bold	Times-Bold
6	Times	italic	normal	Times-Italic
6	Times	italic	bold	Times-BoldItalic
7	Symbol	normal	normal	Symbol
8	ZapfDingbats	normal	normal	ZapfDingbats

The TrueType fonts are listed in the following table. All TrueType fonts will be subsetted and embedded into PDF.


Number	Font Family Name	Style	Weight	Actual Font	Actual Font Type
1	Albany WT	normal	normal	ALBANYWT.ttf	TrueType (Latin1 only)
2	Albany WT J	normal	normal	ALBANWTJ.ttf	TrueType (Japanese flavor)
3	Albany WT K	normal	normal	ALBANWTK.ttf	TrueType (Korean flavor)
4	Albany WT SC	normal	normal	ALBANWTS.ttf	TrueType (Simplified Chinese flavor)
5	Albany WT TC	normal	normal	ALBANWTT.ttf	TrueType (Traditional Chinese flavor)
6	Andale Duospace WT	normal	normal	ADUO.ttf	TrueType (Latin1 only, Fixed width)
6	Andale Duospace WT	bold	bold	ADUOB.ttf	TrueType (Latin1 only, Fixed width)
7	Andale Duospace WT J	normal	normal	ADUOJ.ttf	TrueType (Japanese flavor, Fixed width)
7	Andale Duospace WT J	bold	bold	ADUOJB.ttf	TrueType (Japanese flavor, Fixed width)
8	Andale Duospace WT K	normal	normal	ADUOK.ttf	TrueType (Korean flavor, Fixed width)
8	Andale Duospace WT K	bold	bold	ADUOKB.ttf	TrueType (Korean flavor, Fixed width)
9	Andale Duospace WT SC	normal	normal	ADUOSC.ttf	TrueType (Simplified Chinese flavor, Fixed width)
9	Andale Duospace WT SC	bold	bold	ADUOSCB.ttf	TrueType (Simplified Chinese flavor, Fixed width)
10	Andale Duospace WT TC	normal	normal	ADUOTC.ttf	TrueType (Traditional Chinese flavor, Fixed width)
10	Andale Duospace WT TC	bold	bold	ADUOTCB.ttf	TrueType (Traditional Chinese flavor, Fixed width)

Setting Runtime Configuration Properties