Guidelines for Loading Benefits and Pensions for the UK
You must provide one Benefits and Pensions record for every UK employee you are capturing Pensions information for.
Even if you are updating an existing Benefits and Pensions card and the calculation card itself isn’t being updated, still include the calculation card record to group other related data supplied in the file.
Benefits and Pensions Calculation Card Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | A unique identifier for the Benefits and Pensions calculation card. For new calculation card supply the source key attributes. You can also identify calculation cards with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the calculation card. |
| DirCardDefinitionName | N/A | The name of the card definition. Specify ‘Benefits and Pensions’ |
| AssignmentId(SourceSystemId) | AssignmentNumber | Either supply the source system ID, or assignment number that identifies the employee assignment this calculation card is for. |
| EffectiveStartDate | N/A | The start date of the calculation card. |
| CardSequence | N/A | A number to uniquely identify this card when multiple calculation cards for the same card definition exist for the employee. Not required when source keys are used. |
These attributes are supplied against the CalculationCard discriminator. Always supply the CalculationCard record, even when updating an existing card.
Card Components Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | A unique identifier for the Benefits and Pensions card component. For new card components supply the source key attributes. You can also identify card components with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the card component definition. |
| DirCardId(SourceSystemId) | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | The parent Benefits and Pensions calculation card should be identified by using the same key type used to identify the calculation card. When using source keys, supply this attribute with the value supplied for the calculation card’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent calculation card. |
| EffectiveStartDate | N/A | The start date of the card component. This must be after or equal to the EffectiveStartDate on the Benefits and Pensions calculation card. |
| EffectiveEndDate | N/A | The end date is optional for the card component. |
| DirCardCompDefName | N/A | The component definition name. Provide the name of the component as generated by the element template. |
| ComponentSequence | N/A | Specify a sequence number to uniquely identify this card component. |
| Context1 | The Pension Payroll ID used to uniquely identify employee’s pension enrolment. |
These attributes are supplied against the CardComponent discriminator.
Component Detail Attributes
The Benefits and Pensions card component uses three flexfield contexts. In addition
to the common attributes defined here, include the necessary flexfield segment
attribute values for these flexfield contexts:
- Retirement Date Details (ORA_HRX_GB_PS_RETIRE_DATE)
- Effective Pension Age Reporting Details (ORA_HRX_GB_PS_CSP_EPA_PENSION)
- LGPS Details (ORA_HRX_GB_LGPS_DETAILS)
Note: You can find the flexfield segment attribute names for this flexfield context
using the View Business Objects task.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, DirInformationCategory, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName, DirCardCompDefName | A unique identifier for the component detail. For new component detail records supply the source key attributes. You can also identify card components with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the card component definition. |
| DirCardCompId(SourceSystemId) | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | The parent Benefits and Pensions card component should be referenced using the same key type used to identify the parent record. When using source keys, supply this attribute with the value supplied for the card component’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card component. |
| EffectiveStartDate | N/A | The start date of the component detail, or update to the component detail if you are providing date-effective history. This must be after or equal to the EffectiveStartDate provided for the Benefits and Pensions card component. |
| EffectiveEndDate | N/A | The optional end date of the component detail, or if you are providing date-effective history the last day of the date-effective changes. |
| DirCardCompDefName | N/A | The name of the card component this detail is for. This is used to identify the flexfield context and should be supplied even when a source key is used to identify the parent card component. |
| DirInformationCategory | N/A | The code for the flexfield context, such as ‘ORA_HRX_GB_PS_RETIRE_DATE’. Flexfield context codes are visible on the Flexfield Attributes tab of the View Business Objects task. |
| FLEX:Deduction DeveloperDF | Supply the same value as for the DirInformationCategory attribute. |
These attributes are supplied against the ComponentDetail discriminator.
Value Definitions for Benefits and Pensions
| Value Definition Name | Functional Description | Type of Scheme |
|---|---|---|
| Payee | Third party organisation to which the pension contributions are paid. | All |
| Reference Number | Optional employee reference number with the payee. | All |
| Partial Deduction Allowed | Indicates whether partial deduction is allowed. | All |
| Percentage for Employee Contribution | Employee’s contribution percentage | Private sector schemes and partnership schemes |
| Percentage for Employee Additional Contribution | Employee’s additional contribution percentage | All additional contributions |
| Percentage for Employer Contribution | Employer’s contribution percentage (overrides the value stored in the Calculation Value Definition if it exists) | Private sector schemes |
| Employer Matching Percentage | Used for partnership schemes only to indicate the percentage an employer may choose to contribute the match the employee’s contribution rate. | Partnership schemes only |
| Employee WPS Percentage | Used for Alpha only to indicate the employee’s WPS rate. It must be a multiple of 1.5 | Alpha only |
| Normal Retirement Age | N/A | Private sector schemes |
Calculation Value Definition Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | A unique identifier for the calculation value definition record. For new records supply the source key attributes. You can also identify calculation value definition records with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the card component definition. |
| SourceId(SourceSystemId) | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | The parent Benefits and Pensions card component should be referenced by using the same key type used to identify the card component. When using source keys, supply this attribute with the value supplied for the card component’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card component. |
| EffectiveStartDate | N/A | The start date of the parent Benefits and Pensions card component or the date the calculation value definition starts, if later. |
| DirCardCompDefName | N/A | The definition name of the parent Benefits and Pensions card component. Specify the same value as provided on the parent card component record. |
| ValueDefinitionName | N/A | The name of the value being overridden. The list of value definitions applicable to this card component are listed above. |
These attributes are supplied against the CalculationValueDefinition discriminator.
Enterable Calculation Value Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | A unique identifier for the enterable calculation value record. For new records supply the source key attributes. You can also identify calculation value definition records with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the override value. |
| ValueDefnId(SourceSystemId) | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName, ValueDefinitionName | Identify the parent Calculation Value Definition record using the same key type used to identify the calculation value definition. When using source keys, supply this attribute with the value supplied for the calculation value definition’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent record. |
| EffectiveStartDate | N/A | The effective start date of the parent calculation value definition record, or the update to the override value if supplying date-effective history. |
| EffectiveEndDate | N/A | The optional end date of the override value, or if you are providing date-effective history, the last day of the date-effective changes |
| Value1 | N/A | The value for the value definition identified by the parent calculation value definition record. |
These attributes are supplied against the EnterableCalculationValue discriminator.
Associating the Benefits and Pensions Calculation Card
The card association records associate the Benefits and Pension card component with
the employee’s tax reporting unit.
Note: When creating a Benefits and Pensions card
via Manage Calculation Card UI, the card association is non-enterable. However,
when loading using HCM Data Loader, supply both the Card Association and Card
Association Detail records.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | AssignmentNumber, CardSequence, DirCardDefinitionName, LegislativeDataGroupName | A unique identifier for the Benefits and Pensions card association. For new card associations supply the source key attributes. You can also identify card components with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| DirCardId(SourceSystemId) | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | The parent Benefits and Pensions calculation card should be identified by using the same key type used to identify the calculation card. When using source keys, supply this attribute with the value supplied for the calculation card’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent calculation card. |
| EffectiveStartDate | N/A | The start date of the card association or the update to the card association if you are providing date-effective history. This must be after or equal to the EffectiveStartDate provided for the Benefits and Pensions calculation card. |
These attributes are supplied against the CardAssociation discriminator.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | AssignmentNumber, CardSequence, DirCardDefinitionName, LegislativeDataGroupName | A unique identifier for the card association detail record. For new card associations supply the source key attributes. You can also identify card components with the user key attributes. |
| SourceSystemOwner | N/A | The name of the source system owner used to generate the source system ID. |
| DirCardId(SourceSystemId) | AssignmentNumber, CardSequence, DirCardDefinitionName, LegislativeDataGroupName | The parent card association record should be identified by using the same key type supplied to against the card association. When using source keys, supply this attribute with the value supplied for the card’s association SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card association. |
| EffectiveStartDate | N/A | The effective start date of the card association. |
| EffectiveEndDate | N/A | The effective end date of the card association. |
| DirCardCompId(SourceSystemId) | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | Identify the Benefits and Pensions card component this association is for. |
| AssociationAssignmentId(SourceSystemId) | AssociationAssignmentNumber | Identify the employee’s assignment to associate with card component. |
These attributes are supplied against the CardAssociationDetail discriminator.