4 * This package contains Compensation Workbench Plan Design APIs.
1 Package BEN_CWB_PL_DSGN_API AUTHID CURRENT_USER as
2 /* $Header: becpdapi.pkh 120.6.12020000.4 2013/03/14 07:16:02 kmsuresh ship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Compensation Workbench Plan Design
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_plan_or_option >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates compensation workbench plan and option information.
17 *
18 * This API information is used by all self-service pages that create plan
19 * design data.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A valid plan/option for Compensation Workbench must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * A Compensation Workbench Plan will have been created in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * A Compensation Workbench Plan will not be created in the database.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_pl_id Specifies the Compensation Workbench Plan.
37 * @param p_oipl_id Specifies options for Compensation Workbench Plan.
38 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
39 * @param p_effective_date Determines when the DateTrack operation comes into
40 * force.
41 * @param p_name This parameter specifies the Compensation Workbench Plan name.
42 * @param p_group_pl_id This parameter specifies Compensation Workbench Group
43 * Plan.
44 * @param p_group_oipl_id Specifies options for a Compensation Workbench Group
45 * Plan.
46 * @param p_opt_hidden_flag This parameter specifies if the Compensation
47 * Workbench Plan options will be displayed in the SS pages.
48 * @param p_opt_id This parameter specifies the option and is foreign Key to
49 * BEN_OPT_F.
50 * @param p_pl_uom This parameter specifies the Compensation Workbench Plan
51 * currency.
52 * @param p_pl_ordr_num This parameter specifiesthe Compensation Workbench Plan
56 * @param p_pl_xchg_rate This parameter specifies the exchange rate for
53 * order number.
54 * @param p_oipl_ordr_num This parameter specifiesthe Compensation Workbench
55 * Plan options order number.
57 * Compensation Workbench Plan currency.
58 * @param p_opt_count This parameter keeps count of plan options.
59 * @param p_uses_bdgt_flag This parameter specifies if budgeting is used or
60 * not.
61 * @param p_prsrv_bdgt_cd This parameter specifies if budget is stored as
62 * amount or percentage of eligible salaries.
63 * @param p_upd_start_dt Self Service update start date
64 * @param p_upd_end_dt Self Service update end date
65 * @param p_approval_mode This parameter specifies approval mode for
66 * allocations submission. Valid values are defined in 'BEN_CWB_APPROVAL_MODE'
67 * lookup type.
68 * @param p_enrt_perd_start_dt {@rep:casecolumn
69 * BEN_CWB_PL_DSGN.ENRT_PERD_START_DT}
70 * @param p_enrt_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_END_DT}
71 * @param p_yr_perd_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_START_DT}
72 * @param p_yr_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_END_DT}
73 * @param p_wthn_yr_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_START_DT}
74 * @param p_wthn_yr_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_END_DT}
75 * @param p_enrt_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_ID}
76 * @param p_yr_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_ID}
77 * @param p_business_group_id {@rep:casecolumn
78 * PER_ALL_ASSIGNMENTS_F.BUSINESS_GROUP_ID}
79 * @param p_perf_revw_strt_dt {@rep:casecolumn BEN_ENRT_PERD.PERF_REVW_STRT_DT}
80 * @param p_asg_updt_eff_date {@rep:casecolumn BEN_ENRT_PERD.ASG_UPDT_EFF_DATE}
81 * @param p_emp_interview_typ_cd This parameter specifies performance rating
82 * type. It specifies the valid values defined in 'EMP_INTERVIEW_TYPE' lookup
83 * type.
84 * @param p_salary_change_reason {@rep:casecolumn
85 * BEN_CWB_PL_DSGN.SALARY_CHANGE_REASON}
86 * @param p_ws_abr_id This parameter specifies worksheet rate. It is null if no
87 * worksheet rate is defined.
88 * @param p_ws_nnmntry_uom This parameter specifies the non-monetory units of
89 * measure such as stocks.
90 * @param p_ws_rndg_cd This parameter specifies the numeric rounding parameter.
91 * Valid values are defined in 'BEN_RNDG' lookup type.
92 * @param p_ws_sub_acty_typ_cd This parameter specifies worksheet rate sub
93 * activity type code. Valid values are defined in 'BEN_SUB_ACTY_TYP' lookup
94 * type.
95 * @param p_dist_bdgt_abr_id This parameter specifies distribution budget rate.
96 * @param p_dist_bdgt_nnmntry_uom This parameter specifies the non-monetory
97 * units of measure such as stocks.
98 * @param p_dist_bdgt_rndg_cd This parameter specifies the numeric rounding
99 * parameter. Valid values defined are in 'BEN_RNDG' lookup type.
100 * @param p_ws_bdgt_abr_id This parameter specifies worksheet budget rate.
101 * @param p_ws_bdgt_nnmntry_uom This parameter specifies the non-monetory units
102 * of measure such as stocks.
103 * @param p_ws_bdgt_rndg_cd This parameter specifies the numeric rounding
104 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
105 * @param p_rsrv_abr_id This parameter specifies reserve budget rate.
106 * @param p_rsrv_nnmntry_uom This parameter specifies the non-monetory units of
107 * measure such as stocks.
108 * @param p_rsrv_rndg_cd This parameter specifies the numeric rounding
109 * parameter. Valid values defined are in 'BEN_RNDG' lookup type.
110 * @param p_elig_sal_abr_id This parameter specifies eligible salary rate.
111 * @param p_elig_sal_nnmntry_uom This parameter specifies the non-monetory
112 * units of measure such as stocks.
113 * @param p_elig_sal_rndg_cd This parameter specifies the non-monetory units of
114 * measure such as stocks.
115 * @param p_misc1_abr_id This parameter specifies miscellaneous 1 rate.
116 * @param p_misc1_nnmntry_uom This parameter specifies the non-monetory units
117 * of measure such as stocks.
118 * @param p_misc1_rndg_cd This parameter specifies the numeric rounding
119 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
120 * @param p_misc2_abr_id This parameter specifies miscellaneous 2 rate.
121 * @param p_misc2_nnmntry_uom This parameter specifies the non-monetory units
122 * of measure such as stocks.
123 * @param p_misc2_rndg_cd This parameter specifies the numeric rounding
124 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
125 * @param p_misc3_abr_id This parameter specifies miscellaneous 3 rate.
126 * @param p_misc3_nnmntry_uom This parameter specifies the non-monetory units
127 * of measure such as stocks.
128 * @param p_misc3_rndg_cd This parameter specifies the numeric rounding
129 * parameter. Valid values defined in 'BEN_RNDG' lookup type.
130 * @param p_stat_sal_abr_id This parameter specifies the stated salary rate.
131 * @param p_stat_sal_nnmntry_uom This parameter specifies the non-monetory
132 * units of measure such as stocks.
133 * @param p_stat_sal_rndg_cd This parameter specifies the numeric rounding
134 * parameter. Valid values defined in 'BEN_RNDG' lookup type.
135 * @param p_rec_abr_id This parameter specifies the recommended rate.
136 * @param p_rec_nnmntry_uom This parameter specifies the non-monetory units of
137 * measure such as stocks.
138 * @param p_rec_rndg_cd This parameter specifies the numeric rounding
139 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
140 * @param p_tot_comp_abr_id This parameter specifies the total compensation.
141 * @param p_tot_comp_nnmntry_uom This parameter specifies the non-monetory
142 * units of measure such as stocks.
143 * @param p_tot_comp_rndg_cd This parameter specifies the numeric rounding
144 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
148 * @param p_oth_comp_rndg_cd This parameter specifies the numeric rounding
145 * @param p_oth_comp_abr_id This parameter specifies the other compensation.
146 * @param p_oth_comp_nnmntry_uom This parameter specifies the non-monetory
147 * units of measure such as stocks.
149 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
150 * @param p_actual_flag This parameter specifies if balance type is actual or
151 * not.
152 * @param p_acty_ref_perd_cd This parameter specifies the activity reference
153 * period. Valid values are defined in 'BEN_ACTY_REF_PERD' lookup type.
154 * @param p_legislation_code This parameter specifies the legislation to which
155 * the information type applies. Foreign key to FND_TERRITORIES.
156 * @param p_pl_annulization_factor {@rep:casecolumn
157 * BEN_CWB_PL_DSGN.PL_ANNULIZATION_FACTOR}
158 * @param p_pl_stat_cd This parameter specifies the plan status code. Valid
159 * values are defined in 'BEN_STAT' lookup type.
160 * @param p_uom_precision {@rep:casecolumn BEN_CWB_PL_DSGN.UOM_PRECISION}
161 * @param p_ws_element_type_id {@rep:casecolumn
162 * BEN_CWB_PL_DSGN.WS_ELEMENT_TYPE_ID}
163 * @param p_ws_input_value_id {@rep:casecolumn
164 * BEN_CWB_PL_DSGN.WS_INPUT_VALUE_ID}
165 * @param p_data_freeze_date This parameter specifies the freeze date on which
166 * snapshot for Compensation Workbench Person is performed.
167 * @param p_ws_amt_edit_cd This parameter specifies the allocations amount edit
168 * code.
169 * @param p_ws_amt_edit_enf_cd_for_nul This parameter specifies allocations
170 * amount edit code for nulls.
171 * @param p_ws_over_budget_edit_cd This parameter specifies allocations over
172 * budget edit code.
173 * @param p_ws_over_budget_tol_pct This parameter specifies allocations over
174 * budget tolerance percentage.
175 * @param p_bdgt_over_budget_edit_cd This parameter specifies budgets over
176 * budget edit code.
177 * @param p_bdgt_over_budget_tol_pct This parameter specifies distribution
178 * budget over budget tolerance percentage.
179 * @param p_auto_distr_flag This parameter specifies a flag for automatic
180 * distribution.
181 * @param p_pqh_document_short_name This parameter is a short name for PQH
182 * (Public sector HR) document.
183 * @param p_ovrid_rt_strt_dt This parameter allows the user to override the
184 * effective date when post process is run to post data.
185 * @param p_do_not_process_flag If yes, then post process skips processing
186 * the particular local plan for which it is set.
187 * @param p_ovr_perf_revw_strt_dt This parameter overrides the effective date
188 * for performance related changes.
189 * @param p_post_zero_salary_increase If yes, then post process posts zero
190 * salary increase
191 * @param p_show_appraisals_n_days This parameter specifies the number of
192 * days within which completed appraisals will be shown in worksheet
193 * @param p_grade_range_validation This parameter specifies the validation
194 * of new salary against the grade range
195 * @param p_object_version_number If p_validate is false, then set to the
196 * version number of the created Compensation Workbench Plan. If p_validate is
197 * true, then the value will be null.
198 * @rep:displayname Create Compensation Workbench Plan
199 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
200 * @rep:lifecycle active
201 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
202 * @rep:scope public
203 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
204 */
205 --
206 -- {End Of Comments}
207 --
208 procedure create_plan_or_option
209 (p_validate in boolean default false
210 ,p_pl_id in number
211 ,p_oipl_id in number
212 ,p_lf_evt_ocrd_dt in date
213 ,p_effective_date in date default null
214 ,p_name in varchar2 default null
215 ,p_group_pl_id in number default null
216 ,p_group_oipl_id in number default null
217 ,p_opt_hidden_flag in varchar2 default null
218 ,p_opt_id in number default null
219 ,p_pl_uom in varchar2 default null
220 ,p_pl_ordr_num in number default null
221 ,p_oipl_ordr_num in number default null
222 ,p_pl_xchg_rate in number default null
223 ,p_opt_count in number default null
224 ,p_uses_bdgt_flag in varchar2 default null
225 ,p_prsrv_bdgt_cd in varchar2 default null
226 ,p_upd_start_dt in date default null
227 ,p_upd_end_dt in date default null
228 ,p_approval_mode in varchar2 default null
229 ,p_enrt_perd_start_dt in date default null
230 ,p_enrt_perd_end_dt in date default null
231 ,p_yr_perd_start_dt in date default null
232 ,p_yr_perd_end_dt in date default null
233 ,p_wthn_yr_start_dt in date default null
234 ,p_wthn_yr_end_dt in date default null
235 ,p_enrt_perd_id in number default null
236 ,p_yr_perd_id in number default null
237 ,p_business_group_id in number default null
238 ,p_perf_revw_strt_dt in date default null
239 ,p_asg_updt_eff_date in date default null
240 ,p_emp_interview_typ_cd in varchar2 default null
241 ,p_salary_change_reason in varchar2 default null
242 ,p_ws_abr_id in number default null
246 ,p_dist_bdgt_abr_id in number default null
243 ,p_ws_nnmntry_uom in varchar2 default null
244 ,p_ws_rndg_cd in varchar2 default null
245 ,p_ws_sub_acty_typ_cd in varchar2 default null
247 ,p_dist_bdgt_nnmntry_uom in varchar2 default null
248 ,p_dist_bdgt_rndg_cd in varchar2 default null
249 ,p_ws_bdgt_abr_id in number default null
250 ,p_ws_bdgt_nnmntry_uom in varchar2 default null
251 ,p_ws_bdgt_rndg_cd in varchar2 default null
252 ,p_rsrv_abr_id in number default null
253 ,p_rsrv_nnmntry_uom in varchar2 default null
254 ,p_rsrv_rndg_cd in varchar2 default null
255 ,p_elig_sal_abr_id in number default null
256 ,p_elig_sal_nnmntry_uom in varchar2 default null
257 ,p_elig_sal_rndg_cd in varchar2 default null
258 ,p_misc1_abr_id in number default null
259 ,p_misc1_nnmntry_uom in varchar2 default null
260 ,p_misc1_rndg_cd in varchar2 default null
261 ,p_misc2_abr_id in number default null
262 ,p_misc2_nnmntry_uom in varchar2 default null
263 ,p_misc2_rndg_cd in varchar2 default null
264 ,p_misc3_abr_id in number default null
265 ,p_misc3_nnmntry_uom in varchar2 default null
266 ,p_misc3_rndg_cd in varchar2 default null
267 ,p_stat_sal_abr_id in number default null
268 ,p_stat_sal_nnmntry_uom in varchar2 default null
269 ,p_stat_sal_rndg_cd in varchar2 default null
270 ,p_rec_abr_id in number default null
271 ,p_rec_nnmntry_uom in varchar2 default null
272 ,p_rec_rndg_cd in varchar2 default null
273 ,p_tot_comp_abr_id in number default null
274 ,p_tot_comp_nnmntry_uom in varchar2 default null
275 ,p_tot_comp_rndg_cd in varchar2 default null
276 ,p_oth_comp_abr_id in number default null
277 ,p_oth_comp_nnmntry_uom in varchar2 default null
278 ,p_oth_comp_rndg_cd in varchar2 default null
279 ,p_actual_flag in varchar2 default null
280 ,p_acty_ref_perd_cd in varchar2 default null
281 ,p_legislation_code in varchar2 default null
282 ,p_pl_annulization_factor in number default null
283 ,p_pl_stat_cd in varchar2 default null
284 ,p_uom_precision in number default null
285 ,p_ws_element_type_id in number default null
286 ,p_ws_input_value_id in number default null
287 ,p_data_freeze_date in date default null
288 ,p_ws_amt_edit_cd in varchar2 default null
289 ,p_ws_amt_edit_enf_cd_for_nul in varchar2 default null
290 ,p_ws_over_budget_edit_cd in varchar2 default null
291 ,p_ws_over_budget_tol_pct in number default null
292 ,p_bdgt_over_budget_edit_cd in varchar2 default null
293 ,p_bdgt_over_budget_tol_pct in number default null
294 ,p_auto_distr_flag in varchar2 default null
295 ,p_pqh_document_short_name in varchar2 default null
296 ,p_ovrid_rt_strt_dt in date default null
297 ,p_do_not_process_flag in varchar2 default null
298 ,p_ovr_perf_revw_strt_dt in date default null
299 ,p_post_zero_salary_increase in varchar2 default null
300 ,p_show_appraisals_n_days in number default null
301 ,p_grade_range_validation in varchar2 default null
302 ,p_object_version_number out nocopy number
303 );
304 --
305 -- ----------------------------------------------------------------------------
306 -- |--------------------------< update_plan_or_option >-----------------------|
307 -- ----------------------------------------------------------------------------
308 --
309 -- {Start Of Comments}
310 /*#
311 * This API updates compensation workbench plan and option information.
312 *
313 * This information is used by all self-service pages that update plan design
314 * data.
315 *
316 * <p><b>Licensing</b><br>
317 * This API is licensed for use with Human Resources.
318 *
319 * <p><b>Prerequisites</b><br>
320 * A Compensation Workbench Plan to update in the database exists.
321 *
322 * <p><b>Post Success</b><br>
323 * The Compensation Workbench Plan will be updated in the database.
324 *
325 * <p><b>Post Failure</b><br>
326 * The Compensation Workbench Plan will be not updated in the database.
327 *
328 * @param p_validate If true, then validation alone will be performed and the
329 * database will remain unchanged. If false and all validation checks pass,
330 * then the database will be modified.
331 * @param p_pl_id This parameter specifies the Compensation Workbench Plan.
332 * @param p_oipl_id This parameter specifies options for Compensation Workbench
333 * Plan.
334 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
335 * @param p_effective_date Determines when the DateTrack operation comes into
336 * force.
337 * @param p_name This parameter specifies the Compensation Workbench Plan name.
338 * @param p_group_pl_id This parameter specifies Compensation Workbench Group
339 * Plan.
340 * @param p_group_oipl_id This parameter specifies options for a Compensation
344 * @param p_opt_id This parameter specifies the option and is foreign Key to
341 * Workbench Group Plan.
342 * @param p_opt_hidden_flag This parameter specifies if the Compensation
343 * Workbench Plan options will be displayed in the SS pages.
345 * BEN_OPT_F.
346 * @param p_pl_uom This parameter specifies the Compensation Workbench Plan
347 * currency.
348 * @param p_pl_ordr_num This parameter specifies the Compensation Workbench
349 * Plan order number.
350 * @param p_oipl_ordr_num This parameter specifies the Compensation Workbench
351 * Plan options order number.
352 * @param p_pl_xchg_rate This parameter specifies the exchange rate for
353 * Compensation Workbench Plan currency.
354 * @param p_opt_count This parameter keeps count of plan options.
355 * @param p_uses_bdgt_flag This parameter specifies if budgeting is used or
356 * not.
357 * @param p_prsrv_bdgt_cd This parameter specifies if budget is stored as
358 * amount or percentage of eligible salaries.
359 * @param p_upd_start_dt Self Service update start date
360 * @param p_upd_end_dt Self Service update end date
361 * @param p_approval_mode This parameter specifies the approval mode for
362 * allocations submission. Valid values are defined in 'BEN_CWB_APPROVAL_MODE'
363 * lookup type.
364 * @param p_enrt_perd_start_dt {@rep:casecolumn
365 * BEN_CWB_PL_DSGN.ENRT_PERD_START_DT}
366 * @param p_enrt_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_END_DT}
367 * @param p_yr_perd_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_START_DT}
368 * @param p_yr_perd_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_END_DT}
369 * @param p_wthn_yr_start_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_START_DT}
370 * @param p_wthn_yr_end_dt {@rep:casecolumn BEN_CWB_PL_DSGN.WTHN_YR_END_DT}
371 * @param p_enrt_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.ENRT_PERD_ID}
372 * @param p_yr_perd_id {@rep:casecolumn BEN_CWB_PL_DSGN.YR_PERD_ID}
373 * @param p_business_group_id {@rep:casecolumn
374 * PER_ALL_ASSIGNMENTS_F.BUSINESS_GROUP_ID}
375 * @param p_perf_revw_strt_dt {@rep:casecolumn BEN_ENRT_PERD.PERF_REVW_STRT_DT}
376 * @param p_asg_updt_eff_date {@rep:casecolumn BEN_ENRT_PERD.ASG_UPDT_EFF_DATE}
377 * @param p_emp_interview_typ_cd This parameter specifies the performance
378 * rating type. Valid values are defined in 'EMP_INTERVIEW_TYPE' lookup type.
379 * @param p_salary_change_reason {@rep:casecolumn
380 * BEN_CWB_PL_DSGN.SALARY_CHANGE_REASON}
381 * @param p_ws_abr_id This parameter specifies worksheet rate. It is null if no
382 * worksheet rate is defined.
383 * @param p_ws_nnmntry_uom This parameter specifies the non-monetory units of
384 * measure such as stocks.
385 * @param p_ws_rndg_cd This parameter specifies the numeric rounding parameter.
386 * Valid values are defined in 'BEN_RNDG' lookup type.
387 * @param p_ws_sub_acty_typ_cd This parameter specifies worksheet rate sub
388 * activity type code. Valid values are defined in 'BEN_SUB_ACTY_TYP' lookup
389 * type.
390 * @param p_dist_bdgt_abr_id This parameter specifies the distribution budget
391 * rate.
392 * @param p_dist_bdgt_nnmntry_uom This parameter specifies the non-monetory
393 * units of measure such as stocks.
394 * @param p_dist_bdgt_rndg_cd This parameter specifies the numeric rounding
395 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
396 * @param p_ws_bdgt_abr_id This parameter specifies worksheet budget rate.
397 * @param p_ws_bdgt_nnmntry_uom This parameter specifies the non-monetory units
398 * of measure such as stocks.
399 * @param p_ws_bdgt_rndg_cd This parameter specifies the numeric rounding
400 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
401 * @param p_rsrv_abr_id This parameter specifies the reserve budget rate.
402 * @param p_rsrv_nnmntry_uom This parameter specifies the non-monetory units of
403 * measure such as stocks.
404 * @param p_rsrv_rndg_cd This parameter specifies the numeric rounding
405 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
406 * @param p_elig_sal_abr_id This parameter specifies the eligible salary rate.
407 * @param p_elig_sal_nnmntry_uom This parameter specifies the non-monetory
408 * units of measure such as stocks.
409 * @param p_elig_sal_rndg_cd This parameter specifies the non-monetory units of
410 * measure such as stocks.
411 * @param p_misc1_abr_id This parameter specifies miscellaneous 1 rate.
412 * @param p_misc1_nnmntry_uom This parameter specifies the non-monetory units
413 * of measure such as stocks.
414 * @param p_misc1_rndg_cd This parameter specifies the numeric rounding
415 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
416 * @param p_misc2_abr_id This parameter specifies miscellaneous 2 rate.
417 * @param p_misc2_nnmntry_uom This parameter specifies the non-monetory units
418 * of measure such as stocks.
419 * @param p_misc2_rndg_cd This parameter specifies the numeric rounding
420 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
421 * @param p_misc3_abr_id This parameter specifies miscellaneous 3 rate.
422 * @param p_misc3_nnmntry_uom This parameter specifies the non-monetory units
423 * of measure such as stocks.
424 * @param p_misc3_rndg_cd This parameter specifies the numeric rounding
425 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
426 * @param p_stat_sal_abr_id This parameter specifies the stated salary rate.
427 * @param p_stat_sal_nnmntry_uom This parameter specifies the non-monetory
428 * units of measure such as stocks.
429 * @param p_stat_sal_rndg_cd This parameter specifies the numeric rounding
430 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
431 * @param p_rec_abr_id This parameter specifies the recommended rate.
432 * @param p_rec_nnmntry_uom This parameter specifies the non-monetory units of
433 * measure such as stocks.
434 * @param p_rec_rndg_cd This parameter specifies the numeric rounding
435 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
439 * @param p_tot_comp_rndg_cd This parameter specifies the numeric rounding
436 * @param p_tot_comp_abr_id This parameter specifies the total compensation.
437 * @param p_tot_comp_nnmntry_uom This parameter specifies the non-monetory
438 * units of measure such as stocks.
440 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
441 * @param p_oth_comp_abr_id This parameter specifies the other compensation.
442 * @param p_oth_comp_nnmntry_uom This parameter specifies the non-monetory
443 * units of measure such as stocks.
444 * @param p_oth_comp_rndg_cd This parameter specifies the numeric rounding
445 * parameter. Valid values are defined in 'BEN_RNDG' lookup type.
446 * @param p_actual_flag This parameter specifies if balance type is actual or
447 * not.
448 * @param p_acty_ref_perd_cd This parameter specifies the activity reference
449 * period. Valid values are defined in 'BEN_ACTY_REF_PERD' lookup type.
450 * @param p_legislation_code This parameter specifies the legislation to which
451 * the information type applies. Foreign key is to FND_TERRITORIES.
452 * @param p_pl_annulization_factor {@rep:casecolumn
453 * BEN_CWB_PL_DSGN.PL_ANNULIZATION_FACTOR}
454 * @param p_pl_stat_cd This parameter specifies the plan status code. Valid
455 * values are defined in 'BEN_STAT' lookup type.
456 * @param p_uom_precision {@rep:casecolumn BEN_CWB_PL_DSGN.UOM_PRECISION}
457 * @param p_ws_element_type_id {@rep:casecolumn
458 * BEN_CWB_PL_DSGN.WS_ELEMENT_TYPE_ID}
459 * @param p_ws_input_value_id {@rep:casecolumn
460 * BEN_CWB_PL_DSGN.WS_INPUT_VALUE_ID}
461 * @param p_data_freeze_date This parameter specifies the freeze date on which
462 * snapshot for Compensation Workbench Person is performed.
463 * @param p_ws_amt_edit_cd This parameter specifies the allocations amount edit
464 * code.
465 * @param p_ws_amt_edit_enf_cd_for_nul This parameter specifies the allocations
466 * amount edit code for nulls.
467 * @param p_ws_over_budget_edit_cd This parameter specifies allocations over
468 * budget edit code.
469 * @param p_ws_over_budget_tol_pct This parameter specifies the allocations
470 * over budget tolerance percentage.
471 * @param p_bdgt_over_budget_edit_cd This parameter specifies the budgets over
472 * budget edit code.
473 * @param p_bdgt_over_budget_tol_pct This parameter specifies the distribution
474 * budget over budget tolerance percentage.
475 * @param p_auto_distr_flag This parameter specifies the flag for automatic
476 * distribution.
477 * @param p_pqh_document_short_name This parameter specifies the short name for
478 * PQH (Public sector HR) document.
479 * @param p_call_data_syncopation This parameter specifies if the internal
480 * procedure, which makes sure that all the child rows, get correct data from
481 * parent HR tables.
482 * @param p_ovrid_rt_strt_dt This parameter allows the user to override the
483 * effective date when post process is run to post data.
484 * @param p_do_not_process_flag If yes, then post process skips processing
485 * the particular local plan for which it is set.
486 * @param p_ovr_perf_revw_strt_dt This parameter overrides the effective date
487 * for performance related changes.
488 * @param p_post_zero_salary_increase If yes, then post process posts zero
489 * salary increase
490 * @param p_show_appraisals_n_days This parameter specifies the number of
491 * days within which completed appraisals will be shown in worksheet
492 * @param p_grade_range_validation This parameter specifies the validation
493 * of new salary against the grade range
494 * @param p_object_version_number Pass in the current version number of the
495 * Compensation Workbench Plan to be updated. When the API completes if
496 * p_validate is false, will be set to the new version number of the updated
497 * Compensation Workbench Plan. If p_validate is true will be set to the same
498 * value which was passed in.
499 * @param p_email_password_protected Specifies if the compensation statement pdf should be password protected
500 * or not
501 * @param p_email_cc_manager This parameter states if the compenstaion statement should also be copied to
502 * the manager
503 * @param p_email_subject The subject of the email
504 * @param p_email_content The content of the email
505 * @param p_email_sample_address The sample email address where the Compensation Statements are sent for testing purpose
506 * @rep:displayname Update Compensation Workbench Plan
507 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
508 * @rep:lifecycle active
509 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
510 * @rep:scope public
511 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
512 */
513 --
514 -- {End Of Comments}
515 --
516 procedure update_plan_or_option
517 (p_validate in boolean default false
518 ,p_pl_id in number
519 ,p_oipl_id in number
520 ,p_lf_evt_ocrd_dt in date
521 ,p_effective_date in date default hr_api.g_date
522 ,p_name in varchar2 default hr_api.g_varchar2
523 ,p_group_pl_id in number default hr_api.g_number
524 ,p_group_oipl_id in number default hr_api.g_number
525 ,p_opt_hidden_flag in varchar2 default hr_api.g_varchar2
526 ,p_opt_id in number default hr_api.g_number
527 ,p_pl_uom in varchar2 default hr_api.g_varchar2
528 ,p_pl_ordr_num in number default hr_api.g_number
529 ,p_oipl_ordr_num in number default hr_api.g_number
530 ,p_pl_xchg_rate in number default hr_api.g_number
531 ,p_opt_count in number default hr_api.g_number
532 ,p_uses_bdgt_flag in varchar2 default hr_api.g_varchar2
536 ,p_approval_mode in varchar2 default hr_api.g_varchar2
533 ,p_prsrv_bdgt_cd in varchar2 default hr_api.g_varchar2
534 ,p_upd_start_dt in date default hr_api.g_date
535 ,p_upd_end_dt in date default hr_api.g_date
537 ,p_enrt_perd_start_dt in date default hr_api.g_date
538 ,p_enrt_perd_end_dt in date default hr_api.g_date
539 ,p_yr_perd_start_dt in date default hr_api.g_date
540 ,p_yr_perd_end_dt in date default hr_api.g_date
541 ,p_wthn_yr_start_dt in date default hr_api.g_date
542 ,p_wthn_yr_end_dt in date default hr_api.g_date
543 ,p_enrt_perd_id in number default hr_api.g_number
544 ,p_yr_perd_id in number default hr_api.g_number
545 ,p_business_group_id in number default hr_api.g_number
546 ,p_perf_revw_strt_dt in date default hr_api.g_date
547 ,p_asg_updt_eff_date in date default hr_api.g_date
548 ,p_emp_interview_typ_cd in varchar2 default hr_api.g_varchar2
549 ,p_salary_change_reason in varchar2 default hr_api.g_varchar2
550 ,p_ws_abr_id in number default hr_api.g_number
551 ,p_ws_nnmntry_uom in varchar2 default hr_api.g_varchar2
552 ,p_ws_rndg_cd in varchar2 default hr_api.g_varchar2
553 ,p_ws_sub_acty_typ_cd in varchar2 default hr_api.g_varchar2
554 ,p_dist_bdgt_abr_id in number default hr_api.g_number
555 ,p_dist_bdgt_nnmntry_uom in varchar2 default hr_api.g_varchar2
556 ,p_dist_bdgt_rndg_cd in varchar2 default hr_api.g_varchar2
557 ,p_ws_bdgt_abr_id in number default hr_api.g_number
558 ,p_ws_bdgt_nnmntry_uom in varchar2 default hr_api.g_varchar2
559 ,p_ws_bdgt_rndg_cd in varchar2 default hr_api.g_varchar2
560 ,p_rsrv_abr_id in number default hr_api.g_number
561 ,p_rsrv_nnmntry_uom in varchar2 default hr_api.g_varchar2
562 ,p_rsrv_rndg_cd in varchar2 default hr_api.g_varchar2
563 ,p_elig_sal_abr_id in number default hr_api.g_number
564 ,p_elig_sal_nnmntry_uom in varchar2 default hr_api.g_varchar2
565 ,p_elig_sal_rndg_cd in varchar2 default hr_api.g_varchar2
566 ,p_misc1_abr_id in number default hr_api.g_number
567 ,p_misc1_nnmntry_uom in varchar2 default hr_api.g_varchar2
568 ,p_misc1_rndg_cd in varchar2 default hr_api.g_varchar2
569 ,p_misc2_abr_id in number default hr_api.g_number
570 ,p_misc2_nnmntry_uom in varchar2 default hr_api.g_varchar2
571 ,p_misc2_rndg_cd in varchar2 default hr_api.g_varchar2
572 ,p_misc3_abr_id in number default hr_api.g_number
573 ,p_misc3_nnmntry_uom in varchar2 default hr_api.g_varchar2
574 ,p_misc3_rndg_cd in varchar2 default hr_api.g_varchar2
575 ,p_stat_sal_abr_id in number default hr_api.g_number
576 ,p_stat_sal_nnmntry_uom in varchar2 default hr_api.g_varchar2
577 ,p_stat_sal_rndg_cd in varchar2 default hr_api.g_varchar2
578 ,p_rec_abr_id in number default hr_api.g_number
579 ,p_rec_nnmntry_uom in varchar2 default hr_api.g_varchar2
580 ,p_rec_rndg_cd in varchar2 default hr_api.g_varchar2
581 ,p_tot_comp_abr_id in number default hr_api.g_number
582 ,p_tot_comp_nnmntry_uom in varchar2 default hr_api.g_varchar2
583 ,p_tot_comp_rndg_cd in varchar2 default hr_api.g_varchar2
584 ,p_oth_comp_abr_id in number default hr_api.g_number
585 ,p_oth_comp_nnmntry_uom in varchar2 default hr_api.g_varchar2
586 ,p_oth_comp_rndg_cd in varchar2 default hr_api.g_varchar2
587 ,p_actual_flag in varchar2 default hr_api.g_varchar2
588 ,p_acty_ref_perd_cd in varchar2 default hr_api.g_varchar2
589 ,p_legislation_code in varchar2 default hr_api.g_varchar2
590 ,p_pl_annulization_factor in number default hr_api.g_number
591 ,p_pl_stat_cd in varchar2 default hr_api.g_varchar2
592 ,p_uom_precision in number default hr_api.g_number
593 ,p_ws_element_type_id in number default hr_api.g_number
594 ,p_ws_input_value_id in number default hr_api.g_number
595 ,p_data_freeze_date in date default hr_api.g_date
596 ,p_ws_amt_edit_cd in varchar2 default hr_api.g_varchar2
597 ,p_ws_amt_edit_enf_cd_for_nul in varchar2 default hr_api.g_varchar2
598 ,p_ws_over_budget_edit_cd in varchar2 default hr_api.g_varchar2
599 ,p_ws_over_budget_tol_pct in number default hr_api.g_number
600 ,p_bdgt_over_budget_edit_cd in varchar2 default hr_api.g_varchar2
601 ,p_bdgt_over_budget_tol_pct in number default hr_api.g_number
602 ,p_auto_distr_flag in varchar2 default hr_api.g_varchar2
603 ,p_pqh_document_short_name in varchar2 default hr_api.g_varchar2
604 ,p_call_data_syncopation in varchar2 default 'Y'
605 ,p_ovrid_rt_strt_dt in date default hr_api.g_date
606 ,p_do_not_process_flag in varchar2 default 'N'
607 ,p_ovr_perf_revw_strt_dt in date default hr_api.g_date
608 ,p_post_zero_salary_increase in varchar2 default hr_api.g_varchar2
609 ,p_show_appraisals_n_days in number default hr_api.g_number
610 ,p_grade_range_validation in varchar2 default hr_api.g_varchar2
611 ,p_object_version_number in out nocopy number
612 ,p_email_password_protected in varchar2 default hr_api.g_varchar2
613 ,p_email_cc_manager in varchar2 default hr_api.g_varchar2
614 ,p_email_subject in varchar2 default hr_api.g_varchar2
615 ,p_email_content in clob default empty_clob()
616 ,p_email_sample_address in varchar2 default hr_api.g_varchar2
617 );
618 --
619 -- ----------------------------------------------------------------------------
620 -- |--------------------------< delete_plan_or_option >-----------------------|
621 -- ----------------------------------------------------------------------------
622 --
623 -- {Start Of Comments}
624 /*#
625 * This API deletes compensation workbench plan and option information.
626 *
627 * Any self-service page which deletes plan design data uses this API.
628 *
629 * <p><b>Licensing</b><br>
630 * This API is licensed for use with Human Resources.
631 *
632 * <p><b>Prerequisites</b><br>
633 * A Compensation Workbench Plan to delete exists in the database.
634 *
635 * <p><b>Post Success</b><br>
636 * The Compensation Workbench Plan will be deleted in the database.
637 *
638 * <p><b>Post Failure</b><br>
639 * The Compensation Workbench Plan will be not deleted from the database.
640 *
641 * @param p_validate If true, then validation alone will be performed and the
642 * database will remain unchanged. If false and all validation checks pass,
643 * then the database will be modified.
644 * @param p_pl_id This parameter specifies the Compensation Workbench Plan.
645 * @param p_oipl_id This Parameter specifies the options for Compensation
646 * Workbench Plan.
647 * @param p_lf_evt_ocrd_dt {@rep:casecolumn BEN_CWB_PL_DSGN.LF_EVT_OCRD_DT}
648 * @param p_object_version_number Current version number of the Compensation
649 * Workbench Plan to be deleted.
650 * @rep:displayname Delete Compensation Workbench Plan
651 * @rep:category BUSINESS_ENTITY BEN_CWB_PLAN
652 * @rep:lifecycle active
653 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
654 * @rep:scope public
655 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
656 */
657 --
658 -- {End Of Comments}
659 --
660 procedure delete_plan_or_option
661 (p_validate in boolean default false
662 ,p_pl_id in number
663 ,p_oipl_id in number
664 ,p_lf_evt_ocrd_dt in date
665 ,p_object_version_number in number
666 );
667 end BEN_CWB_PL_DSGN_API;
[Home] [Help]