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