This is version 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 . It is not the current version, and thus it cannot be edited.

Back to current versionRestore this version

Benefit Enrollment Information#

Functionality:#

This function retrieves information as seen on IBEN, for an employee's benefit enrollment.

Parameters:#

EEM_ID	The actual ID for the employment record of the employee you are getting data for
PLAN_CODE	The plan code you are retrieving
WHAT	Identifies which element of the IBEN display you want to access. This must be one of the values as noted below.
AS_OF	Optional. Provides a date frame to retrieve the data. If it is not provided, the current system date will be used.
FLAGS	Optional. If set to "N" will return values for un-enrolled records. Otherwise only Enrolled records are retrieved.

WHAT Parameter Values#

COVERAGE_CODE	The actual coverage code that the employee is enrolled in
COVERAGE_STEP_CODE	The coverage step code that the employee is enrolled in
PLAN_REG_NUMBER	The plan registration number from the employee's enrollment record
ENROLLMENT_STATUS	The saved value from the ENROLLMENT_STATUS
ELIGIBILITY_START_DATE	The eligibility start date of the employee's enrollment
ELIGIBILITY_END_DATE	The eligibility end date of the employee's enrollment
PREMIUM_START_DATE	The premium start date of the employee's enrollment
PREMIUM_END_DATE	The premium end date of the employee's enrollment
BC-Bnnnn	Returns the AMOUNT or AMOUNT_OVERRIDE for the component value where nnnn is the benefit component code
ON_SCHEDULE	If the employee indicated is eligible for the plan(according to IBSC schedule only) , you will get back “Y”. Otherwise you will get back “N”. See below for schedule eligibility steps.

Returns: #

Varchar2 (regardless of the type of data being requested)

Errors: #

• If the employee is not enrolled as of the date specified, and the FLAGS parameter is set to "Y" (default) then NULL is returned
• If an invalid PLAN_CODE parameter is passed, then NO SUCH PLAN is returned
• If no Enrollment record is found for that employee/plan combination, then NO ENROLLMENT is returned
• If no enrollment detail information is found as of the date specified (corrupt data), then NO BEN DETAIL is returned
• If a bad benefit component code is provided, then BAD BC CODE is returned
• If the BC Code provided does not appear in the enrollment record (plan definition), then NO BC CODE is returned
• If an invalid WHAT parameter is provided, then BAD WHAT is returned.
• If you are requesting ON_SCHEDULE, and there is an issue retrieving the employee assignment information NO ASSIGNMENT INFO is returned
• If you are requesting ON_SCHEDULE, and there is an issue retrieving the benefit schedule information *BAD SCHEDULE is returned

Example: #

P2K_PU.BEN(~,'VISION','ELIGIBILITY_START_DATE')

Will return the ELIGIBILITY_START_DATE for the employee's VISION plan enrollment record.

P2K_PU.BEN(~,'MED KAISER FLEX','BC-B1040')

Will return the deduction amount BC-B1040 for the employee's MED KAISER FLEX

Notes#

• If a Benefit Component value is requested, the AMOUNT_OVERRIDE will be returned. If this field is zero or NULL, then the AMOUNT field will be returned.

• If you want to retrieve records even if the employee is no longer enrolled in the plan, then set the FLAGS parameter to "N"

• Eligibility (for ON_SCHEDULE) is determined by:
  • Plan is Not scheduled
  • Employee is specifically scheduled for this plan
  • Employee’s Entity-Unit-Group (as of the AS_OF date) are scheduled for this plan
  • Employee’s Entity-Unit (as of the AS_OF date) are scheduled for this plan
  • Employee’s Entity (as of the AS_OF date) are scheduled for this plan
  • All employees are scheduled for this plan

---

Notes#

Click to create a new notes page