1 PACKAGE GCS_CONS_ENG_UTILITY_PKG as
2 /* $Header: gcs_eng_utils.pls 120.5 2007/08/31 16:30:44 hakumar noship $ */
3
4 TYPE r_cons_entity_wf_info IS RECORD
5 (consolidation_hierarchy NUMBER(15),
6 consolidation_entity NUMBER(15),
7 run_identifier VARCHAR2(80),
8 cal_period_id NUMBER,
9 cal_period_end_date DATE,
10 balance_type_code VARCHAR2(30),
11 run_detail_id NUMBER(15),
12 process_method VARCHAR2(30),
13 num_of_categories NUMBER(15),
14 curr_category_num NUMBER(15),
15 cons_relationship_id NUMBER(15),
16 prior_run_identifier VARCHAR2(80),
17 xlate_entry_id NUMBER(15),
18 request_id NUMBER(15),
19 --Bugfix 5017120: Added support for data types
20 source_dataset_code NUMBER,
21 hierarchy_dataset_code NUMBER,
22 -- Bugfix 5569522: Added for business process kick-off support
23 analysis_cycle_id NUMBER);
24
25
26
27 TYPE r_oper_entity_wf_info IS RECORD
28 (parent_workflow_key VARCHAR2(400),
29 operating_entity NUMBER(15),
30 cons_relationship_id NUMBER(15),
31 run_detail_id NUMBER(15),
32 translation_required VARCHAR2(1),
33 xlate_entry_id NUMBER(15));
34
35
36 TYPE r_module_parameters IS RECORD
37 (errbuf VARCHAR2(2000),
38 retcode VARCHAR2(2000),
39 cal_period_id NUMBER,
40 run_name VARCHAR2(240),
41 category_code VARCHAR2(30),
42 hierarchy_id NUMBER(15),
43 balance_type_code VARCHAR2(30),
44 entry_id NUMBER(15),
45 xlate_entry_id NUMBER(15),
46 xlate_mode VARCHAR2(30),
47 run_detail_id NUMBER(15),
48 cons_entity_id NUMBER(15),
49 child_entity_id NUMBER(15),
50 cons_relationship_id NUMBER(15),
51 period_end_date DATE,
52 stat_required VARCHAR2(1),
53 bp_undo_prior VARCHAR2(1),
54 intercompany_mode VARCHAR2(2),
55 bp_post_xlate VARCHAR2(1),
56 elim_rule_id NUMBER(15),
57 rp_parameters gcs_rules_processor.contextRecord,
58 rp_rule_data gcs_rules_processor.ruleDataRecord,
59 currency_code VARCHAR2(30),
60 bp_mode VARCHAR2(1),
61 -- Bugfix 3818829 : Added Two additional modules parameters
62 undo_entity_type VARCHAR2(30),
63 undo_entity_id NUMBER(15),
64 -- Bugfix 5017120 : Added Support for data types
65 source_dataset_code NUMBER,
66 hierarchy_dataset_code NUMBER);
67
68 --
69 -- Procedure
70 -- execute_module()
71 -- Purpose
72 -- Wrapper around the individual engines to execute them in autonomous transactions
73 -- Arguments
74 -- module_code VARCHAR2 (i.e. DATAPREPARATION, INTERCOMPANY, etc)
75 -- p_parameter_list Parameters required for the module
76 -- p_item_key Item Key of the Workflow Process
77 -- Notes
78 --
79 PROCEDURE execute_module (module_code IN VARCHAR2,
80 p_parameter_list IN OUT NOCOPY gcs_cons_eng_utility_pkg.r_module_parameters,
81 p_item_key IN VARCHAR2);
82
83 --
84 -- Procedure
85 -- get_cons_entity_wf_info()
86 -- Purpose
87 -- Retrieves all the item type attributes for a Consolidation Entity Process
88 -- Arguments
89 -- item_type type of the current item
90 -- item_key key of the current item
91 -- cons_entity_wf_info Record of Item Type Attributes
92 -- Notes
93 --
94 PROCEDURE get_cons_entity_wf_info (itemtype IN VARCHAR2,
95 itemkey IN VARCHAR2,
96 cons_entity_wf_info IN OUT NOCOPY r_cons_entity_wf_info);
97
98 --
99 -- Procedure
100 -- get_oper_entity_wf_info()
101 -- Purpose
102 -- Retrieves all the item type attributes for an Operating Entity Process
103 -- Arguments
104 -- item_type type of the current item
105 -- item_key key of the current item
106 -- cons_entity_wf_info Record of Consolidation Entity Level Attributes
107 -- oper_entity_wf_info Record of Operating Entity Level Attributes
108 -- Notes
109 --
110 PROCEDURE get_oper_entity_wf_info (itemtype IN VARCHAR2,
111 itemkey IN VARCHAR2,
112 cons_entity_wf_info IN OUT NOCOPY r_cons_entity_wf_info,
113 oper_entity_wf_info IN OUT NOCOPY r_oper_entity_wf_info);
114
115 --
116 -- Procedure
117 -- balances_processor()
118 -- Purpose
119 -- Executes the balances processor
120 -- Arguments
121 -- item_type type of the current item
122 -- item_key key of the current item
123 -- actid process activity instance id
124 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
125 -- result
126 -- COMPLETE[]
127 -- Notes
128 --
129
130 PROCEDURE balances_processor ( itemtype IN VARCHAR2,
131 itemkey IN VARCHAR2,
132 actid IN NUMBER,
133 funcmode IN varchar2,
134 result IN OUT NOCOPY varchar2);
135
136 --
137 -- Procedure
138 -- check_adj_required()
139 -- Purpose
140 -- Check if any adjustment categories exist, or if an adjustment is required
141 -- Arguments
142 -- item_type type of the current item
143 -- item_key key of the current item
144 -- actid process activity instance id
145 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
146 -- result
147 -- COMPLETE[:T or :F]
148 -- Notes
149 --
150 PROCEDURE check_adj_required ( itemtype IN VARCHAR2,
151 itemkey IN VARCHAR2,
152 actid IN NUMBER,
153 funcmode IN varchar2,
154 result IN OUT NOCOPY varchar2);
155
156 --
157 -- Procedure
158 -- extract_manual_adj()
159 -- Purpose
160 -- Extract Manual Adjustments to be Applied
161 -- Arguments
162 -- item_type type of the current item
163 -- item_key key of the current item
164 -- actid process activity instance id
165 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
166 -- result
167 -- COMPLETE[]
168 -- Notes
169 --
170 PROCEDURE extract_manual_adj( itemtype IN VARCHAR2,
171 itemkey IN VARCHAR2,
172 actid IN NUMBER,
173 funcmode IN varchar2,
174 result IN OUT NOCOPY varchar2);
175
176 --
177 -- Procedure
178 -- check_translation_required()
179 -- Purpose
180 -- Check if Translation is Required
181 -- Arguments
182 -- item_type type of the current item
183 -- item_key key of the current item
184 -- actid process activity instance id
185 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
186 -- result
187 -- COMPLETE[:T or :F]
188 -- Notes
189 --
190 PROCEDURE check_translation_required( itemtype IN VARCHAR2,
191 itemkey IN VARCHAR2,
192 actid IN NUMBER,
193 funcmode IN varchar2,
194 result IN OUT NOCOPY varchar2);
195 --
196 -- Procedure
197 -- update_process_status()
198 -- Purpose
199 -- Update the process status based on dependencies
200 -- Arguments
201 -- item_type type of the current item
202 -- item_key key of the current item
203 -- actid process activity instance id
204 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
205 -- result
206 -- COMPLETE[]
207 -- Notes
208 --
209 PROCEDURE update_process_status( itemtype IN VARCHAR2,
210 itemkey IN VARCHAR2,
211 actid IN NUMBER,
212 funcmode IN varchar2,
213 result IN OUT NOCOPY varchar2);
214
215 --
216 -- Procedure
217 -- execute_translation()
218 -- Purpose
219 -- Wrapper around the Translation Engine
220 -- Arguments
221 -- item_type type of the current item
222 -- item_key key of the current item
223 -- actid process activity instance id
224 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
225 -- result
226 -- COMPLETE[]
227 -- Notes
228 --
229
230 PROCEDURE execute_translation( itemtype IN VARCHAR2,
231 itemkey IN VARCHAR2,
232 actid IN NUMBER,
233 funcmode IN varchar2,
234 result IN OUT NOCOPY varchar2);
235
236 --
237 -- Procedure
238 -- eliminations_processor()
239 -- Purpose
240 -- Wrapper around the rules processor / intercompany engine
241 -- Arguments
242 -- item_type type of the current item
243 -- item_key key of the current item
244 -- actid process activity instance id
245 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
246 -- result
247 -- COMPLETE[]
248 -- Notes
249 --
250
251 PROCEDURE eliminations_processor( itemtype IN VARCHAR2,
252 itemkey IN VARCHAR2,
253 actid IN NUMBER,
254 funcmode IN varchar2,
255 result IN OUT NOCOPY varchar2);
256
257 --
258 -- Procedure
259 -- category_exists()
260 -- Purpose
261 -- Checks if additional categories exist
262 -- Arguments
263 -- item_type type of the current item
264 -- item_key key of the current item
265 -- actid process activity instance id
266 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
267 -- result
268 -- COMPLETE[:F or :T]
269 -- Notes
270 --
271
272 PROCEDURE category_exists( itemtype IN VARCHAR2,
273 itemkey IN VARCHAR2,
274 actid IN NUMBER,
275 funcmode IN varchar2,
276 result IN OUT NOCOPY varchar2);
277
278 --
279 -- Procedure
280 -- check_max_category()
281 -- Purpose
282 -- Checks if the max category has been reached
283 -- Arguments
284 -- item_type type of the current item
285 -- item_key key of the current item
286 -- actid process activity instance id
287 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
288 -- result
289 -- COMPLETE[:T or :F]
290 -- Notes
291 --
292 PROCEDURE check_max_category( itemtype IN VARCHAR2,
293 itemkey IN VARCHAR2,
294 actid IN NUMBER,
295 funcmode IN varchar2,
296 result IN OUT NOCOPY varchar2);
297
298 --
299 -- Procedure
300 -- create_initializing_journal()
301 -- Purpose
302 -- Creates the initializing journal
303 -- Arguments
304 -- item_type type of the current item
305 -- item_key key of the current item
306 -- actid process activity instance id
307 -- funcmode function execution mode ('RUN', 'CANCEL', 'TIMEOUT')
308 -- result
309 -- COMPLETE[]
310 -- Notes
311 --
312 PROCEDURE create_initializing_journal( itemtype IN VARCHAR2,
313 itemkey IN VARCHAR2,
317 --
314 actid IN NUMBER,
315 funcmode IN varchar2,
316 result IN OUT NOCOPY varchar2);
318 -- Procedure
319 -- submit_xml_ntf_program
320 -- Purpose
321 -- Submits the XML and Notification Concurrent Program Utility
322 -- Arguments
323 -- p_run_name Process Identifier
324 -- p_cons_entity_id Consolidation Entity
325 -- p_category_code Category Code
326 -- p_child_entity_id Child Entity
327 -- p_run_detail_id Run Detail
328
329 PROCEDURE submit_xml_ntf_program(p_run_name IN VARCHAR2,
330 p_cons_entity_id IN NUMBER,
331 p_category_code IN VARCHAR2,
332 p_child_entity_id IN NUMBER DEFAULT NULL,
333 p_run_detail_id IN NUMBER DEFAULT NULL);
334
335
336 END GCS_CONS_ENG_UTILITY_PKG;
337
[Home] [Help]