DBA Data[Home] [Help]

PACKAGE: APPS.WF_DIAGNOSTICS

Source


1 package WF_DIAGNOSTICS AUTHID CURRENT_USER as
2 /* $Header: WFDIAGPS.pls 120.3.12020000.2 2012/08/01 17:15:58 alsosa ship $ */
3 
4 -- Table cell
5 type tdType is table of varchar2(4005) index by binary_integer;
6 
7 --
8 -- Get_Ntf_Item_Info
9 --   Returns a HTML table of Notification Information from wf_notifications table.
10 --
11 function Get_Ntf_Item_Info(p_nid in number)
12 return varchar2;
13 
14 --
15 -- Get_Group_Ntfs
16 --   Returns a HTML table of notifications associated to this notification group id
17 --
18 function Get_Group_Ntfs(p_nid in number)
19 return varchar2;
20 
21 --
22 -- Get_Ntf_Role_Users
23 --   Returns a HTML table of users who belong to the notification recipient
24 --   table, if the recipient role has more than one user associated
25 --
26 function Get_Ntf_Role_Users(p_nid in number)
27 return varchar2;
28 
29 
30 --
31 -- Get_Summary_Ntf_Role_Users
32 --   Returns a HTML table of users who belong to the given role
33 --   , if the recipient role has more than one user associated
34 --
35 function Get_Summary_Ntf_Role_Users(p_role  in varchar2)
36 return varchar2;
37 
38 --
39 -- Get_Ntf_Role_Info
40 --    Returns a HTML table of the recipient role's information as in wf_roles
41 --
42 function Get_Ntf_Role_Info(p_nid in number)
43 return varchar2;
44 
45 --
46 -- Get_Summary_Ntf_Role_Info
47 --    Returns a HTML table of the recipient role's information as in wf_roles
48 --
49 function Get_Summary_Ntf_Role_Info(p_role in varchar2)
50 return varchar2;
51 
52 --
53 -- Get_Routing_Rules
54 --    Returns a HTML table of the routing rules for the notfication's recipient
55 --    role
56 --
57 function Get_Routing_Rules(p_nid in number)
58 return varchar2;
59 
60 --
61 -- Get_Ntf_More_Info
62 --   Returns a HTML table of the More info role's information as in wf_roles
63 --
64 function Get_Ntf_More_Info(p_nid in number)
65 return varchar2;
66 
67 --
68 -- Get_Ntf_Msg_Attrs
69 --   Returns a HTML table of all the Message Attributes associated with the
70 --   Notification message
71 --
72 procedure Get_Ntf_Msg_Attrs(p_nid   in  number,
73                             p_value in out nocopy clob);
74 
75 --
76 -- Get_Ntf_Attrs
77 --   Returns a HTML table of all the Notification Attributes associated with the
78 --   Notification message
79 procedure Get_Ntf_Attrs(p_nid   in  number,
80                         p_value in out nocopy clob);
81 
82 --
83 -- Get_User_Comments
84 --   Returns a HTML table of all the User Comments exchanged in Question/Answer modes
85 --
86 procedure Get_User_Comments(p_nid   in number,
87                             p_value in out nocopy clob);
88 
89 --
90 -- Get_Event_Queue_Status
91 --   Returns a HTML table of the status of an event from a specified BES queue with the
92 --   matching event key provided.
93 --
94 function Get_Event_Queue_Status(p_queue_name in varchar2,
95                                 p_event_name in varchar2,
96                                 p_event_key  in varchar2)
97 return varchar2;
98 
99 --
100 -- Get_JMS_Queue_Status
101 --   Returns a HTML table of the status of an event message from a specified JMS
102 --   queue with the matching event key provided.
103 --
104 function Get_JMS_Queue_Status(p_queue_name in varchar2,
105                               p_event_name in varchar2,
106                               p_event_key  in varchar2)
107 return varchar2;
108 
109 --
110 -- Get_JMS_Queue_Status
111 --   Returns a HTML table of the status of an event message from a specified JMS
112 --   queue with the matching event key, name, and corr_id provided.
113 --
114 function Get_JMS_Queue_Status(p_queue_name in varchar2,
115                               p_event_name in varchar2,
116                               p_event_key  in varchar2,
117 			      p_corr_id    in varchar2)
118 return varchar2;
119 
120 
121 --
122 -- Get_Ntf_Templates
123 --   Returns HTML table of the email templates and the Notification Message body
124 --   for HTML as well as Text formatting
125 --
126 procedure Get_Ntf_Templates(p_nid   in number,
127                             p_value in out nocopy clob);
128 
129 
130 --
131 -- get_Summary_Templates
132 --   Returns HTML table of the Summary (email)templates and the Notification Message body
133 --   for HTML as well as Text formatting
134 --
135 procedure get_Summary_Templates(p_role in varchar2,
136  	                        p_ntf_pref in varchar2,
137  	                        p_value in out nocopy clob);
138 
139 --
140 -- Get_Ntf_Message
141 --   Returns a HTML table of the Notification Message source as it is generated for
142 --   the mailer
143 --
144 procedure Get_Ntf_Message(p_nid   in number,
145                           p_value in out nocopy clob);
146 
147 
148 
149 -- Get_Summary_Ntf_Message
150 -- Get the XML for oracle.apps.wf.notification.summary.send event
151 -- Output of WF_XML.generate function
152 --
153 procedure Get_Summary_Ntf_Message(p_role   in varchar2,
154                                   p_value in out nocopy clob);
155 
156 --
157 -- Get_Ntf_Msg_From_Out
158 -- Returns PAYLOAD from WF_NOTIFICATION_OUT AQ for a given nid / event key
159 --
160 procedure Get_Ntf_Msg_From_Out(p_nid   in number,
161                                p_value in out nocopy clob);
162 
163 -- Get_Ntf_Msg_From_Out
164 -- Returns PAYLOAD from WF_NOTIFICATION_OUT AQ for a given nid / event key
165 --
166 procedure Get_Ntf_Msg_From_Out(p_nid   in VARCHAR2,
167                                p_corr_id in varchar2,
168                                p_value in out nocopy clob);
169 
170 --
171 -- Get_Ntf_Msg_From_In
172 -- Returns PAYLOAD from WF_NOTIFICATION_IN AQ for a given nid / event key
173 --
174 procedure Get_Ntf_Msg_From_In(p_nid   in number,
175                                p_value in out nocopy clob);
176 
177 -- Get_Ntf_Msg_From_In
178 -- Returns PAYLOAD from WF_NOTIFICATION_In AQ for a given nid / event key
179 --
180 procedure Get_Ntf_Msg_From_In(p_nid   in varchar2,
181                                p_corr_id in varchar2,
182                                p_value in out nocopy clob);
183 
184 -- Get_Summary_Msg_From_Out
185 -- Returns PAYLOAD from WF_NOTIFICATION_OUT AQ for a given role
186 --
187 procedure Get_Summary_Msg_From_Out(p_role   in varchar2,
188  	                           p_value in out nocopy clob);
189 
190 
191 --
192 -- Get_GSC_Comp_Parameters
193 --    Returns a HTML table of all the Service Components and their parameters given the
194 --    Component type and/or the component name.
195 --
196 procedure Get_GSC_Comp_Parameters(p_comp_type in varchar2,
197                                   p_comp_name in varchar2 default null,
198                                   p_value     in out nocopy clob);
199 
200 
201 
202 --
203 -- Get_GSC_Comp_ScheduledEvents -
204 --
205 -- Returns scheduled events for a given component
206 -- Out
207 --  p_value
208 --    Returns a HTML table of all the Service Components
209 --    and their scheduled events for a  given
210 --    Component type and/or the component name.
211 --
212 procedure Get_GSC_Comp_ScheduledEvents(p_comp_type in varchar2,
213                                   p_comp_name in varchar2 default null,
214                                   p_value     in out nocopy clob);
215 
216 --
217 -- Get_Mailer_Tags
218 --    Returns a HTML table of all the Mailer Tag information
219 --
220 function Get_Mailer_Tags return varchar2;
221 
222 --
223 -- GetTOC
224 --    Generates the Table of Contents for the Mailer Debug Information.
225 --
226 function Get_Mailer_TOC(p_nid in number)
227 return varchar2;
228 
229 --
230 -- Get_Mailer_Debug
231 --    Returns a complete HTML document of the Mailer Debug information
232 --
233 procedure Get_Mailer_Debug(p_nid   in number,
234                            p_value out nocopy clob);
235 
236 --
237 -- Check the GSC Control Queue Status Info
238 --    Returns the basic information about Control Queue Status
239 
240 procedure Get_Control_Queue_Status(p_value out nocopy clob);
241 
242 --
243 -- Check the Migration Status Info
244 --    Returns the basic information about Migration Status
245 procedure Get_BES_Clone_Status (p_value out nocopy clob);
246 
247 --
248 -- Show
249 --   Given a varchar2 string, the value is written to the console using
250 --   dbms_output.put_line
251 procedure Show(p_value     in varchar2);
252 
253 --
254 -- Show
255 --   Given a CLOB string, the value is written to the console using
256 --   dbms_output.put_line
257 procedure Show(p_value     in CLOB);
258 
259 --
260 -- CheckObjectsValidity
261 --   Checks if the WF/ECX Objects in the database are valid and gives a
262 --   result back to the caller
263 procedure CheckObjectsValidity(p_status   out nocopy varchar2,
264                                p_report   out nocopy varchar2);
265 
266 --
267 -- CheckXMLParserStatus
268 --   Checks the installation status of XML Parser.
269 procedure CheckXMLParserStatus(p_status   out nocopy varchar2,
270                                p_report   out nocopy varchar2);
271 
272 --
273 -- CheckAgentsAQStatus
274 --   Checks the validity of the Agents, AQs associated with the Agents, rules
275 --   and AQ subscribers
276 procedure CheckAgentsAQStatus(p_status   out nocopy varchar2,
277                               p_report   out nocopy CLOB);
278 
279 --
280 -- GetXMLParserVersion
281 --   Gets the XML Parser version in the database. This function is modeled
282 --   after ECX_UTILS.XMLVersion for use within Standalone Workflow
283 function GetXMLParserVersion return varchar2;
284 
285 --
286 -- Get_Bes_Debug
287 --    Returns a complete HTML document of the BES Debug information
288 --
289 procedure Get_Bes_Debug(p_event_name   in varchar2,
290                         p_event_key    in varchar2,
291                         p_value        out nocopy clob);
292 
293 
294 --
295 -- Get_Mailer_Summary_Ntf_Debug
296 --  Returns information about summary notification for a role
297 procedure Get_Summary_Mailer_Debug(p_role in varchar2,
298                                    p_content out nocopy clob);
299 
300 
301 --
302 --  Get_Mailer_Alert_Debug
303 --  Returns information about Alert for a module with id string
304 procedure Get_Mailer_Alert_Debug(p_module   in varchar2,
305 				 p_idstring in varchar2,
306                                  p_content  out nocopy clob);
307 
308 
309 
310 end WF_DIAGNOSTICS;