[Home] [Help]
PACKAGE: APPS.M4U_XML_GENPROCESS_OUT
Source
1 PACKAGE m4u_xml_genprocess_out AUTHID CURRENT_USER AS
2 /* $Header: M4UOUTWS.pls 120.0 2005/05/24 16:20:56 appldev noship $ */
3 /*#
4 * This package contains the private APIs which are invoked by the M4USTD/Generic XML Outbound Workflow
5 * @rep:scope private
6 * @rep:product CLN
7 * @rep:displayname M4U Generic XML Outbound workflow private APIs.
8 * @rep:category BUSINESS_ENTITY EGO_ITEM
9 */
10
11 -- Name
12 -- create_collab_setattr
13 -- Purpose
14 --
15 -- Arguments
16 -- itemtype => WF item type
17 -- itemkey => WF item key
18 -- actid => WF act id
19 -- funcmode => WF func mode
20 -- resultout => result param
21 -- Notes
22 -- creates new SCTC collaboration based on M4USTD WF item-attributes
23 /*#
24 * This procedure creates collaboration based on XMLGateway, CLN parameters with are set as item-attributes of the workflow.
25 * @param itemtype WF activity itemtype parameter
26 * @param itemkey WF activity itemkey parameter
27 * @param actid WF activity actid parameter
28 * @param funcmode WF activity funcmode parameter
29 * @param resultout WF activity resultout parameter
30 * @rep:scope private
31 * @rep:displayname Creates collaboration based on XMLGateway, CLN parameters
32 */
33 PROCEDURE create_collab_setattr(
34 itemtype IN VARCHAR2,
35 itemkey IN VARCHAR2,
36 actid IN NUMBER,
37 funcmode IN VARCHAR2,
38 resultout IN OUT NOCOPY VARCHAR2
39 );
40
41
42 -- Name
43 -- update_collab_setattr
44 -- Purpose
45 --
46 -- Arguments
47 -- itemtype => WF item type
48 -- itemkey => WF item key
49 -- actid => WF act id
50 -- funcmode => WF func mode
51 -- resultout => result param
52 -- Notes
53 -- updates SCTC collaboration based on M4USTD WF item-attributes
54 /*#
55 * This procedure updates the collaboration history for item-batch with the progress made by the workflow or any other errors encountered by the workflow.
56 * @param itemtype WF activity itemtype parameter
57 * @param itemkey WF activity itemkey parameter
58 * @param actid WF activity actid parameter
59 * @param funcmode WF activity funcmode parameter
60 * @param resultout WF activity resultout parameter
61 * @rep:scope private
62 * @rep:displayname Updates collaboration history with progress in workflow.
63 */
64 PROCEDURE update_collab_setattr(
65 itemtype IN VARCHAR2,
66 itemkey IN VARCHAR2,
67 actid IN NUMBER,
68 funcmode IN VARCHAR2,
69 resultout IN OUT NOCOPY VARCHAR2
70 );
71
72
73 -- Name
74 -- create_batchcollab_setattr
75 -- Purpose
76 --
77 -- Arguments
78 -- itemtype => WF item type
79 -- itemkey => WF item key
80 -- actid => WF act id
81 -- funcmode => WF func mode
82 -- resultout => result param
83 -- Notes
84 -- creates multiple SCTC collaboration based on M4USTD WF item-attributes
85 /*#
86 * This procedure creates multiple collaborations for an item batch.
87 * @param itemtype WF activity itemtype parameter
88 * @param itemkey WF activity itemkey parameter
89 * @param actid WF activity actid parameter
90 * @param funcmode WF activity funcmode parameter
91 * @param resultout WF activity resultout parameter
92 * @rep:scope private
93 * @rep:displayname Creates multiple collaborations for an item batch.
94 */
95 PROCEDURE create_batchcollab_setattr(
96 itemtype IN VARCHAR2,
97 itemkey IN VARCHAR2,
98 actid IN NUMBER,
99 funcmode IN VARCHAR2,
100 resultout IN OUT NOCOPY VARCHAR2
101 );
102
103 -- Name
104 -- update_batchcollab_setattr
105 -- Purpose
106 --
107 -- Arguments
108 -- itemtype => WF item type
109 -- itemkey => WF item key
110 -- actid => WF act id
111 -- funcmode => WF func mode
112 -- resultout => result param
113 -- Notes
114 -- updates multiple SCTC collaboration based on M4USTD WF item-attributes
115 /*#
116 * The procedure updates the collaboration history for an item-batch with the progress made by the workflow or any other errors encountered by the workflow.
117 * @param itemtype WF activity itemtype parameter
118 * @param itemkey WF activity itemkey parameter
119 * @param actid WF activity actid parameter
120 * @param funcmode WF activity funcmode parameter
121 * @param resultout WF activity resultout parameter
122 * @rep:scope private
123 * @rep:displayname Updates multiple collaborations for an item-batch with progress in workflow.
124 */
125 PROCEDURE update_batchcollab_setattr(
126 itemtype IN VARCHAR2,
127 itemkey IN VARCHAR2,
128 actid IN NUMBER,
129 funcmode IN VARCHAR2,
130 resultout IN OUT NOCOPY VARCHAR2
131 );
132
133
134 -- Name
135 -- set_aq_correlation
136 -- Purpose
137 -- sets the PROTOCOL_TYPE event attribute in the ECX_EVENT_MESSAGE item attribute
138 -- This is in-turn used to set AQ correlation-id by the queue-handler
139 -- Arguments
140 -- itemtype => WF item type
141 -- itemkey => WF item key
142 -- actid => WF act id
143 -- funcmode => WF func mode
144 -- resultout => result param
145 -- Notes
146 -- none
147 /*#
148 * Sets value of event attribute 'AQ correlation id', of the ECX_EVENT_MESSAGE item-attribute to UCC:HTTP or UCC:AS2
149 * based on the value of the profile M4U_USE_HTTP_ADAPTER. If any errors encountered previously in the workflow, the correlation-id
150 * is set to 'UCC:ERROR'.
151 * @param itemtype Workflow itemtype parameter
152 * @param itemkey Workflow itemkey parameter
153 * @param actid Workflow actid parameter
154 * @param funcmode Workflow funcmode parameter
155 * @param resultout Workflow resultout parameter
156 * @rep:scope private
157 * @rep:displayname Set AQ colleration-id of XML message event.
158 */
159 PROCEDURE set_aq_correlation(
160 itemtype IN VARCHAR2,
161 itemkey IN VARCHAR2,
162 actid IN NUMBER,
163 funcmode IN VARCHAR2,
164 resultout IN OUT NOCOPY VARCHAR2);
165
166
167
168 -- Name
169 -- check_send_method
170 -- Purpose
171 -- returns send_method to be used
172 -- Arguments
173 -- itemtype => WF item type
174 -- itemkey => WF item key
175 -- actid => WF act id
176 -- funcmode => WF func mode
177 -- resultout => result param
178 -- Notes
179 -- None.
180 /*#
181 * This M4USTD/Send XML Payload workflow branches to select the correct adapter to be
182 * used for transporting the XML message to UCCnet registry.
183 * @param itemtype Workflow itemtype parameter
184 * @param itemkey Workflow itemkey parameter
185 * @param actid Workflow actid parameter
186 * @param funcmode Workflow funcmode parameter
187 * @param resultout Workflow resultout parameter, possible values are UCC:HTTP, UCC:AS2, UCC:ERROR
188 * @rep:scope private
189 * @rep:displayname Check send method.
190 */
191 PROCEDURE check_send_method(
192 itemtype IN VARCHAR2,
193 itemkey IN VARCHAR2,
194 actid IN NUMBER,
195 funcmode IN VARCHAR2,
196 resultout IN OUT NOCOPY VARCHAR2) ;
197
198
199
200 -- Name
201 -- dequeue_ucc_message
202 -- Purpose
203 -- dequeues payload from AQ when correlation is UCC:ERROR|UCC:HTTP
204 -- Arguments
205 -- itemtype => WF item type
206 -- itemkey => WF item key
207 -- actid => WF act id
208 -- funcmode => WF func mode
209 -- resultout => result param
210 -- Notes
211 -- Need to make a modification to set QueueName to be used in dequeue
212 /*#
213 * Dequeues the generated XML messages from the ECX outqueue, when the UCCnet HTTP Adapter
214 * is used for transporting the XML message payload to UCCnet.
215 * @param itemtype Workflow itemtype parameter
216 * @param itemkey Workflow itemkey parameter
217 * @param actid Workflow actid parameter
218 * @param funcmode Workflow funcmode parameter
219 * @param resultout Workflow resultout parameter
220 * @rep:scope private
221 * @rep:displayname Dequeue UCCnet XML message from ECX AQ.
222 */
223 PROCEDURE dequeue_ucc_message(
224 itemtype IN VARCHAR2,
225 itemkey IN VARCHAR2,
226 actid IN NUMBER,
227 funcmode IN VARCHAR2,
228 resultout IN OUT NOCOPY VARCHAR2);
229
230
231 -- Name
232 -- raise_payload_event
233 -- Purpose
234 -- Code workaround since raiseEvent is not propogating the event payload to
235 -- JAVA Business Event Subscriptions
236 -- Arguments
237 -- itemtype => WF item type
238 -- itemkey => WF item key
239 -- actid => WF act id
240 -- funcmode => WF func mode
241 -- resultout => result param
242 -- Notes
243 -- None.
244 /*#
245 * Raises a business event, whose name is supplied as an activity-attribute
246 * with the generated XML message as event data.
247 * @param itemtype Workflow itemtype parameter
248 * @param itemkey Workflow itemkey parameter
249 * @param actid Workflow actid parameter
250 * @param funcmode Workflow funcmode parameter
251 * @param resultout Workflow resultout parameter
252 * @rep:scope private
253 * @rep:displayname Raise business event with XML payaload.
254 */
255 PROCEDURE raise_payload_event(
256 itemtype IN VARCHAR2,
257 itemkey IN VARCHAR2,
258 actid IN NUMBER,
259 funcmode IN VARCHAR2,
260 resultout IN OUT NOCOPY VARCHAR2);
261
262
263 END m4u_xml_genprocess_out;