Global Absence Plan Entitlement
The Global Absence Plan Entitlement fast formula can be used to define the entire entitlement structure for a qualification plan for cases where matrix architecture does not fit the bill.
Configuration Point in HCM Cloud
If you have created this formula, you can attach this formula to the absence plan definition.
Navigation
- In the Absence Administration work area, click Absence Plans to open the Absence Plans page.
- On the Search Results section toolbar, click Create to open the Create Absence Plan dialog box.
- In the Plan Type field, select Qualification.
- Click Continue.
- On the Edit Absence Plan page Entitlements tab, Entitlement Attributes section, choose Formula in the Entitlement Definition Type choice button field.
- Select the defined formula in the Entitlement Formula field.
Contexts
The following contexts are available in this formula type:
| Context Name | Data Type |
|---|---|
| ABSENCE_CATEGORY_ID | Number |
| ABSENCE_ENTRY_ID | Number |
| ABSENCE_MATERNITY_ID | Number |
| ABSENCE_REASON_ID | Number |
| ABSENCE_TYPE_ID | Number |
| ACCRUAL_PLAN_ID | Number |
| DATE_EARNED | Date |
| EFFECTIVE_DATE | Date |
| END_DATE | Date |
| ENTERPRISE_ID | Number |
| HR_ASSIGNMENT_ID | Number |
| HR_RELATIONSHIP_ID | Number |
| HR_TERM_ID | Number |
| JOB_ID | Number |
| LEGAL_EMPLOYER_ID | Number |
| LEGISLATIVE_DATA_GROUP_ID | Number |
| ORGANIZATION_ID | Number |
| PAYROLL_ASSIGNMENT_ID | Number |
| PAYROLL_ID | Number |
| PAYROLL_RELATIONSHIP_ID | Number |
| PAYROLL_TERM_ID | Number |
| PERSON_ID | Number |
| START_DATE | Date |
Input Values
| Variable Name | Data Type | Description |
|---|---|---|
| IV_START_DATE | Date | Start date of absence entry |
| IV_END_DATE | Date | End date of absence entry |
| IV_TOTALDURATION | Number | Duration of absence entry |
| IV_START_DURATION | Number | Start date duration of the absence entry. Applicable when absence entry is being recorded against an Elapsed based work schedule |
| IV_END_DURATION | Number | End date duration of the absence entry. Applicable when absence entry is being recorded against an Elapsed based work schedule |
| IV_START_TIME | Text | Start time on the start date of the absence entry. Applicable when absence entry is being recorded against a Time based work schedule. For elapsed work schedules it will be 00:00. |
| IV_END_TIME | Text | End time on the end date for the absence being entered. Applicable when absence entry is being recorded against a Time based work schedule. For elapsed work schedules it will be 23:59. |
| IV_ACTUALCHILDBIRTHDATE | Date | Actual date of childbirth entered for the absence. Applicable for Childbirth/placement absence pattern |
| IV_ACTUALSTARTDATE | Date | Actual start date of absence. Applicable for Childbirth/placement absence pattern |
| IV_ACTUALENDDATE | Date | Actual end date of absence. Applicable for Childbirth/placement absence pattern |
| IV_EXPECTEDCHILDBIRTHDATE | Date | Expected date of childbirth entered for the absence. Applicable for Childbirth/placement absence pattern |
| IV_PLANNEDSTARTDATE | Date | Expected start date of absence. Applicable for Childbirth/placement absence pattern |
| IV_PLANNEDENDDATE | Date | Expected end date of absence. Applicable for Childbirth/placement absence pattern |
| IV_ABSENCE_REASON | Text | Absence reason in the language of the current session |
| IV_ATTRIBUTE_CATEGORY | Text | Context of the DFF row for Absence Recordings DFF |
| IV_ATTRIBUTE_1* | Text | First text segment of the Absence Recordings DFF |
| IV_ATTRIBUTE_NUMBER1* | Number | First number segment of the Absence Recordings DFF |
| IV_ATTRIBUTE_DATE1* | Date | First date segment of the Absence Recordings DFF |
| IV_ATTRIBUTE_ARR | Text_Number | Array of text segments of the Absence Recordings DFF. The index indicates the segment number. Eg: IV_ATTRIBUTE_ARR[1] holds the value of segment ATTRIBUTE1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_ATTRIBUTE_ARR.exists(1)) |
| IV_ATTRIBUTE_NUMBER_ARR | Number_Number | Array of number segments of the Absence Recordings DFF. The index indicates the segment number. Eg: IV_ATTRIBUTE_NUMBER_ARR[1] holds the value of segment ATTRIBUTE_NUMBER1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_ATTRIBUTE_NUMBER_ARR.exists(1)) |
| IV_ATTRIBUTE_DATE_ARR | Date_Number | Array of date segments of the Absence Recordings DFF. The index indicates the segment number. Eg: IV_ATTRIBUTE_DATE_ARR[1] holds the value of segment ATTRIBUTE_DATE1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_ATTRIBUTE_DATE_ARR.exists(1)) |
| IV_INFORMATION_CATEGORY | Text | Context of the DDF row for ANC_PER_ABS_ENTRIES DDF |
| IV_INFORMATION_1* | Text | First text segment of the ANC_PER_ABS_ENTRIES DDF |
| IV_INFORMATION_NUMBER1* | Number | First number segment of the ANC_PER_ABS_ENTRIES DDF |
| IV_INFORMATION_DATE1* | Date | First date segment of the ANC_PER_ABS_ENTRIES DDF |
| IV_INFORMATION_ARR | Text_Number | Array of text segments of the ANC_PER_ABS_ENTRIES DDF. The index indicates the segment number. Eg: IV_INFORMATION_ARR[1] holds the value of segment INFORMATION1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_INFORMATION_ARR.exists(1)) |
| IV_INFORMATION_NUMBER_ARR | Number_Number | Array of number segments of the ANC_PER_ABS_ENTRIES DDF. The index indicates the segment number. Eg: IV_INFORMATION_NUMBER_ARR[1] holds the value of segment INFORMATION_NUMBER1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_INFORMATION_NUMBER_ARR.exists(1)) |
| IV_INFORMATION_DATE_ARR | Date_Number | Array of date segments of the ANC_PER_ABS_ENTRIES DDF. The index indicates the segment number. Eg: IV_INFORMATION_DATE_ARR[1] holds the value of segment INFORMATION_DATE1 in ANC_PER_ABS_ENTRIES table. The index begins at 1 and ends at 30. If a particular index is used and data does not exist, the application would throw an error. Hence it is a good practice to first check if data exists before using the input value. This can be done using the “exists” command. Eg: if(IV_INFORMATION_DATE_ARR.exists(1)) |
| IV_PAYMENT_DTL_BAND | Number | Identifier of the payment band chosen for the absence linked to an agreement |
| IV_NOTIFICATION_DATE | Date | Date of Illness/Injury notification |
| IV_MATCHING_DATE | Date | Date on which child is matched with the worker for adoption |
| IV_LNKG_ABS_ID | Number_Number | Array of absence entry identifier for which linkage is created |
| IV_LNKG_LNKD_ABS_ID | Number_Number | Array of absence entry identifier to which absence is linked |
| IV_LNKG_LNKD_ABS_START | Date_Number | Array of start date time of absences which are linked |
| IV_LNKG_LNKD_ABS_END | Date_Number | Array of end date time of absences which are linked |
| IV_LNKG_REASON | Text_Number | Array of linkage reasons |
| IV_LNKG_REASON_ID | Number_Number | Array of linkage reason identifiers |
| IV_LNKG_CHAIN_ID | Number_Number | Array of linkage chain identifiers |
| IV_UI_PER_CERT_ID | Text | Identifier of the certificate record added to the absence. Applicable for certificates acted up-on by admin. |
| IV_UI_ABS_CERT_ID | Text | Absence certificate identifier. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_TYPE | Text | Certification type. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_REVPAYSTART_DATE | Date | Revised pay start date for the certificate. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_REVPAYEND_DATE | Date | Revised pay end date for the certificate. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_REVPAY_FACTOR | Number | Revised payment percentage for the certificate. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_CREATION_TYPE | Text | Certification creation type. Applicable for certificates acted up-on by admin. |
| IV_UI_CERT_STATUS | text | Certification status. Applicable for certificates acted up-on by admin. |
*The sequence for this input value can be extended up to 5
Return Variables
| Variable Name | Data Type | Description |
|---|---|---|
| BAND1PAYFACTOR | Number | Pay factor for the entitlement BAND1ENTITLEMENT |
| BAND1ENTITLEMENT | Number | Entitlement duration that the worker is eligible for |
| BAND1RATEDEFINITION | Number | Identifier of the rate definition to be used for BAND1ENTITLEMENT |
| BAND1USEDENTITLEMENT | Number | Used entitlement value to be used for BAND1ENTITLEMENT |
| BAND2PAYFACTOR | Number | Pay factor for the entitlement BAND2ENTITLEMENT |
| BAND2ENTITLEMENT | Number | Entitlement duration that the worker is eligible for |
| BAND2RATEDEFINITION | Number | Identifier of the rate definition to be used for BAND2ENTITLEMENT |
| BAND2USEDENTITLEMENT | Number | Used entitlement value to be used for BAND2ENTITLEMENT |
| BAND3PAYFACTOR | Number | Pay factor for the entitlement BAND3ENTITLEMENT |
| BAND3ENTITLEMENT | Number | Entitlement duration that the worker is eligible for |
| BAND3RATEDEFINITION | Number | Identifier of the rate definition to be used for BAND3ENTITLEMENT |
| BAND3USEDENTITLEMENT | Number | Used entitlement value to be used for BAND3ENTITLEMENT |
| BAND4PAYFACTOR | Number | Pay factor for the entitlement BAND4ENTITLEMENT |
| BAND4ENTITLEMENT | Number | Entitlement duration that the worker is eligible for |
| BAND4RATEDEFINITION | Number | Identifier of the rate definition to be used for BAND4ENTITLEMENT |
| BAND4USEDENTITLEMENT | Number | Used entitlement value to be used for BAND4ENTITLEMENT |
| BAND5PAYFACTOR | Number | Pay factor for the entitlement BAND5ENTITLEMENT |
| BAND5ENTITLEMENT | Number | Entitlement duration that the worker is eligible for |
| BAND5RATEDEFINITION | Number | Identifier of the rate definition to be used for BAND5ENTITLEMENT |
| BAND5USEDENTITLEMENT | Number | Used entitlement value to be used for BAND5ENTITLEMENT |
| CERT_NAMES | Text_Number | Array of certificates (managed by entitlement formula certificates) to be associated with the absence entry |
| CERT_START_DATES | Date_Number | Array of certification start dates of certificates (managed by entitlement formula certificates) associated with the absence entry |
| CERT_END_DATES | Date_Number | Array of certification end dates of certificates (managed by entitlement formula certificates) associated with the absence entry |
| CERT_COMMENTS | Text_Number | Array of certification comments associated with the absence entry |
| DEBUG_MESSAGE | Text | Text passed into this output variable would get logged if application logging is enabled. Useful for debugging. |
Sample Formula
Requirement: The organization has an entitlement payment band structures that is based on the working location of the worker. Workers belonging to a location that is in California follow a different band structure as compared to workers in the rest of the country.
Solution: A Global Absence Plan Entitlement formula such as the one below can be used.
FORMULA NAME: ANC_PLN_ENTLMNT
FORMULA TYPE: Global Absence Plan Entitlement
DESCRIPTION: This formula evaluates the entitlement band based on location of Worker
DEFAULT FOR PER_ASG_LOC_REGION2 IS ' XXXXXXXXXX'
IF (PER_ASG_LOC_REGION2 = 'CA')
THEN {
BAND1PAYFACTOR = 100
BAND1ENTITLEMENT = 50
BAND2PAYFACTOR = 75
BAND2ENTITLEMENT = 50
BAND3PAYFACTOR = 50
BAND3ENTITLEMENT = 50
)
ELSE (
BAND1PAYFACTOR = 100
BAND1ENTITLEMENT = 40
BAND2PAYFACTOR = 75
BAND2ENTITLEMENT = 40
BAND3PAYFACTOR = 50
BAND3ENTITLEMENT = 40
)
RETURN BAND1PAYFACTOR, BAND1ENTITLEMENT, BAND2PAYFACTOR, BAND2ENTITLEMENT, BAND3PAYFACTOR, BAND3ENTITLEMENT