Guidelines for Creating Student and Postgraduate Loan for the UK
Refer to the Overview of Court Orders and Student Loans for the United Kingdom topic for considerations and prerequisites for bulk-loading Court Orders and Student Loans calculation cards.
Student or Postgraduate Loans Record Types
The Court Orders and Student Loans card is created with HCM Data Loader using the Global Payroll Calculation Card business object. This generic object hierarchy provides record types to support the various country-specific requirements.
| Component | Functional Description | File Discriminator |
|---|---|---|
| Calculation Card | Defines the calculation card type and the employee assignment that it captures information for. | CalculationCard |
| Card Component | Used to group and segregate data required by the calculation card. | CardComponent |
| Component Detail | Used to capture data in the flexfield segments supported by each card component. | ComponentDetail |
| Calculation Value Definition | Specifies the value definitions that will be overridden on the calculation card. | CalculationValueDefinition |
| Enterable Calculation Value | Defines the overriding value for each calculation value definition. | EnterableCalculationValue |
| Component Association | Associates the educational loan card component with the Tax Reporting Unit the employee reports to. | ComponentAssociation |
Student or Postgraduate Loans Card Hierarchy
The card shape for an educational loan differs from that of a court order. This diagram describes all records that are relevant to all court order types:
Two card components are always required. Court Order Information is a parent card component to the card component which is named after the element created for the student or postgraduate loan.
Supply a Component Detail record for the flexfield context applicable to the student or postgraduate loan.
Supply a Calculation Value Definition and Enterable Calculation Value record for the Override Amount value definition.
The following describes the attributes to supply for each record type.
Calculation Card Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | A unique identifier for the Court Orders and Student Loans 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 ‘Court Orders and Student Loans’. |
| 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. |
| CardSeqeunce | 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 Component Attributes
Supply two card component records, one for the Court Order Information card component, the other is named by the element created for the educational loan type.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | A unique identifier for the Court Orders and Student Loans 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 Court Orders and Student Loans 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 Court Orders and Student Loans calculation card. |
| EffectiveEndDate | N/A | The end date is optional for the card component. |
| DirCardCompDefName | N/A | The component definition name. Supply ‘Court Order Information’ for one of the card components, and provide the name of the element created for the court order type for the other card component. |
| ComponentSequence | N/A | Specify a sequence number to uniquely identify this card component. Not required when supplying source keys. |
| Context1 | N/A | The educational loan reference, as provided on the official notification. |
These attributes are supplied against the CardComponent discriminator.
Component Detail Attributes
The flexfield context to supply is dependent on the type of educational loan:
Student Loan
- Student Loan (ORA_HRX_GB_SL)
Postgraduate Loan
- Postgraduate Loan (ORA_HRX_GB_PGL)
| 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 card component should be referenced using the same key
type used to identify the parent record. This is the card component
that is named by the element created for the court order
type. 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 parentcard 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_INVD’. Flexfield context codes are visible on the Flexfield Attributes tab of the View Business Objects task. |
| FLEX:Deduction DeveloperDF | N/A | Supply the same value as for the DirInformationCategory attribute. |
Calculation Value Definition Attributes
The Calculation Value Definition specifies the value definition name.
When creating calculation value definition records, refer to the card component that is named after the element created for the court order type as the parent card component.
| 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 card component should be referenced by using the same
key type used to identify the card component. This is the card
component that is named by the element created for the court order
type. 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 card component or the date the calculation value definition starts, if later. |
| DirCardCompDefName | N/A | The definition name of the parent card component. Specify the name of the element created for the court order type. |
| ValueDefinitionName | N/A | The name of the value being overridden. Specify ‘Override Amount’. |
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 Educational Loan Card Component
The component association record associates the student /postgraduate loan card component with the tax reporting units the employee reports to.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | AssignmentNumber, CardSequence, ComponentSequence, DirCardCompDefName, DirCardDefinitionName, LegislativeDataGroupName, TaxReportingUnitName | A unique identifier for the educational loan component 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. |
| LegislativeDataGroupName | N/A | The name of the legislative data group for the card definition. |
| DirCardCompId(SourceSystemId) | AssignmentNumber, CardSequence, ComponentSequence, DirCardCompDefName, DirCardDefinitionName, LegislativeDataGroupName |
The parent educational loan card component 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 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 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 Tax Withholding calculation cardeducational loan card component. |
| TaxReportingUnitName | N/A | The name of the tax reporting unit the employee reports to. |
These attributes are supplied against the ComponentAssociation discriminator.