Guidelines for Creating Court Orders 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.

Court Order 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.

These record types are used when creating a calculation card to record court order information.

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
Card Association Associates the calculation card with the Tax Reporting Unit the employee reports to. CardAssociation
Card Association Detail Associates card components with the employee’s assignments. CardAssociationDetails

Court Orders Card Hierarchy

The card shape for a court order differs not only from student and postgraduate loans, but also depending upon the type of court order.

This diagram describes all records that are relevant to all court order types:

uk court orders card hierarchy

Two card components are always required regardless of the court order type. Court Order Information is a parent card component to the second card component which is named after the element created for the court order type. The Court Orders component card name is defined by the element template.

Supply a Component Detail record for each flexfield context applicable to the court order type. Supply a Calculation Value Definition and Enterable Calculation Value record for each override value applicable to the court order type.

The Student Loans and Court Orders calculation card is associated with the employee’s tax reporting unit by the card association and card association detail record types.

The following describes the attributes to supply for each record type.

Calculation Card Attributes

The Court Order and Student Loans calculation card record uses these 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 court order type.

uk court orders card component hierarchy

The Court Order and Student Loans card components use these attributes:

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
ParentDirCardCompId (SourceSystemId) AssignmentNumber, CardSequence, DirCardDefinitionName, LegislativeDataGroupName, ParentComponentSequence, ParentDirCardCompDefNam Don’t supply a value for the Court Order Information record. For the card component named for the court order element, supply a reference to the Court Order Information 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 court order reference, as provided on the official notification.

These attributes are supplied against the CardComponent discriminator.

Component Detail Flexfield Contexts Applicable by Court Order Type

uk court order component detai hierarchy

The type of court order determines the flexfield context to supply:

Attachment of Earning Order (AEO) Fines
  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Court Order Percentage Deductions (ORA_HRX_GB_PCT)

Attachment of Earning Order (AEONI) Fines Northern Ireland

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)

Attachment of Earning Order (AEO) Non-Priority

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)

Attachment of Earning Order (AEO) Non-Priority Northern Ireland

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)

Attachment of Earning Order (AEO) Priority

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)

Attachment of Earning Order (AEO) Priority Northern Ireland

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)

Child Maintenance Service Deduction from Earnings Order (CMSDEO)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Child Maintenance Service Deduction from Earning Order (ORA_HRX_GB_CMSDEO)

Conjoined Arrestment Order (CAO)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Court Order Percentage Deductions (ORA_HRX_GB_PCT)

Council Tax Attachment of Earnings Order (CTAEO)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Court Order Percentage Deductions (ORA_HRX_GB_PCT)

Current Maintenance Arrestment (CMA)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)

Deduction from Earnings Order (DEO)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Deduction from Earnings Order (ORA_HRX_GB_DEO)

Direct Earnings Attachment (DEA)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Attachment of Earning Order (ORA_HRX_GB_AEO)
  • Direct Earnings Attachment (ORA_HRX_GB_DEA)

Earnings Arrestment (EA)

  • Involuntary Deduction Information (ORA_HRX_GB_INVD)
  • Court Order Percentage Deductions (ORA_HRX_GB_PCT)

Use the Component Detail record type to supply flexfield data.

Component Detail Attributes

The common attributes for all Component Detail record are as follows:

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.
When creating component detail records, refer to the card component that is named after the element created for the court order type as the parent card component. These attributes are supplied against the ComponentDetail discriminator.
Note: You can find the flexfield segment attribute names for each flexfield context using the View Business Objects task.

Value Definitions Applicable by Court Order Type

The type of court order determines the value definitions to supply:

Attachment of Earning Order (AEO) Fines

  • Original Outstanding Debt

Attachment of Earning Order (AEONI) Fines Northern Ireland

  • Original Outstanding Debt

Attachment of Earning Order (AEO) Non-Priority

  • Nominal Deduction Rate
  • Original Outstanding Debt

Attachment of Earning Order (AEO) Non-Priority Northern Ireland

  • Nominal Deduction Rate
  • Original Outstanding Debt

Attachment of Earning Order (AEO) Priority

  • Nominal Deduction Rate
  • Protected Earnings Rate
  • Original Outstanding Debt

Attachment of Earning Order (AEO) Priority Northern Ireland

  • Nominal Deduction Rate
  • Protected Earnings Rate
  • Original Outstanding Debt

Child Maintenance Service Deduction from Earnings Order (CMSDEO)

  • Nominal Deduction Rate (all frequencies)

Conjoined Arrestment Order (CAO)

  • CMA Daily Deduction Rate
  • CMA Daily Protected Earnings Rate

Council Tax Attachment of Earnings Order (CTAEO)

  • Original Outstanding Debt

Council Tax Attachment of Earnings Order Wales (CTAEOC)

  • Original Outstanding Debt

Current Maintenance Arrestment (CMA)

  • CMA Daily Deduction Rate
  • CMA Daily Protected Earnings Rate

Deduction from Earnings Order (DEO)

  • Nominal Deduction Rate
  • Protected Earnings Rate

Direct Earnings Attachment (DEA)

  • EA Original Outstanding Debt
  • Fixed Amount to Deduct

Earnings Arrestment (EA)

  • Original Outstanding Debt

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.

Supply these 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 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. The list of value definitions applicable to this court order type are listed above.

These attributes are supplied against the CalculationValueDefinition discriminator.

Enterable Calculation Value Attributes

The Enterable Calculation Value provides the override value for the value definition. Supply these 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.
ValueDefnIdSourceSystemId) 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 Court Orders and Student Loans Calculation Card

The card association record associates the Court Orders and Student Loans card component with a tax reporting unit. The card association details record allows Court Orders components to be associated with an employee assignment.

Card Association Attributes

HCM Data Loader Attribute Alternative User Key Attributes Functional Description
SourceSystemId AssignmentNumber, CardSequence, DirCardDefinitionName, LegislativeDataGroupName A unique identifier for the Court Orders and Student Loans 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.
LegislativeDataGroupName N/A The name of the legislative data group for the card 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 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 card.
TaxReportingUnitName N/A

The name of the employee’s tax reporting unit to associate with the Court Orders and Student Loans calculation card.

If source keys are used to identify the card association, you must also specify the LegislativeDataGroupName attribute to identify the tax reporting unit.

These attributes are supplied against the CardAssociation discriminator.

Card Association Detail Attributes

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.
DirRepCardId(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 card component this association is for. This is the card component that is named by the element created for the court order type.
AssociationAssignmentId(SourceSystemId) AssociationAssignmentNumber Identify the employee’s assignment to associate with card component.

These attributes are supplied against the CardAssociationDetail discriminator.