1 package ZPB_PERSONAL_AW as
2 /* $Header: zpbpersonalaw.pls 120.0.12010.4 2006/08/03 17:36:45 appldev noship $ */
3
4 -------------------------------------------------------------------------------
5 -- AW_CREATE - Driver program to create the user's personal AW from the shared
6 -- AW
7 --
8 -- IN: p_user - The user ID
9 -------------------------------------------------------------------------------
10 procedure aw_create(p_user in varchar2,
11 p_business_area_id in number);
12
13 -------------------------------------------------------------------------------
14 -- AW_DELETE - Driver program to completely and irreversibly delete
15 -- the user's personal AW. Will delete the AW and any
16 -- SQL Views defined for that AW.
17 --
18 -- IN: p_user - The user ID
19 -------------------------------------------------------------------------------
20 procedure aw_delete(p_user in varchar2,
21 p_business_area_id in number);
22
23 -------------------------------------------------------------------------------
24 -- AW_UPDATE - Driver program to update the user's personal AW from the shared
25 -- AW
26 --
27 -- IN: p_user - The user ID
28 -- x_return_status - The return status
29 --
30 -- OUT: whether the structures have changed to require a new Metadata Map
31 -------------------------------------------------------------------------------
32 function AW_UPDATE(p_user IN VARCHAR2,
33 x_return_status IN OUT NOCOPY VARCHAR2,
34 p_read_only IN VARCHAR2 := FND_API.G_FALSE)
35 return BOOLEAN;
36
37 -------------------------------------------------------------------------------
38 -- DATA_VIEWS_CREATE - Creates the views associated with the measures of the
39 -- instance.
40 --
41 -- IN: p_user - User ID
42 -- p_instance - The instance ID
43 -------------------------------------------------------------------------------
44 procedure DATA_VIEWS_CREATE(p_user in varchar2,
45 p_instance in varchar2,
46 p_type in varchar2,
47 p_template in varchar2 default null,
48 p_approver in varchar2 default null);
49
50 -------------------------------------------------------------------------------
51 -- IMPORT - Imports objects from one AW to personal AW
52 --
53 -- IN: p_user - The user id.
54 -- p_fromAw - The AW to import from. Defaults to the shared AW
55 -- p_noScope - 'Y' if readscoping should be removed for the import
56 -------------------------------------------------------------------------------
57 procedure IMPORT (p_user in varchar2,
58 p_fromAw in varchar2 default null,
59 p_noScope in varchar2 default 'N');
60
61 -------------------------------------------------------------------------------
62 -- MEASURES_DELETE - Deletes measures defined in the personal
63 --
64 -- IN: p_user - The User ID
65 -- p_instance - The instance ID
66 -- p_type - SHARED_VIEW, PERSONAL, APPROVER. def. SHARED_VIEW
67 -- p_template - The template ID. Null if N/A (default)
68 -- p_approvee - The approvee ID. Null if N/A (default)
69 --
70 -------------------------------------------------------------------------------
71 procedure measures_delete(p_user in varchar2,
72 p_instance in varchar2,
73 p_type in varchar2 default 'SHARED_VIEW',
74 p_template in varchar2 default NULL,
75 p_approvee in varchar2 default NULL);
76
77 -------------------------------------------------------------------------------
78 -- MEASURES_SHARED_UPDATE - Creates any formulas and views that point to the
79 -- shared AW measure formulas
80 --
81 -- IN: p_user - User ID
82 -- x_return_status - The return status
83 --
84 -- OUT: whether the structures have changed to require a new Metadata Map
85 -------------------------------------------------------------------------------
86 function MEASURES_SHARED_UPDATE(p_user IN VARCHAR2,
87 x_return_status IN OUT NOCOPY VARCHAR2)
88 return BOOLEAN;
89
90 -------------------------------------------------------------------------------
91 -- METADATA_CREATE - Copies the metadata objects from shared AW into a
92 -- new personal AW. Copies all dimensions, hierarchies,
93 -- levels, aggregation, allocation, and attributes defined
94 -- in ECM.
95 --
96 -- IN: p_user - User ID
97 -------------------------------------------------------------------------------
98 procedure metadata_create(p_user in varchar2);
99
100 -------------------------------------------------------------------------------
101 -- METADATA_UPDATE - Updates the Personal AW with any changes to the shared
102 -- AW's metadata. It will merge the changes in the
103 -- shared with the personal, never deleting any user-
104 -- created personal metadata or data objects.
105 --
106 -- IN: p_user - The user ID
107 -- x_return_status - The return status
108 --
109 -- OUT: The list of Dimension ID's whose views need to be recreated
110 -------------------------------------------------------------------------------
111 function METADATA_UPDATE(p_user IN VARCHAR2,
112 x_return_status IN OUT NOCOPY VARCHAR2)
113 return VARCHAR2;
114
115 -------------------------------------------------------------------------------
116 -- SECURITY_UPDATE - Updates the data access control structures to reflect
117 -- the last maintenance changes for a given user.
118 --
119 -- IN: p_user - The User Id
120 -- x_return_status - The return status
121 ------------------------------------------------------------------------------
122 procedure SECURITY_UPDATE(p_user IN VARCHAR2,
123 x_return_status IN OUT NOCOPY VARCHAR2);
124
125 -------------------------------------------------------------------------------
126 -- API name : Startup
127 -- Type : Private
128 -- Function : Starts up the OLAP session for the user. Attaches the AW's
129 -- needed for the session, synch's them up, and distributes any
130 -- measures needed
131 -- Pre-reqs : None.
132 -- Parameters :
133 -- IN : p_api_version IN NUMBER Required
134 -- p_init_msg_list IN VARCHAR2 Optional Default = G_FALSE
135 -- p_commit IN VARCHAR2 Optional Default = G_FALSE
136 -- p_validation_level IN NUMBER Optional Default = G_VALID_LEVEL_FULL
137 -- p_business_area IN NUMBER The business area id
138 -- p_user_id IN NUMBER The user id to start up
139 --
140 -- OUT : x_return_status OUT VARCHAR2(1)
141 -- x_msg_count OUT NUMBER
142 -- x_msg_data OUT VARCHAR2(2000)
143 --
144 -- Version : Current version 1.0
145 -- Initial version 1.0
146 --
147 -- Notes : None
148 --
149 -------------------------------------------------------------------------------
150 procedure STARTUP(p_api_version IN NUMBER,
151 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
152 p_commit IN VARCHAR2 := FND_API.G_FALSE,
153 p_validation_level IN NUMBER
154 := FND_API.G_VALID_LEVEL_FULL,
155 x_return_status OUT NOCOPY VARCHAR2,
156 x_msg_count OUT NOCOPY NUMBER,
157 x_msg_data OUT NOCOPY VARCHAR2,
158 p_user IN VARCHAR2,
159 p_read_only IN VARCHAR2 := FND_API.G_FALSE);
160
161 -------------------------------------------------------------------------------
162 -- VIEWS_UPDATE - Creates/Updates the Dimension LMAPs for the personal AW.
163 --
164 -- IN: p_aw - AW Name
165 -- p_user - User ID
166 -- p_dims - Space-separated list of dimension id's to update. If NULL
167 -- (the default), all data dimensions are updated
168 -- p_doPers - Y if should look for personal views (with personal levels)
169 -- to update
170 -------------------------------------------------------------------------------
171 procedure views_update(p_aw in varchar2,
172 p_user in varchar2,
173 p_dims in varchar2 := NULL,
174 p_doPers in varchar2 := 'N');
175
176 -------------------------------------------------------------------------------
177 -- PERSONAL_AW_RW_SCAN checks whether the given user's personal AW is
178 -- attached R/W by an open session and returns session info sufficient
179 -- do close the session.
180 --
181 -- IN : User ID
182 -- IN : Business Area ID
183 -- OUT : SID
184 -- OUT : serial_no
185 -- OUT : sess_user
186 -- OUT : OS_user
187 -- OUT : status
188 -- OUT : schema_name
189 -- OUT : machine name
190 -------------------------------------------------------------------------------
191 procedure PERSONAL_AW_RW_SCAN(p_user in varchar2,
192 p_business_area in NUMBER,
193 p_SID out nocopy number,
194 p_serial_no out nocopy number,
195 p_sess_user out nocopy varchar2,
196 p_os_user out nocopy varchar2,
197 p_status out nocopy varchar2,
198 p_schema_name out nocopy varchar2,
199 p_machine out nocopy varchar2);
200
201 -------------------------------------------------------------------------------
202 -- PERSONAL_AW_SESS_CLOSE kills the specified personal AW r/w session.
203 --
204 -- IN : SID
205 -- IN : SERIAL NO
206 -------------------------------------------------------------------------------
207 procedure personal_aw_sess_close(p_SID in number, p_serial_no in number);
208
209 -------------------------------------------------------------------------------
210 -- MEASURES_APPROVER_UPDATE - Deletes any approver formulas that have been
211 -- submitted and thus made obsolete in a previous
212 -- user session
213 --
214 -- IN: p_user - User ID
215 -- x_return_status - The return status
216 --
217 -------------------------------------------------------------------------------
218 procedure MEASURES_APPROVER_UPDATE(p_user IN VARCHAR2,
219 x_return_status IN OUT NOCOPY VARCHAR2);
220
221 -------------------------------------------------------------------------
222 -- UPDATE_SHADOW - Called when a user starts shadowing another user
223 --
224 -- IN: p_business_area_id - The current business area id
225 -- p_shadow_id - The user id of the user who is being shadowed
226 -----------------------------------------------------------------------
227 PROCEDURE UPDATE_SHADOW (p_business_area_id IN NUMBER,
228 p_shadow_id IN NUMBER default null);
229
230 end ZPB_PERSONAL_AW;
[Home] [Help]