1 PACKAGE XDP_INTERFACES_PUB AUTHID CURRENT_USER AS
2 /* $Header: XDPINPBS.pls 120.2 2006/04/07 03:34:41 dputhiye ship $ */
3 /*#
4 * A public interface for Service Fulfillment Manager that is used to submit,
5 * retrieve details or cancel Service Fulfillment Orders. Upstream systems
6 * can provide an external order number and version which can be used to track the
7 * corresponding SFM order created. The type definitions of the parameters to the
8 * APIs can be found in the PL/SQL package XDP_TYPES.
9 * @rep:scope public
10 * @rep:product XDP
11 * @rep:lifecycle active
12 * @rep:displayname Service Fulfillment Order Processing
13 * @rep:category BUSINESS_ENTITY XDP_SERVICE_ORDER
14 * @rep:comment @see XDP_TYPES#SERVICE_ORDER_HEADER
15 * @rep:comment @see XDP_TYPES#SERVICE_ORDER_PARAM_LIST
16 * @rep:comment @see XDP_TYPES#SERVICE_ORDER_LINE_LIST
17 * @rep:comment @see XDP_TYPES#SERVICE_LINE_PARAM_LIST
18 */
19
20 -- Start of comments
21 -- API name : Process_Order
22 -- Type : Public
23 -- Function : This API is used for submitting a service order to SFM.
24 -- Pre-reqs : None.
25 -- Parameters :
26 --
27 -- IN : p_api_version: NUMBER Required
28 -- p_init_msg_list: VARCHAR2 Optional
29 -- Default = FND_API.G_FALSE
30 -- p_commit: VARCHAR2 Optional
31 -- Default = FND_API.G_FALSE
32 -- When calling this API via a database link, this
33 -- parameter must be FND_API.G_FALSE
34 -- p_validation_level NUMBER Optional
35 -- Default = FND_API.G_VALID_LEVEL_FULL
36 -- p_order_header: XDP_TYPES.ORDER_HEADER Required
37 -- Order header information which requires the
38 -- following atrribute values to be supplied:
39 -- order_number:
40 -- The order identifier which is assigned by the
41 -- calling system
42 -- order_version:
43 -- The version of the order. This attribute
44 -- can be NULL
45 -- provisioning_date:
46 -- The date this order is supposed to begin
47 -- fulfillment. If the value is not supplied then
48 -- it will be default to the sysdate.
49 -- order_action:
50 -- The fulfillment action which can be applied
51 -- to all the lines in the order. This attribute is
52 -- optional.
53 -- jeopardy_enabled_flag:
54 -- The flag indicates whether the jeopardy analysis
55 -- should be enabled for the order or not. The user
56 -- can then use this flag combine with other order
57 -- information in the post process user hook package
58 -- to determine whether to start a jeopardy timer or
59 -- not. This attribute is optional.
60 -- p_order_parameter: XDP_TYPES.ORDER_PARAMETER_LIST Required
61 -- The parameters that can be accessed by all
62 -- the order lines. The list can be empty.
63 -- p_order_line_list: XDP_TYPES.ORDER_LINE_LIST Required
64 -- The list of order line items which requires
65 -- the following attribute values to be supplied:
66 -- line_number:
67 -- The index number of the current line
68 -- line_item_name:
69 -- The name of the service item
70 -- version:
71 -- The version of the service item
72 -- action:
73 -- The fulfillment action of the current line. If this
74 -- value is not supplied, SFM will default it to the order
75 -- action
76 -- provisioning_date:
77 -- The date this order line is scheduled to
78 -- be fulfilled. If the value is not supplied SFM will
79 -- default it to order provisioning date.
80 -- provisioning_sequence:
81 -- SFM uses this attrribute to determine dependency between
82 -- order lines. If the value is not supplied SFM will
83 -- assume there is not dependency for this line.
84 -- p_line_parameter_list: XDP_TYPES.LINE_PARAM_LIST Required
85 -- The list of the parameters for each order line. The list
86 -- can be empty. For every record in the list, the
87 -- following attribute values to be supplied:
88 -- line_number:
89 -- The line number of this parameter is associated with
90 -- parameter_name:
91 -- The name of the parameter
92 -- parameter_value:
93 -- The value of the parameter. It can be null.
94 -- parameter_ref_value:
95 -- The reference value of the parameter. This
96 -- attribute is optional.
97 --
98 -- OUT : x_return_status: VARCHAR2(1) Required
99 -- The caller must examine this parameter value
100 -- after the call is completed. If the value is
101 -- FND_API.G_RET_STS_SUCCESS, the caller routine
102 -- must do commit, otherwise, the caller routine
103 -- must do rollback.
104 -- x_msg_count: NUMBER
105 -- x_msg_data: VARCHAR2(2000)
106 -- x_sdp_Order_id: NUMBER
107 -- The internal order ID which is assigned by SFM
108 -- when an order is successfully submitted to SFM
109 --
110 -- Version : Current version 11.5
111 -- Notes :
112 -- This API is used for upstream ordering system to submit a
113 -- service order to SFM. If the customer wishes to perform order
114 -- dependency and jeopardy analysis, he or she can put the
115 -- business logic in the post process API under the customer
116 -- hook package which will be supported by SFM per CRM coding
117 -- standard.
118 --
119 -- End of comments
120 PROCEDURE Process_Order(
121 p_api_version IN NUMBER,
122 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
123 p_commit IN VARCHAR2 := FND_API.G_FALSE,
124 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
125 x_RETURN_STATUS OUT NOCOPY VARCHAR2,
126 x_msg_count OUT NOCOPY NUMBER,
127 x_msg_data OUT NOCOPY VARCHAR2,
128 P_ORDER_HEADER IN XDP_TYPES.ORDER_HEADER,
129 P_ORDER_PARAMETER IN XDP_TYPES.ORDER_PARAMETER_LIST,
130 P_ORDER_LINE_LIST IN XDP_TYPES.ORDER_LINE_LIST,
131 P_LINE_PARAMETER_LIST IN XDP_TYPES.LINE_PARAM_LIST,
132 x_SDP_ORDER_ID OUT NOCOPY NUMBER);
133
134 -- Start of comments
135 -- API name : Cancel_Order
136 -- Type : Public
137 -- Function : This API is used for canceling a service order
138 -- Pre-reqs : None.
139 -- Parameters :
140 --
141 -- IN : p_api_version: NUMBER Required
142 -- p_init_msg_list: VARCHAR2 Optional
143 -- Default = FND_API.G_FALSE
144 -- p_commit: VARCHAR2 Optional
145 -- Default = FND_API.G_FALSE
146 -- This API is an autonomous routine which
147 -- handles the database transaction independently.
148 -- The value of p_commit parameter will be ignored.
149 -- p_validation_level NUMBER Optional
150 -- Default = FND_API.G_VALID_LEVEL_FULL
151 -- p_sdp_Order_id: NUMBER Required
152 -- The internal order ID which was assigned by SFM
153 -- when an order was successfully submitted to SFM
154 -- p_caller_name: VARCHAR2 Required
155 -- The name of the user who is calling this API
156 --
157 -- OUT : x_return_status: VARCHAR2(1) Required
158 -- The execution status of the API call.
159 -- x_msg_count: NUMBER
160 -- x_msg_data: VARCHAR2(2000)
161 --
162 -- Version : Current version 11.5
163 -- Notes :
164 -- This API is used for upstream ordering system to cancel
165 -- a service order which was submitted to SFM previously.
166 --
167 -- End of comments
168
169 PROCEDURE Cancel_Order(
170 p_api_version IN NUMBER,
171 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
172 p_commit IN VARCHAR2 := FND_API.G_FALSE,
173 p_validation_level IN NUMBER :=
174 FND_API.G_VALID_LEVEL_FULL,
175 x_RETURN_STATUS OUT NOCOPY VARCHAR2,
176 x_msg_count OUT NOCOPY NUMBER,
177 x_msg_data OUT NOCOPY VARCHAR2,
178 P_SDP_ORDER_ID IN NUMBER,
179 p_caller_name IN VARCHAR2 );
180
181 -- Start of comments
182 -- API name : Get_Order_Parameter_List
183 -- Type : Public
184 -- Function : This API is used for retrieve order parameter list
185 -- Pre-reqs : XDP_ENGIN.PARAMETER_LIST
186 -- Parameters :
187 --
188 -- IN : p_api_version: NUMBER Required
189 -- p_sdp_Order_id: NUMBER Required
190 -- The internal order ID which was assigned by SFM
191 -- when an order was successfully submitted to SFM
192 -- p_caller_name: VARCHAR2 Required
193 -- The name of the user who is calling this API
194 --
195 -- OUT : x_return_status: VARCHAR2(1) Required
196 -- The execution status of the API call.
197 -- x_return_msg: VARCHAR2(2000)
198 -- The execution comments of the API call
199 -- x_order_param_list: XDP_ENGINE.PARAMETER_LIST;
200 --
201 -- Version : Current version 11.5
202 -- Notes :
203 -- This API is used for upstream ordering system to retrieve order parameter list
204 -- for further used to acquire order parameter value.
205 --
206 -- End of comments
207
208 PROCEDURE Get_Order_Parameter_List(
209 p_api_version IN NUMBER,
210 x_RETURN_STATUS OUT NOCOPY VARCHAR2,
211 x_RETURN_MSG OUT NOCOPY VARCHAR2,
212 x_ORDER_PARAM_LIST OUT NOCOPY XDP_ENGINE.PARAMETER_LIST,
213 P_SDP_ORDER_ID IN NUMBER,
214 p_CALLER_NAME IN VARCHAR2 );
215
216 -- Start of comments
217 -- API name : Get_Order_Parameter_Value
218 -- Type : Public
219 -- Function : This API is used for retrieve order parameter value
220 -- Pre-reqs :
221 -- Parameters :
222 --
223 -- IN : p_api_version: NUMBER Required
224 -- p_sdp_Order_id: NUMBER Required
225 -- The internal order ID which was assigned by SFM
226 -- when an order was successfully submitted to SFM
227 -- p_order_param_name: VARCHAR2 Required
228 -- The name of the order parameter whose value will be retrieved
229 -- by calling this API
230 -- p_caller_name: VARCHAR2 Required
231 -- The name of the user who is calling this API
232 --
233 -- OUT : x_return_status: VARCHAR2(1) Required
234 -- The execution status of the API call.
235 -- x_return_msg: VARCHAR2(2000)
236 -- The execution comments of the API call
237 -- x_order_param_value: VARCHAR2;
238 --
239 -- Version : Current version 11.5
240 -- Notes :
241 -- This API is used for upstream ordering system to retrieve order parameter value.
242 --
243 -- End of comments
244
245 PROCEDURE Get_Order_Parameter_Value(
246 p_api_version IN NUMBER,
247 x_RETURN_STATUS OUT NOCOPY VARCHAR2,
248 x_RETURN_MSG OUT NOCOPY VARCHAR2,
249 x_ORDER_PARAM_VALUE OUT NOCOPY VARCHAR2,
250 p_SDP_ORDER_ID IN NUMBER,
251 p_ORDER_PARAM_NAME IN VARCHAR2,
252 p_CALLER_NAME IN VARCHAR2 );
253
254 -- Start of comments
255 -- API name : Get_Line_Parameter_Value
256 -- Type : Public
257 -- Function : This API is used for retrieve order line item parameter value
258 -- Pre-reqs :
259 -- Parameters :
260 --
261 -- IN : p_api_version: NUMBER Required
262 -- p_sdp_Order_id: NUMBER Required
263 -- The internal order ID which was assigned by SFM
264 -- when an order was successfully submitted to SFM
265 -- p_Line_Number: NUMBER Required
266 -- The line number supplied by upstream ordering system when
267 -- submiting an order
268 -- p_Line_param_name: VARCHAR2 Required
269 -- The name of the order parameter whose value will be retrieved
270 -- by calling this API
271 -- p_caller_name: VARCHAR2 Required
272 -- The name of the user who is calling this API
273 --
274 -- OUT : x_return_status: VARCHAR2(1) Required
275 -- The execution status of the API call.
276 -- x_return_msg: VARCHAR2(2000)
277 -- The execution comments of the API call
278 -- x_Line_param_value: VARCHAR2;
279 --
280 -- Version : Current version 11.5
281 -- Notes :
282 -- This API is used for upstream ordering system to retrieve order line item parameter value.
283 --
284 -- End of comments
285
286 PROCEDURE Get_Line_Parameter_Value(
287 p_api_version IN NUMBER,
288 x_RETURN_STATUS OUT NOCOPY VARCHAR2,
289 x_RETURN_MSG OUT NOCOPY VARCHAR2,
290 x_LINE_PARAM_VALUE OUT NOCOPY VARCHAR2,
291 p_SDP_ORDER_ID IN NUMBER,
292 P_LINE_NUMBER IN NUMBER,
293 p_LINE_PARAM_NAME IN VARCHAR2,
294 p_CALLER_NAME IN VARCHAR2 );
295 --
296 -- Implementation for Open Interface
297 -- 06/07/2001
298
299 -- Start of comments
300 -- API name : Process_Order
301 -- Type : Public
302 -- Function : This API is used for submitting a service order to SFM.
303 -- Pre-reqs : None.
304 -- Parameters :
305 --
306 -- IN : p_api_version: NUMBER Required
307 --
308 -- p_init_msg_list: VARCHAR2 Optional
309 -- Default = FND_API.G_FALSE
310 --
311 -- p_commit: VARCHAR2 Optional
312 -- Default = FND_API.G_FALSE
313 -- When calling this API via a database link, this
314 -- parameter must be FND_API.G_FALSE
315 --
316 -- p_validation_level NUMBER Optional
317 -- Default = FND_API.G_VALID_LEVEL_FULL
318 --
319 -- p_order_header: XDP_TYPES.SERVICE_ORDER_HEADER Required
320 -- Order header information which requires the
321 -- following atrribute values to be supplied:
322 --
323 -- order_number:
324 -- The order identifier which is assigned by the
325 -- calling system
326 --
327 -- order_version:
328 -- The version of the order. This attribute
329 -- can be NULL
330 --
331 -- provisioning_date:
332 -- The date this order is supposed to begin
333 -- fulfillment. If the value is not supplied then
334 -- it will be default to the sysdate.
335 --
336 -- jeopardy_enabled_flag:
337 -- The flag indicates whether the jeopardy analysis
338 -- should be enabled for the order or not. The user
339 -- can then use this flag combine with other order
340 -- information in the post process user hook package
341 -- to determine whether to start a jeopardy timer or
342 -- not. This attribute is optional.
343 --
344 -- order_ref_name:
345 -- This field is used to identify the type of the source system
346 -- for this order. It should be only of the following value
347 -- For Sales Orders:
348 -- ORDER_REF_NAME = 'SALES'
349 -- For Service Requests:
350 -- ORDER_REF_NAME = 'SERVICE_REQUEST'
351 -- execution_mode
352 -- This field indicate the order should be fulfilled sycn or asynchnorosly
353 -- Valid values are 'SYNC' and 'ASYNC'
354 --
355 -- account_id/account_number:
356 -- For whom the order is submitted on behalf of.
357 -- one of these two fields must be specified
358 -- The account must exist in the TCA model.
359 --
360 -- p_order_param_list: XDP_TYPES.SERVICE_ORDER_PARAM_LIST Required
361 -- The parameters that can be accessed by all
362 -- the order lines. The list can be empty.
363 -- p_order_line_list: XDP_TYPES.SERVICE_ORDER_LINE_LIST Required
364 -- The list of order line items which requires
365 -- the following attribute values to be supplied:
366 --
367 -- line_number:
368 -- The index number of the current line
369 --
370 -- line_source:
371 -- Source object name of the upstream application
372 --
373 -- inventory_item_id:
374 -- The item id in Oracle product catalog
375 -- service_item_name:
376 -- The item name in Oracle product catalog or workitem name in SFM
377 --
378 -- version:
379 -- The version of the workitem item. Only applicable when
380 -- serive_item_name is a workitem
381 -- action_code:
382 -- The fulfillment action of the current line.
383 --
384 -- fulfillment_date:
385 -- The date this order line is scheduled to
386 -- be fulfilled. If the value is not supplied SFM will
387 -- default it to order fulfillment date.
388 --
389 -- fulfillment_sequence:
390 -- SFM uses this attrribute to determine dependency between
391 -- order lines. If the value is not supplied SFM will
392 -- assume there is not dependency for this line.
393 --
394 -- organization_code/organization_id:
395 -- SFM uses these attrributes to determine organization id for the
396 -- item in the inventory system.
397 --
398 -- site_use_id:
399 -- SFM uses this attrribute to determine install to address for this item
400 --
401 -- ib_source:
402 -- SFM uses this attrribute to determine
403 -- Oracle Installed Base system to which SFM will
404 -- update product installation information for the customer
405 --
406 -- ib_source_id:
407 -- SFM uses this attrribute to determine
408 -- value that uniquely identifies a transaction line detail
409 -- in Oracle Installed Base or an item instance in
410 -- Oracle Installed Base
411 --
412 -- required_fulfillment_date:
413 -- The date customer requires for this item to be fulfilled
414 --
415 -- bundle_id:
416 -- If this line item is part of a bundle, this fields identify
417 -- the bundle it belongs to. Reserved.
418 --
419 -- bundle_sequence:
420 -- If this line item is part of a bundle, this fields identify
421 -- the sequence of this itme in the bundle, Reserved.
422 --
423 -- priority:
424 -- The priority of the line item to be fulfilled.
425 --
426 -- due_date:
427 -- The data the order should be fulfilled, otherwise, a
428 -- jeopardy event could be fired.
429 --
430 -- jeopardy_enabled_flag:
431 -- The flag indicates whether the jeopardy analysis
432 -- should be enabled for the order or not. The user
433 -- can then use this flag combine with other order
434 -- information in the post process user hook package
435 -- to determine whether to start a jeopardy timer or
436 -- not. This attribute is optional.
437 --
438 -- starting_number:
439 -- NP number range
440 --
441 -- ending_number:
442 -- NP number range
443 --
444 -- attribute 1-20:
445 -- Descriptive flexfields.
446 --
447 -- p_line_param_list: XDP_TYPES.G_MISS_LINE_PARAM_LIST Required
448 -- The list of the parameters for each order line. The list
449 -- can be empty. For every record in the list, the
450 -- following attribute values to be supplied:
451 -- line_number:
452 -- The line number of this parameter is associated with
453 -- parameter_name:
454 -- The name of the parameter
455 -- parameter_value:
456 -- The value of the parameter. It can be null.
457 -- parameter_ref_value:
458 -- The reference value of the parameter. This
459 -- attribute is optional.
460 --
461 -- OUT : x_return_status: VARCHAR2(1) Required
462 -- The caller must examine this parameter value
463 -- after the call is completed. If the value is
464 -- FND_API.G_RET_STS_SUCCESS, the caller routine
465 -- must do commit, otherwise, the caller routine
466 -- must do rollback.
467 -- x_msg_count: NUMBER
468 -- x_msg_data: VARCHAR2(2000)
469 -- x_order_id: NUMBER
470 -- The internal order ID which is assigned by SFM
471 -- when an order is successfully submitted to SFM
472 -- x_error_code VARCHAR2
473 -- The application error code that is specific to SFM
474 --
475 -- Version : Current version 11.5
476 -- Notes :
477 -- This API is used for upstream systems to submit a
478 -- service order to SFM. If the customer wishes to perform order
479 -- dependency and jeopardy analysis, he or she can put the
480 -- business logic in the post process API under the customer
481 -- hook package which will be supported by SFM per CRM coding
482 -- standard.
483 --
484 -- End of comments
485 /*#
486 * Submit a Service Fulfillment Order for processing. The order information is to be submitted as a set of
487 * SFM order structures, which include the order header, order parameters, order lines and order line parameters.
488 * An external order number and version can be specified in the order header. The internal order id is returned.
489 *
490 * @param p_api_version API version used to check call compatibility. Current version is '11.5'.
491 * @param p_init_msg_list Flag indicating whether internal message tables should be initialized.
492 * @param p_commit Flag indicating whether this API should commit the transaction, if the call is successful.
493 * @param p_validation_level The level of input validation required from the API.
494 * @param x_return_status Return status of API call.
495 * @param x_msg_count Count of stored processing messages.
496 * @param x_msg_data List of all stored processing messages.
497 * @param x_error_code SFM-specific application error code returned.
498 * @param p_order_header Header-level value information for the service order.
499 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_HEADER}
500 * @param p_order_param_list List of header-level parameters. Each parameter is a name-value pair.
501 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_PARAM_LIST}
502 * @param p_order_line_list Line-level value information for the service order.
503 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_LINE_LIST}
504 * @param p_line_param_list List of line-level parameters. Each parameter is a name-value pair.
505 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_LINE_PARAM_LIST}
506 * @param x_order_id The SFM order id for the service order.
507 * @return The internal service fulfillment order id
508 * @rep:scope public
509 * @rep:lifecycle active
510 * @rep:displayname Process Service Fulfillment Order
511 */
512 PROCEDURE Process_Order(
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 x_error_code OUT NOCOPY VARCHAR2,
521 p_order_header IN XDP_TYPES.SERVICE_ORDER_HEADER := XDP_TYPES.G_MISS_SERVICE_ORDER_HEADER,
522 p_order_param_list IN XDP_TYPES.SERVICE_ORDER_PARAM_LIST := XDP_TYPES.G_MISS_ORDER_PARAM_LIST,
523 p_order_line_list IN XDP_TYPES.SERVICE_ORDER_LINE_LIST := XDP_TYPES.G_MISS_SERVICE_ORDER_LINE_LIST,
524 p_line_param_list IN XDP_TYPES.SERVICE_LINE_PARAM_LIST := XDP_TYPES.G_MISS_LINE_PARAM_LIST,
525 x_order_id OUT NOCOPY NUMBER
526 );
527
528 -- Start of comments
529 -- API name : Cancel_Order
530 -- Type : Public
531 -- Function : This API is used for canceling a service order
532 -- Pre-reqs : None.
533 -- Parameters :
534 --
535 -- IN : p_api_version: NUMBER Required
536 --
537 -- p_init_msg_list: VARCHAR2 Optional
538 -- Default = FND_API.G_FALSE
539 --
540 -- p_commit: VARCHAR2 Optional
541 -- Default = FND_API.G_FALSE
542 -- This API is an autonomous routine which
543 -- handles the database transaction independently.
544 -- The value of p_commit parameter will be ignored.
545 --
546 -- p_validation_level NUMBER Optional
547 -- Default = FND_API.G_VALID_LEVEL_FULL
548 --
549 -- p_order_id: NUMBER requried if p_order_number is null
550 -- The internal order ID which was assigned by SFM
551 -- when an order was successfully submitted to SFM
552 --
553 -- p_order_number: VARCHAR2 requried if p_order_id is null
554 -- The order number given by the caller when the order is submitted.
555 -- This field with p_version will be used to identify which order
556 -- to cancel
557 --
558 -- p_order_version: VARCHAR2 Required
559 --
560 --
561 -- OUT : x_return_status: VARCHAR2(1) Required
562 -- The execution status of the API call.
563 -- x_msg_count: NUMBER
564 -- x_msg_data: VARCHAR2(2000)
565 -- x_error_code VARCHAR2
566 -- The application error code that is specific to SFM
567 --
568 -- Version : Current version 11.5
569 -- Notes :
570 -- This API is used for upstream ordering system to cancel
571 -- a service order which was submitted to SFM previously.
572 --
573 -- End of comments
574 /*#
575 * Cancel a Service Fulfillment Order. A known external order number and version or a known SFM order id must be supplied.
576 * The given order number and version are references specified by the upstream ordering system while submitting a new service order.
577 * SFM order id is the internal order identifier for a service order in SFM.
578 *
579 * @param p_api_version API version used to check call compatibility. Current version is '11.5'.
580 * @param p_init_msg_list Flag indicating whether internal message tables should be initialized.
581 * @param p_commit This parameter is ignored. This API is an autonomous routine, which handles the database transaction independently.
582 * @param p_validation_level The level of input validation required from the API.
583 * @param x_return_status Return status of API call.
584 * @param x_msg_count Count of stored processing messages.
585 * @param x_msg_data List of all stored processing messages.
586 * @param p_order_number The external order number reference value.
587 * @param p_order_version The external order version reference value. This parameter is optional and is defaulted to '1'.
588 * @param p_order_id The SFM order id. This value is optional if p_order_number is specified.
589 * @param x_error_code SFM-specific error code returned in case of errors.
590 * @param p_caller_name The calling user/module. This parameter is optional.
591 * @rep:scope public
592 * @rep:lifecycle active
593 * @rep:displayname Cancel Service Fulfillment Order
594 */
595 PROCEDURE Cancel_Order(
596 p_api_version IN NUMBER := FND_API.G_MISS_NUM,
597 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
598 p_commit IN VARCHAR2 := FND_API.G_FALSE,
599 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
600 x_return_status OUT NOCOPY VARCHAR2,
601 x_msg_count OUT NOCOPY NUMBER,
602 x_msg_data OUT NOCOPY VARCHAR2,
603 p_order_number IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
604 p_order_version IN VARCHAR2 DEFAULT '1',
605 p_order_id IN NUMBER := FND_API.G_MISS_NUM,
606 x_error_code OUT NOCOPY VARCHAR2,
607 p_caller_name IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR
608 );
609
610 -- Start of comments
611 -- API name : Get_Order_Details
612 -- Type : Public
613 -- Function : This API is used for retrieving current information about
614 -- a service order
615 -- Pre-reqs : None.
616 -- Parameters :
617 --
618 -- IN : p_api_version: NUMBER Required
619 --
620 -- p_init_msg_list: VARCHAR2 Optional
621 -- Default = FND_API.G_FALSE
622 --
623 -- p_commit: VARCHAR2 Optional
624 -- Default = FND_API.G_FALSE
625 -- This API is an autonomous routine which
626 -- handles the database transaction independently.
627 -- The value of p_commit parameter will be ignored.
628 --
629 -- p_validation_level NUMBER Optional
630 -- Default = FND_API.G_VALID_LEVEL_FULL.
631 --
632 -- p_order_id: NUMBER requried if p_order_number is null
633 -- The internal order ID which was assigned by SFM
634 -- when an order was successfully submitted to SFM.
635 --
636 -- p_order_number: VARCHAR2 requried if p_order_id is null
637 -- The order number given by the caller when the order is submitted.
638 -- This field with p_version will be used to identify which order
639 -- to cancel.
640 --
641 -- p_order_version: VARCHAR2, Optional.
642 --
643 --
644 -- OUT : x_return_status: VARCHAR2(1) Required
645 -- The execution status of the API call.
646 --
647 -- x_msg_count: NUMBER
648 --
649 -- x_msg_data: VARCHAR2(2000)
650 --
651 -- x_error_code VARCHAR2
652 -- The application error code that is specific to SFM
653 --
654 -- x_order_header
655 -- Order header information which contains current information
656 -- in SFM systme for the following atrributes:
657 --
658 -- order_number:
659 -- The order identifier which is assigned by the
660 -- calling system
661 --
662 -- order_version:
663 -- The version of the order. This attribute
664 -- can be NULL
665 --
666 -- provisioning_date:
667 -- The date this order is supposed to begin
668 -- fulfillment. If the value is not supplied then
669 -- it will be default to the sysdate.
670 --
671 -- jeopardy_enabled_flag:
672 -- The flag indicates whether the jeopardy analysis
673 -- should be enabled for the order or not. The user
674 -- can then use this flag combine with other order
675 -- information in the post process user hook package
676 -- to determine whether to start a jeopardy timer or
677 -- not. This attribute is optional.
678 --
679 -- execution_mode
680 -- This field indicate the order should be fulfilled sycn or asynchnorosly
681 -- Valid values are 'SYNC' and 'ASYNC'
682 --
683 -- account_id/account_number:
684 -- For whom the order is submitted on behalf of.
685 -- one of these two fields must be specified
686 -- The account must exist in the TCA model.
687 -- order_status
688 -- Current SFM order status
689 --
690 -- fulfillment_status
691 -- Current value of order parameter "Fulfillemnt Status"
692 --
693 -- fulfillment_result
694 -- Current value of order parameter "Fulfillemnt Result"
695 --
696 -- actual_fulfillment_date
697 -- The date when the fulfillment process was started for this order
698 --
699 -- completiont_date
700 -- The date when this order is fulfilled
701 --
702 -- x_order_param_list
703 -- The list of name value pair for this order. Values are the most updated ones
704 --
705 -- x_line_item_list
706 -- The table of line items of this order. Each record contains updated information
707 -- about this line item. For more details about field of this record, please refer
708 -- to the definition of record Service_Line_Item.
709 --
710 -- x_line_param_list
711 -- The list of name value pair for line items of this order. Values are the most updated ones
712 --
713 -- Version : Current version 11.5
714 -- Notes :
715 -- This API is used for upstream ordering system to cancel
716 -- a service order which was submitted to SFM previously.
717 --
718 -- End of comments
719 /*#
720 * Retrieve order header, lines and other information from a Service Fulfillment Order. An external order number and version or a known SFM order id must be supplied.
721 * The given order number and version are references specified by the upstream ordering system while submitting a new service order. SFM order id is the
722 * internally assigned order identifier for a service order in SFM.
723 * @param p_api_version API version used to check call compatibility. Current version is '11.5'.
724 * @param p_init_msg_list Flag indicating whether internal message tables should be initialized.
725 * @param p_commit This parameter is optional and is ignored.
726 * @param p_validation_level The level of input validation required from the API.
727 * @param x_return_status Return status of API call.
728 * @param x_msg_count Count of stored processing messages.
729 * @param x_msg_data List of all stored processing messages.
730 * @param x_error_code SFM-specific error code returned in case of errors.
731 * @param p_order_number The external order number reference value.
732 * @param p_order_version The external order version reference value. This parameter is optional and is defaulted to '1'.
733 * @param p_order_id The SFM order id. This value is optional if p_order_number is specified.
734 * @param x_order_header Header-level value information retrieved from the service order.
735 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_HEADER}
736 * @param x_order_param_list List of header-level parameters retrieved from the service order. Each parameter is a name-value pair.
737 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_PARAM_LIST}
738 * @param x_line_item_list Line-level value information retrieved from the service order.
739 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_LINE_LIST}
740 * @param x_line_param_list List of line-level parameters retrieved from the service order. Each record is a name-value pair.
741 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_LINE_PARAM_LIST}
742 * @return Header-level value information, List of header-level parameters, Line-level value information and List of line-level parameters
743 * @rep:scope public
744 * @rep:lifecycle active
745 * @rep:displayname Get Service Fulfillment Order Details
746 */
747 PROCEDURE Get_Order_Details(
748 p_api_version IN NUMBER ,
749 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
750 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
751 p_validation_level IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
752 x_return_status OUT NOCOPY VARCHAR2,
753 x_msg_count OUT NOCOPY NUMBER,
754 x_msg_data OUT NOCOPY VARCHAR2,
755 x_error_code OUT NOCOPY VARCHAR2,
756 p_order_number IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
757 p_order_version IN VARCHAR2 DEFAULT '1',
758 p_order_id IN NUMBER DEFAULT FND_API.G_MISS_NUM,
759 x_order_header OUT NOCOPY XDP_TYPES.SERVICE_ORDER_HEADER,
760 x_order_param_list OUT NOCOPY XDP_TYPES.SERVICE_ORDER_PARAM_LIST,
761 x_line_item_list OUT NOCOPY XDP_TYPES.SERVICE_ORDER_LINE_LIST,
762 x_line_param_list OUT NOCOPY XDP_TYPES.SERVICE_LINE_PARAM_LIST
763 );
764
765 -- Start of comments
766 -- API name : Get_Order_Status
767 -- Type : Public
768 -- Function : This API is used for retrieving status of
769 -- a service order
770 -- Pre-reqs : None.
771 -- Parameters :
772 --
773 -- IN : p_api_version: NUMBER Required
774 --
775 -- p_init_msg_list: VARCHAR2 Optional
776 -- Default = FND_API.G_FALSE
777 --
778 -- p_commit: VARCHAR2 Optional
779 -- Default = FND_API.G_FALSE
780 -- This API is an autonomous routine which
781 -- handles the database transaction independently.
782 -- The value of p_commit parameter will be ignored.
783 --
784 -- p_validation_level NUMBER Optional
785 -- Default = FND_API.G_VALID_LEVEL_FULL.
786 --
787 -- p_order_id: NUMBER requried if p_order_number is null
788 -- The internal order ID which was assigned by SFM
789 -- when an order was successfully submitted to SFM.
790 --
791 -- p_order_number: VARCHAR2 requried if p_order_id is null
792 -- The order number given by the caller when the order is submitted.
793 -- This field with p_version will be used to identify which order
794 -- to cancel.
795 --
796 -- p_order_version: VARCHAR2, Optional.
797 --
798 --
799 -- OUT : x_return_status: VARCHAR2(1) Required
800 -- The execution status of the API call.
801 --
802 -- x_msg_count: NUMBER
803 --
804 -- x_msg_data: VARCHAR2(2000)
805 --
806 -- x_error_code VARCHAR2
807 -- The application error code that is specific to SFM
808 --
809 -- x_order_status SERVICE_ORDER_STATUS
810 -- Record that holds order status information which contains the
811 -- following fields
812 --
813 -- order_id: NUMBER
814 -- The internal order ID which was assigned by SFM
815 -- when an order was successfully submitted to SFM.
816 --
817 -- order_number: VARCHAR2
818 -- The order number given by the caller when the order is submitted.
819 -- This field with p_version will be used to identify which order
820 -- to cancel.
821 --
822 -- order_version: VARCHAR2
823
824 -- order_status
825 -- Current SFM order status
826 --
827 -- fulfillment_status
828 -- Current value of order parameter "Fulfillemnt Status"
829 --
830 -- fulfillment_result
831 -- Current value of order parameter "Fulfillemnt Result"
832 --
833 -- actual_fulfillment_date
834 -- The date when the fulfillment process was started for this order
835 --
836 -- completion_date
837 -- The date when this order is fulfilled
838 --
839 -- End of comments
840 /*#
841 * Retrieve the fulfillment status of a Service Fulfillment Order. An external order number and version or a known SFM order id must be supplied.
842 * The given order number and version are references specified by the upstream ordering system while submitting a new service order. SFM order id is the
843 * internally assigned order identifier for a service order in SFM.
844 * @param p_api_version API version used to check call compatibility. Current version is '11.5'.
845 * @param p_init_msg_list Flag indicating whether internal message tables should be initialized.
846 * @param p_commit This parameter is optional and is ignored.
847 * @param p_validation_level The level of input validation required from the API.
848 * @param x_return_status Return status of API call.
849 * @param x_msg_count Count of stored processing messages.
850 * @param x_msg_data List of all stored processing messages.
851 * @param x_error_code SFM-specific error code returned in case of errors.
852 * @param p_order_number The external order number reference value.
853 * @param p_order_version The external order version reference value. This parameter is optional and is defaulted to '1'.
854 * @param p_order_id The SFM order id. This value is optional if p_order_number is specified.
855 * @param x_order_status Status information record for the service order.
856 * @paraminfo {@rep:innertype XDP_TYPES.SERVICE_ORDER_STATUS}
857 * @return Processing status record for the service order
858 * @rep:scope public
859 * @rep:lifecycle active
860 * @rep:displayname Get Service Fulfillment Order Status
861 */
862 PROCEDURE Get_Order_Status(
863 p_api_version IN NUMBER,
864 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
865 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
866 p_validation_level IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
867 x_return_status OUT NOCOPY VARCHAR2,
868 x_msg_count OUT NOCOPY NUMBER,
869 x_msg_data OUT NOCOPY VARCHAR2,
870 x_error_code OUT NOCOPY VARCHAR2,
871 p_order_number IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
872 p_order_version IN VARCHAR2 DEFAULT '1',
873 p_order_id IN NUMBER DEFAULT FND_API.G_MISS_NUM,
874 x_order_status OUT NOCOPY XDP_TYPES.SERVICE_ORDER_STATUS
875 );
876
877 END XDP_INTERFACES_PUB;
[Home] [Help]