Release
10.1.3.4.1
Part No. E12691-10
July 2009
This document contains the following topics:
These release notes describe known issues and workarounds for Oracle Business Intelligence Publisher releases 10.1.3.3, 10.1.3.3.1, 10.1.3.3.2, 10.1.3.3.3, 10.1.3.4, and 10.1.3.4.1. For installation information, consult the Oracle Business Intelligence Publisher Installation Guide, which is available on the Oracle Business Intelligence Publisher install media and on the Oracle Business Intelligence Publisher Web site:
http://www.oracle.com/technology/documentation/bi_pub.html
These release notes are organized into the following sections:
Documentation Accessibility
These release notes are updated periodically as new information becomes available. To ensure that you are reading the latest version of the release notes, check the Oracle Business Intelligence Publisher Web site:
http://www.oracle.com/technology/documentation/bi_pub.html
Currently the Oracle BI Publisher installer does not include an upgrade option. Follow these steps to upgrade BI Publisher versions 10.1.3.2 and later to version 10.1.3.4.1.
This procedure applies to BI Publisher installations originally installed using the BI Publisher Installer or originally installed by following the manual install instructions in the Oracle Business Intelligence Publisher Installation Guide.
The upgrade procedure described in this section consists of the following general steps:
Back up your existing install.
Manually deploy the xmlpserver.ear or xmlpserver.war to your application server.
Copy the specified files from the install media to your XMLP repository folders.
Prepare your existing installation by backing up files and noting your existing scheduler configuration.
Back up all the directories under the BI Publisher repository.
The BI Publisher repository is the directory named "XMLP" that contains the following subdirectories:
Admin
Demofiles
Reports
Tools
Users
If you do not know the location of the BI Publisher repository:
Log in to BI Publisher with Administrator privileges and select the Admin tab.
Under System Maintenance options, select Report Repository to see the path to your BI Publisher repository.
Back up the BI Publisher configuration file: xmlp-server-config.xml
located in the <application-installation>/WEB-INF/ directory, where your application server unpacked the BI Publisher WAR or EAR file.
For example, in an Oracle AS/OC4J 10.1.3 deployment, the location is
<ORACLE_HOME>/j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/xmlp-server-config.xml
Note your existing scheduler configuration details: From the Admin tab, under System Maintenance, select Scheduler Configuration.
After upgrading the BI Publisher server, you must reenter the scheduler database connection details in this page. Have this information available to complete the upgrade.
Shut down BI Publisher.
Undeploy the BI Publisher application ("xmlpserver") from your J2EE application server. See your application server documentation for instructions on how to undeploy an application.
Deploy the new version of the xmlpserver.ear or xmlpserver.war to your application server. See the chapter "Manually Installing BI Publisher to a J2EE Application Server" in the Oracle Business Intelligence Publisher Installation Guide for guidelines for your application server type.
To upgrade the repository, manually copy the files listed here from the install media to your existing BI Publisher repository.
Copy the following files from the 10.1.3.4.1 install media to your existing BI Publisher Repository:
manual/XMLP/Admin/DataSource/jdbcdefaults.xml
manual/XMLP/Admin/DataSource/msmdacc.dll
manual/XMLP/Admin/Security/bip.product
manual/XMLP/Admin/Security/bip.instance
manual/XMLP/Admin/Security/ssodefaults.xml
manual/XMLP/Admin/Scheduler/database-config.xml
Manually copy all files in the following directories from the 10.1.3.4.1 install media to your existing BI Publisher Repository :
manual/XMLP/Admin/Translation
manual/XMLP/Tools
Copy the saved backup copy of the xmlp-server-config.xml from the previous step to the newly created BI Publisher <application installation>/WEB-INF/ directory, where your application server unpacked the BI Publisher war or ear file.
Example:
In an Oracle AS/OC4J 10.1.3 deployment, the location is
<ORACLE_HOME>/j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/xmlp-server-config.xml
Restart the BI Publisher application (xmlpserver).
Enter the Scheduler Configuration details.
Navigate to the Scheduler Configuration page (Admin > System Maintenance > Scheduler Configuration) and enter the connection details that you noted in a previous step. Test the connection.
You do not need to reinstall the scheduler schema.
Restart the BI Publisher application (xmlpserver).
After extended use, the BI Publisher Web UI may enter a state in which the top header frame colors appear reversed (blue screen objects appear white); however, the navigation links remain white. Therefore you may not be able to see
Welcome, <username> Preferences Sign Out Help
To correct this problem, restart the browser.
The Java SE Development Kit (JDK) 5.0 version 1_5_0_7 contains a bug that impacts the performance of BI Publisher.
To correct this problem, upgrade to JDK 5.0 update 11 (1_5_0_11). You can download this update from:
http://java.sun.com/javase/downloads/index_jdk5.jsp
When performing an advanced install into an existing ORACLE_HOME a runtime error will occur if a space character is in the directory name of the selected ORACLE_HOME. This is a limitation of the Oracle Universal Installer (OUI) version 10.1.0.6.0 used for BI Publisher 10.1.3.3. The directory name is not validated before installation, thereby allowing installation to proceed. However, the runtime error will be encountered, which will require you to cancel the installation.
To work around this issue, choose an ORACLE_HOME directory name that does not include a space character.
If you encounter either of the following errors when using Discoverer Worksheets in your report data model:
500 Internal Server Error
The server encountered an internal error or misconfiguration and was unable to complete your request.
or Error 501
It is possible that the HTTP server where BI Publisher is running is timing out before the Discoverer Web service returns the data from the worksheet. If that is the case, you can correct this problem by increasing the values of Timeout and KeepAliveTimeout in the file:
<Oracle_Home>\Apache\Apache\conf\httpd.conf
For example you can change the following values:
Timeout 1800
KeepAliveTimeout 15
to
Timeout 7200
KeepAliveTimeout 150
Note the values are in seconds (1800=30 minutes, 7200=2 hours).
If you are running the BI Publisher server on a Linux or Unix machine that does not have an X Server installed reports that contain images may not be properly generated.
Workaround: If you are running Java 1.4.2 or later, start the environment with a headless implementation. Specify the following property at the Java command line:
-Djava.awt.headless=true
For JDK versions prior to 1.4.2 please see your documentation on how to implement X Host for your environment.
If your report file name contains multibyte characters and you download the report by selecting the Report Actions icon then clicking Download this report, the file names in the generated zip file will be invalid. This is due to a Java bug (details available from the Sun Developer Network). Consequently, the downloaded report zip file cannot be uploaded back to the BI Publisher server. To work around this issue, use only ASCII characters in file names.
Because the encoding of multibyte character file names is dependent on the operating system and locale of the runtime environment, BI Publisher cannot support multibyte characters in file names. To work around this issue, use only ASCII characters in file names.
Oracle BI Publisher does not support column-level time zone settings applied in BI Presentation Services. BI Publisher reports that use BI Answers requests with column-level time zone settings may result in different dates displayed in BI Presentation Services and BI Publisher. This is not an issue for reports without column-level time zone settings as long as the User Time Zone setting for BI Publisher and BI Presentation Services is the same.
To use external Web Services or HTTP data sources when your BI Publisher server is set up behind a firewall or requires a proxy to access the internet, then you must configure Oracle Containers for J2EE (OC4J), or your supported J2EE application server to be aware of the proxy.
For OC4J, update the <Oracle_Home>\oc4j\bin\oc4j.cmd file. Locate the following line:
rem JVMARGS
set JVMARGS=-Djava.library.path=C:\oracle\bi\server\Bin;C:\oracle\bi\web\bin -DSAROOTDIR=C:\oracle\bi -DSADATADIR=C:\oracle\bidata -XX:MaxPermSize=128m -Xmx512m %OC4J_JVM_ARGS%
and update with the following string:
-Dhttp.proxyHost=<proxy.mycompany.com> -Dhttp.proxyPort=80
so the result will be:
rem JVMARGS
set JVMARGS=-Dhttp.proxyHost=<proxy.mycompany.com> -Dhttp.proxyPort=80 -Djava.library.path=C:\oracle\bi\server\Bin;C:\oracle\bi\web\bin -DSAROOTDIR=C:\oracle\bi -DSADATADIR=C:\oracle\bidata -XX:MaxPermSize=128m -Xmx512m %OC4J_JVM_ARGS%
For other application servers, consult your documentation.
If you create an Analyzer template with multibyte characters in the template name and run the report by selecting the View link or button, you will receive the following error:
500 Internal Server Error
Servlet error: An exception occurred. The current application deployment descriptors do not allow for including it in this response. Please consult the application log for details.
If you select View again, the report will be rendered correctly.
To work around this issue, use only ASCII characters in template names, or turn off the auto-run option for the report.
If SSO is enabled, the Report Editor panel may fail to display correctly if you are also using Internet Explorer 6.0 as your Web browser. To work around this issue, use either Internet Explorer 7.0 or Firefox 2.0.
If you integrate Oracle BI Publisher Enterprise with the E-Business Suite, you may not be able to see the Admin tab after logging in to BI Publisher with an E-Business Suite user who has the appropriate BI Publisher responsibilities. This results when the database NLS_LANG setting does not match the OC4J NLS_LANG setting.
OC4J derives its NLS_LANG value from the operating system locale. Therefore, to resolve this issue, you must define the LANG environment variable for your OC4J operating system with the proper locale name to match the NLS_LANG setting for the E-Business Suite database. For example, if OC4J is deployed on Linux, and the NLS_LANG for the E-Business Suite database is defined as "American_America.UTF8", then you must define the LANG environment variable for your Linux OS as "en_US.UTF-8". For more information on setting this variable, see the following notes on Oracle MetaLink:
Note: 264157.1: The Correct NLS_LANG Setting in Unix Environments
Note: 351919.1: Globalization Support : JavaVM, Oracle JDBC Driver, NLS_LANG and OC4J
If you create a report using a Discoverer worksheet as a data source and the report includes parameter names that contain multibyte characters, then when you schedule that report, the report history does not correctly display the parameter names with the multibyte characters.
When you choose an analyzer template with interactive output format and click "Link to this report" and then choose the "Document Only" option, if you copy the URL into a new browser window to request the report by this URL, you will encounter a 500 internal error.
There is no workaround for this issue.
Note: This issue has been fixed in Smart Space, Fusion Edition 11.1.1.1.
To enable BI Publisher to work with Oracle Smart Space, Fusion Edition (Release 11.1.1), you must force the BI Publisher Web service to appear as RPC-encoded. The solution for this issue is to set the JVM parameter described below.
Important: Setting this option causes the BI Office component of the Oracle Business Intelligence Enterprise Edition to fail. You therefore cannot integrate BI Publisher with Smart Space if you also wish to use BI Office.
To enable BI Publisher to integrate with Smart Space, modify the Java command that starts your J2EE application server that runs BI Publisher to include the following parameter:
-Daxis.ServerConfigFile=server-rpc-config.wsdd
For example, if you are using the default oc4j.cmd you would change this line:
set
JVMARGS=-Djava.library.path=C:\oracle\bise1\bi\server\Bin;C:\oracle\bise1\bi\w
eb\bin -DSAROOTDIR=C:\oracle\bise1\bi -DSADATADIR=C:\oracle\bise1\bidata
-XX:MaxPermSize=128m -Xmx512m %OC4J_JVM_ARGS%
to this
set
JVMARGS=-Djava.library.path=C:\oracle\bise1\bi\server\Bin;C:\oracle\bise1\bi\w
eb\bin -DSAROOTDIR=C:\oracle\bise1\bi -DSADATADIR=C:\oracle\bise1\bidata
-Daxis.ServerConfigFile=server-rpc-config.wsdd -XX:MaxPermSize=128m
-Xmx512m %OC4J_JVM_ARGS%
If you are not integrating with Oracle Smart Space this command is unnecessary.
This applies to Sun Java System Web Server deployments only.
To enable users to download and install the Analyzer for Microsoft Excel from their BI Publisher session, you must update your Web server mime.types file as follows:
Locate the line:
type=magnus-internal/cgi exts=cgi,exe,bat
Update it as follows:
type=magnus-internal/cgi exts=cgi,bat
Locate the line:
type=application/octet-stream exts=bin
Update it as follows:
type=application/octet-stream exts=bin,exe
If you choose a different context root than "xmlpserver" when you deploy the BI Publisher application to your application server, you will not be able to download the BI Publisher desktop tools from the BI Publisher server.
To work around this issue you must manually configure the web.xml file. The web.xml file is located:
/<application installation>/xmlpserver/WEB-INF/web.xml
Update the following parameters to specify the context root you chose:
xmlp-online-web-dir
service-endpoint
web-dir
For example, if you specified your context root to be "bipub", update the parameters in the web.xml file as follows:
<#> <init-param>
<! -
This is the root webdir for the xmlpserver application. Modify this
if xmlpserver.ear is not deployed to its standard location.
- >
<param-name>xmlp-online-web-dir</param-name>
<param-value>/bipub</param-value>
</init-param>
<#> <init-param>
<! -
Path to the ServiceGateway SOAP end point. Most likely this will be the path for services deployed with Axis.
- >
<param-name>service-endpoint</param-name>
<param-value>/bipub/services/ServiceGateway</param-value>
</init-param>
<#> <init-param>
<! -
Path to report service web directory. - >
<param-name>web-dir</param-name>
<param-value>/bipub/report_service</param-value>
</init-param>
An MHTML reader is currently not available for Mac OS X. If your client is running Mac OS X and you choose the MHTML output format for a report, you will receive an error.
This issue has no workaround.
This applies to installations of BI Publisher on the HP-UX PA-RISC (32-bit) operating system only. After first installing BI Publisher, the "Move" and "Move All" shuttle icons that enable you to move items from one list to another may appear as text strings rather than icons.
To correct this issue, restart the BI Publisher server (xmlpserver).
PDF output generated from BI Publisher Flash templates may not render properly if you are using Adobe Reader 7.0.x,
To work around this issue, upgrade to Adobe Reader version 7.1 or higher.
When generating Microsoft Excel output from an RTF template, Excel may ignore or misinterpret formatting of date values. This is more likely to occur when you are running your operating system in languages other than English. You may be able to work around this issue by removing the date format applied to the field.
The following applies to Linux installations only.
If you require support for multibyte characters, before you install the BI Publisher server you must set the character encoding for your Linux server to UTF-8. Set the encoding as follows:
setenv LC_ALL xx_XX.utf8
where xx is the language code and XX is the country code. For example:
setenv LC_ALL en_US.utf8
This setting is required because BI Publisher uses the file system for its repository. Therefore if a user creates a report name or folder name with multibyte characters, BI Publisher requires that the operating system can also store the multibyte characters encoded with UTF-8.
When installing BI Publisher Enterprise standalone server on Linux (OEL4), Japanese characters appear garbled in the installation dialogs if LANG and LC_ALL are set to Japanese locale, for example, ja_JP.utf8, ja_JP.eucjp.
This occurs because the installer uses JRE version 1.4.2.
To work around this issue, specify a 1.5.x JRE when starting runInstaller, for example:
./runInstaller -jreLoc /usr/java/jdk1.5.0_15/jre
BI Publisher uses the internationalization (I18N) library that is packaged with the Oracle9i Database. If you are using BI Publisher with Oracle Database 10g or later, date and time formatting for certain locales returned by the Oracle Database will not match those returned by BI Publisher.
This issue has no workaround.
In release 10.1.3.4.1, BI Publisher introduced certification for Microsoft SQL Server 2008. However, the BI Publisher Add Data Source page does not include Microsoft SQL Server 2008 as an option in the list of Driver Types.
To add a JDBC connection to a Microsoft SQL Server 2008 data source, choose Microsoft SQL Server 2005 as the Driver Type, and enter the remaining information to connect to your database.
In release 10.1.3.4.1, BI Publisher introduced certification for Netezza 4.5. However, the BI Publisher Add Data Source page does not include Netezza 4.5 as an option in the list of Driver Types.
To add a JDBC connection to a Netezza 4.5 data source, choose Netezza 4.0 as the Driver Type, and enter the remaining information to connect to your database.
Parameters defined for BI Publisher reports allow for users to enter values directly if the parameter is not associated with a list of values (LOV). When a BI Publisher parameter is associated with an LOV, a user can only select values from the list. In Discoverer, parameter values can be either entered directly or selected from an LOV through a control called a combo-box. BI Publisher does not provide a combo box. For BI Publisher reports based on Discoverer worksheets that have parameters associated with an LOV, users will only be able to select parameter values from the LOV. Users will not be able to enter values for these parameters directly.
For data models based on Discoverer worksheets, BI Publisher references the workbook and worksheet by name. If the workbook or worksheet name is changed in Discoverer, the BI Publisher report cannot run until you update the BI Publisher report's data model to point to the newly named Discoverer workbook or worksheet.
When configuring the trusted user to integrate Discoverer with BI Publisher, the username must contain only single-byte, ASCII characters. BI Publisher cannot access Discoverer connections created with a username that contains multibyte characters.
If your XML data file is larger than 5 megabytes, do not use the Analyzer for Excel in native mode. Instead, use the Disabled Client Access mode. This mode is set as a report property. For information about enabling this mode, see the topic "Using the Report Editor" in the Oracle Business Intelligence Publisher Report Designer's Guide. Note that the Disabled Client Access mode requires that your data be in <ROWSET><ROW>...</ROWS>..</ROWSET> format.
The RC4 algorithm is less secure than newer algorithms such as AES and is not recommended for use in new applications. However, the RC4 algorithm is the only supported encryption algorithm for Adobe Acrobat 6.0. Support for AES encryption for Adobe Acrobat 7.0 and higher versions is planned for future releases of Oracle BI Publisher.
This issue has no workaround.
It is strongly recommended that you enable HTTPS on the middle tier hosting the Web services as the trusted username/password that is passed can be intercepted. This also pertains to Web services that are used for communication between BI Publisher and Oracle BI Presentation Services and between Oracle BI Publisher and Oracle BI Discoverer.
If you receive errors when making calls to a Web service that is protected via Secure Sockets Layer (SSL) (that is, uses https://), you may need to export the certificate from the Web server hosting the Web service and import it into the Java keystore on the machine running BI Publisher. An example error might be: "SSL received a record that exceeded the maximum permissible length.”
The steps for importing the certificate are:
Navigate to the HTTPS site where the WSDL resides.
Download the certificate following the prompts (the prompts you see will vary depending on the browser you are using).
Install the Certificate into your keystore using the Java keytool, as follows:
keytool -import -file <certfile> -alias <certalias> -dest <keystore file>
(Conditional) If you do not already have a system-wide keystore for Java set up, then set the JAVA_OPTS environment variable to tell the BI Publisher server where to find the keystore, as follows:
set JAVA_OPTS=-Djavax.net.ssl.trustStore=<keystore file>
Restart the application server.
These steps should not be required if the server certificate is linked to some certificate authority (such as Verisign), as the default Java keystore can handle that. But if the Web service server is using some self-generated certificate (for example, in a testing environment), then these steps will be required.
If you are using Microsoft Internet Explorer 6 or 7 over SSL (that is, https://) you will not be able to open PDF or other binary documents. This is an Internet Explorer issue that results when the header "Cache-Control: No Cache" is present in an HTTP response. For more information see the following Microsoft documents:
Internet Explorer file downloads over SSL do not work with the cache control headers
Prevent caching when you download active documents over SSL
For Oracle Application Server deployments, you can work around this issue by modifying the mod_osso.conf file as follows:
Locate the following entry:
<Location /xmlpserver>
require valid-user
AuthType Basic
</Location>
Modify this entry as follows:
<Location /xmlpserver>
require valid-user
AuthType Basic
OssoSendCacheHeaders off
Header unset Pragma
Header unset Cache-Control
Header unset Vary
</Location>
For non-Oracle Application Server deployments, please see the Microsoft documents noted above for possible resolutions that can be implemented in your environment as well as your application server documentation for information on turning off the "Pragma" and "Cache-Control" HTTP header properties.
If you have configured BI Publisher to use an LDAP server, users with multibyte characters in their user name will not be able to see the Admin tab, even when granted the Administration Role. To work around this issue, create a user name with ASCII characters for users needing the Administration role.
When you delete a user, the user directory under the Reports tab/repository (Home>Users) is not deleted and cannot be deleted through the user interface.
To work around this issue, you must manually delete the user folder from the repository:
For file-based repositories:
Log on to the machine where BI Publisher is installed.
Locate the user folder under the %BIPublisher_Repository%/Users directory. Each user folder starts with a tilda character, for example: ~User1.
Delete the folder of the removed user.
If you click the Dashboards link from the BI Publisher application to navigate to the Business Intelligence Dashboards page, you will be prompted to log in again before you can access the Dashboards page.
This issue has no workaround.
Users of Fusion Intelligence will get the following error when attempting to launch BI Publisher from the Oracle Business Intelligence More Products menu:
Oracle BI Publisher Enterprise
Error processing your BI Publisher request. Please contact your administrator to review the log files.
Error Details
Error Codes: S8VLP8HS
The Fusion Intelligence authentication method does not work with BI Publisher and users will not be able to navigate to BI Publisher from the More Products menu when using Fusion Intelligence.
This issue has no workaround.
The privileges assigned to the BI Publisher Superuser account are limited to tasks on the Admin page. The intention of the Superuser is to allow access to the system in the event of a failed or misconfigured external security model.
If you are using a clustered environment, and you have a CUPS server implemented as a delivery option with no other printers defined, you may not see your CUPS Server as a delivery option.
To work around this problem, add a real or dummy printer destination by creating an entry in the Admin > Delivery > Printer interface.
The following issues relate to the BI Publisher scheduler.
Starting with version 10.1.3.2.1 if the administrator has not correctly configured the BI Publisher scheduler, the Schedules tab and the Schedule buttons will be disabled even when the user has the XMLP_SCHEDULER role. To enable the Schedules tab and the Schedule button, you must configure and install the Scheduler tables. See the topic: Configuring the Scheduler Database in the Oracle Business Intelligence Publisher Installation Guide.
To install the BI Publisher scheduler schema in Microsoft SQL 2005 server when BI Publisher is hosted on an OC4J container, you must remove the TopLink JAR files located in the folder:
<OC4J_Home>\toplink\jlib\*
These jar files conflict with the JDBC driver JAR file sqljdbc.jar placed in the WEB-INF/lib folder of BI Publisher Enterprise Server.
On the Scheduler Configuration page, after you select your database type and apply your settings, the database type may reset to a different version of your selected type in the user interface. Although the type displays differently on the Scheduler Configuration page this has no impact on the underlying implementation or the functionality of the scheduler.
This may occur in the following cases:
Microsoft SQL Server 2000 resets to Microsoft SQL Server 2005
IBM DB2 v8 resets to IBMDB2 v9
MySQL 5.0 resets to MySQL 4.1
In release 10.1.3.4.1, BI Publisher introduced certification for Microsoft SQL Server 2008. However, the BI Publisher Scheduler Configuration page does not include Microsoft SQL Server 2008 as an option in the list of supported Database Types.
To use Microsoft SQL Server 2008 as your scheduler database, choose Microsoft SQL Server 2005 as the Database Type, and enter the remaining information to connect to your database.
The user guide contains the "Row Formatting" topic that describes how to set the background color on alternate rows in a tabular report. This description works for PDF output only. In HTML, RTF, and Excel output formats, the alternate rows do not show the background color. In these output formats, all the rows appear with a white background.
This issue has no workaround.
Microsoft Word provides a Page Setup option for specifying the margin for the headers and footers from the edge of the page. This option is available by choosing the File menu, then Page Setup, then the Margins tab, and then the From edge box. This margin setting is not retained when the output format is RTF. The output is created with the default margin settings instead. The margin settings do work correctly for other output formats such as HTML, PDF, and Excel.
This issue has no workaround.
As Oracle XDK conforms to XSL standards for IEEE 754, you might encounter rounding issues when adding numbers that are decimals. For example, suppose you add 13683.80 and 516.39, using this syntax in Oracle BI Publisher:
<?13683.80 + 516.39?>
The value returned is 14200.189999999999 which is caused by a limitation based on the IEEE 754 Binary Floating-Point-Arithmetic.
To work around this issue, use the format-number function or the round syntax as shown here to obtain a return value of 14200.19:
<?format-number:(13683.80 + 516.39);'D99'?>
or
<?(round((13683.80 + 516.39)*100) div 100)?>
When you design a PDF template with repeatable fields, the output in portrait mode is correctly formatted. However, when the same report is created in landscape mode, the table headers are correct but the following occurs:
Repeating line information (that is, each data field in the iteration) rotates by 90 degree.
The repeating lines spread across in a horizontal direction from right to left instead of top to bottom in a vertical direction.
This issue has no workaround.
BI Publisher's PDF mapping tool used to map data fields to form fields in a PDF template, currently does not support Adobe Acrobat Reader 8.0. You must use Acrobat Reader 7.0 (or Acrobat Reader 6.0 if English is the only language required for your site).
If you are working in multiple languages, to show and input the text on the Template Builder dialogs correctly, you must set your operating system regional settings for the target language. To set the Regional and Language Options:
From the Control Panel choose Regional and Language Options.
Click the Advanced tab.
Under Language for non-Unicode programs, select the appropriate language from the list.
The Template Builder does not support other languages than those available from your system regional settings.
If you wish to use both the BI Publisher Analyzer for Excel and the new BI Office Add-in (available with the Oracle Business Intelligence Enterprise Edition), you must install the BI Publisher Analyzer for Excel first. If you install the BI Office Add-in first, you must uninstall it before you can install the BI Publisher for Analyzer for Excel, then reinstall the BI Office Add-in.
Microsoft applications, including Excel, have a file name length limit. The limit differs by versions and operating system combinations. For Excel to open a file, the total length of the full path and file name including extension cannot exceed the limit (usually 200 - 256 characters). If your file name exceeds this limit and you try to launch the Excel Analyzer you will receive the error:
"Unable to find file <filename>.xls, please check file name spelling, and make sure file location is correct."
This is most likely to occur when your file name contains multibyte characters.
To work around this issue, rename your report with a shorter name and do not use multibyte characters in the file name.
When using the Template Builder, if you attempt to insert a group or a repeating group around a chart, no dialog box will appear to allow you to specify the properties of the repeating group.
To work around this issue, follow these steps:
Place your cursor before the chart in your template.
From the Oracle BI Publisher menu select Insert, then Field.
Select any element from your data displayed in the Field dialog and insert it before the chart.
After the field has been inserted, select the field and the chart.
From the Oracle BI Publisher menu select Insert, then Repeating Group.
Specify the properties for the repeating group in the BI Publisher Properties dialog and insert the repeating group.
After the repeating group has been inserted, delete the temporary field you created before the chart.
Flash templates require Adobe Flash Player 9. Currently the Flash Player 9 is not available for FireFox on Solaris. Until Flash Player 9 is released for this platform, Flash templates cannot be viewed on Solaris. This issue has no workaround.
Reports based that use the BI Publisher data template as the data model may fail with the following error:
Data not defined
This will occur if you define a parameter in your data template that you do not pass a value to via the user interface. For example, if you define a data template with a parameter ("P1" in the example) similar to the following:
<dataTemplate name="prodTemplate" dataSourceRef="demo-hr">
<parameters>
<parameter name="P1" dataType="character" defaultValue="Hello"/>
</parameters>
<dataQuery>
<sqlStatement name="prodStmt">
<![CDATA[
select last_name, first_name, salary
from employees
where salary > 4000
]]>
</sqlStatement>
</dataQuery>
</dataTemplate>
But you do not define this parameter in BI Publisher's Edit report page, you will get the error.
Note that reports defined this way would not cause an error in 10.1.3.2, but will result in the error in 10.1.3.3.
To work around this issue, define the parameter in BI Publisher's Edit report page.
This issue applies to version 10.1.3.4.1.
Prior to release 10.1.3.4.1, the data type of a parameter passed by a BI Publisher Data Template was not validated. Parameter values were passed as string objects regardless of the data types defined for the parameters in the data template. Therefore, parameters could be passed from the data template to a function or to a report that defined the parameter data type differently, without encountering an error.
In 10.1.3.4.1 data type validation has been implemented. Now if the parameter data type passed by the data template does not match the parameter data type defined in the function or report, an error will be thrown.
Note that you may encounter errors for reports that previously ran successfully. To avoid errors, ensure that a parameter data type defined in a data template matches the data type defined in the function or report to which it is passed.
The BI Publisher Query Builder includes an option to "Check All" when selecting columns from a table. If the table contains more than 20 columns, only the first 20 will be selected.
To work around this issue, you must manually select all columns.
When building a query using the BI Publisher Query Builder you have the option of specifying an Alias for the column name. If the name you specify includes multibtye characters you will get the following error:
"Illegal character found in the alias."
This issue has no workaround.
When creating a query for a list of values (LOV), you can choose the "Default Data Source" or select a specific data source. If you select the "Default Data Source," when you run the report it may either fail to run and return the following error:
Parameter name: <parameter> Can not establish database connection (null)
or just display the "Processing...." indicator, and never return any data.
To work around this problem, select a specific data source when creating a query for an LOV.
When setting up a Web service as a data source and the Web service WSDL and the Web service end point use HTTPS protocol, you must perform the appropriate configuration to enable the BI Publisher server and the requested target to perform an SSL (Secure Socket Layer) handshake.
To set up the SSL handshake:
Navigate to the HTTPS site where the WSDL resides.
Download the Certificate following the prompts (the prompts will vary depending on your browser).
Install the Certificate into your keystore using the Java keytool, as follows:
keytool -import -file <certfile> -alias <certalias> -dest <keystore file>
Before starting your application server, set the JAVA_OPTS environment variable to tell the BI Publisher server where to find the keystore, as follows:
set JAVA_OPTS=-Djavax.net.ssl.trustStore=<keystore file>
Now when you restart your application server, BI Publisher will be able to access the HTTPS WSDL.
The online help included with the Template Builder Add-in for Microsoft Word states the following:
The Template Builder can be used with a BI Publisher configuration file. The configuration file must be named xdoconfig.xml and must be stored in the config directory (example path: C:\Program Files\Oracle\BI Publisher Desktop\config) under the BI Publisher directory.
The path to the config directory is incorrect. The path should be noted as:
C:\Program Files\Oracle\BI Publisher Desktop\Template Builder for Word\config
The online help included with the Template Builder for Microsoft Word Add-in contains an incorrect description of setting the font size for Tree View panes and Properties panes. The description is found on the help page for the Options Dialog, under the UI tab description. The font size setting has been removed from the Options, UI tab; therefore the section titled "Font Size" on the help page is incorrect and should be ignored.
The BI Publisher Certification Guide has been updated. IBM Websphere 6.0 is no longer supported as an application server. If you are upgrading from a previous version of BI Publisher, you must upgrade Websphere to version 6.1.
The initial release of the BI Publisher certification guide incorrectly stated that the BI Publisher Template Builder Add-in for Microsoft Word was certified with Java Runtime Environment (JRE) version 1.4. This has been corrected to Java version 1.5.
For all current certification information for this release, please refer to the Oracle Business Intelligence Publisher Certification Information available from the Oracle Business Intelligence Publisher documentation library:
http://www.oracle.com/technology/documentation/bi_pub.html
Starting with release 10.1.3.4, BI Publisher no longer supports Java 1.4. The BI Publisher server and BI Publisher desktop components both require Java 5.0 (1.5) or later.
The Oracle Business Intelligence Publisher Installation Guide (E12690-01) incorrectly states that Java Runtime 1.4 is supported in the following places:
Page 1-3: BI Publisher is supported to run against any database that supports JDBC based on Java 1.4.2 or Java 5.0 (1.5). This should state Java 5.0 (1.5) only.
Page 1-5: The Template Builder for Microsoft Word Add-in requires Java Runtime or JDK 1.4 or later. This should state Java Runtime 1.5 or later.
In the Oracle Business Intelligence Publisher Report Designer's Guide (for release 10.1.3.4) and the Oracle Business Intelligence Publisher User's Guide (for releases prior to 10.1.3.4), the Parameter Mapping table under the topic "Enabling Bursting" incorrectly lists the parameters for the Printer channel.
The correct parameter values are shown in the following table alongside the incorrect listings currently shown in the documentation.
| Parameter | Incorrect Value in Document | Corrected Value |
|---|---|---|
| Parameter 1 | Printer Group | Printer Name |
| Parameter 2 | Printer | Number of copies |
| Parameter 3 | Number of Copies | Sides |
| Parameter 4 | Sides | Tray |
| Parameter 5 | Tray | not used |
The following documentation error applies to the Oracle Business Intelligence Publisher Report Designer's Guide (for release 10.1.3.4) and the Oracle Business Intelligence Publisher User's Guide (for releases prior to 10.1.3.4).
In the chapter, "Creating an RTF Template," the CD Ratings Example under the topic "Drawing, Shape, and Clip Art Support" shows incorrect syntax for repeating the star shape. The incorrect syntax and corrected syntax are shown in the following tables:
| Field | Form Field Entry |
|---|---|
| (star shape) | <?for-each@shape:xdoxslt:foreach_number($_XDOCTX,0,USER_RATING,1)?> |
The corrected syntax is shown in the following table. Note that the 0 shown after $_XDOCTX should be 1.
| Field | Form Field Entry |
|---|---|
| (star shape) | <?for-each@shape:xdoxslt:foreach_number($_XDOCTX,1,USER_RATING,1)?> |
In the Oracle Business Intelligence Publisher Administrator's and Developer's Guide (for release 10.1.3.4) and the Oracle Business Intelligence Publisher User's Guide (for releases prior to 10.1.3.4), the chapter "Defining a Security Model" incorrectly lists the internal name for the "BI Publisher Template Designer" role as "XMLP_TEMPLATE_DESIGNER". The correct internal name is "XMLP_TEMPLATE_BUILDER".
This BI Publisher role is incorrectly listed in the following sections:
Integrating with LDAP
Integrating with Oracle E-Business Suite Security
Integrating with Oracle BI Server Security
Integrating with Oracle Database Security
The BI Publisher Template Designer role is described as follows: "allows users to connect to the BI Publisher server from the Template Builder and to upload and download templates."
If you have already set up (or plan to set up) one of the security models listed and you require the BI Publisher Template Designer role for your users, then you must set up the role "XMLP_TEMPLATE_BUILDER" in your security model and assign this role to your users.
The Oracle Business Intelligence Publisher Administrator's and Developer's Guide (page 11-3) incorrectly lists the required JAR files for working with the BI Publisher Java APIs. The correct list is as follows:
bicmn.jar - a charting library
bipres.jar - a charting library
collections.jar - required only if you are working with the delivery APIs or bursting engine
i18nAPI_v3.jar - the i18n library used for localization functions
jewt4.jar - a charting support library
orai18n.jar - contains character set and globalization support files
share.jar - a charting support library
versioninfo.jar
Note: If you are using the E-Business Suite version of BI Publisher, use aolj.jar instead.
xdochartstyles.jar - contains additional chart styles not included in BI Beans
xdocore.jar - the core BI Publisher library
xdoparser.jar - the scalable XML parser and XSLT 2.0 engine
xmlparserv2.jar - the main XML parser/XSLT engine
In the Oracle Business Intelligence Publisher Report Designer's Guide, chapter "Extended Function Support in RTF Templates," under the topic "Extended SQL and XSL Functions," the syntax for the division function is incorrectly given as:
<?xdofx:2/3?>
the correct syntax is:
<?xdofx:2 div 3?>
In the Oracle Business Intelligence Publisher Report Designer's Guide topic "Scheduling a Report," the description for the Run Monthly option states that you can select multiple days of the month to run a report, as follows: "To select multiple days of the month to run the report, enter each day separated by a comma (example: 1,15,28)."
This description is incorrect. The field for entering the day of the month does not support multiple days. You can only enter one day of the month with this option.
In the Oracle Business Intelligence Publisher Report Designer's Guide chapter "Creating an RTF Template," under the topic "Inserting Images and Charts," the syntax for rendering BLOB data as an image is incorrect.
The chapter states: If your data source is a Data Template and your results XML contains image data that had been stored as a BLOB in the database, use the following syntax in a form field inserted in your template where you want the image to render at runtime:
<fo:instream-foreign-object content type="image/jpg">
<xsl:value-of select="IMAGE_ELEMENT"/>
</fo:instream-foreign-object>
The "content type" attribute as shown is incorrect. "content-type' should be hyphenated as follows:
<fo:instream-foreign-object content-type="image/jpg">
The RTF template feature that enables you to specify the ending page of your report (odd or even) is only supported for PDF output. This limitation is not noted in the Oracle Business Intelligence Publisher Report Designer's Guide chapter "Creating an RTF Template."
This section describes issues that have been resolved since the initial release of Oracle BI Publisher version 10.1.3.3.
When viewing a report layout that has a chart in Excel output, you may not see the chart and only see a small icon in the place where you expect to see the chart.
To work around this problem, you must unblock security on image URLs as follows:
Open WEB-INF/web.xml.
Find the following block:
<filter-mapping>
<filter-name>SecurityFilter</filter-name>
<url-pattern>/xdo/tmp/*</url-pattern>
</filter-mapping>
Change the <url-pattern> element as shown:
<filter-mapping>
<filter-name>SecurityFilter</filter-name>
<url-pattern>/xdo/tmp/*.tmp</url-pattern>
</filter-mapping>
Note that by relaxing this security policy as described above, any HTTP session can access and view these images without authentication. Although random numbers are used for image file names, it poses some risk to allow someone to write a program to explore dynamic images (charts and graph) used by BI Publisher HTML reports.
On certain platforms, when generating a report in PDF format from the View Report page, the "processing" or "busy" indicator may not appear to indicate that BI Publisher is processing the request, leaving the user unsure if the submit action was successful.
If your data source is concatenated XML from multiple SQL queries, the XML data will not load properly to the Template Builder from the direct connection to the BI Publisher server.
To work around this issue, after building your data model, generate sample data and save it to an accessible directory. Use the Template Builder's load data function (Oracle BI Publisher > Data > Load Sample XML Data) to load the report data to the Template Builder. For more information on using the Template Builder in disconnected mode, see the Oracle Business Intelligence Publisher User's Guide.
Three areas of the BI Publisher View report page have been enhanced to meet accessibility standards. These are the following:
An alternate text tag has been added to the Oracle logo in the banner.
Proper label tags for assistive technology have been added to the Parameter, Template and Output format lists.
A "Skip Navigation" tag has been added to the navigation links.
In 10.1.3.3.0 the system parameter CURRENT_SERVER_URL available to be included in RTF layout templates does not return a value. This is fixed in 10.1.3.3.1.
If the administrator changes the name of the BI Publisher "Guest" folder and restarts the server for this change to take effect, users will be prompted to enter credentials the next time they try to access this folder. To work around this issue, do not change the name of the Guest folder.
If you are using an LDAP security model, the privileges of member groups may not be properly inherited from the parent groups. For example, suppose you have an Oracle Internet Directory (OID) group named XMLP_Development and this group is a member of another group called XMLP_Admin. Users who are members of the group XMLP_Development may not inherit the privileges assigned to XMLP_Admin as expected.
In 10.1.3.3.0 users with the "BI Publisher Developer" role and not "BI Publisher Administrator" role get a 500 Server Internal Error when they attempt to Edit a report. The workaround was to grant "BI Publisher Administrator" role to all users who needed to edit reports.
If you are using the Template Builder for Word on Microsoft Windows XP and have applied the Microsoft Security Update for Windows XP KB936021, you may receive the following error when trying to load XML data:
"Compile error in hidden module Module-starter"
To work around this issue, perform the following:
Close Microsoft Word.
From the Windows Start Menu: Select Programs, then Oracle BI Publisher Desktop, then Template Builder for Word Language.
Select your language and click OK.
When using BI Publisher's data template to generate XML data, extended ASCII characters, such as é or ë are not created correctly in the XML data when the property scalable_mode is set to "on". This property is set in the <properties> section of the data template as follows: <property name="scalable_mode" value="on"/>
If you are using BI Publisher's bursting feature and your bursting job includes PDF reports to be sent to a printer, the print reports may fail with the following error:
Client: (40A) Document Format Not Supported
This is caused by the setting of the document content type to application/pdf by the bursting engine, which is not recognized by all printers. To correct this issue, in 10.1.3.3.1 the bursting engine sets the content type to application/octet-stream for print jobs.
If you use the <?xdofx:chr(n)?> function in an RTF template you may encounter the following error when trying to run or preview the report:
oracle.xdo.parser.v2.XPathException: Extension function error: Method not found 'chr'
New features added to BI Publisher for the 10.1.3.3, 10.1.3.3.1, 10.1.3.3.2, and 10.1.3.3.3 releases are documented in the Oracle Business Intelligence New Features Guide. This guide contains detailed descriptions of the following new features added after the 10.1.3.2 release of Oracle BI Publisher.
For release 10.1.3.4, the base documentation (that is, the Oracle Business Intelligence Publisher Report Designer's Guide and the Oracle Business Intelligence Publisher Administrator's and Developer's Guide) was updated to include these features.
Template Builder Enhancements
Flash Templates
PowerPoint Output
Integration with Oracle BI Discoverer
Performance Improvements
Converting Reports from Oracle Reports to BI Publisher
Support for Digital Signatures in PDF Documents
Support for PostScript Printers
Time Out Value for Web Service Data Sources
Bidirectional Function for eText Data Fields
Default Repository
Oracle BI Publisher Web Services
Support for Document Cache
Support for New Output Types
DataDirect Connect for JDBC Drivers Bundled with BI Publisher Libraries
"Link to this Report" Can Now Be Set as a Report Option
Enhanced Support for Pagination Control in RTF Output
Support for Multiple Cascading Parameters
Support for Vertical Alignment of External Graphics
Support for Multiple Currency Symbol Displays in Report
Integration with Oracle Enterprise Performance Management Workspace
Integration with Oracle Smart Space
Support for Multidimensional Data Sources
Enhancements to the BI Publisher Web Service
Support for "After Report" Triggers
Support for Complex Web Services as a Data Source
New Report Property "Disable Client Access from Analyzer for Excel"
Enhancements to the Template Builder for Microsoft Word Add-in, including page break support, support for additional chart types, and enhanced cross tab features
New features added for release 10.1.3.4.1 are documented in the Oracle Business Intelligence Publisher New Features Guide Release 10.1.3.4.1. These features include:
Support for Oracle WebLogic Server 10.3
Extended Support for Single Sign-On Providers
Automatic Refresh of LDAP Cache
Support for Siebel CRM Security
Support for Secure File Transfer Protocol (SFTP) for Burst Reports
Data Model Enhancements
Scheduler Support for JNDI Connection Pools
Support for Expressions to Calculate Date Parameters
RTF Template Enhancements
Remove Logos and Links from the BI Publisher Header
Restrict Access to Guest Page
Updates to the BI Publisher Web Service
This guide is included in the documentation library delivered with Oracle BI Publisher.
To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.
Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.
Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.
This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services.
![]()
Copyright © 2004, 2009, Oracle. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.