DBA Data[Home] [Help]

PACKAGE: APPS.BSC_ANALYSIS_OPTION_PUB

Source


1 package BSC_ANALYSIS_OPTION_PUB as
2 /* $Header: BSCPANOS.pls 120.2 2007/02/08 13:59:31 akoduri ship $ */
3 /*
4  +======================================================================================+
5  |    Copyright (c) 2001 Oracle Corporation, Redwood Shores, CA, USA                    |
6  |                         All rights reserved.                                         |
7  +======================================================================================+
8  | FILENAME                                                                             |
9  |                      BSCPANOS.pls                                                    |
10  |                                                                                      |
11  | Creation Date:                                                                       |
12  |                      October 10, 2001                                                |
13  |                                                                                      |
14  | Creator:                                                                             |
15  |                      Mario-Jair Campos                                               |
16  |                                                                                      |
17  | Description:                                                                         |
18  |                      Public Specs version.                                           |
19  |      This package creates a BSC Analysis Option.                                     |
20  |                                                                                      |
21  |      14-JUN-2004   ADRAO   Modified Records Bsc_Option_Rec_Type and                  |
22  |                            Bsc_Analysis_Option_Rec to include Short_Name for AO      |
23  |                            Enhancement#3540302                                       |
24  |      02-jul-2004   rpenneru Modified for Enhancement#3532517                         |
25  |      22-AUG-2005   ashankar Bug#4220400 added the constants                          |
26  |                             c_ANALYSIS_GROUP0                                        |
27  |                             c_ANALYSIS_GROUP1                                        |
28  |                             c_ANALYSIS_GROUP2                                        |
29  |                             c_ANAL_SERIES_ENABLED                                    |
30  |                             c_ANAL_SERIES_DISABLED                                   |
31  |                    added the following APIS                                          |
32  |                    1.Set_Default_Analysis_Option                                     |
33  |                    2.Default_Anal_Option_Changed                                     |
34  |                    3.Get_Analysis_Group_Id                                           |
35  |                    4.Get_Num_Analysis_options                                        |
36  |      31-Jan-2007   akoduri   Enh #5679096 Migration of multibar functionality from   |
37  |                              VB to Html                                              |
38  +======================================================================================+
39 */
40 
41 C_BSC_UNDERSCORE               CONSTANT VARCHAR2(5) := 'BSC_';
42 c_ANALYSIS_GROUP0              CONSTANT NUMBER      := 0;
43 c_ANALYSIS_GROUP1              CONSTANT NUMBER      := 1;
44 c_ANALYSIS_GROUP2              CONSTANT NUMBER      := 2;
45 c_ANAL_SERIES_ENABLED          CONSTANT NUMBER      := 1;
46 c_ANAL_SERIES_DISABLED         CONSTANT NUMBER      := 0;
47 
48 
49 
50 Type Anal_Opt_Comb_Num_Tbl_Type IS TABLE OF NUMBER INDEX BY BINARY_INTEGER;
51 
52 /* RECORD Type for Data Sets.*/
53 
54 TYPE Bsc_Option_Rec_Type is RECORD(
55   Bsc_Analysis_Group_Id         number
56  ,Bsc_Analysis_Option_Id        number
57  ,Bsc_Dataset_Axis              number
58  ,Bsc_Dataset_Bm_Color          number
59  ,Bsc_Dataset_Bm_Flag           number
60  ,Bsc_Dataset_Budget_Flag       number
61  ,Bsc_Dataset_Default_Value     number
62  ,Bsc_Dataset_Help              BSC_SYS_DATASETS_TL.Help%TYPE
63  ,Bsc_Dataset_Id                number
64  ,Bsc_Dataset_Name              BSC_SYS_DATASETS_TL.Name%TYPE
65  ,Bsc_Dataset_Series_Color      number
66  ,Bsc_Dataset_Series_Id         number
67  ,Bsc_Dataset_New_Series_Id     number
68  ,Bsc_Dataset_Series_Type       number
69  ,Bsc_Dataset_Stack_Series_Id   number
70  ,Bsc_Dim_Set_Id                number
71  ,Bsc_Grandparent_Option_Id     number
72  ,Bsc_Kpi_Id                    number
73  ,Bsc_Language                  varchar2(5)
74  ,Bsc_Measure_Help              BSC_KPI_ANALYSIS_MEASURES_TL.Help%TYPE
75  ,Bsc_Measure_Long_Name         BSC_KPI_ANALYSIS_MEASURES_TL.Name%TYPE
76  ,Bsc_Measure_Prototype_Flag    number
77  ,Bsc_New_Kpi                   varchar2(1)
78  ,Bsc_Option_Group0             number
79  ,Bsc_Option_Group1             number
80  ,Bsc_Option_Group2             number
81  ,Bsc_Option_Help               BSC_KPI_ANALYSIS_OPTIONS_TL.Help%TYPE
82  ,Bsc_Option_Name               BSC_KPI_ANALYSIS_OPTIONS_TL.Name%TYPE
83  ,Bsc_Parent_Option_Id          number
84  ,Bsc_Source_Language           varchar2(5)
85  ,Bsc_User_Level0               number
86  ,Bsc_User_Level1               number
87  ,Bsc_User_Level1_Default       number
88  ,Bsc_User_Level2               number
89  ,Bsc_User_Level2_Default       number
90  ,Bsc_Option_Short_Name         BSC_KPI_ANALYSIS_OPTIONS_B.SHORT_NAME%TYPE
91  ,Bsc_Kpi_Measure_Id            BSC_KPI_ANALYSIS_MEASURES_B.kpi_measure_id%TYPE
92  ,Bsc_Option_Default_Value      BSC_KPI_ANALYSIS_GROUPS.default_value%TYPE
93  ,Bsc_Change_Action_Flag        VARCHAR2(1) := FND_API.G_TRUE
94 );
95 
96 TYPE Bsc_Option_Tbl_Type IS TABLE OF Bsc_Option_Rec_Type
97   INDEX BY BINARY_INTEGER;
98 TYPE Bsc_Analysis_Group_Rec is  RECORD
99 (      Bsc_analysis_group_id    BSC_KPI_ANALYSIS_GROUPS.analysis_group_id%TYPE
100    ,   Bsc_no_option_id         BSC_KPI_ANALYSIS_GROUPS.num_of_options%TYPE
101    ,   Bsc_dependency_flag      BSC_KPI_ANALYSIS_GROUPS.dependency_flag%TYPE
102    ,   Bsc_Ana_Group_Short_Name BSC_KPI_ANALYSIS_GROUPS.SHORT_NAME%TYPE
103    ,   Bsc_Change_Dim_Set       BSC_KPI_ANALYSIS_GROUPS.change_dim_set%TYPE
104 );
105 
106 TYPE Bsc_Anal_Opt_Tbl_Type IS TABLE OF Bsc_Analysis_Group_Rec INDEX BY BINARY_INTEGER;
107 
108 
109 TYPE Bsc_Analysis_Option_Rec is RECORD
110 (
111        Bsc_Option_Id              BSC_KPI_ANALYSIS_OPTIONS_B.Option_Id%TYPE
112    ,   Bsc_Parent_Option_Id       BSC_KPI_ANALYSIS_OPTIONS_B.Parent_Option_Id%TYPE
113    ,   Bsc_Grandparent_Option_Id  BSC_KPI_ANALYSIS_OPTIONS_B.Grandparent_Option_Id%TYPE
114    ,   Bsc_dependency_flag        BSC_KPI_ANALYSIS_GROUPS.dependency_flag%TYPE
115    ,   No_of_child                NUMBER
116    ,   Bsc_Option_Short_Name      BSC_KPI_ANALYSIS_OPTIONS_B.SHORT_NAME%TYPE
117 );
118 
119 TYPE Bsc_Anal_Opt_Det_Tbl_Type IS TABLE OF Bsc_Analysis_Option_Rec INDEX BY BINARY_INTEGER;
120 
121 procedure Create_Analysis_Options(
122   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
123  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
124  ,x_return_status       OUT NOCOPY     varchar2
125  ,x_msg_count           OUT NOCOPY     number
126  ,x_msg_data            OUT NOCOPY     varchar2
127 );
128 
129 procedure Retrieve_Analysis_Options(
130   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
131  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
132  ,x_Anal_Opt_Rec        IN OUT NOCOPY      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
133  ,x_return_status       OUT NOCOPY     varchar2
134  ,x_msg_count           OUT NOCOPY     number
135  ,x_msg_data            OUT NOCOPY     varchar2
136 );
137 
138 procedure Retrieve_Analysis_Options(
139   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
140  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
141  ,x_Anal_Opt_Rec        IN OUT NOCOPY     BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
142  ,p_data_source         IN             VARCHAR2
143  ,x_return_status       OUT NOCOPY     varchar2
144  ,x_msg_count           OUT NOCOPY     number
145  ,x_msg_data            OUT NOCOPY     varchar2
146 );
147 
148 procedure Update_Analysis_Options(
149   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
150  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
151  ,p_data_Source         IN             VARCHAR2
152  ,x_return_status       OUT NOCOPY     varchar2
153  ,x_msg_count           OUT NOCOPY     number
154  ,x_msg_data            OUT NOCOPY     varchar2
155 );
156 
157 procedure Update_Analysis_Options(
158   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
159  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
160  ,x_return_status       OUT NOCOPY     varchar2
161  ,x_msg_count           OUT NOCOPY     number
162  ,x_msg_data            OUT NOCOPY     varchar2
163 );
164 
165 procedure Delete_Analysis_Options(
166   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
167  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
168  ,x_return_status       OUT NOCOPY     varchar2
169  ,x_msg_count           OUT NOCOPY     number
170  ,x_msg_data            OUT NOCOPY     varchar2
171 );
172 
173 procedure Create_Analysis_Measures(
174   p_commit              IN      VARCHAR2  :=  FND_API.G_FALSE
175  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
176  ,x_return_status       OUT NOCOPY     varchar2
177  ,x_msg_count           OUT NOCOPY     number
178  ,x_msg_data            OUT NOCOPY     varchar2
179 );
180 
181 procedure Retrieve_Analysis_Measures(
182   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
183  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
184  ,x_Anal_Opt_Rec        IN OUT NOCOPY      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
185  ,x_return_status       OUT NOCOPY     varchar2
186  ,x_msg_count           OUT NOCOPY     number
187  ,x_msg_data            OUT NOCOPY     varchar2
188 );
189 
190 procedure Update_Analysis_Measures(
191   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
192  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
193  ,x_return_status       OUT NOCOPY     varchar2
194  ,x_msg_count           OUT NOCOPY     number
195  ,x_msg_data            OUT NOCOPY     varchar2
196 );
197 
198 procedure Delete_Analysis_Measures(
199   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
200  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
201  ,x_return_status       OUT NOCOPY     varchar2
202  ,x_msg_count           OUT NOCOPY     number
203  ,x_msg_data            OUT NOCOPY     varchar2
204 );
205 
206 /*********************************************************
207 
208 /***********************************************************/
209 PROCEDURE Delete_Ana_Opt_Mult_Groups
210 (       p_commit              IN            VARCHAR2:=FND_API.G_FALSE
211     ,   p_Kpi_id              IN            BSC_KPIS_B.indicator%TYPE
212     ,   p_Anal_Opt_Tbl        IN            BSC_ANALYSIS_OPTION_PUB.Bsc_Anal_Opt_Tbl_Type
213     ,   p_max_group_count     IN            NUMBER
214     ,   p_Anal_Opt_Comb_Tbl   IN            BSC_ANALYSIS_OPTION_PUB.Anal_Opt_Comb_Num_Tbl_Type
215     ,   p_Anal_Opt_Rec        IN            BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
216     ,   x_return_status       OUT NOCOPY    VARCHAR2
217     ,   x_msg_count           OUT NOCOPY    NUMBER
218     ,   x_msg_data            OUT NOCOPY    VARCHAR2
219 );
220 
221 PROCEDURE Synch_Kpi_Anal_Group
222 (
223          p_commit              IN            VARCHAR2:=FND_API.G_FALSE
224      ,   p_Kpi_Id              IN            BSC_KPIS_B.indicator%TYPE
225      ,   p_Anal_Opt_Tbl        IN            BSC_ANALYSIS_OPTION_PUB.Bsc_Anal_Opt_Tbl_Type
226      ,   x_return_status       OUT NOCOPY    VARCHAR2
227      ,   x_msg_count           OUT NOCOPY    NUMBER
228      ,   x_msg_data            OUT NOCOPY    VARCHAR2
229 );
230 
231 
232 PROCEDURE store_anal_opt_grp_count
233 (     p_kpi_id        IN            NUMBER
234   ,   x_Anal_Opt_Tbl  IN OUT NOCOPY BSC_ANALYSIS_OPTION_PUB.Bsc_Anal_Opt_Tbl_Type
235 ) ;
236 
237 PROCEDURE Validate_Custom_Measure
238 (    p_kpi_id              IN         BSC_OAF_ANALYSYS_OPT_COMB_V.INDICATOR%TYPE
239     , p_option0            IN         BSC_OAF_ANALYSYS_OPT_COMB_V.ANALYSIS_OPTION0%TYPE
240     , p_option1            IN         BSC_OAF_ANALYSYS_OPT_COMB_V.ANALYSIS_OPTION1%TYPE
241     , p_option2            IN         BSC_OAF_ANALYSYS_OPT_COMB_V.ANALYSIS_OPTION2%TYPE
242     , p_series_id          IN         BSC_OAF_ANALYSYS_OPT_COMB_V.SERIES_ID%TYPE
243     , x_return_status       OUT NOCOPY    VARCHAR2
244     , x_msg_count           OUT NOCOPY    NUMBER
245     , x_msg_data            OUT NOCOPY    VARCHAR2
246 );
247 PROCEDURE delete_extra_series(
248       p_Bsc_Anal_Opt_Rec      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
249     , x_return_status       OUT NOCOPY    VARCHAR2
250     , x_msg_count           OUT NOCOPY    NUMBER
251     , x_msg_data            OUT NOCOPY    VARCHAR2
252 );
253 -----------------------------------------------------------
254 PROCEDURE Create_Data_Series
255 (       p_commit              IN            varchar2 -- :=  FND_API.G_FALSE
256     ,   p_Anal_Opt_Rec        IN            BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
257     ,   x_Anal_Opt_Rec        OUT NOCOPY    BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
258     ,   x_return_status       OUT NOCOPY    VARCHAR2
259     ,   x_msg_count           OUT NOCOPY    NUMBER
260     ,   x_msg_data            OUT NOCOPY    VARCHAR2
261 );
262 procedure Delete_Data_Series(
263   p_commit              IN      varchar2 -- :=  FND_API.G_FALSE
264  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
265  ,x_return_status       OUT NOCOPY     varchar2
266  ,x_msg_count           OUT NOCOPY     number
267  ,x_msg_data            OUT NOCOPY     varchar2
268 );
269 
270 procedure Update_Data_Series
271 (       p_commit              IN            varchar2 -- :=  FND_API.G_FALSE
272     ,   p_Anal_Opt_Rec        IN            BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
273     ,   x_return_status       OUT NOCOPY    VARCHAR2
274     ,   x_msg_count           OUT NOCOPY    NUMBER
275     ,   x_msg_data            OUT NOCOPY    VARCHAR2
276 );
277 
278 procedure Rearrange_Data_Series(
279     p_commit            IN      varchar2  -- FND_API.G_FALSE
280    ,p_Kpi_Id            IN      number
281    ,p_option_group0     IN      number
282    ,p_option_group1     IN      number
283    ,p_option_group2     IN      number
284    ,p_Measure_Seq       IN      varchar2   -- FND_API.G_FALSE
285    ,p_add_flag          IN      varchar2   -- FND_API.G_FALSE
286    ,p_remove_flag       IN      varchar2
287    ,x_return_status     OUT NOCOPY     varchar2
288    ,x_msg_count         OUT NOCOPY     number
289    ,x_msg_data          OUT NOCOPY     varchar2
290 );
291 
292 
293 PROCEDURE Set_Default_Analysis_Option
294 (
295       p_commit              IN             VARCHAR
296     , p_obj_id              IN             BSC_KPIS_B.indicator%TYPE
297     , p_Anal_Opt_Comb_Tbl   IN             BSC_ANALYSIS_OPTION_PUB.Anal_Opt_Comb_Num_Tbl_Type
298     , p_Anal_Grp_Id         IN             BSC_KPIS_B.ind_group_id%TYPE
299     , x_return_status       OUT NOCOPY     VARCHAR2
300     , x_msg_count           OUT NOCOPY     NUMBER
301     , x_msg_data            OUT NOCOPY     VARCHAR2
302 );
303 
304 FUNCTION Get_Num_Analysis_options
305 (
306     p_obj_id       IN  BSC_KPIS_B.indicator%TYPE
307   , p_anal_grp_Id  IN  BSC_KPI_ANALYSIS_GROUPS.analysis_group_id%TYPE
308 ) RETURN NUMBER;
309 
310 
311 FUNCTION Get_Analysis_Group_Id
312 (
313    p_Anal_Opt_Comb_Tbl      IN   BSC_ANALYSIS_OPTION_PUB.Anal_Opt_Comb_Num_Tbl_Type
314  , p_obj_id                 IN   BSC_KPIS_B.indicator%TYPE
315 ) RETURN NUMBER ;
316 
317 FUNCTION Default_Anal_Option_Changed
318 (
319    p_Anal_Num_Tbl           IN   BSC_ANALYSIS_OPTION_PUB.Anal_Opt_Comb_Num_Tbl_Type
320  , p_Old_Anal_Num_Tbl       IN   BSC_ANALYSIS_OPTION_PUB.Anal_Opt_Comb_Num_Tbl_Type
321 )RETURN BOOLEAN;
322 
323 PROCEDURE Cascade_Deletion_Color_Props (
324   p_commit              IN      VARCHAR2  :=  FND_API.G_FALSE
325  ,p_Anal_Opt_Rec        IN      BSC_ANALYSIS_OPTION_PUB.Bsc_Option_Rec_Type
326  ,x_return_status       OUT NOCOPY     varchar2
327  ,x_msg_count           OUT NOCOPY     number
328  ,x_msg_data            OUT NOCOPY     varchar2
329 ) ;
330 
331 end BSC_ANALYSIS_OPTION_PUB;