Siebel Administration >  Setting Log Levels for BI Publisher at different levels

How to enable Logs in BI Publisher

In many of the potential error scenarios which could be encountered there is a benefit in having increased logging available on the BI Publisher Server following analysis of the Siebel-side logs. The following section details how to enable increased logging on the BI Publisher Server.

Enabling Logging in BI Publisher 10g :- 

To get xdo.log:-

1) In the Bi Publisher enterprise go to Admin > Server Configuration
2) Under General Properties, set Debug Level to Debug
3) Identify the %ORACLE_HOME% directory into which BI Publisher is installed
4) Create a file called xdodebug.cfg at the following location - <%ORACLE_HOME>\jdk\jre\lib
5) Open the file using a text editor and copy and paste the following text into the file :

LogLevel=STATEMENT
LogDir=C:\OraHome_1\jdk\jre\lib\temp

Note : Replace the 'C:\OraHome_1' text with the path identified in above step 3. And also ensure the log directory specified has write permissions.

6) Within the '<%ORACLE_HOME>\jdk\jre\lib' directory create a subdirectory (in this case the 'temp' directory) which will contain the resulting log files for the increased logging.
5) Shutdown and restart the BI Publisher Command Window

Once BI Publisher has restarted attempt to perform the problematic operation again and a set of files will be created within the 'LogDir' directory set in the xdodebug.cfg. In most cases the most interesting log for debugging purposes will be the xdo.log which contains the command/console window contents along with other diagnostic information. For a succesful report completion there will be a number of other files created within this location which contain various aspects of the data from the report generation as can be seen in the following listing :

09/09/2015 15:30 <DIR> .
09/09/2015 15:30 <DIR> ..
09/09/2015 18:04 1,995,642 xdo.log
09/09/2015 18:03 0 xdo_012110_110322171_rtf_out.xsl
09/09/2015 18:03 0 xdo_012110_110322171_rtf_out_xliff.xml
09/09/2015 18:03 49,752 xdo_012110_110322171_rtf_template.rtf
09/09/2015 18:04 46,724 xdo_012110_110433171_rtf_out.xsl
09/09/2015 18:04 17,001 xdo_012110_110433171_rtf_out_xliff.xml
09/09/2015 18:04 49,752 xdo_012110_110433171_rtf_template.rtf
09/09/2015 18:04 47,065 xdo_012110_110436562_fo_data_11.xsl
09/09/2015 18:04 795 xdo_012110_110436562_fo_data_12.xml
09/09/2015 18:04 1,666 xdo_012110_110436562_fo_fo_14.fo
09/09/2015 18:04 3,888 xdo_012110_110436562_fo_out3.out

Enabling Logging in BI Publisher 11g :-

To get xdo.log:-

1. Determine the absolute path of JAVA_HOME for the WebLogic Domain from file "setDomainEnv.cmd"

%MW_HOME%\user_projects\domains\bifoundation_domain\bin\setDomainEnv.cmd

JAVA_HOME for the domain (bifoundation_domain):

Windows:
C:\> echo %JAVA_HOME%
Result: C:\I\11.1.1\obi\middleware\Oracle_BI1\jdk.

2. Set the environment variable from the above result:

JAVA_HOME = C:\I\11.1.1\obi\middleware\Oracle_BI1\jdk.

3. Create a file named xdodebug.cfg in the "JAVA_HOME\jre\lib" directory

Example: C:\I\11.1.1\obi\middleware\Oracle_BI1\jdk\jre\lib

4. xdodebug.cfg file must contain below two lines:

LogLevel=STATEMENT
LogDir=C:\BIPLogs

Note: Ensure the log directory specified has write permissions.

5. Restart the WebLogic Server.

Trigger a report generation from Siebel,following debug files may be generated:

xdo.log : BI Publisher core engine debug log file
xdo_...xsl : XSL-FO version of the RTF template
xdo_...xml : XML data file that is sent from Siebel side to BIP for that report.
xdo_...fo : temporary file created by the FO Engine (only RTF / XSL templates)
xdo_...out : output file (may not exist in case of complete failure)

To get bipublisher.log:-

1. Log into Enterprise Manager - http://<BIP machine>:port/em (Log in with User/Password)
2. In the left pane, drilldown on Weblogic-Domain -> bifoundation_domain -> Adminserver
3. In the right screen, below Admin Server, click on Weblogic Server dropdown and select 'log'.
4. In the below screen, in the search text box, search for 'xdo'
5. In the search result, you will get Oracle.xdo and then in the adjacent drop down select “Trace:32” and click on 'Apply' in the right hand corner.
6. Restart the BI Publisher services through web logic console. 

Log file bipublisher.log is located under -\BIP11ghome\user_projects\domains\bifoundation_domain\servers\AdminServer\logs\bipublisher

Enabling Logging in BI Publisher 12c :-  

To get bipublisher.log:-

1. Login to BI Publisher enterprise manager - http:/biphost:9500/em
2. Click on the tree hierarchy which is present on the top left hand side
3. Expand until bi_server1, and then right click on it . Under ‘Logs’ choose ‘Log Configuration’.
4. It will open ‘Log Configuration’ window. Search for ‘Oracle xdo’
5. Under 'All Categories' search for 'xdo'
6. This will retrieve the record with name 'Oracle.xdo'.
7. Under ‘Oracle Diagnostic Logging Level (Java level)’ choose ‘Trace:32 (FINEST)’ and click on ‘Apply’
8. Wait until you receive the confirmation.
8. Restart find the detailed bipublisher.log generated under
\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\servers\bi_server1\logs\bipublisher

Trace32 logging is the finest logging level, this file will increase to a large size, once the required logging is completed, confirm the logging level is reverted.

Note: If you restart bi_server, changes here will be lost and it will reset to default log level ‘Notification’

To get xdo.log:-

1. Determine the absolute path of JAVA_HOME for the WebLogic Domain from file "setDomainEnv.cmd"

\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bin\setDomainEnv.cmd

JAVA_HOME for the domain (bifoundation_domain):

Either it might be set to C:\JDK Or C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk

Windows:
C:\> echo %JAVA_HOME%
Result: C:\JDK
Or
C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk               

2. Set the environment variable from the above result:

JAVA_HOME = C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk Or C:\jdk

Suppose if JAVA_HOME in setDomainEnv.cmd is set to C:\jdk then set the environment variable JAVA_HOME to C:\jdk

Suppose if JAVA_HOME in setDomainEnv.cmd is set to C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk then set the environment variable JAVA_HOME to C:\jdk

3. Create a file named xdodebug.cfg in the "JAVA_HOME\jre\lib" directory

Example: C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\lib  Or C:\jdk\jre\lib

4. xdodebug.cfg file must contain below two lines:

LogLevel=STATEMENT
LogDir=C:\BIPLogs

Note: Ensure the log directory specified has write permissions.

5. Restart the WebLogic Server.

Trigger a report generation from Siebel,following debug files may be generated:

xdo.log : BI Publisher core engine debug log file
xdo_...xsl : XSL-FO version of the RTF template
xdo_...xml : XML data file that is sent from Siebel side to BIP for that report.
xdo_...fo : temporary file created by the FO Engine (only RTF / XSL templates)
xdo_...out : output file (may not exist in case of complete failure)

Enable Logging in Dedicated or Mobile Clients

The same mechanism applies to enable debugging in dedicated clients as it does when enabling logging on the BI Publisher Server itself.

In order to enable logging an xdodebug.cfg file must be created and contain the LogLevel and LogDir parameters. The difference when enabling logging for the dedicated or mobile clients is the location into which this must be placed. In these instances the xdodebug.cfg must be placed into the 'lib' dir of the jre installation being used by the client. This can be established through reviewing the PATH settings on the client. For example :

Once the file has been created, a suitable logging directory been made available, and the directory specified in the xdodebug.cfg then any subsequent runs of BI Publisher reports through the web client should log information as detailed above for the BI Publisher Server.

Enabling HTTP access logging for the BI Publisher Server

In order to test whether or not there are problems accessing the BI Publisher Server from within Siebel an access control log can be enabled on the BI Publisher which will allow a review of HTTP requests and response codes to be reviewed. The following steps detail how to enable this when running BI Publisher within OC4J :

1) Navigate to ‘%ORACLE_HOME%\oc4j_bi\j2ee\home\config’
2) Take a backup of and then open the default-web-site.xml
3) Make the following changes :
    From :

    To :

    From :

    To :

4) Then shutdown and restart the BI Publisher Server

This will then result in an access log being written to the following path with the date appended to the filename :
<access-log path="../log/default-web-access.log" split="day"/>