1 PACKAGE JTF_FM_REQUEST_GRP AUTHID CURRENT_USER AS
2 /* $Header: jtfgfms.pls 120.2 2005/12/27 00:36:01 anchaudh ship $*/
3 -- Priority Levels of the fulfillment requests.
4 -- Lower number represents higher priority
5 G_PRIORITY_HIGHEST CONSTANT NUMBER := 1;
6 G_PRIORITY_REGULAR CONSTANT NUMBER := 7;
7 G_PRIORITY_BATCH_REQUEST CONSTANT NUMBER := 8;
8
9 -- Table of string
10 TYPE G_VARCHAR_TBL_TYPE IS TABLE OF VARCHAR2(1000)
11 INDEX BY BINARY_INTEGER;
12
13 L_VARCHAR_TBL G_VARCHAR_TBL_TYPE;
14
15 -- Table of numbers
16 TYPE G_NUMBER_TBL_TYPE IS TABLE OF NUMBER
17 INDEX BY BINARY_INTEGER;
18
19 L_NUMBER_TBL G_NUMBER_TBL_TYPE;
20
21
22 ---------------------------------------------------------------------
23 -- PROCEDURE
24 -- Start_Request
25 --
26 -- PURPOSE
27 -- Start a new Fulfillment Request.
28 --
29 -- PARAMETERS
30 -- x_request_id - Unique request id
31 -- NOTES
32 -- . A unique request_id will be returned to the user
33 ---------------------------------------------------------------------
34
35 PROCEDURE Start_Request
36 (
37 p_api_version IN NUMBER,
38 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
39 p_commit IN VARCHAR2 := FND_API.G_FALSE,
40 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
41 x_return_status OUT NOCOPY VARCHAR2,
42 x_msg_count OUT NOCOPY NUMBER,
43 x_msg_data OUT NOCOPY VARCHAR2,
44 x_request_id OUT NOCOPY NUMBER
45 );
46
47 ---------------------------------------------------------------------
48 -- PROCEDURE
49 -- Get_Content_XML
50 --
51 -- PURPOSE
52 -- Forms the XML request for a content based on the parameters passed
53 -- and returns it as an output parameter.
54 --
55 -- PARAMETERS
56 -- p_content_id: Unique Id of the content. (Required)
57 -- p_content_nm: The Name of the content.
58 -- p_quantity: Quantity of the content to be sent (Default = 1) .
59 -- p_media_type: Type of media - FAX, EMAIL, PRINTER, PATH.
60 -- p_printer: Address of the printer
61 -- p_email: Email Address
62 -- p_fax : Fax Address
63 -- p_file_path : File Path address
64 -- p_user_note: Any note that the agent wants to attach
65 -- p_content_type: Type of the content - QUERY, ATTACHMENT or COLLATERAL
66 -- p_bind_var : The list of bind variables
67 -- p_bind_var_type: The type of the corresponding bind variables
68 -- p_bind_val: Actual values of the corresponding bind variables.
69 -- p_request_id: The request ID obtained by calling the Start_Request API.
70 -- x_content_xml: Output content XML
71 --
72 -- NOTES
73 -- 1. The content_type can be of type QUERY, COLLATERAL or ATTACHMENT.
74 -- 2. The API currently does not form XML for DATA type of requests.
75 -- 3. The Get_Content_XML API further handles only one Content per call.
76 -- Hence the output content_XML string needs to be appended to the
77 -- content_xml from the previous calls.
78 ---------------------------------------------------------------------
79
80 PROCEDURE Get_Content_XML
81 (
82 p_api_version IN NUMBER,
83 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
84 p_commit IN VARCHAR2 := FND_API.G_FALSE,
85 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
86 x_return_status OUT NOCOPY VARCHAR2,
87 x_msg_count OUT NOCOPY NUMBER,
88 x_msg_data OUT NOCOPY VARCHAR2,
89 p_content_id IN NUMBER,
90 p_content_nm IN VARCHAR2 := FND_API.G_MISS_CHAR,
91 p_document_type IN VARCHAR2 := FND_API.G_MISS_CHAR, -- depreciated
92 p_quantity IN NUMBER := 1,
93 p_media_type IN VARCHAR2,
94 p_printer IN VARCHAR2 := FND_API.G_MISS_CHAR,
95 p_email IN VARCHAR2 := FND_API.G_MISS_CHAR,
96 p_fax IN VARCHAR2 := FND_API.G_MISS_CHAR,
97 p_file_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
98 p_user_note IN VARCHAR2 := FND_API.G_MISS_CHAR,
99 p_content_type IN VARCHAR2,
100 p_bind_var IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
101 p_bind_val IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
102 p_bind_var_type IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
103 p_request_id IN NUMBER,
104 x_content_xml OUT NOCOPY VARCHAR2
105 );
106
107
108 ---------------------------------------------------------------------
109 -- PROCEDURE (Overloaded method added by SXKRISHN 10-28-02)
110 -- Get_Content_XML
111 --
112 -- PURPOSE
113 -- Forms the XML request for a content based on the parameters passed
114 -- and returns it as an output parameter.
115 --
116 -- PARAMETERS
117 -- p_content_id: Unique Id of the content. (Required)
118 -- p_content_nm: The Name of the content.
119 -- p_quantity: Quantity of the content to be sent (Default = 1) .
120 -- p_media_type: Type of media - FAX, EMAIL, PRINTER, PATH.
121 -- p_printer: Address of the printer
122 -- p_email: Email Address
123 -- p_fax : Fax Address
124 -- p_file_path : File Path address
125 -- p_user_note: Any note that the agent wants to attach
126 -- p_content_type: Type of the content - QUERY, ATTACHMENT or COLLATERAL
127 -- p_bind_var : The list of bind variables
128 -- p_bind_var_type: The type of the corresponding bind variables
129 -- p_bind_val: Actual values of the corresponding bind variables.
130 -- p_request_id: The request ID obtained by calling the Start_Request API.
131 -- x_content_xml: Output content XML
132 -- p_content_source ; Source where the content is stored, MES Repository or OCM Repository (default mes)
133 -- p_body : whether content needs to be body of the email :
134 -- p_version : If using OCM content, need to provide version of the document,default is latest
135 --
136 -- NOTES
137 -- 1. The content_type can be of type QUERY, COLLATERAL or ATTACHMENT.
138 -- 2. The API currently does not form XML for DATA type of requests.
139 -- 3. The Get_Content_XML API further handles only one Content per call.
140 -- Hence the output content_XML string needs to be appended to the
141 -- content_xml from the previous calls.
142 ---------------------------------------------------------------------
143
144 PROCEDURE Get_Content_XML
145 (
146 p_api_version IN NUMBER,
147 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
148 p_commit IN VARCHAR2 := FND_API.G_FALSE,
149 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
150 x_return_status OUT NOCOPY VARCHAR2,
151 x_msg_count OUT NOCOPY NUMBER,
152 x_msg_data OUT NOCOPY VARCHAR2,
153 p_content_id IN NUMBER,
154 p_content_nm IN VARCHAR2 := FND_API.G_MISS_CHAR,
155 p_document_type IN VARCHAR2 := FND_API.G_MISS_CHAR, -- depreciated
156 p_quantity IN NUMBER := 1,
157 p_media_type IN VARCHAR2,
158 p_printer IN VARCHAR2 := FND_API.G_MISS_CHAR,
159 p_email IN VARCHAR2 := FND_API.G_MISS_CHAR,
160 p_fax IN VARCHAR2 := FND_API.G_MISS_CHAR,
161 p_file_path IN VARCHAR2 := FND_API.G_MISS_CHAR,
162 p_user_note IN VARCHAR2 := FND_API.G_MISS_CHAR,
163 p_content_type IN VARCHAR2,
164 p_bind_var IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
165 p_bind_val IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
166 p_bind_var_type IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
167 p_request_id IN NUMBER,
168 x_content_xml OUT NOCOPY VARCHAR2,
169 p_content_source IN VARCHAR2 := 'mes',
170 p_version IN NUMBER
171 );
172
173 ---------------------------------------------------------------------
174 -- PROCEDURE
175 -- Send_Request
176 --
177 -- PURPOSE
178 -- This procedure can be used to submit a new request for a single customer
179 -- to the fulfillment system. This overloaded Submit_Request procedure allows
180 -- the caller to specify whether this request should be dispatched or simply
181 -- previewed
182 --
183 -- PARAMETERS
184 -- p_user_id: Agent/User Id
185 -- p_party_id: Customer ID
186 -- p_priority: These are defined as global constants in package JTF_FM_Request_GRP.
187 -- User Note - Unused priority numbers are for future use.
188 -- p_source_code_id : Campaign/promotion field
189 -- p_source_code : Campaign/promotion field
190 -- p_object_type : Campaign/promotion field
191 -- p_object_id : Campaign/promotion field
192 -- p_order_id: Unique identifier of the order
193 -- p_server_id: Unique identifier of the sever
194 -- p_queue_response : Field to specify if response needs to queued in Response queue
195 -- p_content_xml : The content xml formed by calling the Get_Content_XML
196 -- or Get_Multiple_Content_XML API's.
197 -- p_request_id : Request ID obtained by calling the Start_Request API.
198 -- p_preview : boolean condition of whether or not this is a preview request.
199
200 -- NOTES
201 -- 1. The API will generate an XML request and submit it to the Fulfillment
202 -- Request Queue.
203 -- 2. It also updates/creates fulfillment History and status records.
204 -- 3. Default priority is G_PRIORITY_REGULAR
205 -------------------------------------------------------------------------
206
207 ----------------------------------------------------------------------
208 -- PROCEDURE
209 -- Send_Request
210 --
211 -- HISTORY
212 -- 10/01/99 nyalaman Create.
213 -- 05/07/01 sxkrishn overloaded with org_id
214 ---------------------------------------------------------------
215 PROCEDURE Send_Request
216 (p_api_version IN NUMBER,
217 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
218 p_commit IN VARCHAR2 := FND_API.G_FALSE,
219 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
220 x_return_status OUT NOCOPY VARCHAR2,
221 x_msg_count OUT NOCOPY NUMBER,
222 x_msg_data OUT NOCOPY VARCHAR2,
223 p_template_id IN NUMBER := FND_API.G_MISS_NUM,
224 p_subject IN VARCHAR2 := FND_API.G_MISS_CHAR,
225 p_party_id IN NUMBER := FND_API.G_MISS_NUM,
226 p_party_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
227 p_user_id IN NUMBER,
228 p_priority IN NUMBER := G_PRIORITY_REGULAR,
229 p_source_code_id IN NUMBER := FND_API.G_MISS_NUM,
230 p_source_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
231 p_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
232 p_object_id IN NUMBER := FND_API.G_MISS_NUM,
233 p_order_id IN NUMBER := FND_API.G_MISS_NUM,
234 p_doc_id IN NUMBER := FND_API.G_MISS_NUM,
235 p_doc_ref IN VARCHAR2 := FND_API.G_MISS_CHAR,
236 p_server_id IN NUMBER := FND_API.G_MISS_NUM,
237 p_queue_response IN VARCHAR2 := 'S',
238 p_extended_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
239 p_content_xml IN VARCHAR2,
240 p_request_id IN NUMBER,
241 p_preview IN VARCHAR2 := FND_API.G_FALSE
242 );
243
244
245 ---------------------------------------------------------------------
246 -- PROCEDURE
247 -- Submit_Request
248 --
249 -- PURPOSE
250 -- This procedure can be used to submit a new request for a single customer
251 -- to the fulfillment system.
252 --
253 -- PARAMETERS
254 -- p_user_id: Agent/User Id
255 -- p_party_id: Customer ID
256 -- p_priority: These are defined as global constants in package JTF_FM_Request_GRP.
257 -- User Note - Unused priority numbers are for future use.
258 -- p_source_code_id : Campaign/promotion field
259 -- p_source_code : Campaign/promotion field
260 -- p_object_type : Campaign/promotion field
261 -- p_object_id : Campaign/promotion field
262 -- p_order_id: Unique identifier of the order
263 -- p_server_id: Unique identifier of the sever
264 -- p_queue_response : Field to specify if response needs to queued in Response queue
265 -- p_content_xml : The content xml formed by calling the Get_Content_XML
266 -- or Get_Multiple_Content_XML API's.
267 -- p_request_id : Request ID obtained by calling the Start_Request API.
268
269 -- NOTES
270 -- 1. The API will generate an XML request and submit it to the Fulfillment
271 -- Request Queue.
272 -- 2. It also updates/creates fulfillment History and status records.
273 -- 3. Default priority is G_PRIORITY_REGULAR
274 -------------------------------------------------------------------------
275
276 PROCEDURE Submit_Request
277 ( p_api_version IN NUMBER,
278 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
279 p_commit IN VARCHAR2 := FND_API.G_FALSE,
280 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
281 x_return_status OUT NOCOPY VARCHAR2,
282 x_msg_count OUT NOCOPY NUMBER,
283 x_msg_data OUT NOCOPY VARCHAR2,
284 p_template_id IN NUMBER := FND_API.G_MISS_NUM,
285 p_subject IN VARCHAR2 := FND_API.G_MISS_CHAR,
286 p_party_id IN NUMBER := FND_API.G_MISS_NUM,
287 p_party_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
288 p_user_id IN NUMBER,
289 p_priority IN NUMBER := G_PRIORITY_REGULAR,
290 p_source_code_id IN NUMBER := FND_API.G_MISS_NUM,
291 p_source_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
292 p_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
293 p_object_id IN NUMBER := FND_API.G_MISS_NUM,
294 p_order_id IN NUMBER := FND_API.G_MISS_NUM,
295 p_doc_id IN NUMBER := FND_API.G_MISS_NUM,
296 p_doc_ref IN VARCHAR2 := FND_API.G_MISS_CHAR,
297 p_server_id IN NUMBER := FND_API.G_MISS_NUM,
298 p_queue_response IN VARCHAR2 := FND_API.G_FALSE,
299 p_extended_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
300 p_content_xml IN VARCHAR2,
301 p_request_id IN NUMBER
302 );
303
304
305
306
307 PROCEDURE Submit_Previewed_Request(
308 p_api_version IN NUMBER,
309 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
310 p_commit IN VARCHAR2 := FND_API.G_FALSE,
311 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
312 x_return_status OUT NOCOPY VARCHAR2,
313 x_msg_count OUT NOCOPY NUMBER,
314 x_msg_data OUT NOCOPY VARCHAR2,
315 p_request_id IN NUMBER
316 );
317
318 ---------------------------------------------------------------------
319 -- PROCEDURE
320 -- Resubmit_Request (overloaded)
321 --
322 -- PURPOSE
323 -- Allows the agent/user to resubmit a fulfillment that is already in the
324 -- system.
325 --
326 -- PARAMETERS
327 -- p_request_id: System generated fulfillment request id - from the previously
328 -- created request
329 -- x_request_id: OUT parameter. New design, a new reqest id is created for
330 -- every request submitted
331 --
332 -- NOTES
333 -- 1. Currently 1-to-1 fulfillment does not allow modifying a request
334 -- that was previously submitted and resubmitting it.
335 -- Signature has been modified to send back a new request id
336 -- To be consistent with the new schema changes, every req is unique
337 ---------------------------------------------------------------------
338
339 PROCEDURE Resubmit_Request(
340 p_api_version IN NUMBER,
341 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
342 p_commit IN VARCHAR2 := FND_API.G_FALSE,
343 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
344 x_return_status OUT NOCOPY VARCHAR2,
345 x_msg_count OUT NOCOPY NUMBER,
346 x_msg_data OUT NOCOPY VARCHAR2,
347 p_request_id IN NUMBER,
348 x_request_id OUT NOCOPY NUMBER
349 );
350
351 ---------------------------------------------------------------------
352 -- PROCEDURE
353 -- Resubmit_Request
354 --
355 -- PURPOSE
356 -- Allows the agent/user to resubmit a fulfillment that is already in the
357 -- system.
358 --
359 -- PARAMETERS
360 -- p_request_id: System generated fulfillment request id - from the previously
361 -- created request
362 --
363 -- NOTES
364 -- 1. Currently 1-to-1 fulfillment does not allow modifying a request
365 -- that was previously submitted and resubmitting it.
366 -- Signature has been modified to send back a new request id
367 -- To be consistent with the new schema changes, every req is unique
371 p_api_version IN NUMBER,
368 ---------------------------------------------------------------------
369
370 PROCEDURE Resubmit_Request(
372 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
373 p_commit IN VARCHAR2 := FND_API.G_FALSE,
374 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
375 x_return_status OUT NOCOPY VARCHAR2,
376 x_msg_count OUT NOCOPY NUMBER,
377 x_msg_data OUT NOCOPY VARCHAR2,
378 p_request_id IN NUMBER
379
380 );
381
382
383 ---------------------------------------------------------------------
384 -- PROCEDURE
385 -- Cancel_Request
386 --
387 -- PURPOSE
388 -- Allows the agent/user to cancel a fulfillment that is already in the system.
389 --
390 -- PARAMETERS
391 -- p_request_id: System generated fulfillment request id - from the previously
392 -- created request
393 --
394 -- NOTES
395 -- 1. Only messages that are still in the request queue will be cancelled.
396 -- Once the fulfillment engine dequeues the message from the request queue,
397 -- the request cannot be cancelled.
398 ---------------------------------------------------------------------
399
400 PROCEDURE Cancel_Request(
401 p_api_version IN NUMBER,
402 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
403 p_commit IN VARCHAR2 := FND_API.G_FALSE,
404 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
405 x_return_status OUT NOCOPY VARCHAR2,
406 x_msg_count OUT NOCOPY NUMBER,
407 x_msg_data OUT NOCOPY VARCHAR2,
408 p_request_id IN NUMBER,
409 p_submit_dt_tm IN DATE := FND_API.G_MISS_DATE
410 );
411
412 ---------------------------------------------------------------------
413 -- PROCEDURE
414 -- Get_Multiple_Content_XML
415 --
416 -- PURPOSE
417 -- Forms the XML request for multiple contents based on parameters passed and
418 -- returns the XML as an output parameter.
419 --
420 -- PARAMETERS
421 -- p_content_id: Unique Id of the content. (Required)
422 -- p_content_nm: The Name of the content.
423 -- p_quantity: Quantity of the content to be sent (Default = 1) .
424 -- p_media_type: Type of media - FAX, EMAIL, PRINTER, PATH.
425 -- p_printer: Address of the printer
426 -- p_email: Email Address
427 -- p_fax : Fax Address
428 -- p_file_path : File Path address
429 -- p_user_note: Any note that the agent wants to attach
430 -- p_content_type: Type of the content - QUERY, ATTACHMENT or COLLATERAL
431 -- p_bind_var : The list of bind variables
432 -- p_bind_var_type: The type of the corresponding bind variables
433 -- p_bind_val: Actual values of the corresponding bind variables.
434 -- p_request_id: The request ID obtained by calling the Start_Request API.
435 -- x_content_xml: Output content XML
436 --
437 -- NOTES
438 -- 1. The content_type can be of type COLLATERAL or ATTACHMENT.
439 -- 2. This API currently does not form XML for QUERY or DATA type of requests.
440 -- 3. The Get_Multiple_Content_XML API can handle multiple Contents per call.
441 -- Again the output content_XML string needs to be appended to the
442 -- content_xml from the previous calls.
443 ---------------------------------------------------------------------
444
445 PROCEDURE Get_Multiple_Content_XML
446 (
447 p_api_version IN NUMBER,
448 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
449 p_commit IN VARCHAR2 := FND_API.G_FALSE,
450 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
451 x_return_status OUT NOCOPY VARCHAR2,
452 x_msg_count OUT NOCOPY NUMBER,
453 x_msg_data OUT NOCOPY VARCHAR2,
454 p_request_id IN NUMBER,
455 p_content_type IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
456 p_content_id IN G_NUMBER_TBL_TYPE := L_NUMBER_TBL,
457 p_content_nm IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
458 p_document_type IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL, --depreciated
459 p_media_type IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
460 p_printer IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
461 p_email IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
462 p_fax IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
463 p_file_path IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
464 p_user_note IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
465 p_quantity IN G_NUMBER_TBL_TYPE := L_NUMBER_TBL,
466 x_content_xml OUT NOCOPY VARCHAR2
467 );
468
469 ---------------------------------------------------------------------
470 -- PROCEDURE
471 -- Submit_Batch_Request (Overloaded - Striped by org_id p_org_id)
472 --
473 -- PURPOSE
474 -- This procedure can be used to submit a new batch request for a multiple
475 -- customers to the fulfillment system
476 --
477 -- PARAMETERS
478 -- p_user_id: Agent/User Id
479 -- p_party_id: Customer ID
480 -- p_priority: These are defined as global constants in package JTF_FM_Request_GRP.
481 -- User Note - Unused priority numbers are for future use.
482 -- p_source_code_id : Campaign/promotion field
483 -- p_source_code : Campaign/promotion field
484 -- p_object_type : Campaign/promotion field
485 -- p_object_id : Campaign/promotion field
486 -- p_order_id : Unique identifier of the order
487 -- p_list_type : Specifies whether the customer list an their addresses
488 -- are to be picked up from a view in the database or if
492 -- p_email : The list of email addresses of the customers
489 -- the list is passed on the API.
490 -- p_view_name : The name of the view in the database.
491 -- p_party_id : List of Customer ID's for the batch request
493 -- p_fax : The list of fax addresses of the customers
494 -- p_printer : The list of printer addresses of the customers
495 -- p_file_path : The list of file path addresses of the customers
496 -- p_server_id : Unique identifier of the sever
497 -- p_queue_response : Field to specify if response needs to queued in Response queue
498 -- p_content_xml : The content xml formed by calling the Get_Content_XML
499 -- or Get_Multiple_Content_XML API's.
500 -- p_request_id : Request ID obtained by calling the Start_Request API.
501 -- p_per_user_history : The value of this parameter determines whether detailed
502 -- user level history is to be written for the batch request.
503 -- p_org_id : Striping by org_id
504 --
505 -- NOTES
506 -- 1. The API will generate an XML request and submit it to the Fulfillment
507 -- Request Queue.
508 -- 2. It also updates/creates fulfillment History and status records.
509 -- 3. The priority for batch request will always be G_PRIORITY_BATCH_REQUEST
510 ---------------------------------------------------------------------
511
512 PROCEDURE Submit_Batch_Request
513 ( p_api_version IN NUMBER,
514 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
515 p_commit IN VARCHAR2 := FND_API.G_FALSE,
516 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
517 x_return_status OUT NOCOPY VARCHAR2,
518 x_msg_count OUT NOCOPY NUMBER,
519 x_msg_data OUT NOCOPY VARCHAR2,
520 p_template_id IN NUMBER := NULL,
521 p_subject IN VARCHAR2 := FND_API.G_MISS_CHAR,
522 p_user_id IN NUMBER,
523 p_source_code_id IN NUMBER := FND_API.G_MISS_NUM,
524 p_source_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
525 p_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
526 p_object_id IN NUMBER := FND_API.G_MISS_NUM,
527 p_order_id IN NUMBER := FND_API.G_MISS_NUM,
528 p_doc_id IN NUMBER := FND_API.G_MISS_NUM,
529 p_doc_ref IN VARCHAR2 := FND_API.G_MISS_CHAR,
530 p_list_type IN VARCHAR2,
531 p_view_nm IN VARCHAR2 := FND_API.G_MISS_CHAR,
532 p_party_id IN G_NUMBER_TBL_TYPE := L_NUMBER_TBL,
533 p_party_name IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
534 p_printer IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
535 p_email IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
536 p_fax IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
537 p_file_path IN G_VARCHAR_TBL_TYPE := L_VARCHAR_TBL,
538 p_server_id IN NUMBER := FND_API.G_MISS_NUM,
539 p_queue_response IN VARCHAR2 := FND_API.G_FALSE,
540 p_extended_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
541 p_content_xml IN VARCHAR2,
542 p_request_id IN NUMBER,
543 p_per_user_history IN VARCHAR2 := FND_API.G_FALSE
544 );
545
546 ---------------------------------------------------------------------------
547
548 PROCEDURE Submit_Mass_Request
549 ( p_api_version IN NUMBER,
550 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
551 p_commit IN VARCHAR2 := FND_API.G_FALSE,
552 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
553 x_return_status OUT NOCOPY VARCHAR2,
554 x_msg_count OUT NOCOPY NUMBER,
555 x_msg_data OUT NOCOPY VARCHAR2,
556 p_template_id IN NUMBER := NULL,
557 p_subject IN VARCHAR2 := FND_API.G_MISS_CHAR,
558 p_user_id IN NUMBER,
559 p_source_code_id IN NUMBER := FND_API.G_MISS_NUM,
560 p_source_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
561 p_object_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
562 p_object_id IN NUMBER := FND_API.G_MISS_NUM,
563 p_order_id IN NUMBER := FND_API.G_MISS_NUM,
564 p_doc_id IN NUMBER := FND_API.G_MISS_NUM,
565 p_doc_ref IN VARCHAR2 := FND_API.G_MISS_CHAR,
566 p_list_type IN VARCHAR2, --deprecated
567 p_view_nm IN VARCHAR2 := FND_API.G_MISS_CHAR,
568 p_server_id IN NUMBER := FND_API.G_MISS_NUM,
569 p_queue_response IN VARCHAR2 := FND_API.G_FALSE,
570 p_extended_header IN VARCHAR2 := FND_API.G_MISS_CHAR,
571 p_content_xml IN VARCHAR2,
572 p_request_id IN NUMBER,
573 p_per_user_history IN VARCHAR2 := FND_API.G_FALSE,
574 p_mass_query_id IN NUMBER, --deprecated
575 p_mass_bind_var IN JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE := JTF_FM_REQUEST_GRP.L_VARCHAR_TBL, --deprecated
576 p_mass_bind_var_type IN JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE := JTF_FM_REQUEST_GRP.L_VARCHAR_TBL, --deprecated
577 p_mass_bind_val IN JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE := JTF_FM_REQUEST_GRP.L_VARCHAR_TBL --deprecated
578 ) ;
579
580 ---------------------------------------------------------------------------
581 --What parameters does it need?
582 -- 1. REQUEST_ID
583 -- 2. WHAT_TO_DO : EITHER PAUSE OR RESUME
584 --
585 --What does it do?
586 -- Gets all the DISTINCT MESSAGE IDS from STATUS TABLE
587 -- PUT MESSAGES INTO PAUSE QUEUE.
588 -- Also Update STATUS for these requests to "PAUSED"
589 --
590 --This should be available to public.
594 p_api_version IN NUMBER,
591 -------------------------------------------------------------
592 PROCEDURE PAUSE_RESUME_REQUEST
593 (
595 p_init_msg_list IN VARCHAR2,
596 p_commit IN VARCHAR2,
597 p_validation_level IN NUMBER,
598 x_return_status OUT NOCOPY VARCHAR2,
599 x_msg_count OUT NOCOPY NUMBER,
600 x_msg_data OUT NOCOPY VARCHAR2,
601 p_request_id IN NUMBER,
602 p_what_to_do IN VARCHAR
603 );
604
605 ---------------------------------------------------------------------------
606 --What parameters does it need?
607 -- 1. REQUEST_ID
608 -- 2. WHAT_TO_DO : EITHER PAUSE OR RESUME
609 --
610 --What does it do?
611 --
612 --This should be available to public.
613 -------------------------------------------------------------
614 PROCEDURE NEW_PAUSE_RESUME_REQUEST --anchaudh added
615 (
616 p_api_version IN NUMBER,
617 p_init_msg_list IN VARCHAR2,
618 p_commit IN VARCHAR2,
619 p_validation_level IN NUMBER,
620 x_return_status OUT NOCOPY VARCHAR2,
621 x_msg_count OUT NOCOPY NUMBER,
622 x_msg_data OUT NOCOPY VARCHAR2,
623 p_request_id IN NUMBER,
624 p_what_to_do IN VARCHAR
625 );
626
627 ---------------------------------------------------------------------
628 -- PROCEDURE
629 -- New_Cancel_Request
630 --
631 -- PURPOSE
632 -- Allows the agent/user to cancel a fulfillment that is already in the system.
633 --
634 -- PARAMETERS
635 -- p_request_id: System generated fulfillment request id - from the previously
636 -- created request
637 --
638 -- NOTES
639 --
640 ---------------------------------------------------------------------
641 PROCEDURE New_Cancel_Request --anchaudh added
642 (
643 p_api_version IN NUMBER,
644 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
645 p_commit IN VARCHAR2 := FND_API.G_FALSE,
646 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
647 x_return_status OUT NOCOPY VARCHAR2,
648 x_msg_count OUT NOCOPY NUMBER,
649 x_msg_data OUT NOCOPY VARCHAR2,
650 p_request_id IN NUMBER,
651 p_submit_dt_tm IN DATE := FND_API.G_MISS_DATE
652 );
653
654 ------------------------------------------------------------
655 --Determines which route the request has taken for its processing.
656 --The NEWROUTE/OLDROUTE
657 ----------------------------------------------------------------
658 PROCEDURE Determine_Request_Path --anchaudh added
659 (
660 x_return_status OUT NOCOPY VARCHAR2,
661 x_msg_count OUT NOCOPY NUMBER,
662 x_msg_data OUT NOCOPY VARCHAR2,
663 x_determined_path OUT NOCOPY VARCHAR2,
664 p_request_id IN NUMBER
665 );
666
667 ------------------------------------------------------------
668 --Resubmit Individual Jobs within a Mass Request
669 -- This API allows the user to resubmit it using a new media
670 -- The new media type and address can be passed to this api
671
672 ----------------------------------------------------------------
673
674 PROCEDURE RESUBMIT_JOB(
675 p_api_version IN NUMBER,
676 p_init_msg_list IN VARCHAR2,
677 p_commit IN VARCHAR2,
678 p_validation_level IN NUMBER,
679 x_return_status OUT NOCOPY VARCHAR2,
680 x_msg_count OUT NOCOPY NUMBER,
681 x_msg_data OUT NOCOPY VARCHAR2,
682 p_request_id IN NUMBER,
683 p_job_id IN NUMBER,
684 p_media_type IN VARCHAR2,
685 p_media_address IN VARCHAR2,
686 x_request_id OUT NOCOPY NUMBER
687
688 );
689
690 --------------------------------------------------------
691 -- API To correct malformed email addresss
692 -- A list of jobs and corresponding email addresses will be accepted
693 -- By this API for a given request Id.
694 -- The list can contain 1 elelent too.
695 ---------------------------------------------------
696 PROCEDURE CORRECT_MALFORMED
697 (
698 p_api_version IN NUMBER,
699 p_init_msg_list IN VARCHAR2,
700 p_commit IN VARCHAR2,
701 p_validation_level IN NUMBER,
702 x_msg_count OUT NOCOPY NUMBER,
703 x_msg_data OUT NOCOPY VARCHAR2,
704 p_request_id IN NUMBER,
705 p_job IN JTF_FM_REQUEST_GRP.G_NUMBER_TBL_TYPE,
706 p_corrected_address IN JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE,
707 x_return_status OUT NOCOPY VARCHAR2
708 );
709
710 ------------------------------------------------------------
711 -- API To Resubmit Malformed Emails
712 -- This API will check to see if Malformed Emails have been
713 -- corrected, if so it will resubmit the request to the
714 -- corrected address.
715 --
716 ------------------------------------------------------------
717
718 PROCEDURE RESUBMIT_MALFORMED(
719 p_api_version IN NUMBER,
720 p_init_msg_list IN VARCHAR2,
721 p_commit IN VARCHAR2,
725 p_request_id IN NUMBER,
722 p_validation_level IN NUMBER,
723 x_msg_count OUT NOCOPY NUMBER,
724 x_msg_data OUT NOCOPY VARCHAR2,
726 x_request_id OUT NOCOPY JTF_FM_REQUEST_GRP.G_NUMBER_TBL_TYPE,
727 x_return_status OUT NOCOPY VARCHAR2
728 );
729
730 -- Utility function to replace XML tags
731 FUNCTION REPLACE_TAG
732 (
733 p_string IN VARCHAR2
734 )
735 RETURN VARCHAR2;
736
737 END JTF_FM_REQUEST_GRP;
738
739
740
741
742
[Home] [Help]