Define Runtime Configurations

This topic describes processing properties for PDF document security, FO processing, PDF accessibility, and specific properties for each output type.

Set Runtime Properties

The Runtime Configuration page enables you to set runtime properties at the server level.

These same properties can also be set at the report level, from the report editor's Properties dialog. If different values are set for a property at each level, then report level takes precedence.

PDF Output Properties

Generate the type of PDF files you want by setting available output properties.

Property Name Description Default Configuration Name

Compress PDF output

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

true pdf-compression

Hide PDF viewer's menu bars

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.

false pdf-hide-menubar

Hide PDF viewer's tool bars

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

false pdf-hide-toolbar

Replace smart quotes

Specify "false" if you don't want curly quotes replaced with straight quotes in the PDF output.

true pdf-replace-smartquotes

Disable opacity and gradient shading for DVT chart

Specify "true" if you don't want opacity and gradient shading for the PDF output. This reduces the size of the PostScript file.

false pdf-dvt-no-opacity-no-gradient-shading

Enable PDF Security

Specify "true” if you want to encrypt the PDF output. You can then also specify the following properties:

  • Open document password

  • Modify permissions password

  • Encryption Level

false pdf-security

Open document password

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 Adobe's password restrictions apply. The password must contain only Latin 1 characters and must be no more than 32 bytes long.

N/A pdf-open-password

Modify permissions password

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

N/A pdf-permissions-password

Encryption level

Specify the encryption level for the output PDF file. The possible values are:

  • 0: Low (40-bit RC4, Acrobat 3.0 or later)

  • 1: Medium (128-bit RC4, Acrobat 5.0 or later)

  • 2: High (128-bit AES, Acrobat 7.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 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

2 - high pdf-encryption-level

Disable document modification

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

false pdf-no-changing-the-document

Disable printing

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

false pdf-no-printing

Disable adding or changing comments and form fields

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.

false pdf-no-accff

Disable context copying, extraction, and accessibility

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

false pdf-no-cceda

Enable text access for screen readers

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

true pdf-enable-accessibility

Enable copying of text, images, and other content

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

false pdf-enable-copying

Allowed change level

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

0 pdf-changes-allowed

Allowed printing level

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

  • 0: None

  • 1: Low resolution (150 dpi)

  • 2: High resolution

0 pdf-printing-allowed

Use only one shared resources object for all pages

The default mode of 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.

true pdf-use-one-resources

PDF Navigation Panel Initial View

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

  • Panels Collapsed - displays the PDF document with the navigation panel collapsed.

  • Bookmarks Open (default) - displays the bookmark links for easy navigation.

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

Bookmarks Open pdf-pagemode

PDF Digital Signature Properties

There are specific 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.

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.

Property Name Description Default Configuration Name

Enable Digital Signature

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

false

signature-enable

Existing signature field name

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.

N/A signature-field-name

Signature field location

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

N/A signature-field-location

Signature field X coordinate

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.

0 signature-field-pos-x

Signature field Y coordinate

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.

0 signature-field-pos-y

Signature field width

Enter in points (72 points equal one inch) the desired width of the inserted digital signature field. This applies only if you're also setting the Signature field x coordinate and Signature field Y coordinate properties..

0 signature-field-width

Signature field height

Enter in points (72 points equal one inch) the desired height of the inserted digital signature field. This applies only if you're also setting the Signature field x coordinate and Signature field Y coordinate properties.

0 signature-field-height

PDF Accessibility Properties

Set the properties described in the table below to configure PDF accessibility.

Property Name Description Default

Make PDF output accessible

Set to “true” to make the PDF outputs accessible. Accessible PDF output contains the document title and PDF tags. False

Use PDF/UA format for accessible PDF output

Set to “true” to use the PDF/UA format for the accessible PDF outputs. False

PDF/A Output Properties

Set the properties described in the table below to configure PDF/A output.

Property Name Description Default Configuration Name

PDF/A version

Set the PDF/A version.

PDF/A-1B pdfa-version

PDF/A ICC Profile Data

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.

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).

Default profile data provided by JVM pdfa-icc-profile-data

PDF/A ICC Profile Info

ICC profile information (required when pdfa-icc-profile-data is specified)

sRGB IEC61966-2.1 pdfa-icc-profile-info

PDF/A file identifier

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 (,).

Automatically generated file identifier pdfa-file-identifier

PDF/A document ID

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

None pdfa-document-id

PDF/A version ID

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

None pdfa-version-id

PDF/A rendition class

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

None pdfa-rendition-class

PDF/X Output Properties

Configure PDF/X output by setting the properties described below. The values that you set for these properties will depend on the printing device.

Note the following restrictions on other PDF properties:

  • pdf-version — Value above 1.4 is not allowed for PDF/X-1a output.

  • pdf-security — Must be set to False.

  • pdf-encryption-level — Must be set to 0.

  • pdf-font-embedding — Must be set to true.

Property Name Description Default Configuration Name

PDF/X ICC Profile Data

(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 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.

Profile data is also available from Adobe support or colormanagement.org.

None pdfx-dest-output-profile-data

PDF/X output condition identifier

(Required) The name of one of the standard printing conditions registered with ICC (International Color Consortium). 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.

None pdfx-output-condition-identifier

PDF/X output condition

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.

None pdfx-output-condition

PDF/X registry name

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.

http://www.color.org pdfx-registry-name

PDF/X version

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.

PDF/X-1a:2003 pdfx-version

DOCX Output Properties

The table below describes the properties that control DOCX output files.

Property Name Description Default Configuration Name

Enable change tracking

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

false docx-track-changes

Protect document for tracked changes

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

false docx-protect-document-for-tracked-changes

Default font

Use this property to define the font style and size in the 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 processing engine at runtime.

Arial:12 docx-output-default-font

Open password

Use this property to specify the password that report users must provide to open any DOCX report.

NA docx-open-password

RTF Output Properties

Configure RTF output files by setting the properties described in the table below.

Property Name Description Default Configuration Name

Enable change tracking

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

false rtf-track-changes

Protect document for tracked changes

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

false rtf-protect-document-for-tracked-changes

Default font

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 processing engine at runtime. See Define Font Mappings for information about installing fonts and for the list of predefined fonts.

Arial:12 rtf-output-default-font

Enable widow orphan

Set to "true" to ensure that the document includes no “hanging paragraphs”. Suppose the last para in a page contains an orphaned line and the remaining lines of the paragraph continue on the next page. With this setting enabled, the starting line of the paragraph moves to the next page to keep all the lines of the paragraph together for improved readability.

false rtf-enable-widow-orphan

PPTX Output Properties

The table below describes the properties that control PPTX output files.

Property Name Description Default Configuration Name

Open password

Use this property to specify the password that report users must provide to open any PPTX report.

NA pptx-open-password

HTML Output Properties

The table below describes the properties that control HTML output files.

Property Name Description Default Configuration Name

Show header

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

true html-show-header

Show footer

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

true html-show-footer

Replace smart quotes

Set to "false" if you don't want curly quotes replaced with straight quotes in the HTML output.

true html-replace-smartquotes

Character set

Specify the output HTML character set.

UTF-8 html-output-charset

Make HTML output accessible

Set to "true" to make the HTML output accessible.

false make-accessible

Use percentage width for table columns

Set to "true" to display 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 display tables with extremely wide columns. Setting this property to true improves the readability of the tables.

true html-output-width-in-percentage

View Paginated

When you set this property 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.

false  

Reduce Padding in Table-cell

When you set this property to true, cells in HTML tables are displayed without padding, which maximizes the page space available for text.

false html-reduce-padding

Embed images and charts in HTML for offline viewing

When you set this property to true, charts and images are embedded in the HTML output, which is suitable for viewing offline.

true html-use-data-uri

Use SVG for charts

When you set this property to true, charts display as a SVG (Scalable Vector Graphic) to provide a higher resolution in the HTML output. When you set this property to false, charts display as a raster image.

true html-use-svg

Keep original table width

When you set this property to true, if a column in a table is deleted, the original width of the table is maintained.

true html-keep-original-table-width

Enable horizontal scrollbar automatically for html table

When you set this property to true, a horizontal scroll bar is added to a table that doesn't fit within the current size of the browser window.

false html-enable-horiz-table-scroll

Enable html table column size auto adjust

When you set this property to true, the column widths in a table are automatically adjusted to the size of the browser window.

false html-enable-table-col-size-auto-adjust

Set zero height for empty paragraph

When you set this property to true and the output is HTML, the height of an empty paragraph (that is, a paragraph without text) is set to zero points.

true html-set-empty-paragraph-zero-height

FO Processing Properties

The table below describes the properties that control FO processing.

Property Name Description Default Configuration Name

Use BI Publisher's XSLT processor

Controls the use of parser. If set to false, then XSLT is not parsed.

true xslt-xdoparser

Enable scalable feature of XSLT processor

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.

false xslt-scalable

Enable XSLT runtime optimization

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 Extract attribute sets property to "false".

true xslt-runtime-optimization

Enable XPath Optimization

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

false xslt-xpath-optimization

Pages cached during processing

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.

50 system-cache-page-size

Bidi language digit substitution type

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.

National digit-substitution

Disable variable header support

When set to true, prevents variable header support. Variable header support automatically extends the size of the header to accommodate the contents.

false fo-prevent-variable-header

Enable multithreading

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.

false fo-multi-threads

Disable external references

When set to true, disallows 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.

true xdk-secure-io-mode

FO Parsing Buffer Size

Specifies 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.

1000000 fo-chunk-size

FO extended linebreaking

When set to true, punctuation, hyphenation, and international text are handled properly when line breaking is necessary.

true fo-extended-linebreaking

Enable XSLT runtime optimization for sub-template

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.

The default is true. If you call the FOProcessor directly, the default is false.

true xslt-do-import

Report Timezone

Valid values: User or JVM.

When set to User, 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, 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.

User fo-report-timezone

PDF Bidi Unicode Version

Specifies the Unicode version (3.0 or 4.1) used to display the BIDI strings in the PDF output. 

4.1 pdf-bidi-unicode-version

RTF Template Properties

Configure RTF templates by setting the properties described in the table below.

Property Name Description Default Configuration Name

Extract attribute sets

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

Auto rtf-extract-attribute-sets

Enable XPath rewriting

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.

true rtf-rewrite-path

Characters used for checkbox

The 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 at runtime.

Albany WT J;9746;9747/A rtf-checkbox-glyph

XPT Template Properties

Configure XPT templates by setting the properties described in the table below.

Property Name Description Default

XPT Scalable Mode

When you set this property to true, the scheduled reports that use the XPT template and include a large amount of data run without memory issues. The first 100,000 rows of data in the report are stored in memory and the remaining rows are stored in the file system.

When you set this property to false, the scheduled reports that use XPT template are processed in-memory. Set this property to false for reports that contain less data.

False

Enable Asynchronous Mode for Interactive Output

When you set this property to true, interactive reports that use the XPT template make asynchronous calls to Oracle WebLogic Server.

When you set this property to false, interactive reports that use the XPT template make synchronous calls to Oracle WebLogic Server. Oracle WebLogic Server limits the number of synchronous calls. Any calls that are stuck expire in 600 seconds.

True

PDF Template Properties

Generate the types of PDF files you want by setting available PDF template properties.

Property Name Description Default Configuration Name

Remove PDF fields from output

Specify "true" to remove PDF fields from the output. When PDF fields are removed, data entered in the fields cannot be extracted.

false remove-pdf-fields

Set all fields as read only in output

By default, all fields in the output PDF of a PDF template is read only. If you want to set all fields to be updatable, set this property to "false".

true all-field-readonly

Maintain each field's read only setting

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

false all-fields-readonly-asis

Excel Template Properties

Configure Excel templates by setting the properties described in the table below.

Property Name Description Default

Enable Scalable Mode

When set to true, large reports that use Excel template run without out of memory issues. Data overflows automatically into multiple sheets if a group of data in a sheet exceeds 65000 rows. This overcomes the Microsoft Excel limitation of 65000 rows per sheet.

When set to false, large reports that use Excel template can cause out of memory issues.

false

CSV Output Properties

The table below describes the properties that control comma-delimited value output.

Property Name Description Default

CSV delimiter

Specifies the character used to delimit the data in comma-separated value output. Other options are: Semicolon (;), Tab (\t) and Pipe (|).

Comma (,)

Remove leading and trailing white space

Specify "True" to remove leading and trailing white space between data elements and the delimiter.

false

Add UTF-8 BOM Signature

Specify "False" to remove the UTF-8 BOM signature from the output.

true

Excel 2007 Output Properties

You can set specific properties to control Excel 2007 output.

Property Name Description Default

Show grid lines

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

false

Page break as a new sheet

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

true

Minimum column width

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.

3 (in points, 0.04 inch)

Minimum row height

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 0.001 to 5 points.

1 (in points, 0.01 inch)

Keep values in same column

Set this property to True to minimize column merging. Column width is set based on column contents using the values supplied in the Table Auto Layout property. Output may not appear as neatly laid out as when using the original layout algorithm.

False

Table Auto Layout

Specify a conversion ratio in points and a maximum length in points, for example 6.5,150. See example.

For this property to take effect, the property "Keep values in same column" must be set to True.

This property expands the table column width to fit the contents. The column width is expanded based on the character count and conversion ratio up to the maximum specification.

Example: Assume a report with two columns of Excel data -- Column 1 contains a text string that is 18 characters and Column 2 is 30 characters long. When the value of this property is set to 6.5,150, the following calculations are performed:

Column 1 is 18 characters:

Apply the calculation: 18 * 6.5pts = 117 pts

The column in the Excel output will be 117 pts wide.

Column 2 is 30 characters:

Apply the calculation: 30 * 6.5 pts = 195 pts

Because 195 pts is greater than the specified maximum of 150, Column 2 will be 150 pts wide in the Excel output.

N/A

Maximum allowable nested table row count

Specify the maximum allowable row count for a nested table. Allowed values are 15000 to 999,999.

During report processing, nested inner table rows cannot be flushed to the XLSX writer, therefore they stay in-memory, increasing memory consumption. Set this limit to avoid out-of-memory exceptions. When this limit is reached for the size of the inner table, generation is terminated. The incomplete XLSX output file is returned.

20,000

Open password

Use this property to specify the password that report users must provide to open any XLSX output file.

Configuration name: xlsx-open-password

NA

EText Output Properties

The table below describes the properties that control EText output files.

Property Name Description Default

Add UTF-8 BOM Signature

When set to true, the Etext output is in UTF-8 Unicode with BOM format.

false

Enable bigdecimal

When set to true, you enable high-precision numeric calculation of the Etext output.

false

All Outputs Properties

The properties in the table below apply to all outputs.

Property Name Description Default

Use 11.1.1.5 compatibility mode

Reserved. Do not update unless instructed by Oracle.

false

Memory Guard Properties

The Runtime Configuration page lists the default values of the memory guard properties. The values of the memory guard properties depend on the compute shape used for your instance.

Property Description Default Value
Maximum report data size for online reports Limits the data size for online reports. 300MB
Maximum report data size for offline (scheduled) reports Limits the data size for scheduled reports. 500MB
Maximum report data size for bursting reports Limits the data size for bursting reports. 500MB
Free memory threshold Ensures a minimum available free memory space. 500MB
Maximum report data size under the free memory threshold Limits the data size of a report when the Free memory threshold property is set to a positive value. 50MB
Minimum time span between garbage collection runs Ensures a minimum time gap in seconds between any two subsequent garbage collection runs. 300 (seconds)
Maximum wait time for free memory to come back above the threshold value Limits the time in seconds for a run-report request to wait for the free JVM memory to exceed the threshold value. This property value takes effect only if you specify a positive value for the Free memory threshold property. If free memory is still below the threshold value after the specified wait time, the run-report request is rejected. 30 (seconds)
Timeout for online report Specifies the timeout value in seconds for online reports. 535 (seconds)
Maximum rows for CSV output Limits the rows for reports in CSV format. 1000000

Data Model Properties

The Runtime Configuration page lists the values of the data model properties. The values of the data model properties depend on the compute shape used for your instance.

Property Description Default
Maximum data size limit for data generation Limits the size of XML data that can be generated by executing a data model. 500MB
Maximum sample data size limit Limits the size of a sample data file that can be uploaded from the data model editor. 1MB
Enable Data Model scalable mode Prevents out of memory conditions. When set to true, the data engine takes advantage of the disk space while processing data. True
Enable Auto DB fetch size mode Avoids out of memory conditions, but can significantly increase the processing time. This setting is recommended only for frequently processing complex queries of hundreds of columns. When set to true, the database fetch size is set at runtime according to the total number of columns and the total number of query columns in the data set. Ignores the DB fetch size setting. This property overrides the data model-level database fetch size properties. True

DB fetch size

Limits the database fetch size for a data model. This property value takes effect only when Enable Auto DB fetch size mode is set to False. 20 (rows)

SQL Query Timeout

Specifies the timeout for SQL query-based data models. Irrespective of the settings at the instance level or data model level, the maximum SQL query timeout is 10 minutes for all the reports running online. This avoids stuck threads and server outages. 600 seconds

Enable Data Model diagnostic

Writes the data set details, memory, and SQL execution time information to the log file when set to true. Oracle recommends setting this property to true only for debugging purposes. If you enable this property, the processing time is increased. False

Enable SQL Session Trace

When set to true, for every SQL query that is executed, Publisher writes a SQL session trace log to the database. A database administrator can examine the log. False
Enable SQL Pruning Applies only to the Oracle Database queries that use Standard SQL. If your query returns many columns but only a subset are used by your report template, SQL pruning returns only those columns required by the template. If you enable this property, the processing time and the memory usage reduces. SQL pruning is not applicable for PDF, Excel, and E-text template types. False
DV Data Row Limit Limits the number of rows that can be retrieved from a data set. 2000000

Define Font Mappings

Map base fonts in RTF or PDF templates to target fonts to be used in the published document.

You can specify font mapping at the site or report level. Font mapping is performed only for PDF output and 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.

Make Fonts Available for Publishing

A set of Type1 fonts and a set of TrueType fonts are available for publishing. You can select any of the fonts in these sets as a target font with no additional setup required.

The predefined fonts are located in <oracle_home>/oracle_common/internal/fonts. To map to another font, place the font in this directory to make it available for publishing at runtime. If the environment is clustered, then you must place the font on every server. See Predefined Fonts.

Set 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.

Create a Font Map

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

To create a Font Mapping:
  1. Under RTF Templates or PDF Templates, select Add Font Mapping.

  2. Enter the following on the Add Font Mapping page:

    • Base Font — enter the font family to map 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.

Predefined Fonts

The following Type1 fonts are built-in to Adobe Acrobat and by default the mappings for these fonts are available for publishing.

You can select any of these fonts as a target font with no additional setup required.

The Type1 fonts are listed in the table below.

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 table below. All TrueType fonts are subset 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)

Define Currency Formats

Currency formats defined in the Administration Runtime Configuration page are applied at the system level. Currency formats can also be applied at the report level.

The report-level settings take precedence over the system-level settings here.

Understand 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.

To apply currency formats in the RTF template, use the format-currency function.

To add a currency format:

  1. Click the Add icon.
  2. Enter the ISO currency code, for example: USD, JPY, EUR, GBP, INR.
  3. Enter the format mask to apply for this currency.

    The Format Mask must be in the Oracle number format. The Oracle number format uses the components "9", "0", "D", and "G" to compose the format, for example: 9G999D00

    where

    9 represents a displayed number only if present in data

    G represents the group separator

    D represents the decimal separator

    0 represents an explicitly displayed number regardless of incoming data

The figure below shows sample currency formats.