1 package ZPB_LOG as
2 /* $Header: zpblog.pls 120.6 2007/12/04 15:31:16 mbhat ship $ */
3
4 -------------------------------------------------------------------------------
5 -- BUILD_MESSAGE
6 --
7 -- Procedure to populate structures need to build a message.
8 -- You should clear this message after using it via fnd_message.clear.
9 --
10 -- IN:
11 -- MESSAGE - The Message name defined in FND_MESSAGES table
12 -- TOKEN_# - Any tokens required in the message. Tokens go as a
13 -- a name/value. Omit if not applicable
14 -- POP_MESSAGE - True if the message will not be used again. False means
15 -- you must explicitly clear the message.
16 --
17 -------------------------------------------------------------------------------
18
19 procedure BUILD_MESSAGE (MESSAGE in VARCHAR2,
20 TOKEN_1_NAME in VARCHAR2 default NULL,
21 TOKEN_1_VALUE in VARCHAR2 default NULL,
22 TOKEN_2_NAME in VARCHAR2 default NULL,
23 TOKEN_2_VALUE in VARCHAR2 default NULL,
24 TOKEN_3_NAME in VARCHAR2 default NULL,
25 TOKEN_3_VALUE in VARCHAR2 default NULL,
26 TOKEN_4_NAME in VARCHAR2 default NULL,
27 TOKEN_4_VALUE in VARCHAR2 default NULL,
28 TOKEN_5_NAME in VARCHAR2 default NULL,
29 TOKEN_5_VALUE in VARCHAR2 default NULL);
30
31 -------------------------------------------------------------------------------
32 -- WRITE_TO_CONCMGR_LOG
33 --
34 -- Procedure to write translated informational messages to the concurrent manager request log.
35 -- Message should be tranlated prior to calling this procedure.
36 --
37 -- IN:
38 -- MODULE - The calling package and procedure. Example:
39 -- "zpb_aw_write_back.submit_writeback_request"
40 -- MESSAGE - The Message to be logged (should be translated)
41 --
42 -------------------------------------------------------------------------------
43 procedure WRITE_TO_CONCMGR_LOG (MESSAGE in VARCHAR2);
44
45 -------------------------------------------------------------------------------
46 -- WRITE_TO_CONCMGR_LOG_TR
47 --
48 -- Procedure to log informational translated messages to the concurrent log.
49 --
50 -- IN:
51 -- MODULE - The calling package and procedure. Example:
52 -- "zpb_aw_write_back.submit_writeback_request"
53 -- MESSAGE_NAME - The Message name defined in FND_MESSAGES table
54 -- TOKEN_# - Any tokens required in the message. Tokens go as a
55 -- a name/value. Omit if not applicable
56 -- POP_MESSAGE - True if the message will not be used again. False means
57 -- you must explicitly clear the message.
58 --
59 -------------------------------------------------------------------------------
60 procedure WRITE_TO_CONCMGR_LOG_TR(MESSAGE_NAME in VARCHAR2,
61 TOKEN_1_NAME in VARCHAR2 default NULL,
62 TOKEN_1_VALUE in VARCHAR2 default NULL,
63 TOKEN_2_NAME in VARCHAR2 default NULL,
64 TOKEN_2_VALUE in VARCHAR2 default NULL,
65 TOKEN_3_NAME in VARCHAR2 default NULL,
66 TOKEN_3_VALUE in VARCHAR2 default NULL,
67 TOKEN_4_NAME in VARCHAR2 default NULL,
68 TOKEN_4_VALUE in VARCHAR2 default NULL,
69 TOKEN_5_NAME in VARCHAR2 default NULL,
70 TOKEN_5_VALUE in VARCHAR2 default NULL,
71 POP_MESSAGE in BOOLEAN default TRUE);
72
73 -------------------------------------------------------------------------------
74 -- ERROR
75 --
76 -- Procedure to log at the ERROR BI Beans level
77 --
78 -- IN:
79 -- MESSAGE - The message passed by Bi Beans
80 --
81 -------------------------------------------------------------------------------
82 procedure ERROR (MESSAGE in VARCHAR2 );
83
84 -------------------------------------------------------------------------------
85 -- GET_DEBUGGING_LEVEL
86 --
87 -- Returns the debugging level. Used by CM.LOG in the AW
88 -- 'L' - Log all to log file
89 -- 'C' - Log all to concurrent manager
90 -- 'N' - No extra logging
91 --
92 -------------------------------------------------------------------------------
93 function GET_DEBUGGING_LEVEL return varchar2;
94
95 -------------------------------------------------------------------------------
96 -- GET_LOGGING_LEVEL
97 --
98 -- Returns the logging level. Same as FND_LOG.G_CURRENT_RUNTIME_LEVEL, but
99 -- placed in a function for use in AW's
100 -------------------------------------------------------------------------------
101 function GET_LOGGING_LEVEL return number;
102
103 -------------------------------------------------------------------------------
104 -- LOG_PLSQL_EXCEPTION
105 --
106 -- Logs a generic PL/SQL message stating the module and SQLERRM of an exception
107 -- that just occured. This must be called only if a valid PL/SQL exception
108 -- occurred.
109 --
110 -- IN: p_module - The module where the exception occurred
111 -- p_procedure - The procedure name where the exception occured
112 -- p_pop_message - True if the message stack should be cleared
113 -------------------------------------------------------------------------------
114 procedure LOG_PLSQL_EXCEPTION (p_module in VARCHAR2,
115 p_procedure in VARCHAR2,
116 p_pop_message in BOOLEAN := TRUE);
117
118 -------------------------------------------------------------------------------
119 -- TRACE
120 -- Procedure to log Trace at the BI Beans level
121 --
122 -- IN:
123 -- MESSAGE - The message passed by Bi Beans
124 --
125 -------------------------------------------------------------------------------
126 procedure TRACE(MESSAGE in VARCHAR2 );
127
128
129 -------------------------------------------------------------------------------
130
131 -- WRITE
132 --
133 -- Procedure to log at the PROCEDURE level (2). Log here to mark entering and
134 -- exiting of procedures, as well as input and output parameters from those
135 -- procedures.
136 --
137 -- IN:
138 -- MODULE - The calling package and procedure. Example:
139 -- "zpb_aw_write_back.submit_writeback_request"
140 -- MESSAGE - The Message to be logged (non-translated)
141 --
142 -------------------------------------------------------------------------------
143 procedure WRITE (MODULE in VARCHAR2,
144 MESSAGE in VARCHAR2);
145
146 -------------------------------------------------------------------------------
147 -- WRITE_ERROR
148 --
149 -- Procedure to log at the ERROR level (5). Log here when any user-errors
150 -- or validation errors occur.
151 --
152 -- IN:
153 -- MODULE - The calling package and procedure. Example:
154 -- "zpb_aw_write_back.submit_writeback_request"
155 -- MESSAGE_NAME - The Message name defined in FND_MESSAGES table
156 -- TOKEN_# - Any tokens required in the message. Tokens go as a
157 -- a name/value. Omit if not applicable
158 -- POP_MESSAGE - True if the message will not be used again. False means
159 -- you must explicitly clear the message.
160 --
161 -------------------------------------------------------------------------------
162 procedure WRITE_ERROR (MODULE in VARCHAR2,
163 MESSAGE_NAME in VARCHAR2,
164 TOKEN_1_NAME in VARCHAR2 default NULL,
165 TOKEN_1_VALUE in VARCHAR2 default NULL,
166 TOKEN_2_NAME in VARCHAR2 default NULL,
167 TOKEN_2_VALUE in VARCHAR2 default NULL,
168 TOKEN_3_NAME in VARCHAR2 default NULL,
169 TOKEN_3_VALUE in VARCHAR2 default NULL,
170 TOKEN_4_NAME in VARCHAR2 default NULL,
171 TOKEN_4_VALUE in VARCHAR2 default NULL,
172 TOKEN_5_NAME in VARCHAR2 default NULL,
173 TOKEN_5_VALUE in VARCHAR2 default NULL,
174 POP_MESSAGE in BOOLEAN default TRUE);
175
176 -------------------------------------------------------------------------------
177 -- WRITE_EVENT
178 --
179 -- Procedure to log at the EVENT level (3). Log here when any major event
180 -- occurs. This event message is not translated. Use WRITE_USER_EVENT for
181 -- a translated event. Note that events logged here in a concurrent
182 -- process will be sent to FND_LOG, not the Request log.
183 --
184 -- IN:
185 -- MODULE - The calling package and procedure. Example:
186 -- "zpb_aw_write_back.submit_writeback_request"
187 -- MESSAGE - The message to be logged (not translated)
188 --
189 -------------------------------------------------------------------------------
190 procedure WRITE_EVENT (MODULE in VARCHAR2,
191 MESSAGE in VARCHAR2);
192
193 -------------------------------------------------------------------------------
194 -- WRITE_EVENT_TR
195 --
196 -- Procedure to log at the EVENT level (3). Log here when any major event
197 -- occurs. This event message is translated. If used in a concurrent process,
198 -- these messages will be logged to the Request Log.
199 --
200 --
201 -- IN:
202 -- MODULE - The calling package and procedure. Example:
203 -- "zpb_aw_write_back.submit_writeback_request"
204 -- MESSAGE_NAME - The Message name defined in FND_MESSAGES table
205 -- TOKEN_# - Any tokens required in the message. Tokens go as a
206 -- a name/value. Omit if not applicable
207 -- POP_MESSAGE - True if the message will not be used again. False means
208 -- you must explicitly clear the message.
209 --
210 -------------------------------------------------------------------------------
211 procedure WRITE_EVENT_TR (MODULE in VARCHAR2,
212 MESSAGE_NAME in VARCHAR2,
213 TOKEN_1_NAME in VARCHAR2 default NULL,
214 TOKEN_1_VALUE in VARCHAR2 default NULL,
215 TOKEN_2_NAME in VARCHAR2 default NULL,
216 TOKEN_2_VALUE in VARCHAR2 default NULL,
217 TOKEN_3_NAME in VARCHAR2 default NULL,
218 TOKEN_3_VALUE in VARCHAR2 default NULL,
219 TOKEN_4_NAME in VARCHAR2 default NULL,
220 TOKEN_4_VALUE in VARCHAR2 default NULL,
221 TOKEN_5_NAME in VARCHAR2 default NULL,
222 TOKEN_5_VALUE in VARCHAR2 default NULL,
223 POP_MESSAGE in BOOLEAN default TRUE);
224
225 -------------------------------------------------------------------------------
226 -- WRITE_EXCEPTION_UNTR
227 --
228 -- Procedure to log at the EVENT level (4). Log here when any major exception
229 -- occurs. This exception message is not translated. Use WRITE_EXCEPTION for
230 -- a translated exception. Note that exception logged here in a concurrent
231 -- process will be sent to FND_LOG, not the Request log.
232 --
233 -- IN:
234 -- MODULE - The calling package and procedure. Example:
235 -- "zpb_aw_write_back.submit_writeback_request"
236 -- MESSAGE - The message to be logged (not translated)
237 --
238 -------------------------------------------------------------------------------
239 procedure WRITE_EXCEPTION_UNTR (MODULE in VARCHAR2,
240 MESSAGE in VARCHAR2);
241
242 -------------------------------------------------------------------------------
243 -- WRITE_EXCEPTION
244 --
245 -- Procedure to log at the EXCEPTION level (4). Log here when any non-critical
246 -- exception occurs in the code.
247 --
248 --
249 -- IN:
250 -- MODULE - The calling package and procedure. Example:
251 -- "zpb_aw_write_back.submit_writeback_request"
252 -- MESSAGE_NAME - The Message name defined in FND_MESSAGES table
253 -- TOKEN_# - Any tokens required in the message. Tokens go as a
254 -- a name/value. Omit if not applicable
255 -- POP_MESSAGE - True if the message will not be used again. False means
256 -- you must explicitly clear the message.
257 --
258 -------------------------------------------------------------------------------
259 procedure WRITE_EXCEPTION (MODULE in VARCHAR2,
260 MESSAGE_NAME in VARCHAR2,
261 TOKEN_1_NAME in VARCHAR2 default NULL,
262 TOKEN_1_VALUE in VARCHAR2 default NULL,
263 TOKEN_2_NAME in VARCHAR2 default NULL,
264 TOKEN_2_VALUE in VARCHAR2 default NULL,
265 TOKEN_3_NAME in VARCHAR2 default NULL,
266 TOKEN_3_VALUE in VARCHAR2 default NULL,
267 TOKEN_4_NAME in VARCHAR2 default NULL,
268 TOKEN_4_VALUE in VARCHAR2 default NULL,
269 TOKEN_5_NAME in VARCHAR2 default NULL,
270 TOKEN_5_VALUE in VARCHAR2 default NULL,
271 POP_MESSAGE in BOOLEAN default TRUE);
272
273 -------------------------------------------------------------------------------
274 -- WRITE_STATEMENT
275 --
276 -- Procedure to log at the STATEMENT level (1). Log here for any low-level
277 -- messages, ie. for tracing or debugging
278 --
279 --
280 -- IN:
281 -- MODULE - The calling package and procedure. Example:
282 -- "zpb_aw_write_back.submit_writeback_request"
283 -- MESSAGE - The message to be logged (not translated)
284 --
285 -------------------------------------------------------------------------------
286 procedure WRITE_STATEMENT (MODULE in VARCHAR2,
290 -- WRITE_UNEXPECTED
287 MESSAGE in VARCHAR2);
288
289 -------------------------------------------------------------------------------
291 --
292 -- Procedure to log at the UNEXPECTED level (6). Log here when any critical
293 -- exception occurs in the code. This will be alerted to system admins
294 --
295 --
296 -- IN:
297 -- MODULE - The calling package and procedure. Example:
298 -- "zpb_aw_write_back.submit_writeback_request"
299 -- MESSAGE_NAME - The Message name defined in FND_MESSAGES table
300 -- TOKEN_# - Any tokens required in the message. Tokens go as a
301 -- a name/value. Omit if not applicable
302 -- POP_MESSAGE - True if the message will not be used again. False means
303 -- you must explicitly clear the message.
304 --
308 TOKEN_1_NAME in VARCHAR2 default NULL,
305 -------------------------------------------------------------------------------
306 procedure WRITE_UNEXPECTED (MODULE in VARCHAR2,
307 MESSAGE_NAME in VARCHAR2,
309 TOKEN_1_VALUE in VARCHAR2 default NULL,
310 TOKEN_2_NAME in VARCHAR2 default NULL,
311 TOKEN_2_VALUE in VARCHAR2 default NULL,
312 TOKEN_3_NAME in VARCHAR2 default NULL,
313 TOKEN_3_VALUE in VARCHAR2 default NULL,
314 TOKEN_4_NAME in VARCHAR2 default NULL,
315 TOKEN_4_VALUE in VARCHAR2 default NULL,
316 TOKEN_5_NAME in VARCHAR2 default NULL,
317 TOKEN_5_VALUE in VARCHAR2 default NULL,
318 POP_MESSAGE in BOOLEAN default TRUE);
319
320 end ZPB_LOG;
[Home] [Help]