!!!EXTRACT BENEFIT PLANS

!!Processing Information
The Extract Benefit Plans (XBPN) screen is designed to extract benefit plans including their coverages from an [{$applicationname}] database.

The following information will be extracted with XBPN:
*Benefit Calendars
*Remittance Reports
*Benefit Plan Types
*Frequencies
*Change Reasons
*Employment Statues
*BC Rules
*Benefit Components
*Plan Definitions

Before the XBPN can be run there are [site preferences|SYSTEM PREFERENCE] that must be defined. Within the [IMST] screen, the administrator must define where the Extract and Load files are located and where the load functions are to write the exception files to. These locations are used by the functions to create and retrieve information. The customer can modify these values to represent any directory on their system.

The extract directory is defined using the [EXTRCT DATA FLDR] preference. The load directory is defined using the [LOAD DATA FLDR] preference. The [ATTACHMENTS FLDR|ATTACHMENTS FLDR(System_Preference)] must be specified so the load functions know where to write the report exceptions log to. 

Lexicons, [UserCalcs|USERCALC], [pay components|PAY COMPONENTS], and [elements|PAY ELEMENTS] are not extracted with the XBPN. This means that prior to running the [LMDATA] to load the new benefit plan, any lexicons (e.g. Plan Election Set), [UserCalcs|USERCALC], [pay components|PAY COMPONENTS] or [elements|PAY ELEMENTS] associated to the benefit plan must already exist in the receiving database, otherwise the [LMDATA] will fail to load. Lexicons may be extracted via the [XMLN] function and user calcs may be extracted via the [XMUC] function. Once they have been extracted they must be loaded into the other database using the [LMDATA] prior to the new benefit plan being loaded. [Pay components|PAY COMPONENTS] or [elements|PAY ELEMENTS] will have to be entered manually. 

Other items that are not extracted are the plan's entry in the Benefit Schedule ([IBSC]) screen as well as any association to an Event for Open Enrollments. These can be added after the [LMDATA] has been run.

Once the XBPN function has been run, it will have created an .xml and .data file, it is suggested that the user reviews the .xml file to ensure the correct data was extracted.

The user will then load this data file into the receiving database via the [LMDATA] process.
----
!!Report Parameters & Filters

||Report Parameters||
|File Name|Mandatory\\This is the name of the file that will be created by the XBPN.\\ The name should be representative of the data that is to be extracted.  

||Report Filters||
|Entity|Optional, LOV Available\\This will narrow the list of benefit plans to the Entity selected.
|Remit Report|Optional, LOV Available\\This will narrow the list of benefit plans tied to the Remittance Report selected.
|Plan Type|Optional, LOV Available\\This will narrow the list of benefit plans to those tied to the selected Plan Type.
|Plan|Optional, LOV Available\\This will narrow the list of benefit plans extracted to those that are selected.


----
![Notes|Edit:Internal.XBPN] 	
[{InsertPage page='Internal.XBPN' default='Click to create a new notes page'}]