1 PACKAGE AMS_DMSource_PVT AUTHID CURRENT_USER as
2 /* $Header: amsvdsrs.pls 115.13 2003/09/19 04:55:08 nyostos ship $ */
3 -- Start of Comments
4 -- Package name : AMS_DMSource_PVT
5 -- Purpose :
6 -- History :
7 -- 30-jan-2001 choang Changed p_rule_id to p_rule_id.
8 -- 09-Jul-2001 choang Added bin_probability and replaced rule_id with decile.
9 -- 11-Jul-2001 choang Added process_scores.
10 -- 26-Jul-2001 choang Added generate_odm_input_views
11 -- 07-Jan-2002 choang Removed security group id
12 -- 28-Jul-2003 nyostos Added PERCENTILE column.
13 -- NOTE :
14 -- End of Comments
15
16 -- *******************************************************
17 -- Start of Comments
18 -- -------------------------------------------------------
19 -- Record name: Source_Rec_Type
20 -- -------------------------------------------------------
21 -- Parameters:
22 -- SOURCE_ID
23 -- LAST_UPDATE_DATE
24 -- LAST_UPDATED_BY
25 -- CREATION_DATE
26 -- CREATED_BY
27 -- LAST_UPDATE_LOGIN
28 -- OBJECT_VERSION_NUMBER
29 -- MODEL_TYPE
30 -- ARC_USED_FOR_OBJECT
31 -- USED_FOR_OBJECT_ID
32 -- PARTY_ID
33 -- SCORE_RESULT
34 -- TARGET_VALUE
35 -- CONFIDENCE
36 -- CONTINUOUS_SCORE
37 -- decile
38 -- PERCENTILE
39 --
40 -- Required:
41 -- Defaults:
42 -- Note: This is automatic generated record definition, it includes all columns
43 -- defined in the table, developer must manually add or delete some of the attributes.
44 --
45 -- End of Comments
46
47 TYPE Source_Rec_Type IS RECORD
48 (
49 SOURCE_ID NUMBER := FND_API.G_MISS_NUM,
50 LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,
51 LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,
52 CREATION_DATE DATE := FND_API.G_MISS_DATE,
53 CREATED_BY NUMBER := FND_API.G_MISS_NUM,
54 LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,
55 OBJECT_VERSION_NUMBER NUMBER := FND_API.G_MISS_NUM,
56 MODEL_TYPE VARCHAR2(30) := FND_API.G_MISS_CHAR,
57 ARC_USED_FOR_OBJECT VARCHAR2(30) := FND_API.G_MISS_CHAR,
58 USED_FOR_OBJECT_ID NUMBER := FND_API.G_MISS_NUM,
59 PARTY_ID NUMBER := FND_API.G_MISS_NUM,
60 SCORE_RESULT VARCHAR2(30) := FND_API.G_MISS_CHAR,
61 TARGET_VALUE VARCHAR2(30) := FND_API.G_MISS_CHAR,
62 CONFIDENCE NUMBER := FND_API.G_MISS_NUM,
63 CONTINUOUS_SCORE NUMBER := FND_API.G_MISS_NUM,
64 decile NUMBER := FND_API.G_MISS_NUM,
65 PERCENTILE NUMBER := FND_API.G_MISS_NUM
66 );
67
68 G_MISS_source_rec Source_Rec_Type;
69 TYPE dm_source_Tbl_Type IS TABLE OF Source_Rec_Type INDEX BY BINARY_INTEGER;
70 G_MISS_source_TBL dm_source_Tbl_Type;
71
72
73 -- Start of Comments
74 --
75 -- validation procedures
76 --
77 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
78 -- For create: G_CREATE, for update: G_UPDATE
79 -- Note: 1. This is automated generated item level validation procedure.
80 -- The actual validation detail is needed to be added.
81 -- 2. Validate the unique keys, lookups here
82 -- End of Comments
83
84 PROCEDURE Check_source_Items (
85 P_source_rec IN Source_Rec_Type,
86 p_validation_mode IN VARCHAR2,
87 x_return_status OUT NOCOPY VARCHAR2
88 );
89 -- *******************************************************
90 -- Start of Comments
91 -- *******************************************************
92 -- API Name: Lock_Source
93 -- Type : Private
94 -- Pre-Req :
95 -- Parameters:
96 -- IN
97 -- p_api_version IN NUMBER Required
98 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
99 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
100 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
101 -- P_source_rec IN Source_Rec_Type Required
102 --
103 -- OUT:
104 -- x_return_status OUT VARCHAR2
105 -- x_msg_count OUT NUMBER
106 -- x_msg_data OUT VARCHAR2
107 -- Version : Current version 1.0
108 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
109 -- and basic operation, developer must manually add parameters and business logic as necessary.
110 --
111 -- End of Comments
112 --
113 PROCEDURE Lock_Source(
114 p_api_version IN NUMBER,
115 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
116
117 X_Return_Status OUT NOCOPY VARCHAR2,
118 X_Msg_Count OUT NOCOPY NUMBER,
119 X_Msg_Data OUT NOCOPY VARCHAR2,
120
121 p_SOURCE_ID IN NUMBER,
122 p_object_version IN NUMBER
123 );
124
125 -- *******************************************************
126 -- Start of Comments
127 -- *******************************************************
128 -- API Name: Create_Source
129 -- Type : Private
130 -- Pre-Req :
131 -- Parameters:
132 -- IN
133 -- p_api_version IN NUMBER Required
134 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
135 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
136 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
137 -- P_source_rec IN Source_Rec_Type Required
138 --
139 -- OUT:
140 -- x_return_status OUT VARCHAR2
141 -- x_msg_count OUT NUMBER
142 -- x_msg_data OUT VARCHAR2
143 -- Version : Current version 1.0
144 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
145 -- and basic operation, developer must manually add parameters and business logic as necessary.
146 --
147 -- End of Comments
148 --
149 PROCEDURE Create_Source(
150 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 := FND_API.G_VALID_LEVEL_FULL,
154
155 X_Return_Status OUT NOCOPY VARCHAR2,
156 X_Msg_Count OUT NOCOPY NUMBER,
157 X_Msg_Data OUT NOCOPY VARCHAR2,
158
159 P_source_rec IN Source_Rec_Type := G_MISS_source_rec,
160 X_SOURCE_ID OUT NOCOPY NUMBER
161 );
162
163 -- *******************************************************
164 -- Start of Comments
165 -- *******************************************************
166 -- API Name: Update_Source
167 -- Type : Private
168 -- Pre-Req :
169 -- Parameters:
170 -- IN
171 -- p_api_version IN NUMBER Required
172 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
173 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
174 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
175 -- P_source_rec IN Source_Rec_Type Required
176 --
177 -- OUT:
178 -- x_return_status OUT VARCHAR2
179 -- x_msg_count OUT NUMBER
180 -- x_msg_data OUT VARCHAR2
181 -- Version : Current version 1.0
182 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
183 -- and basic operation, developer must manually add parameters and business logic as necessary.
184 --
185 -- End of Comments
186 --
187 PROCEDURE Update_Source(
188 p_api_version IN NUMBER,
189 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
190 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
191 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
192
193 X_Return_Status OUT NOCOPY VARCHAR2,
194 X_Msg_Count OUT NOCOPY NUMBER,
195 X_Msg_Data OUT NOCOPY VARCHAR2,
196
197 P_source_rec IN Source_Rec_Type,
198 X_Object_Version_Number OUT NOCOPY NUMBER
199 );
200
201 -- *******************************************************
202 -- Start of Comments
203 -- *******************************************************
204 -- API Name: Delete_Source
205 -- Type : Private
206 -- Pre-Req :
207 -- Parameters:
208 -- IN
209 -- p_api_version IN NUMBER Required
210 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
211 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
212 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
213 -- p_SOURCE_ID IN NUMBER
214 -- p_object_version_number IN NUMBER Optional Default = NULL
215 --
216 -- OUT:
217 -- x_return_status OUT VARCHAR2
218 -- x_msg_count OUT NUMBER
219 -- x_msg_data OUT VARCHAR2
220 -- Version : Current version 1.0
221 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
222 -- and basic operation, developer must manually add parameters and business logic as necessary.
223 --
224 -- End of Comments
225 --
226 PROCEDURE Delete_Source(
227 p_api_version IN NUMBER,
228 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
229 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
230 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
231 X_Return_Status OUT NOCOPY VARCHAR2,
232 X_Msg_Count OUT NOCOPY NUMBER,
233 X_Msg_Data OUT NOCOPY VARCHAR2,
234 P_SOURCE_ID IN NUMBER,
235 P_Object_Version_Number IN NUMBER
236 );
237
238
239 -- Start of Comments
240 --
241 -- Record level validation procedures
242 --
243 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
244 -- For create: G_CREATE, for update: G_UPDATE
245 -- Note: 1. This is automated generated item level validation procedure.
246 -- The actual validation detail is needed to be added.
247 -- 2. Developer can manually added inter-field level validation.
248 -- End of Comments
249
250 PROCEDURE Validate_source_rec(
251 p_api_version IN NUMBER,
252 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
253 X_Return_Status OUT NOCOPY VARCHAR2,
254 X_Msg_Count OUT NOCOPY NUMBER,
255 X_Msg_Data OUT NOCOPY VARCHAR2,
256 P_source_rec IN Source_Rec_Type
257 );
258
259 -- Start of Comments
260 --
261 -- validation procedures
262 --
263 -- p_validation_mode is a constant defined in AMS_UTILITY_PVT package
264 -- For create: G_CREATE, for update: G_UPDATE
265 -- Note: 1. This is automated generated item level validation procedure.
266 -- The actual validation detail is needed to be added.
267 -- 2. We can also validate table instead of record. There will be an option for user to choose.
268 -- End of Comments
269
270 PROCEDURE Validate_Source(
271 p_api_version IN NUMBER,
272 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
273 P_Validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
274 P_Validation_mode IN VARCHAR2,
275 P_source_rec IN Source_Rec_Type,
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 -- PURPOSE
284 -- Bin the scores for a scoring run by the probability of a positive score.
285 --
286 -- PARAMETERS
287 -- p_score_id - scoring run identifier.
288 --
289 -- NOTE
290 -- - The bin is generated from the following formula:
291 -- Bin = (10 - FLOOR (LEAST (99, continuous_score)/10))
292 -- - This procedure should be run after scores have been posted for the
293 -- scoring run.
294 -- - The probability of a positive score is represented by the continuous_score
295 -- field.
296 --
297 PROCEDURE bin_probability (
298 p_api_version IN NUMBER,
299 p_init_msg_list IN VARCHAR2,
300 p_commit IN VARCHAR2,
301 x_return_status OUT NOCOPY VARCHAR2,
302 x_msg_count OUT NOCOPY NUMBER,
303 x_msg_data OUT NOCOPY VARCHAR2,
304 p_score_id IN NUMBER
305 );
306
307
308 --
309 -- PURPOSE
310 -- Extract the scoring output generated from the data mining engine, and
311 -- record the scores in the marketing table.
312 --
313 PROCEDURE process_scores (
314 p_api_version IN NUMBER,
315 p_init_msg_list IN VARCHAR2,
316 p_commit IN VARCHAR2,
317 p_score_id IN NUMBER,
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 --
325 -- PURPOSE
326 -- Generate the input data view for the data mining engine.
327 --
328 -- PARAMETERS
329 -- p_object_type - the type should be MODL or SCOR.
330 -- p_object_id - the ID of the respective object.
331 -- p_target_type - the type of target data, which could be either
332 -- persons or organization contacts.
333 --
334 -- NOTE
335 -- The view needs to be dynamically generated because the data
336 -- mining engine cannot filter on the input data.
337 --
338 -- API VERSION
339 -- 2.0 - use data_source to determine select fields
340 -- 1.0 - use target_group to determine select fields
341 --
342 PROCEDURE generate_odm_input_views (
343 p_api_version IN NUMBER,
344 p_init_msg_list IN VARCHAR2,
345 p_object_type IN VARCHAR2,
346 p_object_id IN NUMBER,
347 p_data_source_id IN VARCHAR2,
348 x_return_status OUT NOCOPY VARCHAR2,
349 x_msg_count OUT NOCOPY NUMBER,
350 x_msg_data OUT NOCOPY VARCHAR2
351 );
352
353 --
354 -- PURPOSE
358 -- PARAMETERS
355 -- Drops the input data views along with the synonyms
356 -- created for them in the ODM schema
357 --
359 -- p_object_type - the type should be MODL or SCOR.
360 -- p_object_id - the ID of the respective object.
361 --
362 -- HISTORY
363 -- Sep 17, 2003 nyostos Created.
364 --
365 PROCEDURE cleanup_odm_input_views (
366 p_object_type IN VARCHAR2,
367 p_object_id IN NUMBER
368 );
369
370
371 End AMS_DMSource_PVT;