1 PACKAGE HR_FI_EMPLOYEE_API AUTHID CURRENT_USER AS
2 /* $Header: peempfii.pkh 120.5.12010000.1 2008/07/28 04:34:56 appldev ship $ */
3 /*#
4 * This package contains employee APIs for Finland.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Employee for Finland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_fi_employee >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new employee record with a default primary assignment and
17 * a period of service for the employee.
18 *
19 * This API is effectively an alternative to the API create_employee. If
20 * p_validate is set to false, an employee is created.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * When creating an employee, a business group for the Finland legislation must
27 * already exist. Also, a valid person_type_id, with a corresponding system
28 * type of 'EMP' must be active and in the same business group as the employee
29 * being created.
30 *
31 * <p><b>Post Success</b><br>
32 * The person, primary assignment, and period of service will be successfully
33 * inserted into the database.
34 *
35 * <p><b>Post Failure</b><br>
36 * The person, primary assignment or period of service will not be created and
37 * an error will be raised.
38 *
39 * @param p_validate If true, then validation alone will be performed and the
40 * database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_hire_date Hire Date.
43 * @param p_business_group_id The employee's business group.
44 * @param p_last_name The employee's last name.
45 * @param p_sex Legal gender. Valid values are defined by the SEX lookup type.
46 * @param p_person_type_id The person type id. If this value is omitted, then
47 * the person_type_id of the default `EMP' system person type in the employee's
48 * business group is used.
49 * @param p_comments Employee comment text.
50 * @param p_date_employee_data_verified The date on which the employee data was
51 * last verified.
52 * @param p_date_of_birth The employee's date of birth.
53 * @param p_email_address The employee's email address.
54 * @param p_employee_number The employee's number. If the number generation
55 * method is Manual, then this parameter is mandatory. If the number generation
56 * method is Automatic, then the value of this parameter must be NULL. If
57 * p_validate is false and the employee number generation method is Automatic,
58 * then this will be set to the generated employee number of the person
59 * created. If p_validate is false and the employee number generation method is
60 * Manual, then this will be set to the same value. If p_validate is true, then
61 * this will be set to the same value.
62 * @param p_expense_check_send_to_addres The employee's mailing address.
63 * @param p_first_name The employee's first name.
64 * @param p_known_as The employee's alternative name.
65 * @param p_marital_status The employee's marital status. Valid values are
66 * defined in the 'MAR_STATUS' lookup type.
67 * @param p_nationality The employee's nationality.
68 * @param p_national_identifier The employee's national identifier.
69 * @param p_previous_last_name The employee's previous last name.
70 * @param p_registered_disabled_flag Flag indicating whether the person is
71 * classified as disabled.
72 * @param p_title The employee's title. Valid values are defined in the 'TITLE'
73 * lookup type.
74 * @param p_vendor_id Obsolete parameter, do not use.
75 * @param p_work_telephone The employee's work telephone.
76 * @param p_attribute_category This context value determines which flexfield
77 * structure to use with the descriptive flexfield segments.
78 * @param p_attribute1 Descriptive flexfield segment.
79 * @param p_attribute2 Descriptive flexfield segment.
80 * @param p_attribute3 Descriptive flexfield segment.
81 * @param p_attribute4 Descriptive flexfield segment.
82 * @param p_attribute5 Descriptive flexfield segment.
83 * @param p_attribute6 Descriptive flexfield segment.
84 * @param p_attribute7 Descriptive flexfield segment.
85 * @param p_attribute8 Descriptive flexfield segment.
86 * @param p_attribute9 Descriptive flexfield segment.
87 * @param p_attribute10 Descriptive flexfield segment.
88 * @param p_attribute11 Descriptive flexfield segment.
89 * @param p_attribute12 Descriptive flexfield segment.
90 * @param p_attribute13 Descriptive flexfield segment.
91 * @param p_attribute14 Descriptive flexfield segment.
92 * @param p_attribute15 Descriptive flexfield segment.
93 * @param p_attribute16 Descriptive flexfield segment.
94 * @param p_attribute17 Descriptive flexfield segment.
95 * @param p_attribute18 Descriptive flexfield segment.
96 * @param p_attribute19 Descriptive flexfield segment.
97 * @param p_attribute20 Descriptive flexfield segment.
98 * @param p_attribute21 Descriptive flexfield segment.
99 * @param p_attribute22 Descriptive flexfield segment.
100 * @param p_attribute23 Descriptive flexfield segment.
101 * @param p_attribute24 Descriptive flexfield segment.
102 * @param p_attribute25 Descriptive flexfield segment.
103 * @param p_attribute26 Descriptive flexfield segment.
104 * @param p_attribute27 Descriptive flexfield segment.
105 * @param p_attribute28 Descriptive flexfield segment.
106 * @param p_attribute29 Descriptive flexfield segment.
107 * @param p_attribute30 Descriptive flexfield segment.
108 * @param p_place_of_residence The employee's place of residence.
109 * @param p_secondary_email The employee's secondary e-mail address.
110 * @param p_epost_address The employee's e-post address.
111 * @param p_speed_dial_number The employee's speed dial number.
112 * @param p_qualification The employee's qualification.
113 * @param p_level The level values are defined in the 'FI_QUAL_LEVEL' lookup
114 * type.
115 * @param p_field The field values are defined by 'FI_QUAL_FIELD' lookup type.
116 * @param p_retirement_date The employee's retirement date.
117 * @param p_date_of_death The employee's date of death.
118 * @param p_background_check_status Y/N flag indicates whether background check
119 * has been performed.
120 * @param p_background_date_check Date on which the background check was
121 * performed.
122 * @param p_blood_type Blood Type.
123 * @param p_correspondence_language The employee's preferred language for
124 * correspondence.
125 * @param p_fast_path_employee Obsolete parameter, do not use.
126 * @param p_fte_capacity Full time/part time availability for work.
127 * @param p_honors Honors or degrees awarded.
128 * @param p_internal_location Internal location of office.
129 * @param p_last_medical_test_by Name of physician who performed last medical
130 * test.
131 * @param p_last_medical_test_date Date of last medical test.
132 * @param p_mailstop Office identifier for internal mail.
133 * @param p_office_number Office number.
134 * @param p_on_military_service Y/N flag indicating whether person is employed
135 * in military service.
136 * @param p_projected_start_date Obsolete parameter, do not use.
137 * @param p_resume_exists Y/N flag indicating whether resume is on file.
138 * @param p_resume_last_updated Date resume last updated.
139 * @param p_second_passport_exists Y/N flag indicating whether the person has
140 * multiple passports.
141 * @param p_student_status Full time/part time status of student.
142 * @param p_work_schedule Type of work schedule indicating which days a person
143 * works.Valid values are defined in the 'WORK_SCHEDULE' lookup type.
144 * @param p_benefit_group_id Benefit group id.
145 * @param p_receipt_of_death_cert_date Date the death certificate is received.
146 * @param p_coord_ben_med_pln_no Secondary medical plan name. Column used for
147 * external processing.
148 * @param p_coord_ben_no_cvg_flag No other coverage flag.
149 * @param p_coord_ben_med_ext_er Secondary medical coverage external employer.
150 * @param p_coord_ben_med_pl_name Secondary medical coverage name.
151 * @param p_coord_ben_med_insr_crr_name Secondary medical coverage insurance
152 * carrier.
153 * @param p_coord_ben_med_insr_crr_ident Secondary medical coverage insurance
154 * carrier id.
155 * @param p_coord_ben_med_cvg_strt_dt Secondary medical coverage effective
156 * start date.
157 * @param p_coord_ben_med_cvg_end_dt Secondary medical coverage effective end
158 * date.
159 * @param p_uses_tobacco_flag Type of tobacco used by the employee. Valid
160 * values are defined in the 'TOBACCO_USER' lookup type.
161 * @param p_dpdnt_adoption_date Dependent's adoption date.
162 * @param p_dpdnt_vlntry_svce_flag Dependent's voluntary service flag.
163 * @param p_original_date_of_hire Original date of hire.
164 * @param p_adjusted_svc_date Adjusted service date.
165 * @param p_town_of_birth Town or city of birth.
166 * @param p_region_of_birth Geographical region of birth.
167 * @param p_country_of_birth Country of birth.
168 * @param p_global_person_id Global ID for the person.
169 * @param p_person_id If p_validate is false, then this uniquely identifies the
170 * person created. If p_validate is true, then set to null.
171 * @param p_assignment_id If p_validate is false, then this uniquely identifies
172 * the created assignment. If p_validate is true, then set to null.
173 * @param p_per_object_version_number If p_validate is false, then set to the
174 * version number of the created person. If p_validate is true, then the value
175 * will be null.
176 * @param p_asg_object_version_number If p_validate is false, then this
177 * parameter is set to the version number of the assignment created. If
178 * p_validate is true, then this parameter is null.
179 * @param p_per_effective_start_date If p_validate is false, then this will be
180 * set to the effective start date of the person. If p_validate is true, then
181 * this will be null.
182 * @param p_per_effective_end_date If p_validate is false, then this will be
183 * set to the effective end date of the person. If p_validate is true, then
184 * this will be null.
185 * @param p_full_name If p_validate is false, then this will be set to the
186 * complete full name of the person. If p_validate is true, then this will be
187 * null.
188 * @param p_per_comment_id If p_validate is false, then this will be set to the
189 * id of the corresponding person comment row, if any comment text exists. If
190 * p_validate is true, then this will be null.
191 * @param p_assignment_sequence If p_validate is false, then this will be set
192 * to the sequence number of the primary assignment. If p_validate is true,
193 * then this will be null.
194 * @param p_assignment_number If p_validate is false, then this will be set to
195 * the assignment number of the primary assignment. If p_validate is true, then
196 * this will be null.
197 * @param p_name_combination_warning If set to true, then the combination of
198 * last name, first name and date of birth existed prior to calling this API.
199 * @param p_assign_payroll_warning If set to true, then the date of birth is
200 * not entered. If set to false, then the date of birth has been entered.
201 * Indicates if it will be possible to set the payroll on any of this person's
202 * assignments.
203 * @param p_orig_hire_warning If set to true, an orginal date of hire exists
204 * for a person who has never been an employee.
205 * @param p_union_name Name of the Trade Union to which the employee belongs.
206 * @param p_membership_number Employee's Trade Union membership number.
207 * @param p_payment_mode Mode of Payment. The lookup type
208 * 'FI_TRADE_UNION_FEE_TYPE' defines the valid values.
209 * @param p_fixed_amount Amount to deducted as Union membership
210 * fees.
211 * @param p_percentage Percentage of gross salary to deducted as Union
212 * membership fees.
213 * @param p_pension_joining_date Pension joining date.
214 * @param p_pension_type Type of Pension. The lookup type
215 * 'FI_PENSION_TYPES defines the valid values.
216 * @param p_pension_group Pension Group.
217 * @param p_planned_retirement_age Planned retirement date.
218 * @param p_membership_start_date Union membership start date.
219 * @param p_membership_end_date Union membership end date.
220 * @param p_termination_date Termination date.
221 * @param p_termination_reason Termination reason.
222 * @param p_mother_tongue Mother Tongue
223 * @param p_foreign_personal_id Foreign Personal ID
224 * @param p_pension_insurance_number Pension Insurance Number
225 * @rep:displayname Create Employee for Finland
226 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE
227 * @rep:lifecycle active
228 * @rep:scope public
229 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
230 */
231 --
232 -- {End Of Comments}
233 --
234 PROCEDURE create_fi_employee
235 (p_validate in boolean default false
236 ,p_hire_date in date
237 ,p_business_group_id in number
238 ,p_last_name in varchar2
239 ,p_sex in varchar2
240 ,p_person_type_id in number default null
241 ,p_comments in varchar2 default null
242 ,p_date_employee_data_verified in date default null
243 ,p_date_of_birth in date default null
244 ,p_email_address in varchar2 default null
245 ,p_employee_number in out nocopy varchar2
246 ,p_expense_check_send_to_addres in varchar2 default null
247 ,p_first_name in varchar2
248 ,p_known_as in varchar2 default null
249 ,p_marital_status in varchar2 default null
250 ,p_nationality in varchar2
251 ,p_national_identifier in varchar2 default null
252 ,p_previous_last_name in varchar2 default null
253 ,p_registered_disabled_flag in varchar2 default null
254 ,p_title in varchar2
255 ,p_vendor_id in number default null
256 ,p_work_telephone in varchar2 default null
257 ,p_attribute_category in varchar2 default null
258 ,p_attribute1 in varchar2 default null
259 ,p_attribute2 in varchar2 default null
260 ,p_attribute3 in varchar2 default null
264 ,p_attribute7 in varchar2 default null
261 ,p_attribute4 in varchar2 default null
262 ,p_attribute5 in varchar2 default null
263 ,p_attribute6 in varchar2 default null
265 ,p_attribute8 in varchar2 default null
266 ,p_attribute9 in varchar2 default null
267 ,p_attribute10 in varchar2 default null
268 ,p_attribute11 in varchar2 default null
269 ,p_attribute12 in varchar2 default null
270 ,p_attribute13 in varchar2 default null
271 ,p_attribute14 in varchar2 default null
272 ,p_attribute15 in varchar2 default null
273 ,p_attribute16 in varchar2 default null
274 ,p_attribute17 in varchar2 default null
275 ,p_attribute18 in varchar2 default null
276 ,p_attribute19 in varchar2 default null
277 ,p_attribute20 in varchar2 default null
278 ,p_attribute21 in varchar2 default null
279 ,p_attribute22 in varchar2 default null
280 ,p_attribute23 in varchar2 default null
281 ,p_attribute24 in varchar2 default null
282 ,p_attribute25 in varchar2 default null
283 ,p_attribute26 in varchar2 default null
284 ,p_attribute27 in varchar2 default null
285 ,p_attribute28 in varchar2 default null
286 ,p_attribute29 in varchar2 default null
287 ,p_attribute30 in varchar2 default null
288 ,p_place_of_residence in varchar2 default null
289 ,p_secondary_email in varchar2 default null
290 ,p_epost_address in varchar2 default null
291 ,p_speed_dial_number in varchar2 default null
292 ,p_qualification in varchar2 default null
293 ,p_level in varchar2 default null
294 ,p_field in varchar2 default null
295 ,p_retirement_date in varchar2 default null
296 ,p_union_name in varchar2 default null
297 ,p_membership_number in varchar2 default null
298 ,p_payment_mode in varchar2 default null
299 ,p_fixed_amount in varchar2 default null
300 ,p_percentage in varchar2 default null
301 ,p_pension_joining_date in varchar2 default null
302 ,p_pension_type in varchar2 default null
303 ,p_pension_group in varchar2 default null
304 ,p_planned_retirement_age in varchar2 default null
305 ,p_membership_start_date in varchar2 default null
306 ,p_membership_end_date in varchar2 default null
307 ,p_termination_date in varchar2 default null
308 ,p_termination_reason in varchar2 default null
309 ,p_mother_tongue in varchar2 default null
310 ,p_foreign_personal_id in varchar2 default null
311 ,p_pension_insurance_number in varchar2 default null
312 ,p_date_of_death in date default null
313 ,p_background_check_status in varchar2 default null
314 ,p_background_date_check in date default null
315 ,p_blood_type in varchar2 default null
316 ,p_correspondence_language in varchar2 default null
317 ,p_fast_path_employee in varchar2 default null
318 ,p_fte_capacity in number default null
319 ,p_honors in varchar2 default null
320 ,p_internal_location in varchar2 default null
321 ,p_last_medical_test_by in varchar2 default null
322 ,p_last_medical_test_date in date default null
323 ,p_mailstop in varchar2 default null
324 ,p_office_number in varchar2 default null
325 ,p_on_military_service in varchar2 default null
326 ,p_projected_start_date in date default null
327 ,p_resume_exists in varchar2 default null
328 ,p_resume_last_updated in date default null
329 ,p_second_passport_exists in varchar2 default null
330 ,p_student_status in varchar2 default null
331 ,p_work_schedule in varchar2 default null
332 ,p_benefit_group_id in number default null
333 ,p_receipt_of_death_cert_date in date default null
334 ,p_coord_ben_med_pln_no in varchar2 default null
335 ,p_coord_ben_no_cvg_flag in varchar2 default 'N'
336 ,p_coord_ben_med_ext_er in varchar2 default null
337 ,p_coord_ben_med_pl_name in varchar2 default null
338 ,p_coord_ben_med_insr_crr_name in varchar2 default null
339 ,p_coord_ben_med_insr_crr_ident in varchar2 default null
340 ,p_coord_ben_med_cvg_strt_dt in date default null
341 ,p_coord_ben_med_cvg_end_dt in date default null
342 ,p_uses_tobacco_flag in varchar2 default null
343 ,p_dpdnt_adoption_date in date default null
344 ,p_dpdnt_vlntry_svce_flag in varchar2 default 'N'
345 ,p_original_date_of_hire in date default null
346 ,p_adjusted_svc_date in date default null
347 ,p_town_of_birth in varchar2 default null
348 ,p_region_of_birth in varchar2 default null
349 ,p_country_of_birth in varchar2 default null
350 ,p_global_person_id in varchar2 default null
351 ,p_person_id out nocopy number
352 ,p_assignment_id out nocopy number
353 ,p_per_object_version_number out nocopy number
354 ,p_asg_object_version_number out nocopy number
355 ,p_per_effective_start_date out nocopy date
356 ,p_per_effective_end_date out nocopy date
357 ,p_full_name out nocopy varchar2
358 ,p_per_comment_id out nocopy number
359 ,p_assignment_sequence out nocopy number
360 ,p_assignment_number out nocopy varchar2
361 ,p_name_combination_warning out nocopy boolean
362 ,p_assign_payroll_warning out nocopy boolean
363 ,p_orig_hire_warning out nocopy boolean);
364 --
365
366
367
368 END HR_FI_EMPLOYEE_API;
[Home] [Help]