[Home] [Help]
1 PACKAGE xla_utility_pkg AUTHID CURRENT_USER AS
2 /* $Header: xlacmutl.pkh 120.5 2005/10/22 00:05:37 awan ship $ */
3 /*======================================================================+
4 | Copyright (c) 2000-2002 Oracle Corporation |
5 | Redwood Shores, CA, USA |
6 | All rights reserved. |
7 +=======================================================================+
8 | PACKAGE NAME |
9 | xla_utility_pkg |
10 | |
11 | DESCRIPTION |
12 | XLA Utility Package |
13 | |
14 | This package provides wrapper for debugging/benchmark/testing |
15 | facilities. |
16 | |
17 | A] Trace/Debugging facilities. |
18 | |
19 | The output debug messages are either: |
20 | - printed on the standard OUTPUT, |
21 | - sent to another SRS process waiting for a pipe, |
22 | - written to the current logfile through fnd_file |
23 | - written in an HTML page |
24 | - written in a flat file |
25 | |
26 | Usage from SRS|Forms4.5+: |
27 | Setting up profile options: |
28 | xla_debug_mode (Yes/No) |
29 | xla_debug_level (1..100) |
30 | xla_debug_timeout in seconds (1..n) |
31 | |
32 | Usage from SQL*Plus: |
33 | BEGIN |
34 | xla_utility_pkg.init_trace('OUTPUT|FILE',location); |
35 | <PL/SQL source>(...); |
36 | xla_utility_pkg.trace_off('OUTPUT|FILE',location); |
37 | END; |
38 | |
39 | PL/SQL coding standard: |
40 | BEGIN |
41 | xla_utility_pkg.init_trace(mode,location) |
42 | .../... |
43 | xla_utility_pkg.trace('String',trace_level); |
44 | xla_utility_pkg.trace('String',trace_level); |
45 | .../... |
46 | xla_utility_pkg.trace_off(location); |
47 | END; |
48 | |
49 | |
50 | B] SRS Output and logfile facilities |
51 | |
52 | Example of calls: |
53 | BEGIN |
54 | .../... |
55 | xla_utility_pkg.print_outputfile(msg); |
56 | xla_utility_pkg.print_logfile(msg); |
57 | .../... |
58 | END; |
59 | |
60 | |
61 | C] Statistics |
62 | |
63 | Example of calls: |
64 | BEGIN |
65 | xla_utility_pkg.init_stat; |
66 | <PL/SQL source>(...); |
67 | xla_utility_pkg.stat_off; |
68 | END; |
69 | |
70 | |
71 | D] SQL Trace facilities |
72 | |
73 | Example of calls: |
74 | BEGIN |
75 | .../... |
76 | xla_utility_pkg.init_sqltrace; |
77 | .../... |
78 | xla_utility_pkg.sqltrace_off; |
79 | .../... |
80 | END; |
81 | |
82 | |
83 | |
84 | WARNING |
85 | Procedure init_trace performs a commit in SRS_DBP mode |
86 | |
87 | HISTORY |
88 | 07-Dec-95 P. Labrevois Created |
89 | 08-Feb-01 Created for XLA |
90 | 22-Mar-01 Added Trace level |
91 | 08-May-01 Added get_session_info |
92 | 20-Sep-01 Added dbms_trace |
93 | 20-Oct-05 A.Wan 4693865 ATG Profile Options |
94 +=======================================================================*/
95
96 g_unique_location VARCHAR2(2000) := NULL;
97
98 g_debug BOOLEAN := FALSE;
99 g_trace VARCHAR2(1);
100 g_stat VARCHAR2(1);
101
102 --
103 -- Debug level (0 min - 100 max)
104 --
105 g_trace_level INTEGER;
106 g_profiler VARCHAR2(1);
107 g_dbms_trace VARCHAR2(1);
108
109
110 /*======================================================================+
111 | |
112 | |
113 | |
114 | |
115 | |
116 | |
117 | |
118 | |
119 | |
120 | |
121 | |
122 | |
123 | |
124 | |
125 | |
126 | |
127 | |
128 | |
129 | |
130 | |
131 | Activation/Deactivation |
132 | |
133 | |
134 | |
135 | |
136 | |
137 | |
138 | |
139 | |
140 | |
141 | |
142 | |
143 | |
144 | |
145 | |
146 | |
147 | |
148 | |
149 | |
150 | |
151 | |
152 +======================================================================*/
153
154 /*======================================================================+
155 | |
156 | Public Procedure |
157 | |
158 | Activate |
159 | |
160 | Activate the XLA Debug mode. |
161 | |
162 +======================================================================*/
163 PROCEDURE Activate
164 (p_debug_mode IN VARCHAR2
165 ,p_Location IN VARCHAR2);
166
167
168 /*======================================================================+
169 | |
170 | Public Procedure |
171 | |
172 | deactivate |
173 | |
174 | De-Activate, if set, the XLA debug mode. |
175 | |
176 +======================================================================*/
177 PROCEDURE Deactivate
178 (p_Location IN VARCHAR2);
179
180
181 /*======================================================================+
182 | |
183 | Public Procedure |
184 | |
185 | set_option |
186 | |
187 | Set any option. |
188 | |
189 +======================================================================*/
190 PROCEDURE set_option
191 (p_option IN VARCHAR2
192 ,p_option_value IN VARCHAR2);
193
194
195 /*======================================================================+
196 | |
197 | Public Function |
198 | |
199 | get_session_info |
200 | |
201 | Return system informations about the current session. |
202 | |
203 +======================================================================*/
204 FUNCTION get_session_info
205 (p_option IN VARCHAR2)
206 RETURN VARCHAR2;
207
208
209 /*======================================================================+
210 | |
211 | Public Function |
212 | |
213 | get_option_value |
214 | |
215 | Set any option. |
216 | |
217 +======================================================================*/
218 FUNCTION get_option_value
219 (p_option IN VARCHAR2)
220 RETURN VARCHAR2;
221
222
223
224 /*======================================================================+
225 | |
226 | |
227 | |
228 | |
229 | |
230 | |
231 | |
232 | |
233 | |
234 | |
235 | |
236 | |
237 | |
238 | |
239 | |
240 | |
241 | |
242 | |
243 | |
244 | |
245 | Trace |
246 | |
247 | |
248 | |
249 | |
250 | |
251 | |
252 | |
253 | |
254 | |
255 | |
256 | |
257 | |
258 | |
259 | |
260 | |
264 | |
261 | |
262 | |
263 | |
265 | |
266 +======================================================================*/
267
268 /*======================================================================+
269 | |
270 | Public Procedure |
271 | |
272 | Activate_trace |
273 | |
274 | Activate the XLA Trace mode. |
275 | |
276 +======================================================================*/
277 PROCEDURE Activate_trace
278 (p_debug_mode IN VARCHAR2
279 ,p_Location IN VARCHAR2);
280
281
282 /*======================================================================+
283 | |
284 | Public Procedure |
285 | |
286 | deactivate |
287 | |
288 | De-Activate, if set, the XLA Trace. |
289 | |
290 +======================================================================*/
291 PROCEDURE Deactivate_trace
292 (p_Location IN VARCHAR2);
293
294
295 /*======================================================================+
296 | |
297 | Public Procedure |
298 | |
299 | set_trace_on |
300 | |
301 | Activate the XLA trace. |
302 | |
303 +======================================================================*/
304 PROCEDURE set_trace_on;
305
306
307 /*======================================================================+
308 | |
309 | Public Procedure |
310 | |
311 | set_trace_off |
312 | |
313 | De-Activate, if set, the XLA Trace. |
314 | |
315 +======================================================================*/
316 PROCEDURE set_trace_off;
317
318
319 /*======================================================================+
320 | |
321 | Public Procedure |
322 | |
323 | trace |
324 | |
325 | Debugging. Msg will be printed in the std trace output if the level |
326 | satifsy the context criteria. |
327 | |
328 +======================================================================*/
329 PROCEDURE trace
330 (p_msg IN VARCHAR2
331 ,p_level IN NUMBER );
332
333
334 /*======================================================================+
335 | |
336 | Public Procedure |
337 | |
338 | print_trace_info |
339 | |
340 | Print all information related to the trace to the std Trace output. |
341 | |
342 +======================================================================*/
343 PROCEDURE print_trace_info;
344
345
346
347 /*======================================================================+
348 | |
349 | |
350 | |
351 | |
352 | |
353 | |
354 | |
358 | |
355 | |
356 | |
357 | |
359 | |
360 | |
361 | |
362 | |
363 | |
364 | |
365 | |
366 | |
367 | |
368 | Print |
369 | |
370 | |
371 | |
372 | |
373 | |
374 | |
375 | |
376 | |
377 | |
378 | |
379 | |
380 | |
381 | |
382 | |
383 | |
384 | |
385 | |
386 | |
387 | |
388 | |
389 +======================================================================*/
390
391 /*======================================================================+
392 | |
393 | Public Procedure |
394 | |
395 | print |
396 | |
397 | Debugging. Msg will be printed in the std debug output. |
398 | |
399 +======================================================================*/
400 PROCEDURE print
401 (p_msg IN VARCHAR2);
402
403
404 /*======================================================================+
405 | |
406 | |
407 | |
408 | |
409 | |
410 | |
411 | |
412 | |
413 | |
414 | |
415 | |
416 | |
417 | |
418 | |
419 | |
420 | |
421 | |
422 | |
423 | |
424 | |
425 | SRS log and output files utilities |
426 | |
427 | |
428 | |
429 | |
430 | |
431 | |
432 | |
433 | |
434 | |
438 | |
435 | |
436 | |
437 | |
439 | |
440 | |
441 | |
442 | |
443 | |
444 | |
445 | |
446 +======================================================================*/
447
448
449 /*======================================================================+
450 | |
451 | Public Procedure |
452 | |
453 | print_logfile |
454 | |
455 | Print the messgage to the fnd output file |
456 | |
457 +======================================================================*/
458 PROCEDURE print_outputfile
459 (p_msg IN VARCHAR2) ;
460
461
462 /*======================================================================+
463 | |
464 | Public Procedure |
465 | |
466 | print_logfile |
467 | |
468 | Print the messgage to the fnd log file |
469 | |
470 +======================================================================*/
471 PROCEDURE print_logfile
472 (p_msg IN VARCHAR2) ;
473
474
475 /*======================================================================+
476 | |
477 | |
478 | |
479 | |
480 | |
481 | |
482 | |
483 | |
484 | |
485 | |
486 | |
487 | |
488 | |
489 | |
490 | |
491 | |
492 | |
493 | |
494 | |
495 | |
496 | Statistics |
497 | |
498 | |
499 | |
500 | |
501 | |
502 | |
503 | |
504 | |
505 | |
506 | |
507 | |
508 | |
509 | |
510 | |
511 | |
512 | |
513 | |
514 | |
515 | |
516 | |
517 +======================================================================*/
518
519 /*======================================================================+
523 | Activate_stat |
520 | |
521 | Public Procedure |
522 | |
524 | |
525 | Activate the XLA Stat mode. |
526 | |
527 +======================================================================*/
528 PROCEDURE Activate_stat
529 (p_debug_mode IN VARCHAR2
530 ,p_Location IN VARCHAR2);
531
532
533 /*======================================================================+
534 | |
535 | Public Procedure |
536 | |
537 | deactivate_stat |
538 | |
539 | De-Activate, if set, the XLA Statistical mode |
540 | |
541 +======================================================================*/
542 PROCEDURE Deactivate_stat
543 (p_Location IN VARCHAR2);
544
545
546 /*======================================================================+
547 | |
548 | Public Procedure |
549 | |
550 | set_trace_on |
551 | |
552 | Activate the XLA Statistics. |
553 | |
554 +======================================================================*/
555 PROCEDURE set_stat_on;
556
557
558 /*======================================================================+
559 | |
560 | Public Procedure |
561 | |
562 | set_trace_off |
563 | |
564 | De-Activate, if set, the XLA Statistics. |
565 | |
566 +======================================================================*/
567 PROCEDURE set_stat_off;
568
569
570 /*======================================================================+
571 | |
572 | Public Procedure |
573 | |
574 | print_stat_info |
575 | |
576 | Print all information related to the stat to the std Trace output. |
577 | |
578 +======================================================================*/
579 PROCEDURE print_stat_info;
580
581
582 /*======================================================================+
583 | |
584 | Public Function |
585 | |
586 | get_stat_info |
587 | |
588 | Return a statistic information |
589 | |
590 +======================================================================*/
591 FUNCTION get_stat_info
592 (p_option IN VARCHAR2)
593 RETURN VARCHAR2;
594
595
596 /*======================================================================+
597 | |
598 | |
599 | |
600 | |
601 | |
602 | |
603 | |
604 | |
605 | |
606 | |
607 | |
608 | |
609 | |
610 | |
611 | |
615 | |
612 | |
613 | |
614 | |
616 | |
617 | SQL_Trace |
618 | |
619 | |
620 | |
621 | |
622 | |
623 | |
624 | |
625 | |
626 | |
627 | |
628 | |
629 | |
630 | |
631 | |
632 | |
633 | |
634 | |
635 | |
636 | |
637 | |
638 +======================================================================*/
639
640
641 /*======================================================================+
642 | |
643 | Public Procedure |
644 | |
645 | set_sqltrace_on |
646 | |
647 | Alter the session to start the sql trace mode. |
648 | |
649 +======================================================================*/
650 PROCEDURE set_sqltrace_on;
651
652
653 /*======================================================================+
654 | |
655 | Public Procedure |
656 | |
657 | set_sqltrace_off |
658 | |
659 | Alter the session to finish the sql trace mode. |
660 | |
661 +======================================================================*/
662 PROCEDURE set_sqltrace_off;
663
664
665 /*======================================================================+
666 | |
667 | |
668 | |
669 | |
670 | |
671 | |
672 | |
673 | |
674 | |
675 | |
676 | |
677 | |
678 | |
679 | |
680 | |
681 | |
682 | |
683 | |
684 | |
685 | |
686 | Reset |
687 | |
688 | |
689 | |
690 | |
691 | |
692 | |
693 | |
694 | |
698 | |
695 | |
696 | |
697 | |
699 | |
700 | |
701 | |
702 | |
703 | |
704 | |
705 | |
706 | |
707 +======================================================================*/
708
709 /*======================================================================+
710 | |
711 | Public Procedure |
712 | |
713 | reset |
714 | |
715 | Reset the global variables. |
716 | |
717 +======================================================================*/
718 PROCEDURE reset;
719
720 END xla_utility_pkg;|
|
|
|