[Home] [Help]
PACKAGE: APPS.BSC_BIS_WRAPPER_PVT
Source
1 PACKAGE BSC_BIS_WRAPPER_PVT AS
2 /* $Header: BSCVBISS.pls 120.0 2005/06/01 17:11:21 appldev noship $ */
3
4 /************************************************************************************
5 ************************************************************************************/
6
7 FUNCTION is_measure_dbi(
8 l_measure_shortname IN VARCHAR2
9 ) RETURN BOOLEAN;
10
11 /************************************************************************************
12 ************************************************************************************/
13
14 FUNCTION Get_Actual_Value(
15 p_kpi_code IN NUMBER,
16 p_analysis_option0 IN NUMBER,
17 p_analysis_option1 IN NUMBER,
18 p_analysis_option2 IN NUMBER,
19 p_series_id IN NUMBER,
20 p_user_id IN VARCHAR2,
21 p_responsibility_id IN VARCHAR2
22 ) RETURN VARCHAR2;
23 PRAGMA RESTRICT_REFERENCES(Get_Actual_Value, WNDS);
24
25 /************************************************************************************
26 ************************************************************************************/
27
28 PROCEDURE Get_Actual_Value_From_PMV(
29 p_kpi_info_rec IN BSC_BIS_WRAPPER_PUB.Kpi_Info_Rec_Type,
30 p_user_id IN VARCHAR2,
31 p_responsibility_id IN VARCHAR2,
32 p_dimension_levels IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Tbl_Type,
33 p_time_level_from IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type,
34 p_time_level_to IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type,
35 p_time_comparison_type IN VARCHAR2,
36 p_viewby_level IN VARCHAR2,
37 x_actual_value OUT NOCOPY VARCHAR2,
38 x_compareto_value OUT NOCOPY VARCHAR2,
39 x_return_status OUT NOCOPY VARCHAR2,
40 x_msg_count OUT NOCOPY NUMBER,
41 x_msg_data OUT NOCOPY VARCHAR2
42 );
43
44 /************************************************************************************
45 ***********************************************************************************/
46
47 PROCEDURE Get_AO_Defaults(
48 p_kpi_code IN NUMBER,
49 x_analysis_option0 OUT NOCOPY NUMBER,
50 x_analysis_option1 OUT NOCOPY NUMBER,
51 x_analysis_option2 OUT NOCOPY NUMBER,
52 x_series_id OUT NOCOPY NUMBER
53 );
54 PRAGMA RESTRICT_REFERENCES(Get_AO_Defaults, WNDS);
55
56 /************************************************************************************
57 ************************************************************************************/
58
59 FUNCTION Get_Current_Period(
60 p_kpi_code IN NUMBER,
61 p_analysis_option0 IN NUMBER,
62 p_analysis_option1 IN NUMBER,
63 p_analysis_option2 IN NUMBER,
64 p_series_id IN NUMBER
65 ) RETURN VARCHAR2;
66
67 /************************************************************************************
68 ************************************************************************************/
69
70 PROCEDURE Get_DataSet_Id (
71 p_kpi_code IN NUMBER,
72 p_analysis_option0 IN NUMBER,
73 p_analysis_option1 IN NUMBER,
74 p_analysis_option2 IN NUMBER,
75 p_series_id IN NUMBER,
76 x_dataset_id OUT NOCOPY NUMBER
77 );
78
79 /************************************************************************************
80 ************************************************************************************/
81
82 PROCEDURE Get_DataSet_Info (
83 p_dataset_id IN NUMBER,
84 x_source OUT NOCOPY VARCHAR2,
85 x_measure_id1 OUT NOCOPY NUMBER,
86 x_operation OUT NOCOPY VARCHAR2,
87 x_measure_id2 OUT NOCOPY NUMBER,
88 x_color_method OUT NOCOPY NUMBER,
89 x_measure_col1 OUT NOCOPY VARCHAR2,
90 x_measure_operation1 OUT NOCOPY VARCHAR2,
91 x_measure_short_name OUT NOCOPY VARCHAR2,
92 x_measure_col2 OUT NOCOPY VARCHAR2,
93 x_measure_operation2 OUT NOCOPY VARCHAR2,
94 x_format_id OUT NOCOPY NUMBER
95 );
96
97 /************************************************************************************
98 ************************************************************************************/
99
100 FUNCTION Get_DBI_Current_Period(
101 p_time_dimension_level IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type,
102 p_as_of_date IN VARCHAR2
103
104 ) RETURN VARCHAR2;
105
106 /************************************************************************************
107 ************************************************************************************/
108
109
110 FUNCTION Get_Dimension_Short_Name(
111 p_dimension_id IN NUMBER
112 ) RETURN VARCHAR2;
113
114 /************************************************************************************
115 ************************************************************************************/
116
117 PROCEDURE Get_DimensionSet_Id (
118 p_kpi_code IN NUMBER,
119 p_analysis_option0 IN NUMBER,
120 p_analysis_option1 IN NUMBER,
121 p_analysis_option2 IN NUMBER,
122 p_series_id IN NUMBER,
123 x_dimset_id OUT NOCOPY NUMBER
124 );
125
126 /************************************************************************************
127 ************************************************************************************/
128
129 PROCEDURE Get_Period_Info(
130 p_time_dim_level_short_name IN VARCHAR2,
131 p_source IN VARCHAR2,
132 p_org_dim_level_short_name IN VARCHAR2,
133 p_org_dim_level_value_id IN VARCHAR2,
134 p_period_date IN DATE DEFAULT SYSDATE,
135 x_period_id OUT NOCOPY VARCHAR2,
136 x_period_name OUT NOCOPY VARCHAR2,
137 x_return_status OUT NOCOPY VARCHAR2,
138 x_msg_count OUT NOCOPY NUMBER,
139 x_msg_data OUT NOCOPY VARCHAR2
140 );
141
142 /************************************************************************************
143 ************************************************************************************/
144
145 PROCEDURE Get_Kpi_Info(
146 p_kpi_code IN NUMBER,
147 p_analysis_option0 IN NUMBER,
148 p_analysis_option1 IN NUMBER,
149 p_analysis_option2 IN NUMBER,
150 p_series_id IN NUMBER,
151 x_kpi_info_rec OUT NOCOPY BSC_BIS_WRAPPER_PUB.Kpi_Info_Rec_Type
152 );
153
154 /************************************************************************************
155 ************************************************************************************/
156
157 PROCEDURE Get_Pmf_Measure_Info (
158 p_Measure_ShortName IN VARCHAR2,
159 x_measure_id OUT NOCOPY NUMBER,
160 x_function_name OUT NOCOPY VARCHAR2,
161 x_region_code OUT NOCOPY VARCHAR2,
162 x_attribute_code OUT NOCOPY VARCHAR2,
163 x_compareto_attribute_code OUT NOCOPY VARCHAR2,
164 x_dimension1_short_name OUT NOCOPY VARCHAR2,
165 x_dimension2_short_name OUT NOCOPY VARCHAR2,
166 x_dimension3_short_name OUT NOCOPY VARCHAR2,
167 x_dimension4_short_name OUT NOCOPY VARCHAR2,
168 x_dimension5_short_name OUT NOCOPY VARCHAR2,
169 x_dimension6_short_name OUT NOCOPY VARCHAR2,
170 x_dimension7_short_name OUT NOCOPY VARCHAR2
171 );
172
173 /************************************************************************************
174 ************************************************************************************/
175
176 FUNCTION Get_Target_Value(
177 p_kpi_code IN NUMBER,
178 p_analysis_option0 IN NUMBER,
179 p_analysis_option1 IN NUMBER,
180 p_analysis_option2 IN NUMBER,
181 p_series_id IN NUMBER,
182 p_user_id IN VARCHAR2,
183 p_responsibility_id IN VARCHAR2
184 ) RETURN VARCHAR2;
185 PRAGMA RESTRICT_REFERENCES(Get_Target_Value, WNDS);
186
187 /************************************************************************************
188 ************************************************************************************/
189
190 PROCEDURE Get_Target_Value_From_PMF(
191 p_kpi_info_rec IN BSC_BIS_WRAPPER_PUB.Kpi_Info_Rec_Type,
192 p_user_id IN VARCHAR2,
193 p_responsibility_id IN VARCHAR2,
194 p_dimension_levels IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Tbl_Type,
195 p_time_level IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type,
196 x_target_value OUT NOCOPY VARCHAR2,
197 x_return_status OUT NOCOPY VARCHAR2,
198 x_msg_count OUT NOCOPY NUMBER,
199 x_msg_data OUT NOCOPY VARCHAR2
200 );
201
202 /************************************************************************************
203 ************************************************************************************/
204
205 PROCEDURE Get_Total_DimLevel_Info(
206 p_dimension_short_name IN VARCHAR2,
207 x_total_dimlevel_short_name OUT NOCOPY VARCHAR2,
208 x_total_dimlevel_value_id OUT NOCOPY NUMBER,
209 x_total_dimlevel_value_name OUT NOCOPY VARCHAR2
210 );
211
212 /************************************************************************************
213 ************************************************************************************/
214
215 FUNCTION Get_Dimension_Level_Index(
216 p_dimension_short_name IN VARCHAR2
217 ,p_dimension_levels IN BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Tbl_Type
218 ) RETURN NUMBER;
219
220 /************************************************************************************
221 ************************************************************************************/
222
223 PROCEDURE Get_Default_Time_Level(
224 p_kpi_code IN NUMBER
225 ,p_dimset_id IN NUMBER
226 ,x_time_dimension_level OUT NOCOPY BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type
227 );
228
229 /************************************************************************************
230 ************************************************************************************/
231
232 PROCEDURE Get_Default_Dimension_Levels(
233 p_kpi_code IN NUMBER,
234 p_dimset_id IN NUMBER,
235 p_page_parameters IN BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type,
236 x_default_dimension_levels OUT NOCOPY BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Tbl_Type,
237 x_default_time_level_from OUT NOCOPY BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type,
238 x_default_time_level_to OUT NOCOPY BSC_BIS_WRAPPER_PUB.Dim_level_Rec_Type
239 );
240
241 /************************************************************************************
242 ************************************************************************************/
243
244 FUNCTION Is_Time_Dimension(
245 p_dimension_short_name IN VARCHAR2
246 ) RETURN BOOLEAN;
247
248 /************************************************************************************
249 ************************************************************************************/
250
251 PROCEDURE Populate_Measure_Data(
252 p_tab_id IN NUMBER,
253 p_page_id IN VARCHAR2,
254 p_user_id IN VARCHAR2,
255 p_responsibility_id IN VARCHAR2,
256 p_caching_key IN VARCHAR2,
257 x_return_status OUT NOCOPY VARCHAR2,
258 x_msg_count OUT NOCOPY NUMBER,
259 x_msg_data OUT NOCOPY VARCHAR2
260 );
261
262 /************************************************************************************
263 ************************************************************************************/
264
265 PROCEDURE Populate_Measure_Data(
266 p_user_id IN VARCHAR2,
267 p_responsibility_id IN VARCHAR2,
268 p_caching_key IN VARCHAR2,
269 p_kpi_code IN NUMBER,
270 p_analysis_option0 IN NUMBER,
271 p_analysis_option1 IN NUMBER,
272 p_analysis_option2 IN NUMBER,
273 p_series_id IN NUMBER,
274 p_actual_value IN VARCHAR2,
275 p_target_value IN VARCHAR2,
276 x_return_status OUT NOCOPY VARCHAR2,
277 x_msg_count OUT NOCOPY NUMBER,
278 x_msg_data OUT NOCOPY VARCHAR2
279 );
280
281 /************************************************************************************
282 ************************************************************************************/
283
284 PROCEDURE Get_Page_Parameters(
285 p_user_id IN VARCHAR2,
286 p_page_id IN VARCHAR2,
287 x_page_parameters OUT NOCOPY BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type,
288 x_return_status OUT NOCOPY VARCHAR2,
289 x_msg_count OUT NOCOPY NUMBER,
290 x_msg_data OUT NOCOPY VARCHAR2
291 );
292
293 /************************************************************************************
294 ************************************************************************************/
295
296 PROCEDURE Get_Page_Parameter(
297 p_page_parameters IN BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type,
298 p_page_parameter_name IN VARCHAR2,
299 x_page_parameter OUT NOCOPY BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Type
300 );
301
302 /************************************************************************************
303 ************************************************************************************/
304
305 FUNCTION Get_Time_Comparison_Parameter(
306 p_page_parameters IN BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type
307 ) RETURN VARCHAR2;
308
309 /************************************************************************************
310 ************************************************************************************/
311
312 PROCEDURE Get_Kpis_Data_From_PMF_PMV(
313 p_user_id IN VARCHAR2,
314 p_responsibility_id IN VARCHAR2,
315 p_page_parameters IN BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type,
316 p_page_id IN VARCHAR2,
317 p_kpi_info_tbl IN OUT NOCOPY BSC_BIS_WRAPPER_PUB.Kpi_Info_Rec_Tbl_Type,
318 x_return_status OUT NOCOPY VARCHAR2,
319 x_msg_count OUT NOCOPY NUMBER,
320 x_msg_data OUT NOCOPY VARCHAR2
321 );
322
323 /************************************************************************************
324 ************************************************************************************/
328 p_dimset_id IN VARCHAR2,
325
326 PROCEDURE Get_Kpi_view_by(
327 p_kpi_code IN NUMBER,
329 p_page_parameters IN BSC_BIS_WRAPPER_PUB.Page_Parameter_Rec_Tbl_Type,
330 x_viewby_level OUT NOCOPY VARCHAR2,
331 x_return_status OUT NOCOPY VARCHAR2,
332 x_msg_count OUT NOCOPY NUMBER,
333 x_msg_data OUT NOCOPY VARCHAR2
334 );
335
336 /************************************************************************************
337 ************************************************************************************/
338
339 PROCEDURE get_bsc_format_id(
340 p_measure_shortname IN VARCHAR2
341 ,x_bsc_format_id OUT NOCOPY NUMBER
342 );
343
344 /************************************************************************************
345 ************************************************************************************/
346
347 PROCEDURE get_bsc_format_id(
348 p_display_type IN VARCHAR2
349 ,p_display_format IN VARCHAR2
350 ,x_bsc_format_id OUT NOCOPY NUMBER
351 );
352
353 /************************************************************************************
354 ************************************************************************************/
355
356 FUNCTION get_num_decimal_places(
357 p_display_format IN VARCHAR2
358 ) RETURN NUMBER;
359
360 /************************************************************************************
361 ***********************************************************************************/
362
363 FUNCTION Item_Belong_To_Array_Varchar2(
364 p_item IN VARCHAR2,
365 p_array IN BSC_BIS_WRAPPER_PUB.t_array_of_varchar2,
366 p_num_items IN NUMBER
367 ) RETURN BOOLEAN;
368
369 /************************************************************************************
370 ***********************************************************************************/
371
372 END BSC_BIS_WRAPPER_PVT;