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_E07 | Business Add-In: Determine Guideline |
| Transaction Code | S_ALN_01002090 | (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_E07 | BAdI HRECM00_GUIDELINE |
Document
| Document Class | SIMG | Hypertext: Object Class - Class to which a document belongs. |
| Document Name | HRECM00_GUIDELINE |
Implement this Business Add-In to evaluate the guidelines of compensation plans that are not covered by the standard customizing.
The Business Add-In contains the methods described below.
EVALUATE_GUIDELINE
This method replaces the complete standard guideline evaluation routine.
The following import parameters are provided:
- PERNR
Personnel number. - CPLAN
Compensation plan for which the guideline should be evaluated. - CITEM
Compensation review item (enables you to retrieve the compensation review). - CAREA
Compensation area under which the plan is processed. - EFFDT
Effective date of the compensation plan (can be used as a key date for guideline evaluation). - CNVDT
Key date for currency conversions. - PROG_PERIOD_TAB
Table containing the program period intervals. These intervals are returned by the eligiblity check and mainly correspond to records of infotype Compensation Program (0758) during the evaluation period. - DESIRED_CURRENCY
Currency in which the guideline amounts should be returned. The parameter is only filled for money-based plans (salary adjustment, bonus). - DESIRED_FREQUENCY
Reference frequency for the guideline amounts. The parameter is only filled for salary adjustment plans that have a period validity. - DESIRED_STOCK_UNIT
Stock unit in which the guideline numbers should be returned (only relevant for LTI plans). - MESSAGE_HANDLER
Reference to interface IF_HRPA_MESSAGE_HANDLER. If the evaluation of the effective date 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:
- GUIDELINE
Structure containing the guideline result. For more information on the different fields, see the data elements of the structure. - IS_OK
Indicator set to SPACE if any serious error has prevented the method from obtaining a reasonable result. Otherwise it should be set to 'X'. A non-existing guideline does not cause critical errors. - 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.
EVALUATE_GDL_CONTRIB
This method is applied after the standard evaluation of a guideline contribution. If the guideline key date is a fixed or the effective date (see view "Assign Compensation Review Attributes"), the total guideline result is obtained from only one contribution. If the key date is the end of the program period intervals, the final guideline result is the sum of contributions, each contribution belonging to one program period interval. With this method, you can change the result of a guideline contribution after it has been evaluated by the standard routine. In particular, you can define an alternative proration mechanism that cannot be implemented using the customizing settings.
The following import parameters are provided:
- PERNR
Personnel number. - CPLAN
Compensation plan for which the guideline is evaluated. - CAREA
Compensation area under which the plan is processed. - EVBEG
Start date of the evaluation period, which can be used as a base period for proration. - EVEND
End date of the evaluation period. - CONTRIBUTION_KEY_DATE
Key date on which the guideline contribution should be evaluated. - CNVDT
Key date for currency conversions. - DESIRED_CURRENCY
See method EVALUATE_GUIDELINE. - DESIRED_FREQUENCY
See method EVALUATE_GUIDELINE. - DESIRED_STOCK_UNIT
See method EVALUATE_GUIDELINE. - CONTRIB_PROG_PERIOD_TAB
Table containing the program period intervals relevant for this guideline contribution. In combination with the evaluation period begin and end date, this data can be used for programming an alternative proration routine. - MESSAGE_HANDLER
See method EVALUATE_GUIDELINE.
The following export parameter must be provided by your coding:
- IS_OK
See method EVALUATE_GUIDELINE.
The following change parameters are available:
- GUIDELINE_INDICATORS
Structure containing indicators that enable you to specify which fields of the guideline (amounts, percentage, numbers; minimum, default, maximum) are relevant for this guideline contribution. The structure is prefilled by the standard coding, but its values can be changed within the BAdI-Implementation. - GUIDELINE_VALUES
Structure containing the guideline results for this guideline contribution. On input, the structure is filled with the results for this guideline contribution obtained by the standard coding. In the customer routine, you can change these results (for example, prorate them) and put them back into this structure for further processing on output. - FREQU
Reference frequency of the amounts contained in structure GUIDELINE_VALUES.
Example
- A guideline based on more than three matrix dimensions should be set up.
- A proration rule should be implemented based on the number of quarters the employee was eligible for the plan.
Requirements
Standard settings
Recommendation
Activation and deactivation of the Business Add-In can only be done for both methods. If you still want to perform the standard coding for any of these methods, you either do not add any coding to the method (applies to EVALUATE_GLD_CONTRIB) or add the line PROCESS_STANDARD = 'X' (applies to EVALUATE_GUIDELINE).
Activities
After calling up the IMG activity, a dialog box appears, in which you can enter a name for the implementation.
If you have already made other implementations for this BAdI, another dialog box appears, in which the existing implementations are displayed. In this case, choose Create, and proceed as follows:
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.
The coding you stored in the methods will be run when the application program is executed.
Further notes
For more information on using Business Add-Ins, refer to the SAP Library under Basis Components ->ABAP Workbench (BC-DWB) ->Changing the SAP Standard (BC)->Business Add-Ins.
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 |
