In this Document
APPLIES TO:
Oracle Shipping Execution - Version 11.5.2 and later
Information in this document applies to any platform.
Oracle Shipping Delivery Based - Version: 11.5.2 to 12.1
***Checked for relevance on 18-Mar-2011***
MAIN CONTENT
Goal
Generate debug files to be used to analyze code and assist Support and Development in resolving Shipping application issues.
In addition please also provide the following required outputs :
- Output of the Oracle Order Management Sales Order Setup Test (Document 463673.1) or HTMomse12.sql output of (Document 133464.1),
- Output from either the ACT tool (Document 183274.1) or the Diagnostics Apps Check (Document 276207.1).
Solution
FOR HTML SHIPPING USER INTERFACE FORMS ONLY for Version 12.2.X and above
To generate a debug file from the HTML Shipping Transaction or Quick Ship forms:
For the HTML Shipping User Interface forms, the standard Logging mechanism provided by OAF is in use . This will be different from how “Shipping Debug Log” file is generated from Shipping Transaction form in Shipping Execution.
1) Enable FND logging as per MOS Note 433199.1 to get the debug log.
2) Set the following profile at User Level :
WSH: Debug Enabled - set to Yes
WSH: Debug Log Directory - This profile option may be set at the Site level to any valid directory path.
WSH: Debug Level - set to Statement
FND: Diagnostic to Yes
FND: Debug log enabled to Yes
FND: Debug log module to wsh%
FND: Debug log level to Statement.
3) Log message will get written to table FND_LOG_MESSAGE.
4) Just before the issue is reproducible , execute the following SQL statement:
select max(log_sequence) from fnd_log_messages;
Note down the value as “Start Message Number”.
5) Then perform the reproducible steps. Once completed, again execute the above SQL statement and note down the value as “End Message Number”.
6) To get the log messages, execute the following SQL statement:
select module, message_text, log_sequence from fnd_log_messages where log_sequence between “Start Message Number” and “End Message Number”;
Versions 11.5.9 to 12.x
A. To generate a debug file from the Shipping Transaction or Quick Ship forms:
Note: if executing Pick Release from this form, please refer to B. Pick Release below for additional settings and log file.
1. Please set the following Profile Options at the User level for your user_id. These should be reset to previous values after you complete debugging.
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
WSH: Debug Log Directory - This profile option may be set at the Site level to any valid directory path.
A valid path is any directory that can be written to by the database. To find available paths, run the following SQL statement:
select value from v$parameter where name = 'utl_file_dir'
3. In the Shipping form, go to Tools and check the Debug box. Please make a note of the file name displayed for later retrieval.
4. Perform the action you wish to debug.
5. Go to Tools and uncheck Debug.
6. Provide the debug file from the directory specified in step 3.
7. Reset profile options in Step 1.
**If the profile option WSH:Debug Log Directory is set to the same path as OM: Debug Log Directory profile option, the file may be retrieved using the Order Management concurrent request Diagnostic: OM Debug File Retrieval (Order Management responsibility, Reports,Requests > Request > Single Request). .
B. To generate a debug for Pick Release:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11 >
3. ONLY IF using Warehouse Management (WMS), set the following profile options:
FND: Debug Log Enabled - set to Yes
FND: Debug Log Level - set to Statement
FND: Debug Log Module - set to wms.plsql.%
4. In the Release Sales Order for Picking form go to Tools and check the Debug box.
5. Submit the pick release.
6. Provide the Pick Selection List Generation log file (View > Requests > Find the Pick Selection List Generation Log file > Click on View Log)
7. Reset profile options in Step 1 and if using WMS, Step 3.
C. To generate a debug for Interface Trip Stop - SRS:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5 WSH: Debug Enabled - set to Yes INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11
3. Set the Debug Level parameter to 1 (Debugging ON)
4. Submit the job.
5. Provide the Interface Trip Stop log file (View > Requests > Find the Interface Trip Stop request -> click on view log)
6. Reset profile options in Step 1.
D. To generate a debug for an API:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11
WSH: Debug Log Directory - This profile option may be set at the Site level to any valid directory path.
A valid path is any directory that can be written to by the database.
To find available paths, run the following SQL statement:
select value from v$parameter where name = 'utl_file_dir'
**If the profile option is set to the same path as OM: Debug Log Directory profile option, the file may be retrieved using the Order Management concurrent request Diagnostic: OM Debug File Retrieval (Order Management responsibility, Reports,Requests > Request > Single Request). .
3. Add the following line of code in the wrapper script which calls the API:
DECLARE l_file_name VARCHAR2(32767);
l_return_status VARCHAR2(32767);
l_msg_data VARCHAR2(32767);
l_msg_count NUMBER;
BEGIN
fnd_profile.put('WSH_DEBUG_MODULE','%');
fnd_profile.put('WSH_DEBUG_LEVEL',WSH_DEBUG_SV.C_STMT_LEVEL);
wsh_debug_sv.start_debugger(l_file_name,l_return_status,l_msg_data,l_msg_count);
4. Submit the job.
5. Provide the log file.
6. Reset profile options in Step 1.
Versions 11.5.2 to 11.5.8
E. To generate a debug for Pick Release:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11
3. In the Release Sales Order for Picking form go to Tools and check the Debug box.
4. Submit the pick release.
5. Provide the Pick Selection List Generation log file (View > Requests > Find > click on View Log... for the appropriate file), the file displayed in Step 3.
6. Reset profile options in Step 1.
F. To generate a debug for Interface Trip Stop - SRS:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11
3. Set the Log Level parameter to 1 (Debugging ON)
4. Submit the job.
5. Provide the Interface Trip Stop log file (View > Requests > Find > click on View Log... for the appropriate file).
6. Reset profile options in Step 1.
G. To generate a debug for an API:
1. Following Profile Options need to be set before each test case, then reset after completion:
OM: Debug Level - set to 5
WSH: Debug Enabled - set to Yes
INV: Debug Trace - set to Yes
2. The following Profile Option once set do not need to be changed.
WSH: Debug Level - set to Statement
INV: Debug Level - set to 11
WSH: Debug Log Directory
select value from v$parameter where name = 'utl_file_dir'
3. Add the following line of code in the wrapper script which calls the API:
oe_debug_pub.initialize; oe_debug_pub.SetDebugLevel(5); DBMS_OUTPUT.PUT_LINE('Debug File = ' ||OE_DEBUG_PUB.G_DIR||'/'||OE_DEBUG_PUB.G_FILE);
4. Submit the job.
5. Provide the log file
6. Reset profile options in Step 1.
REFERENCES
NOTE:183274.1 - 11i : Applications DBA RDA Data Collection Test
NOTE:276207.1 - Diagnostics : Apps Check [Video]
NOTE:463673.1 - R12.0.[3-4] : Oracle Order Management Sales Order Setup Test
NOTE:133464.1 - HTMOMSE Sales Order Diagnostic Script
NOTE:1358154.1 - Diagnostics : WSH Shipping Forms Debugging [Video]
NOTE:1358164.1 - Diagnostics : WSH Pick Release Debug [Video]