15 Collecting Debug Data

15.5.2.1 Editing the logging.xml file for Debugging

In order to enable the debug information for the errors that occur when using any RDC application page, the Data Entry window or both, the logging.xml file needs to be updated as follows.

Go to the following location:

middleware_home\user_projects\domains\OPADomain\config\fmwconfig\servers\OpaServer1

Open logging.xml, the logging configuration file and insert the following:

 <?xml version='1.0' encoding='UTF-8'?>
 <logging_configuration>
 <log_handlers>
 ..
 ..
  <log_handler name='rdchandler'
 class='oracle.core.ojdl.logging.ODLHandlerFactory'
 filter='oracle.dfw.incident.IncidentDetectionLogFilter'>
    <property name='path'
 value='${domain.home}/servers/${weblogic.Name}/logs/${weblogic.Name}-rdc_1.log'/>
    <property name='maxFileSize' value='10485760'/>
    <property name='maxLogSize' value='104857600'/>
    <property name='encoding' value='UTF-8'/>
    <property name='useThreadName' value='true'/>
    <property name='supplementalAttributes' value='J2EE_MODULE.name,composite_name,component_name'/>
   </log_handler>
   <log_handler name='dehandler'
 class='oracle.core.ojdl.logging.ODLHandlerFactory'
 filter='oracle.dfw.incident.IncidentDetectionLogFilter'>
    <property name='path'
 value='${domain.home}/servers/${weblogic.Name}/logs/${weblogic.Name}-de_1.log'/>
    <property name='maxFileSize' value='10485760'/>
    <property name='maxLogSize' value='104857600'/>
    <property name='encoding' value='UTF-8'/>
    <property name='useThreadName' value='true'/>
    <property name='supplementalAttributes' value='J2EE_MODULE.name,composite_name,component_name'/>
   </log_handler>
 ..
 ..
 </log_handlers>
 <loggers>
 ..
 ..
   <logger name='oracle.pharma.rdc.logging' level='ALL'
 useParentHandlers='false'>  
    <handler name='rdchandler'/>
   </logger>
   <logger name='oracle.pharma.rdc.de' level='ALL'
 useParentHandlers='false'>  
    <handler name='dehandler'/>
   </logger>
 ..
 ..
 </loggers>
 </logging_configuration>

For more information on how to configure the WebLogic server logs, see the Oracle Clinical Administrator's Guide.

For more information about Oracle WebLogic Server, see http://docs.oracle.com/middleware/12212/wls/index.html.

15.5.2.2 Editing the URL for Debugging

You can collect debug information for errors that occur when using any of the RDC application pages and when using the Data Entry window.

To collect this debug information, add the &debug parameter to your URL that starts the RDC application:

&debug=module-name

where module-name defines the type of debugging you want.

Valid entries for module-name:

• surround (only debug errors pertaining to the RDC application pages, such as the Home page, Casebooks page, Review CRFs page, PSDV page, etc.)

• de (only debug errors pertaining to the RDC Data Entry window)

• all (debug errors pertaining to both the RDC application pages and the Data Entry window)

General format of the URL:

https://server.domain/rdcadfsrnd/faces/Login?setUpDone=Y&debug=module-name

Examples:

https://pharma.company.com/rdcadfsrnd/faces/Login?setUpDone=Y&debug=de

https://pharma1.usa.atlantic.com/rdcadfsrnd/faces/Login?setUpDone=Y&debug=all

On using application with debug turned on (setUpDone=Y&debug=module), the debug logs would be created in the in the application_path\log defined in the rdcConfig.properties file.

15.5.3.1 RDC Application Pages Log Files

Locate and check the ${weblogic.Name}-rdc_1.log log files for the application pages.

RDC records all logs against a user identifier that consists of the user name, the database, and the HTTP session ID.

You can locate all the log entries for the user for a particular RDC session by searching for the HTTP session ID in the log file. The HTTP session ID is the alphanumeric string that follows the user@database information in the <MSG_TEXT> tag.

15.5.3.2 RDC Data Entry Window Log Files

RDC records all logs against a user identifier that consists of the user name, the database, and the HTTP session ID.

To review the information in the data entry logs: 

1. Locate and check the ${weblogic.Name}-de_1.log log files for the data entry window. See Section 15.5.2.1, "Editing the logging.xml file for Debugging" for more information.

2. Use the same session ID to locate the data entry logs.

   When the user opens a Data Entry window, RDC assigns a unique ID to the window. In addition, RDC creates a log entry against the user's HTTP session ID.

   You can locate all data entry logs relevant to the user for the data entry session using the HTTP session ID and the Window context ID. The following example highlights these IDs in bold.

   [9e46412a075dc5104ec7e9a06b704bbfb121525115d20e641d6835974ac786e8] Window context Id for this CRF: 4750992751934458

15.5.3.3 Data Capture API (DCAPI) Logs

Every data entry session is supported by a data capture engine running on the middle tier for that session. This engine consists of the following parts:

• A Java layer

• A process (olsadcapiservice.exe)

• A DLL (olsadcapi.dll) loaded by the process

Each part generates a log file when logging is enabled.

DCAPI log files contain internal technical messages that may be meaningful to Oracle support and development only.

The name of these log files use the following format:

• Java layer: DcapiJava_user-name_date-time.dbg

• Process layer: DcapiExec_user-name_date-time.dbg

• DLL layer: DcapiHtml_user-name_date-time.dbg

  where:

  user-name is the user's login ID.

  date-time is the date and time of the event. For example, 2009Aug15134550236.

15.5.3.4 Data Capture API (DCAPI) Framework Logs

You can enable RDC to generate DCAPI framework logs that capture logs from the common code that creates, manages, and closes DCAPI instances. The DCAPI generates two log files for each instance running WebLogic Admin Server. These log files help when troubleshooting issues with launching data entry sessions.

To enable DCAPI framework logging:  

1. Login to admin server console for OPADomain and locate olsardc. See Section D.1, "Locating the olsardc.ear File" for details.

2. Open olsardc.ear using any utility to unzip. See Section D.2, "Manually Extracting and Repacking the olsardc.ear File" for details.

3. Navigate to the following path: middleware_home\user_projects\domains\OPADomain\servers\AdminServer\upload\olsardc.ear\RdcS urroundAdfWebUIWebApp.war\WEB-INF\

4. Locate and open dcapi.properties with a text editor.

5. Find the following parameter and set the value to 1:

   frameworklog=1

6. Find the following parameter:

   frameworkloglocation=

   Specify the location for the DCAPI framework log files. For example, if you want the DCAPI to save the framework log files in the RDC log folder, set the parameter as follows:

   frameworkloglocation=drive:\\RDC_HOME\\log

   Note that you must specify the double forward slash throughout the directory path. Otherwise, the Java APIs read the single slash as an escape character.

7. Save your changes.

8. Re-deploy olsardc. See Section D.4, "Redeploying RDC with Customizations" for details.

9. Restart the OpaServer. See Section D.5, "Restarting the OPA Server" for details.

Once you log in to RDC and open a CRF, the DCAPI generates the framework log files and continuously adds logs to the files. The names for the framework log files use the following format:

• OHSA_DCAPI_Framework_Java_n.log

• OHSA_DCAPI_Framework_Native_n.log

  where n is the JVM instance number. (If a single JVM is running the OC4J instance, then n is 1.)

15.5.7.1 Location of the Dump File

The name of the dump file uses the following format:

logcode.dump

where logcode is the log code that appears in the Data Entry window in case of a fatal failure.

RDC creates this file on the middle tier inthe application_path\log directory defined in the rdcConfig.properties file.

15.5.7.2 Enabling Dump File Creation

RDC always creates dump files in the case of a fatal failure in data entry, with or without logging enabled. However, it is helpful to Oracle support if you generate and gather more information by enabling logging for data entry.

For critical errors, Oracle suggests that you set the data entry log level to FINEST, and then reproduce the failure to generate the maximum amount of log information.

Choosing Data Entry Log Level

You can set the level of detail for the Data Entry logs with the value of the parameter level, found in the dataentrylogger.properties file. Any of the following is valid:

• FINE

• FINER

• FINEST

• WARNING

• SEVERE

To modify the value, perform the following steps:

1. Login to admin server console for OPADomain and locate olsardc. See Section D.1, "Locating the olsardc.ear File" for details.

2. Open olsardc.ear using any utility to unzip. See Section D.2, "Manually Extracting and Repacking the olsardc.ear File" for details.

3. Navigate to the following path: middleware_home\user_projects\domains\OPADomain\servers\AdminServer\upload\olsardc.ear\RdcS urroundAdfWebUIWebApp.war\WEB-INF\

4. Open the dataentrylogger.properties file with a text editor, find the parameter level and set the value to FINEST:

   level=FINEST
   

5. Save your changes.

6. Re-deploy RDC. See Section D.3, "Deleting the Existing Deployment" for details.

7. Restart the opaserver. See Section D.4, "Redeploying RDC with Customizations" for details.

15.5.7.3 Reading a Dump File

When a fatal failure occurs in a data entry session, the RDC user should note the log code and report it to you. You can use the log code to locate the dump file in the application_path\log directory.

The dump files has several key sections to help with troubleshooting.

As shown in Example 15-1, the first long alphanumeric string in the first section provides the following important identifiers:

• The HTTP session ID for the user

• The user name and database

• The Window Context session ID for the Data Entry window where the failure happened

• The time stamp for the DCAPI log

#Starting dump of context parameters for failureId: 9522631529
#---------------------------------------------------------------
refids=0a957842231c103dc782a58e44a49c2089684b16a007,
<user>@<database>,28905006072188144,2009Jul15161040954
           

You use the user's session ID, the user name, the database, and the window session ID to search the ${weblogic.Name}-de_1.log (as configured in logging.xml) for all relevant entries. You use the time stamp to locate the DCAPI log files. See Section 15.5.3.3, "Data Capture API (DCAPI) Logs" for more information.

The next section of the log file lists the actual exception stack.

#---------------------------------------------------------------
Exception Details:Error in DCAPI Module.
oracle.pharma.rdc.de.exception.FailedOperationException: Error in DCAPI Module.
       at
oracle.pharma.rdc.de.exception.FailedOperationException.<init>
(FailedOperationException.java:75)
       at
oracle.pharma.rdc.de.service.dcs.DciFormData.doFieldUpdate(DciFormData.java:6274)
.
.
.
                 

jvmid=1