**IMPORTANT:** If you are installing the Eucalyptus release for the first time, then the above icons can be
ignored as you will need to install and configure this entire document.
## Installation and Configuration Checklist
The following items must be completed in the listed order to install and configure the packages within
this release.
| | Configuration Item / Task | Requirement? |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| [Package Installation](#package-installation) | | |
| 
### Page Layout Updates
The Eucalyptus ‘25 Release includes new enhancements to the Page Layouts. Some of these Page Layout
updates are Compulsory, while others are optional. Please refer to the details below for more information
about these updates.
Configuration steps:
1. Update Payroll Page Layouts
#### Update Payroll Page Layouts
The Compulsory Page Layouts below must be updated for all the Orgs, whereas the Optional Page
Layout updates only need to be completed if the option to use this functionality is taken. To incorporate
these enhancements, follow the steps below:
##### Employee (Compulsory) 
##### Pay Schedule (Compulsory)
The Page Layout for Pay Schedule requires updating to include the new field of Payroll Jurisdiction. To
complete this, please follow the steps detailed below.
Go to **Setup** > **Object Manager** > **Schedule** > **Page Layouts**
1. Click the **Page Layout Assignments** button.
2. Select the page layout assigned to the Pay Schedule Record Type (i.e. **TC9ET Pay Schedule Layout** ).
3. Add the following fields to the Page Layout, underneath the field Finalise Based On:
1. Payroll Jurisdiction
4. Click **Save** .
##### Pay Transaction (Compulsory)
The Page Layout for Pay Transaction requires updating to include the new field of ETP PAYG Type, which
makes the ETP PAYG Pay Transactions more easily identifiable in the Manual Adjustments UI of the Pay
Batch Manager. To complete this, please follow the steps detailed below.
Go to **Setup** - **Object Manager** - **Pay Transaction** - **Page Layouts**
1. Click the **Page Layout Assignments** button.
2. Select the page layout assigned to the Withholding - ETP PAYG Record Type (i.e. Time2Pay Pay
Transaction - Withholding - PAYG, ETP PAYG, HELP and SFSS).
3. Add the following field to the Page Layout, underneath the PAYG field, within the Withholding
section:
1. ETP PAYG Type
4. Click **Save** .
##### Payee Aggregate (Compulsory)
The Page Layout for Leave Accrual record types of Payee Aggregates requires compulsory updating to
include the new Leave Balance Offset field. To complete this, please follow the steps detailed below:
Go to **Setup** - **Object Manager** - **Payee Aggregate** - **Page Layouts**
1. Click the **Page Layout Assignments** button.
2. Select the page layout assigned to the Record Type Leave Accruals (i.e. **TC9PR Payee Aggregate Leave Layout** ).
3. Add the following field to the Page Layout, underneath the field Leave Taken, within the Leave
Aggregates section:
1. Leave Balance Offset
4. Add the following field to the Page Layout, underneath the field Leave Taken Days, within the
Leave Aggregates section:
1. Leave Balance Offset Days
5. Click **Save** .
##### Payee Pay Batch (Compulsory)
The Payee Pay Batch Object includes new fields that are compulsory to be added to the Page Layout.
Go to **Setup** - **Object Manager** - **Payee Pay Batch** - **Page Layouts**
1. Select **TC9PR Pay Batch Item Layout** .
2. Add the following two fields under the section Deductions (add one field under each of the
existing fields):
1. STP2 CSA Deductions (tc9\_pr**STP2\_CSA\_Deductions**c)
2. STP2 CSA Garnishees (tc9\_pr**STP2\_CSA\_Garnishees**c)
3. Navigate to the ETPs Page Section and add/update the fields as displayed below in the left-hand
column:
1. Non Taxable ETPs
2. ETP Non Taxable B
3. ETP Non Taxable D
4. ETP Non Taxable N
5. ETP Non Taxable O
6. ETP Non Taxable P
7. ETP Non Taxable R
8. ETP Non Taxable S
9. ETP Non Taxable T
4. Navigate to the ETPs Page Section and add/update the fields as displayed below in the
right-hand column:
1. Taxable ETPs
2. ETP Taxable B
3. ETP Taxable D
4. ETP Taxable N
5. ETP Taxable O
6. ETP Taxable P
7. ETP Taxable R
8. ETP Taxable S
9. ETP Taxable T
5. Select **Save** .
Once completed, please ensure that if using any custom page layouts, the required changes are also
applied to those page layouts.
##### Timesheet Entry (Optional)
The below Page Layout updates are Optional, but must be applied where Orgs are using the Shift logic
for interpretations:
Go to **Setup > Object Manager > Timesheet Entry > Page Layouts**
1. Select **Time2Pay Timesheet Entry** .
2. Add the following fields to the Page Layout, underneath the Entry Details section:
1. Shift Start Time
2. Shift Start Date
3. Shift End Time
4. Shift End Date
3. Once the fields have been added, ensure that all these fields are set to READ ONLY.
4. Click **Save** .
### Update Batch Job for Pay Advices
To ensure 2cloudnine will use the latest improvements to the Pay Advices Scheduled Job, the existing
Scheduled Job must be deleted and then rescheduled.
Configuration steps:
1. Delete existing Scheduled Job (Compulsory)
2. Set a New Scheduled Job (Compulsory)
#### Delete existing Scheduled Job (Compulsory)
IMPORTANT: The configuration below is compulsory, however before deleting, please review the
scheduled frequency of the jobs, and if they are different from the times listed below in Script 1, it is
recommended to take a screenshot of them to ensure that when they are rescheduled, they reflect the
same frequency as the existing one.
Go to **Setup** - **Environments** - **Jobs** - **Scheduled Jobs**
1. Scroll down the list of scheduled jobs until you locate all that contain PayAdvice (i.e.
ScheduleCreatePayAdvice or ScheduleSendPayAdvice).
2. Select the **Del** button next to these Scheduled Jobs listed, and then select **OK** from the pop-up.
3. Repeat for all Pay Advices jobs scheduled.
#### Set a New Scheduled Job (Compulsory)
If you have deleted the existing Scheduled Jobs for Pay Advices, they need to be rescheduled so that they
use the latest updates to the code. Please identify if the scheduled jobs are the same frequency as listed
in the script, and ensure the frequency is as per the original jobs.
Go to **Setup** - **Developer Console**
1. **Debug** - **Open Execute Anonymous Window**
2. Delete or comment out any code that is in the window
3. Paste in the copied script from the script box below.
4. Click the **Execute** button.
```apex theme={null}
//script for pay advice PDF creation & email
System.schedule('ScheduleCreatePayAdvicePDF 00', '0 00 * * * ?', new tc9_pr.ScheduleCreationPayAdvicePDF());
System.schedule('ScheduleCreatePayAdvicePDF 20', '0 20 * * * ?', new tc9_pr.ScheduleCreationPayAdvicePDF());
System.schedule('ScheduleCreatePayAdvicePDF 40', '0 40 * * * ?', new tc9_pr.ScheduleCreationPayAdvicePDF());
System.schedule('ScheduleSendPayAdviceEmail 10', '0 10 * * * ?', new tc9_pr.ScheduleSendPayAdviceEmail());
System.schedule('ScheduleSendPayAdviceEmail 30', '0 30 * * * ?', new tc9_pr.ScheduleSendPayAdviceEmail());
System.schedule('ScheduleSendPayAdviceEmail 50', '0 50 * * * ?', new tc9_pr.ScheduleSendPayAdviceEmail());
```
### Disable Assignment Record Type Validations (Optional)
The configuration below is Optional. If you have an integration within your Org which utilises Template
Record Types, you may require the validations to be disabled to save the Assignments. If this is occurring
within your Org, System Administrators will be required to populate the new Custom Setting as detailed
below:
Go to **Setup** - **Custom Settings**
1. Click **Manage** next to **Disable Assignment RecordType Validation** .
2. Click the **New** button.
3. Enter the Developer Name in the **Name** field.
4. Enter the Record Id of the Custom Record Type of Assignment for which 2cloudnine validations
are to be ignored.
5. Click **Save** .
Repeat the above process for each Custom Record Type of Assignment that is required to bypass the
validations, keeping in mind that this will not apply to the standard 2cloudnine Record Types of
Assignments.
### Update the Help text for the Total Deduction Limit field (Compulsory)
This configuration to update the Help text for the Total Deduction Limit field on the Payee Deduction
Template Object is Compulsory. To update the Help Text, please follow the steps below:
Go to **Setup** > **Object Manager** > **Payee Deduction Template** > **Fields & Relationships**
1. Click on the field **Total Deduction Limit** .
1. Click the **Edit** button.
2. In the field Help Text, replace the existing text with “Defines an upper limit to the
deduction amount that can be withheld for the deduction. When deductions are
calculated, the deduction amount withheld will be adjusted to ensure this amount is not
exceeded. If blank, no limit applies.”.
3. Click **Save** .
### Enable Pay Batch Manager Hard Delete (Optional)
An optional custom setting has been added to enable the hard deletion of Pay Batches. Once the data is
deleted, it is not sent to the Recycle Bin. Therefore, the deleted records cannot be restored. To enable the
setting:
Go to **Setup** - **Custom Settings**
1. Click **Manage** next to **Payroll Configuration** .
2. Click the **Edit** button.
3. Tick the checkbox next to the **Enable Pay Batch Hard Delete** field to make sure that it's enabled.
4. Click **Save** .
### Update Report Type and Package the ETP Review Report (Compulsory)
The configuration below is Compulsory. A new report has been created to review the ETP Pay
Transactions and the Withholding ETP PAYG Transactions by ETP PAYG Type, for Consultants to use to
update the ETP PAYG Type field on Pay Transactions for Withholding. To complete, please follow the
steps below:
1. Go to **Reports** .
2. Run the ETP and PAYG Transactions by ETP Type report.
3. Review the **ETP PAYG Type** field on each Pay Transaction with Record Type **Withholding - ETP PAYG** .
4. If the ETP PAYG Type field is blank on the Withholding - ETP PAYG Pay Transaction, populate it
with the same value as the one in the Pay Code: ETP Type column (do not update any values in
the Pay Code: ETP Type column).
5. Ensure you don't have any Pay Transactions in the report with Record Type Withholding - ETP
PAYG where the ETP PAYG Type column is blank.
### Assign Reconciliation Permission Set to Users (Conditionally Compulsory)
A new Permission Set has been created for Payroll Users using the Reconciliation functionality. To assign
this Permission Set to Users, follow the steps below:
Go To **Setup > Permission Sets**
1. Open the new Permission Set **2cloudnine Payroll Reconciliation** .
2. Select the **Manage Assignments** button and click the **Add Assignment** button.
3. Select the checkboxes of the various Users who require this Permission Set to be assigned to
them, and select the **Next** button.
4. Select the radio button for **No Expiry Date** and select the **Assign** button.
5. Assignment Summary will show the confirmation of the successful and failed assignments of the
Permission Sets to the Users selected.
## Appendix 1
The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to the Pay Batch Manager.
**Users Key**
| | |
| ---------- | ------------------------------------------------------------------------ |
| **User 1** | Users who are Payroll Users and will create and edit a Pay Batch |
| **User 2** | Users who are System Administrators and will create and edit a Pay Batch |
| **User 3** | Users who will view a Pay Batch |
**Minimum Access Key**
| | |
| ----- | -------- |
| **R** | Read |
| **C** | Create |
| **E** | Edit |
| **A** | Assigned |
| Type | Name | User 1 | User 2 | User 3 | User 4 |
| ------------------- | ------------------------------------------------------------------------------------------------------ | ------ | ------ | ------ | ------ |
| Object: | Schedule | -- | -- | -- | |
| Fields: | Payroll Jurisdiction | R/E | R/E | R | |
| Object: | Pay Batch | -- | -- | -- | |
| Fields: | Payroll Jurisdiction | R/E | R/E | R | |
| Object: | Pay Batch Item | -- | -- | -- | |
| Fields: | Payroll JurisdictionFlag Payee Cessation Date | R/E | R/E | R | | | Object: | Payee Aggregate | -- | -- | -- | | | Custom
Fields: | Leave Balance Offset
Leave Balance\_Offset Days | R/E | R/E | R | | | Object: | Calendar | -- | -- | -- | | | Custom
Field: | Pay Schedule Period Type | R/E | R/E | R | | | Object: | Calendar Period | -- | -- | -- | | | Custom
Fields: | Tax Period | R/E | R/E | R | | | Object: | Payee Exit Calculation | -- | -- | -- | | | Custom
Field: | Commit Final Payment | R/E | R/E | R | | | Custom
Label | VMSG Schedule Payroll Jurisdiction
VMSG Validate Payroll System
VMSG Validate Payroll System | R/E | R/E | R | | | Object | Payroll Configuration | -- | -- | -- | | | Custom
Setting | Enable Pay Batch Hard Delete | R/E | R/E | R | | | Custom
Setting | | | | | | ## Appendix 2 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to Payee Exit. **Users Key** | | | | ---------- | ------------------------------------------------------------------------ | | **User 1** | Users who are Payroll Users and will create and edit Payee Exits | | **User 2** | Users who are System Administrators and will create and edit Payee Exits | | **User 3** | Users who will view Payee Exits | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | ---------- | ------------------------------- | -------- | -------- | -------- | ------ | | Apex Class | PayeeExitTransactionFactory\_AU | Assigned | Assigned | Assigned | | ## Appendix 3 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to Assignments. **Users Key** | | | | ---------- | ------------------------------------------------------------------------ | | **User 1** | Users who are Payroll Users and will create and edit Assignments | | **User 2** | Users who are System Administrators and will create and edit Assignments | | **User 3** | Users who will view Assignments | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | -------------------- | ----------------------------------------- | ------ | ------ | ------ | ------ | | Custom
Setting: | Disable Assignment Record Type Validation | -- | -- | | | | Custom
Field: | Custom Record Type Id | R/E | R/E | | | ## Appendix 4 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to the Rate Calculator. **Users Key** | | | | ---------- | ----------------------------------------------------------------------------- | | **User 1** | Users who are Payroll Users and will create and edit Rate Calculators | | **User 2** | Users who are System Administrators and will create and edit Rate Calculators | | **User 3** | Users who will view Rate Calculators | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | ---------- | ------------------------------------------------------------------- | -------- | -------- | -------- | ------ | | Apex Class | Batch\_Rate\_Calc\_Line\_Generation
invoke\_RateCalculationNEW | Assigned | Assigned | Assigned | | ## Appendix 5 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to the Invoicing function. **Users Key** | | | | ---------- | ----------------------------------------------------------------------------------------- | | **User 1** | Users who are Payroll Users and will create and edit Invoices and Templates Groups | | **User 2** | Users who are System Administrators and will create and edit Invoices and Template Groups | | **User 3** | Users who will view Invoices and Template Groups | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------ | ------------------------------------------ | ------ | ------ | ------ | ------ | | Object: | Template Group | -- | -- | -- | | | Record
Types | Invoice Settings | R/E | R/E | R | | | Object: | Assignment | -- | -- | -- | | | Custom
Field: | Invoice Settings Template Group | R/E | R/E | R | | | Object: | Invoice Setting | -- | -- | -- | | | Custom
Field: | Template Group
Invoice Group By | R/E | R/E | R | | | Object: | Template Group | -- | -- | -- | | | Page
Layout | Time2Pay Template Group - Invoice Settings | R/E | R/E | R | | ## Appendix 6 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to Assignments using Custom Settings. **Users Key** | | | | ---------- | ----------------------------------------------------------------------- | | **User 1** | Users who are Payroll Users and will update the Custom Settings | | **User 2** | Users who are System Administrators and will update the Custom Settings | | **User 3** | Users who will view the Custom Settings | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------- | ---------------------------------------- | ------ | ------ | ------ | ------ | | Custom
Setting | Disable Assignment RecordType Validation | R/E | R/E | R | | ## Appendix 7 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to STP2 reporting and error handling. **Users Key** | | | | ---------- | ---------------------------------------------------------------------------- | | **User 1** | Users who are Payroll Users and will handle STP reporting and errors | | **User 2** | Users who are System Administrators and will handle STP reporting and errors | | **User 3** | Users who will view STP reporting and errors | **Minimum Access Key** | | | | ----- | -------- | | **R** | Read | | **C** | Create | | **E** | Edit | | **A** | Assigned | | Type | Name | User 1 | User 2 | User 3 | User 4 | | ----------------- | --------------------------------- | -------- | -------- | -------- | ------ | | Apex Class | BatchApexErrorEventTriggerHandler | Assigned | Assigned | Assigned | | | Apex
Trigger | BatchApexErrorEventTrigger | Assigned | Assigned | Assigned | |