Add a New Balance Dimension to an Existing Balance in the Payslip XML

This topic explains how you can add a new balance dimension to an existing balance, if the balance isn't displayed on the payslip.

After you add the balance dimension, you can display the balance dimension on the payslip XML.

For example, add the Inception to Date balance dimension to the Absence Accruals balance and display the Assignment Inception to Date Absence Plan balance in the Payslip XML.

You can add balance dimensions to other balance group records in the Archiver. Add dimensions that have the same level as the records in the balance group. For example, to add a relationship-level balance dimension, find balance group records in the Archiver that correspond to payroll or assignment relationships and add dimensions starting with 'Relationship'.

Here's the list of tasks you must complete:

1. Associate the balance dimension to the balance group.

2. Generate Payments (Generate Check Payment and Make EFT Payment, if applicable)

3. Archive Periodic Payroll Results

Note:

Complete these tasks in the order as listed above.

Complete these tasks only if you want to regenerate the payslips to include the newly added balance dimension.

Associate the Balance Dimension to the Balance Group

Associate the Inception to Date dimension to the Absence Accruals balance group so that the values for the absence accrual balances are retrieved for the inception to date period. Use either of these options to add the balance dimension.

• Manually add a specific dimension to the group. Use this option if you want to add a specific dimension and not all the dimensions under a category to the balance group. Follow steps 4 and 5, given here.

• Use Default Inclusions, as given in steps 6 and 7, to add all existing dimensions within a category and any new dimensions that you include to a category.

Complete these steps to add a balance dimension to a balance group.

1. Navigate to Balance Groups under Payroll in My Client Groups on the Home page.

2. Enter these details and click Search for the requisite balance group.

   Field	Value
   Balance Group Usage	Global Absence Accruals for Global Archive
   Legislative Data Group	Select a Legislative Data Group.

3. Click Global Absence Accruals Balance Group in the Search results section, to open the balance group page.

4. Click Balance Definitions in the left pane. Check if the Balance Name and Dimension Name appears in the list.

5. If not, use the Select and Add option under Actions and add the Assignment Inception to Date Balance Dimension. Click Save.

   Note:

   Alternately, if you want to view all of the balance dimensions within the category, you can use the Default Inclusions, and perform steps 6 and 7.

6. Select the correct Balance Category and Balance Dimension row and click Default Inclusions in the left pane.

7. Click Add and enter these details to create an Inclusion item.

   Field	Value
   Balance Category	Absence Accruals
   Balance Dimension	Assignment Inception to Date
   Legislative Data Group	Select a Legislative Data Group

8. Click Save and then Submit.

Add the Balance Dimension to the Balance Group Usage

Complete these steps to add the Assignment Inception to Date balance dimension to the Global Report Archive Balance Group Usages.

1. Navigate to Balance Group Usages under Payroll in My Client Groups on the Home page.

2. Enter these details and click Search for the requisite balance group.

   Field	Value
   Balance Group Usage	Global Absence Accruals for Global Archive
   Legislative Data Group	Select a Legislative Data Group.

3. Click Global Absence Accruals Balance Group in the Search results section, to open the balance group page.

4. Click Matrix Items in the left pane. Check if the Dimension Name appears in the list.

5. If not, use the Select and Add option under Actions and add these details to create the Matrix Item. .

   Field	Value
   Matrix Item Type	Balance Dimension
   Name	Assignment Inception to Date
   Position	Enter the next numeric Position
   Legislative Data Group	Select a Legislative Data Group.

   Note:

   You can select any Assignment level balance for the Inception to Date dimension, for example, Assignment Inception to Date or Assignment Tax Unit Inception to Date balance.

6. Click Save and then Submit.

Run the Archive and Payments Process

1. Run the Archive Periodic Payroll Results and Payment processes, so that you include the newly added balance dimension in the archive and payments run. The payslip displays the newly added balance dimension only if you include it in the archive and payments processes

Generate the Payments and Payslips

1. Run the following processes:

   • Generate Check Payments or Make EFT Payments

   • Generate Payslips

2. After you run the Payslip, download the Payslip XML from Reports and Analytics > Report Job History. Confirm that the Balance values at ASG ITD dimension is showing in the Payslip XML in tag < LIFETIME> under the <GLB_PAY_ARCH_PAY_ASG_ABSENCE_ACCRUALS> node.

   In the Payslip XML, the <LIFETIME> tag contains values of the Inception-to-Date dimension. The <YEAR> tag contains values of the Year-to-Date dimension, and you must add the YTD balance dimension if you need YTD values on the Payslip XML.

   These are the XML tags or short codes you can use for the balance dimensions:

   • PERIOD

   • MONTH

   • QUARTER

   • YEAR

   • TMONTH

   • TQUARTER

   • THYEAR

   • TYEAR

   • FMONTH

   • FQUARTER

   • FHYEAR

   • FYEAR

   • HYEAR

   • MONTHS

   • LIFETIME

   • R1MTH

   • R3MTH

   • R6MTH

   • R12MTH

3. Configure the Payslip RTF template if you want to add the newly added Balance dimension to the Payslip PDF.