12.2PDF Output Properties

Table 12-1 describes the properties that are available for PDF output.

Table 12-1 PDF Output Properties

Property Name

Description

Compress PDF output

Default: true

Description: Specify "true" or "false" to control compression of the output PDF file.

Internal Name: pdf-compression

Hide PDF viewer's menu bars

Default: false

Description: 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.

Internal Name: pdf-hide-menubar

Hide PDF viewer's tool bars

Default: false

Description: Specify "true" to hide the viewer application's toolbar when the document is active.

Internal Name: pdf-hide-toolbar

Replace smart quotes

Default: true

Description: Set to "false" if you do not want curly quotes replaced with straight quotes in the PDF output.

Internal Name: pdf-replace-smartquotes

Use only one shared resources object for all pages

Default: true

Description: The default mode of BI Publisher creates one shared resources object for all pages in a PDF file. This mode has the advantage of creating an overall smaller file size. However, the disadvantages are the following:

Viewing may take longer for a large file with many SVG objects

If you choose to break up the file by using Adobe Acrobat to extract or delete portions, then the edited PDF files are larger because the single shared resource object (that contains all of the SVG objects for the entire file) is included with each extracted portion.

Setting this property to "false" creates a resource object for each page. The file size is larger, but the PDF viewing is faster and the PDF can be broken up into smaller files more easily.

Internal Name: pdf-use-one-resources

PDF Navigation Panel Initial View

Default: Bookmarks Open

Description: Controls the navigation panel view that is presented when a user first opens a PDF report. The following options are supported:

Pages Open - displays a clickable thumbnail view of each page of the PDF.

Internal Name: pdf-pagemode

12.3PDF Security Properties

Table 12-2 describes the properties that control the security settings for the output PDF documents.

Table 12-2 PDF Security Properties

Property Name

Description

Enable PDF Security

Default: false

Description: If you specify "true," then the output PDF file is encrypted. You can then also specify the following properties:

Open document password

Modify permissions password

Encryption Level

Internal Name: pdf-security

Open document password

Default: N/A

Description: This password is required for opening the document. It enables users to open the document only. This property is enabled only when "Enable PDF Security" is set to "true". Note that BI Publisher follows Adobe's password restrictions. The password must contain only Latin 1 characters and must be no more than 32 bytes long.

Internal Name: pdf-open-password

Modify permissions password

Default: N/A

Description: This password enables users to override the security setting. This property is effective only when "Enable PDF Security" is set to "true". Note that BI Publisher follows the Adobe's password restrictions. The password must contain only Latin 1 characters and must be no more than 32 bytes long.

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 or higher, 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

Internal Name: pdf-encryption-level

Disable document modification

Default: false

Description: Permission available when "Encryption level" is set to 0. When set to "true", the PDF file cannot be edited.

Internal Name: pdf-no-changing-the-document

Disable printing

Default: false

Description: Permission available when "Encryption level" is set to 0. When set to "true", printing is disabled for the PDF file.

Internal Name: pdf-no-printing

Disable adding or changing comments and form fields

Default: false

Description: 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.

Internal Name: pdf-no-accff

Disable context copying, extraction, and accessibility

Default: false

Description: Permission available when "Encryption level" is set to 0. When set to "true", the context copying, extraction, and accessibility features are disabled.

Internal Name: pdf-no-cceda

Enable text access for screen readers

Default: true

Description: Permission available when "Encryption level" is set to 1 or higher. When set to "true", text access for screen reader devices is enabled.

Internal Name: pdf-enable-accessibility

Enable copying of text, images, and other content

Default: false

Description: Permission available when "Encryption level" is set to 1 or higher. When set to "true", copying of text, images, and other content is enabled.

Internal Name: pdf-enable-copying

Allowed change level

Default: 0

Description: Permission available when "Encryption level" is set to 1 or higher. 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

Internal Name: pdf-changes-allowed

Allowed printing level

Default: 0

Description: Permission available when "Encryption level" is set to 1 or higher. Valid values are:

0: None

1: Low resolution (150 dpi)

2: High resolution

Internal Name: pdf-printing-allowed

12.4PDF Digital Signature Properties

Table 12-3 describes the properties that 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 Chapter 6, "Implementing a Digital Signature."

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.

Table 12-3 PDF Digital Signature Properties

Property Name

Description

Enable Digital Signature

Default: false

Description: Set this to "true" to enable digital signature for the report.

Internal Name: signature-enable

Existing signature field name

Default: N/A

Description: This property applies to PDF layout templates only. If the report is based on a PDF template, then you can enter a field from the PDF template in which to place the digital signature.

Description: This property can apply to RTF or PDF layout templates. This property provides a list that contains the following values: Top Left, Top Center, Top Right. Choose one of these general locations and BI Publisher inserts 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.

Internal Name: signature-field-location

Signature field X coordinate

Default: 0

Description: 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.

Internal Name: signature-field-pos-x

Signature field Y coordinate

Default: 0

Description: 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.

Internal Name: signature-field-pos-y

Signature field width

Default: 0

Description: 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.

Internal Name: signature-field-width

Signature field height

Default: 0

Description: 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.

Description: The name of the ICC profile data file, for example: CoatedFOGRA27.icc

The ICC (International Color Consortium) profile is a binary file describing the color characteristics of the environment where this PDF/A file is intended to be displayed. (For more information, see the article at http://en.wikipedia.org/wiki/ICC_profile).

The ICC profile that you select must have a major version below 4.

To use a specific profile data file other than the default settings in the JVM, obtain the file and place it under <bi publisher repository>/Admin/Configuration. When you set this property, you must also set a value for PDF/A ICC Profile Info (pdfa-icc-profile-info).

Description: One or more valid file identifiers set in the xmpMM:Identifier field of the metadata dictionary. To specify more than one identifier, separate values with a comma (,).

Internal Name: pdfa-file-identifier

PDF/A document ID

Default: None

Description: Valid document ID. The value is set in the xmpMM:DocumentID field of the metadata dictionary.

Internal Name: pdfa-document-id

PDF/A version ID

Default: None

Description: Valid version ID. The value is set in the xmpMM:VersionID field of the metadata dictionary.

Internal Name: pdfa-version-id

PDF/A rendition class

Default: None

Description: Valid rendition class. The value is set in the xmpMM:RenditionClass field of the metadata dictionary.

Internal Name: pdfa-rendition-class

12.6 PDF/X Output Properties

Set the properties described in Table 12-5 to configure PDF/X output. The values that you set for these properties will depend on the printing device. Note the following restrictions on other PDF properties:

Description: (Required) The name of the ICC profile data file, for example: CoatedFOGRA27.icc.

The ICC (International Color Consortium) profile is a binary file describing the color characteristics of the intended output device. (For more information, see the article at http://en.wikipedia.org/wiki/ICC_profile). For production environments, the color profile may be provided by your print vendor or by the printing company that prints the generated PDF/X file. The file must be placed under <bi publisher repository>/Admin/Configuration.

Description: (Required) The name of one of the standard printing conditions registered with ICC (International Color Consortium). The list of standard CMYK printing conditions to use with PDF/X-1a is provided on the following ICC website: http://www.color.org/chardata/drsection1.xalter. The value that you enter for this property is a valid "Reference name," for example: FOGRA43.

Choose the appropriate value for the intended printing environment. This name is often used to guide automatic processing of the file by the consumer of the PDF/X document, or to inform the default settings in interactive applications.

Internal Name: pdfx-output-condition-identifier

PDF/X output condition

Default: None

Description: A string describing the intended printing condition in a form that will be meaningful to a human operator at the site receiving the exchanged file. The value is set in OutputCondition field of OutputIntents dictionary.

Internal Name: pdfx-output-condition

PDF/X registry name

Default: http://www.color.org

Description: A registry name. Set this property when the pdfx-output-condition-identifier is set to a characterization name that is registered in a registry other than the ICC registry.

Internal Name: pdfx-registry-name

PDF/X version

Default: PDF/X-1a:2003

Description: The PDF/X version set in GTS_PDFXVersion and GTS_PDFXConformance fields of Info dictionary. PDF/X-1a:2003 is the only value currently supported.

12.7 RTF Output Properties

Description: Set to "true" to enable change tracking in the output RTF document.

Internal Name: rtf-track-changes

Protect document for tracked changes

Default: false

Description: Set to "true" to protect the document for tracked changes.

Internal Name: rtf-protect-document-for-tracked-changes

Default font

Default: Arial:12

Description: 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 Section 12.16, "Defining Font Mappings" for information about installing fonts for the BI Publisher server and also for the list of fonts predefined for BI Publisher.

12.8 HTML Output Properties

Description: Set to "false" to suppress the template header in HTML output.

Internal Name: html-show-header

Show footer

Default: true

Description: Set to "false" to suppress the template footer in HTML output.

Internal Name: html-show-footer

Replace smart quotes

Default: true

Description: Set to "false" if you do not want curly quotes replaced with straight quotes in the HTML output.

Internal Name: html-replace-smartquotes

Character set

Default: UTF-8

Description: Specifies the output HTML character set.

Internal Name: html-output-charset

Make HTML output accessible

Default: false

Description: Specify true if you want to make the HTML output accessible.

Internal Name: make-accessible

Use percentage width for table columns

Default: true

Description: 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 the browser renders tables with extremely wide columns. Setting this property to true improves the readability of the tables.

Internal Name: html-output-width-in-percentage

View Paginated

Default: false

Description: When set to true, HTML output will render in the report viewer with pagination features. These features include:

Generated table of contents

Navigation links at the top and bottom of the page

Ability to skip to a specific page within the HTML document

Search for strings within the HTML document using the browser's search capability

Zoom in and out on the HTML document using the browser's zoom capability

Note that these features are supported for online viewing through the report viewer only.

12.9 FO Processing Properties

Description: Controls BI Publisher's parser usage. If set to false, then XSLT is not parsed.

Internal Name: xslt-xdoparser

Enable scalable feature of XSLT processor

Default: false

Description: 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.

Internal Name: xslt-scalable

Enable XSLT runtime optimization

Default: true

Description: 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 Section 12.10, "RTF Template Properties."

Internal Name: xslt-runtime-optimization

Enable XPath Optimization

Default: false

Description: When set to "true", the XML data file is analyzed for element frequency. The information is then used to optimize XPath in XSL.

Internal Name: xslt-xpath-optimization

Pages cached during processing

Default: 50

Description: 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.

Internal Name: system-cache-page-size

Bidi language digit substitution type

Default: National

Description: Valid values are "None" and "National". When set to "None", Eastern European numbers are used. When set to "National", Hindi format (Arabic-Indic digits) is used. This setting is effective only when the locale is Arabic, otherwise it is ignored.

Internal Name: digit-substitution

Disable variable header support

Default: false

Description: If "true", prevents variable header support. Variable header support automatically extends the size of the header to accommodate the contents.

Description: 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.

Internal Name: fo-multi-threads

Disable external references

Default: true

Description: 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 the system. Set this to "false" if the report or template calls external files.

Internal Name: xdk-secure-io-mode

FO Parsing Buffer Size

Default: 1000000

Description: Sets the size of the buffer for the FO Processor. When the buffer is full, the elements from the buffer are rendered in the report. Reports with large tables or pivot tables 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 affects the memory consumption of the system.

Internal Name: fo-chunk-size

Enable XSLT runtime optimization for sub-template

Default: true

Note: The default is true on the BI Publisher server. If you call the FOProcessor directly, the default is false.

Description: Provides an option to perform XSL import in FOProcessor before passing only one XSL to XDK for further processing. This allows xslt-optimization to be applied to the entire main XSL template which already includes all its subtemplates.

Internal Name: xslt-do-import

Enable PPTX native chart support

Default: false

Description: This property applies to PowerPoint 2007 output. When set to true, charts in PowerPoint 2007 output are rendered as native PowerPoint (PPTX) charts. When set to false, the chart is rendered as an embedded PNG image.

Internal Name: pptx-native-chart

Report Timezone

Default: User

Description: Valid values: User or JVM.

When set to User, BI Publisher uses the User-level Report Time Zone setting for reports. The User Report Time Zone is set in the user's Account Settings.

When set to JVM, BI Publisher uses the server JVM timezone setting for all users' reports. All reports therefore display the same time regardless of individual user settings. This setting can be overridden at the report level.

Internal Name: fo-report-timezone

12.10 RTF Template Properties

Description: The RTF processor automatically extracts 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

Internal Name: rtf-extract-attribute-sets

Enable XPath rewriting

Default: true

Description: When converting an RTF template to XSL-FO, the RTF processor automatically rewrites the XML tag names to represent the full XPath notations. Set this property to "false" to disable this feature.

Internal Name: rtf-rewrite-path

Characters used for checkbox

Default: Albany WT J;9746;9747/A

Description: The BI Publisher default PDF output font does not include a glyph to represent a checkbox. If the template contains a checkbox, use this property to define a Unicode font for the representation of checkboxes in the 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.

Description: 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."

12.14 Excel 2007 Output Properties

Description: Set to true to show the Excel table grid lines in the report output.

Page break as a new sheet

Default: true

Description: When set to "True" a page break that is specified in the report template generates a new sheet in the Excel workbook.

Minimum column width

Default: 3 (in points, 0.04 inch)

Description: When the column width is less than the specified minimum and it contains no data, the column is merged with the preceding column. The value must be set in points. The valid range for this property is 0.5 to 20 points.

Minimum row height

Default: 1 (in points, 0.01 inch)

Description: When the row height is less than the specified minimum and it contains no data, the row is removed. The value must be set in points. The valid range for this property is .001 to 5 points.

12.15 All Outputs Property

Description: Some report output documents display Oracle BI Publisher in the document properties. For example, PDF documents identify Oracle BI Publisher as the PDF Producer in the properties for the document. If you do not want to include the version of BI Publisher that generated the document (for example, Oracle BI Publisher 11.1.1.4.0), then set this property to true.

Use 11.1.1.5 compatibility mode

Reserved. Do not update unless instructed by Oracle.

12.16Defining 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 output and PowerPoint output.

12.16.1 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 Section 12.16.4, "BI Publisher's Predefined Fonts."

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

12.16.2 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 Administration page.

To set a mapping at the report level, view the Properties for the report, then select the Font Mappings tab. These settings apply to the selected report only.

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

12.16.3 Creating a Font Mapping

From the Administration 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 to map to a new font. Example: Arial

12.16.4 BI Publisher's Predefined Fonts

The following Type1 fonts are built-in to Adobe Acrobat and BI Publisher provides a mapping for these fonts by default. You can select any of these fonts as a target font with no additional setup required.

12.17.1 Understanding Currency Formats

The Currency Formats tab enables you to map a number format mask to a specific currency so that your reports can display multiple currencies with their own corresponding formatting. Currency formatting is only supported for RTF and XSL-FO templates.