SAP ABAP IMG Activity HR_ECM_00_AD_E05 (Business Add-In: Determine Eligibility)
Hierarchy
EA-HRGXX (Software Component) Sub component EA-HRGXX of EA-HR
   PA-EC-AD (Application Component) Compensation Administration
     PAOC_ECM_ADM_BL (Package) Compensation Administration - Business Logic
IMG Activity
ID HR_ECM_00_AD_E05 Business Add-In: Determine Eligibility  
Transaction Code S_ALN_01002088   (empty) 
Created on 20030331    
Customizing Attributes HR_ECM_00_AD_3_2_E   Compensation Administration - Not required - Not critical - User Exits 
Customizing Activity HR_ECM_00_AD_E05   BAdI HRECM00_ELIGIBILITY 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name HRECM00_ELIGIBILITY    

Implement this Business Add-In to check an employee's eligibility for a compensation plan according to your customer-specific requirements.

The Business Add-In consists of the three methods described below.

CHECK_ELIGIBILITY

This method replaces the complete standard algorithm to check the employee's micro eligibiliy by a customer-specific routine.

The following import parameters are provided:

  • PERNR
    Personnel number.
  • CITEM
    Compensation review item to be processed. Using this item, you can retrieve the compensation plan and review by reading customizing table T71ADM09.
  • CAREA
    Compensation area under which the plan is processed.
  • MESSAGE_HANDLER
    Reference to interface IF_HRPA_MESSAGE_HANDLER. If the eligibility check triggers any messages that should be sent to the frontend, you can add them to the message list using method ADD_MESSAGE of this interface or function module HR_ECM_ADD_MESSAGE.

The following export parameters must be provided by your coding:

  • XELIG
    Indicator that enables you to specify whether an employee is eligible.
  • ELIDT
    If an employee is eligible but only as of a certain date, for example at the end of a waiting period, this date should be provided here. By leaving the parameter blank, no restrictions apply.
  • PROG_PERIOD_TAB
    This table contains program period intervals. It is required for the proration of guidelines, if a proration rule is assigned in view "Define Guidelines", and for the evaluation of guideline values, if the guideline key date is configured as "End of program period" in view "Assign Compensation Review Attributes". In this case, the guideline is evaluated for each table entry separately.
  • IS_OK
    Indicator to be set to SPACE if any serious error has prevented the method from obtaining a reasonable result. Otherwise it should be set to 'X'. Non-eligible employees are not considered as a critical error.
  • PROCESS_STANDARD
    Indicator to be set to 'X' if you want the system to ignore the result of your implementation and perform the standard routine.

CHECK_MICRO_ELIGIBILITY

With this method, you can define micro eligibility check criteria that are performed in addition to the standard checks. You can also implement another algorithm for the evaluation of the waiting period end date.

The following import parameters are provided:

  • PERNR
    Personnel number.
  • ELKDT
    Eligibility check key date.
  • CAREA
    Compensation area under which the plan is processed.
  • CPLAN
    Compensation plan for which additional criteria should be checked.
  • MESSAGE_HANDLER
    See method CHECK_ELIGIBLITY.

The following export parameters must be provided by your coding:

  • XELIG
    Indicator that enables you to specify whether an employee fulfills additional eligibility criteria.
  • IS_OK
    See method CHECK_ELIGIBILITY.

The following changing parameter is available:

  • ELIDT
    On input, this parameter is filled with the earliest date the employee is eligible according to the waiting period definition in view "Define Eligibility Rules". This date can be changed by your routine. If empty, no restrictions apply.

GET_PROGRAM_PERIOD

With this method, you can replace the standard routine to evaluate the program period, that is, the period during which the employee is eligible according to the compensation program stored in infotype Compensation Program ( 0758).

The following import parameters are provided:

  • PERNR
    Personnel number.
  • CAREA
    Compensation area under which the plan is processed.
  • CPLAN
    Compensation plan for which program period has to be evaluated.
  • EVBEG
    Begin date of evaluation period. The resulting program period should be a subset of the evaluation period.
  • EVEND
    End of evaluation period.
  • MESSAGE_HANDLER
    See method CHECK_ELIGIBILITY.

The following export parameters must be provided by your coding:

  • PROG_PERIOD_TAB
    See method CHECK_ELIGIBILITY.
  • IS_OK
    Indicator to be set to SPACE if any serious error has prevented the method from obtaining a reasonable result. Otherwise it should be set to 'X'. An empty program period tab due to non-eligiblity is not considered as a critical error.
  • PROCESS_STANDARD
    Indicator to be set to 'X' if you want the system to ignore the result of your implementation and perform the standard routine.

Example

  • Employees are eligible for a special bonus plan only if they did not receive this bonus more than twice in the previous calendar year.
  • Employees have to wait three months after a reallocation before they can get a salary adjustment. The reallocation date is stored on a customer-specific infotype.
  • The program period should not be evaluated according to records of infotype 0758 but to organizational assignment criteria stored on infotype Organizational Assignment (0001).

Requirements

Standard settings

Recommendation

Activities

1. In the dialog box, enter a name for the BAdI implementation in the Implementation field, and choose Create.

The screen for creating BAdI implementations is now displayed.

2. Enter a short text for the implementation in the Short text for implementation field.

3. From the tab index, choose Interface.

The Name of implemented class field is already filled on the tab page, as a class name was automatically assigned to the implementation when you named it.

4. Save your entries, and assign the implementation to a development class.

5. Place the cursor on the method, and double-click to enter method processing.

6. Enter the coding for the implementation between the statements method <Interface name> ~ <Name of method> and endmethod.

7. Save and implement your coding. Return to the Edit Implementation screen.

8. Save the entries on the Edit Implementation screen.

Note: You can also create an implementation, and then activate it at a later time. In such a case, end the processing stage at this point.

9. Choose Activate.

Further notes

Activation and deactivation of the Business Add-In can only be done for all three methods together. If for any of these methods you still want to perform the standard coding, you either do not put any coding into the method at all (applies to CHECK_MICRO_ELIGIBILITY) or just add the line PROCESS_STANDARD = 'X' to it (applies to CHECK_ELIGIBILITY, GET_PROGRAM_PERIOD).

Business Attributes
ASAP Roadmap ID 257   Create User Exits 
Mandatory / Optional 3   Nonrequired activity 
Critical / Non-Critical 2   Non-critical 
Country-Dependency A   Valid for all countries 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20031028 
SAP Release Created in 200