1 package EDR_TRANS_ACKN_PUB AUTHID CURRENT_USER as
2 /* $Header: EDRPACKS.pls 120.0.12000000.1 2007/01/18 05:54:19 appldev ship $ */
3 /*#
4 * This API is used to sends appropriate acknowledgement to evidence store
5 * for an e-record based on the status of the business transaction.
6 * You can call this API multiple times for a given e-record to acknowledge
7 * @rep:scope public
8 * @rep:metalink 268669.1 Oracle E-Records API User's Guide
9 * @rep:product EDR
10 * @rep:displayname E-records Evidence Store APIs
11 * @rep:lifecycle active
12 * @rep:category BUSINESS_ENTITY EDR_EVIDENCE_STORE
13 */
14
15 /* Global Constants */
16 G_PKG_NAME CONSTANT varchar2(30) := 'EDR_TRANS_ACKN_PUB';
17
18 -- Start of comments
19 -- API name : SEND_ACKN
20 -- Type : Public
21 -- Function : Creates an acknowledgement for an erecord in the
22 -- evidence store. This acknowledgement would say whether
23 -- the business transaction for which the erecord was
24 -- created, completed successfully or not.
25 -- Pre-reqs : The ERES event should have been raised and its erecord
26 -- id obtained before this api can be called
27 -- Parameters :
28 -- IN : p_api_version IN NUMBER Required
29 -- p_init_msg_list IN VARCHAR2 Optional
30 -- Default = FND_API.G_FALSE
31 -- p_autonomous_commit IN VARCHAR2 Optional
32 -- Default = FND_API.G_FALSE
33 -- This tells the API to commit its changes autonomously
34 -- or not. This flag is different from the p_coomit flag
35 -- in standard APIs. It would do only autonomous commit
36 -- in the case this flag's value = Y
37 -- p_event_name IN VARCHAR2(80) Required
38 -- The event name for which acknowledgement is sent
39 -- p_event_name IN VARCHAR2(240) Required
40 -- The event key for which acknowledgement is sent
41 -- p_erecord_id IN NUMBER Required
42 -- The erecord id for which ackn is being sent
43 -- p_trans_status IN VARCHAR2(30) Required
44 -- The status of the transaction for which ack is
45 -- being created. There is a limited set of possible
46 -- values: SUCCESS, ERROR.
47 -- p_ackn_by IN VARCHAR2(200) Optional
48 -- Default NULL
49 -- The source of the acknowledgement e.g a pgm name
50 -- p_ackn_note IN VARCHAR2(2000) Optional
51 -- Default NULL
52 -- Additional information/comments about the ackn
53 --
54 -- OUT : x_return_status OUT VARCHAR2
55 -- x_msg_count OUT NUMBER
56 -- x_msg_data OUT VARCHAR2
57 --
58 -- Version : Current version 1.0
59 -- Initial version 1.0
60 --
61 -- Notes : Typically the product teams would follow this sequence
62 -- in the case of a single ERES event.
63 -- 1. raise the event
64 -- 2. get the status back
65 -- 3. get the erecord id back
66 -- 4. if the status <> ERROR either commit or rollback the
67 -- business txn based on whether is approved or
68 -- rejected
69 -- 5. send out an ack status of SUCCESS
70 -- 6. if status = ERROR in step 3 above send out ack status
71 -- of ERROR
72 --
73 -- End of comments
74 /*#
75 * This API sends appropriate acknowledgement for an e-record based on the status of the
76 * business transaction.
77 * @rep:scope public
78 * @rep:lifecycle active
79 * @rep:displayname E-record acknowledgement
80 */
81
82 procedure SEND_ACKN
83 ( p_api_version IN NUMBER ,
84 p_init_msg_list IN VARCHAR2 default NULL ,
85 x_return_status OUT NOCOPY VARCHAR2 ,
86 x_msg_count OUT NOCOPY NUMBER ,
87 x_msg_data OUT NOCOPY VARCHAR2 ,
88 p_event_name IN VARCHAR2 ,
89 p_event_key IN VARCHAR2 ,
90 p_erecord_id IN NUMBER ,
91 p_trans_status IN VARCHAR2 ,
92 p_ackn_by IN VARCHAR2 default NULL ,
93 p_ackn_note IN VARCHAR2 default NULL ,
94 p_autonomous_commit IN VARCHAR2 default NULL
95 );
96
97 end EDR_TRANS_ACKN_PUB;
[Home] [Help]