> ## Documentation Index > Fetch the complete documentation index at: https://documentation.2cloudnine.com/llms.txt > Use this file to discover all available pages before exploring further. # Flame Tree '25 - Upgrade Guide export const InlineImage = ({src, alt = "", height = "1.6em"}) => { return {alt}; }; ### Overview | **Release:** | Flame Tree | | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Version:** | v1.244 | | **Release Date:** | 23/01/2026 | | **Packages updated:** | | ### Important Information Only your authorised Salesforce System Administrator or Partner should be actioning any installation, configuration items, and related tasks. The 2cloudnine Payroll Package & Time2Pay Extension Package within this release must be updated if they are already being used. There may be compulsory and optional configuration items and tasks that need to be completed pre and post the installation of the packages. These will be outlined in the checklists below, with further details given within this document. The installer will be responsible for ensuring all these configuration items and tasks are completed within a reasonable timeframe of the packages being installed. Please ensure you have familiarised yourself with all of the requirements before installing the packages and that you have sufficient time and resources available. Failing to do so can negatively impact the User experience and stability of 2cloudnine Payroll. This guide should always be opened and used via your web browser. This will ensure you are viewing the most recent version of the document. Further, downloading the document and opening it with desktop programs, such as Adobe, has been found to cause errors when copying and using the scripts provided for data updates. These errors do not occur when viewed through a browser. ### Pre-Installation Checklist The following items are highly recommended to be completed before commencing the installation and configuration of packages within this release. | | Configuration Item / Task | Requirement? | | ------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------- | | Existing Component Review | | | | | Check the current version of the packages that are installed | **Compulsory** | | New Component Review | | | | | Remove/rename duplicate objects | **Optional** | | | Remove/rename duplicate record types | **Optional** | | | Remove/rename duplicate fields | **Optional** | ### Icons Please refer to the legend below when referencing the icons used throughout the document: | No icon | Icons are NOT used within the original version of a release, or if no changes are made to the
configuration steps in subsequent versions of the document, it will remain without ANY
update icon. | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Update | A new update introduced in the current version of the release document, therefore not in
any previous versions. Any detailed requirements must be actioned. | | Update | An update not in the original version, however, was added in a previous release document
with no further updates for the current release document. If you've been up to date with
the previous versions of the Upgrade Guide from this Release, this can be ignored as it
would have been completed previously. | | New | A brand new package, a new version of a package, or a brand new functionality, with its first
appearance in this release document, that was not included in the previous release
document. Any detailed requirements must be actioned. | | New | A brand new package, a new version of a package, or a brand new functionality, not in the
original release document. This was added in a previous version of the release document,
with no further updates for the current release document. If you’ve been up to date with
the previous versions of this Upgrade Guide from this Release, this can be ignored as it
would have been completed previously. | **IMPORTANT:** If you are installing the Flame Tree release for the first time, then the above icons can be ignored, as you will need to install and configure this entire document. ### Package Installation The installation and configuration of the following packages must be completed as part of the Flame Tree ‘25 Release Upgrade: | Package | Version | Requirement | Installation Link | | ---------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------- | ----------------------------------------------------------------- | | 2cloudnine Payroll | v1.244 | **Compulsory** | packaging/installPackage.apexp?p0=0
4tIS0000004vFn\&isdtp=p1 | | 2cloudnine Payroll
Time2Pay Extension | v1.227
Update | **Compulsory** | packaging/installPackage.apexp?p0=0
4tGB000003FjCg | | 2cloudnine Payroll
Australia Lodgement
Extension | v1.107
Update | **Compulsory** | packaging/installPackage.apexp?p0=0
4tIS000000gfj9 | | 2cloudnine Payroll Data
Creation Extension | v1.79 | **Compulsory** | packaging/installPackage.apexp?p0=0
4tIg000000gQAf\&isdtp=p1 | | 2cloudnine Field Service
Extension | v1.25 | **Conditional**
**Compulsory** | packaging/installPackage.apexp?p0=0
4tJ20000004faZ | | 2cloudnine Agreements | v0.4.0.1 Beta
Update | **Optional** | Please reach out to 2cloudnine for the
link | ### Dependencies This version of the Flame Tree Release contains multiple packages that have been updated, with some packages having dependencies on others. Any packages that have been listed as Compulsory in the Installation and Configuration checklist must be updated, and this should be done in the sequence given in the checklist. ### Configuration Checklist | | Configuration Item / Task | Requirement? | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | [Page Layouts updates to Superannuation Fund](#page-layouts-updates-to-superannuation-fund-compulsory-new) | | | | | [Page Layouts updates to Superannuation Fund](#page-layouts-updates-to-superannuation-fund-compulsory-new) | **Compulsory** | | [SUPERAPI updated to remove Super Choice Fund Identifier](#superapi-updated-to-remove-super-choice-fund-identifier-compulsory-new) | | | | | [SUPERAPI updated to remove Super Choice Fund Identifier](#superapi-updated-to-remove-super-choice-fund-identifier-compulsory-new) | **Compulsory** | | [Updates to Page Layouts](#updates-to-page-layouts) | | | | | [Assignment](#assignment-optional) | **Optional** | | | [Assignment Rate](#assignment-rate-compulsory) | **Compulsory** | | | [Interpretation Rule & Interpretation Breakpoint](#interpretation-rule-interpretation-breakpoint) | **Optional** | | | [Employment Cost](#employment-cost-optional) | **Optional** | | | [Leave](#leave) | **Optional** | | | [Schedule](#schedule-optional) | **Optional** | | | [Timesheet Entry](#timesheet-entry-optional) | **Optional** | | [2cloudnine Agreements Package](#2cloudnine-agreements-package) | | | | | [2cloudnine Agreements Package](#2cloudnine-agreements-package) | **Optional** | | [Updates to Pay Schedule Records](#updates-to-pay-schedule-records) | | | | | [Updates to Pay Schedule Records](#updates-to-pay-schedule-records) | **Optional** | | [Picklist Values](#picklist-values) | | | | | Create new Global Picklist Values and add to the Interpretation
Breakpoint | **Optional** | | Archiving Employment Cost Exception Record Types | | | | | Archiving Employment Cost Exception Record Types | **Optional** | | [STP Lodgement Status](#stp-lodgement-status-compulsory) | | | | | [STP Lodgement Status
](#stp-lodgement-status-compulsory) | **Compulsory** | | Bulk User and Service Resource Creation | Col2 | Col3 | | | [Bulk User and Service Resource Creation](#bulk-user-and-service-resource-creation-conditionally-compulsory) | **Conditionally Compulsory** | | [Resource Absence creation - Bulk Creation](#resource-absence-creation-bulk-creation-conditionally-compulsory) | | | | | [Resource Absence creation - Bulk Creation](#resource-absence-creation-bulk-creation-conditionally-compulsory) | **Conditionally Compulsory** | ### Configuration Items ### Page Layouts updates to Superannuation Fund (Compulsory) New The following Page Layout updates are Compulsory: Go to **Setup** - **Object Manager** - **Superannuation Fund** - **Page Layouts > Page Layout Assignment > Edit Assignment** button 1. Click the Record Type **APRA and RSA Funds** to highlight all rows below. 2. In the Picklist for Page Layout To Use, select **TC9EAU APRA and RSA Fund Layout** . 3. Click the Record Type **Self Managed** to highlight all rows below. 4. In the Picklist for Page Layout To Use, select **TC9EAU Self Managed Superannuation Fund Layout** . 5. Click **Save** . ### SUPERAPI updated to remove Super Choice Fund Identifier (Compulsory) New The following steps are Compulsory for all Orgs. Go to **Setup > Scheduled Jobs** 1. Find the job “Schedule\_RetrieveActiveFunds”, take note of the original time/day it is scheduled to run, and select **Del** next to the job to delete it. 2. Go to the Superannuation Fund Object and review the History Tracking to ensure the following fields are being tracked: 1. External Id (SuperChoice) tc9\_eau External Id (there are 2 of these External Id fields that do not have a suffix - track both if you are unsure which one to track) 2. Fund Name 3. Product Name 3. Whilst in the Superannuation Fund Object, review the security on the two fields called Name and External Id (tc9\_eau). Users who have access to other Superannuation Fund fields should have access to these fields as well. 4. Run Query 1 in Dev Console to find any Payee Withholdings that are using Superannuation Funds that were in the list of SuperChoice duplicate USIs. 1. Go to **Setup** - **Developer Console**, select **Query Editor**, and paste the following text without any hard returns, and then select **Execute** : 5. From the results, if there are multiple Super Funds records listed that contain the same USI, the main record should have its External Id (SuperChoice) field populated with the USI, and for any additional records using the same USI, update the External Id (SuperChoice) field to blank. By removing the value from the External Id (SuperChoice) field, this will stop the integration from overwriting the Super Fund details in the future, as these funds should not be maintained, however, remain untouched to preserve legacy data. ```sql Query 1 theme={null} Select Id, Name, tc9_pr__Effective_Date__c, tc9_pr__Expiry_Date__c, tc9_pr__Superannuation_Fund__r.Name, tc9_pr__Superannuation_Fund__r.tc9_pr__Fund_Name__c, tc9_pr__Superannuation_Fund__r.tc9_pr__Unique_Superannuation_Identifier__c from tc9_pr__payee_withholding__c where tc9_pr__Superannuation_Fund__c != null AND tc9_pr__Superannuation_Fund__c IN (Select Id from tc9_pr__Superannuation_Fund__c where RecordType.DeveloperName = 'APRA_and_RSA_Funds' AND tc9_pr__Unique_Superannuation_Identifier__c IN ('11562340193001', '12003353408001', '15260523913001', '15422102060001', '16671124954001', '17859530306001', '19905422981999', '20891605180001', '24496637884020', '28411695605001', '32367272075151', '33632838393987', '37519822530001','38024193798001', '38876896681007', '38876896681010', '40328908469247', '43905581638011', '43905581638012', '43905581638013', '43905581638014', '43905581638015', '49820299297001', '53226460365001', '56247235345001', '57922340321001', '68486630403001', '68964712340002', '78060306171001', '78518223941001', '82144194929050', '83997082793001', '84575374657001', '92736076512001', '96542365910001', '98128502602001', '98350952022100', '98503137921001', 'BUS0002AU', 'CAR0100AU', 'LIS0100AU', 'OAM0001AU', 'PTC0133AU', 'RES0103AU', 'SSP0001AU', 'STA0100AU') ) ORDER BY tc9_pr__Superannuation_Fund__r.Name ``` 6. Run Script 1 (below) to delete the APRA Superannuation Fund records that do not have any related Payee Withholding records or related Pay Transactions. 1. Copy the block of script to be run. 2. Select **Setup > Developer Console > Debug > Open Execute Anonymous Window** 3. Delete or comment out any code that is in the window 4. Paste in the copied Script 1 from below. 5. Click the **Execute** button. ```apex Script 1 theme={null} DELETE [Select Id, Name, CreatedDate from tc9_pr__Superannuation_Fund__c where RecordType.DeveloperName = 'APRA_and_RSA_Funds' and Id NOT IN (Select tc9_pr__Superannuation_Fund__c from tc9_pr__Payee_Withholding__c) AND ID NOT IN (Select tc9_pr__Superannuation_Fund__c from tc9_pr__Pay_Transaction__c)]; ``` 7. Run Query 2 (below) to check for duplicate funds, grouped by USI: 1. Go to Setup > **Developer Console**, select **Query Editor**, paste the following text without any hard returns, and select Execute: ```sql Query 2 theme={null} Select Id, tc9_pr__Fund_Name__c, tc9_pr__Unique_Superannuation_Identifier__c from tc9_pr__Superannuation_Fund__c where RecordType.DeveloperName = 'APRA_and_RSA_Funds' AND tc9_pr__Unique_Superannuation_Identifier__c IN ('11562340193001', '12003353408001', '15260523913001', '15422102060001', '16671124954001', '17859530306001', '19905422981999', '20891605180001', '24496637884020', '28411695605001', '32367272075151', '33632838393987', '37519822530001','38024193798001', '38876896681007', '38876896681010', '40328908469247', '43905581638011', '43905581638012', '43905581638013', '43905581638014', '43905581638015', '49820299297001', '53226460365001', '56247235345001', '57922340321001', '68486630403001', '68964712340002', '78060306171001', '78518223941001', '82144194929050', '83997082793001', '84575374657001', '92736076512001', '96542365910001', '98128502602001', '98350952022100', '98503137921001', 'BUS0002AU', 'CAR0100AU', 'LIS0100AU', 'OAM0001AU', 'PTC0133AU', 'RES0103AU', 'SSP0001AU', 'STA0100AU') ``` 8. Run Script 2 (below) to populate the External Id field with the USI value, rather than the old SuperChoice Id: 1. Copy the block of script to be run. 2. Select **Setup > Developer Console** 3. **Debug > Open Execute Anonymous Window** 4. Delete or comment out any code that is in the window 5. Paste in the copied script from below. 6. Click the **Execute** button. ```apex Script 2 theme={null} List apraFunds = [Select Id, tc9_eau__External_Id__c, tc9_pr__Unique_Superannuation_Identifier__c from tc9_pr__Superannuation_Fund__c where RecordType.DeveloperName = 'APRA_and_RSA_Funds' AND tc9_eau__External_Id__c != NULL]; for(tc9_pr__Superannuation_Fund__c apraFund : apraFunds){ apraFund.tc9_eau__External_Id__c = apraFund.tc9_pr__Unique_Superannuation_Identifier__c; } update apraFunds; ``` 9. Run Script 3 (below) to instantly run the Superannuation Fund Retrieval job within Dev Console. This will pull in the complete list of Super Funds: 1. Copy the block of script to be run. 2. Select **Setup > Developer Console** 3. **Debug > Open Execute Anonymous Window** 4. Delete or comment out any code that is in the window 5. Paste in the copied script from below. 6. Click the **Execute** button. ```apex Script 3 theme={null} // Script 3 to instantly run the Super Fund Retrieval job tc9_eau.Schedule_RetrieveActiveFunds s = new tc9_eau.Schedule_RetrieveActiveFunds(); s.execute(null); ``` 10. Run a Report on the history of the Superannuation Fund Object to review the data changed today. 11. Reschedule the Fund Retrieval job based on the original schedule (below): Go to **Setup > Apex Classes > Schedule Apex** button 1. Enter the following details: 1. **Job Name:** Schedule\_RetrieveActiveFunds 2. **Apex Class:** Schedule\_RetrieveActiveFunds 3. **Frequency:** as per originally scheduled 4. **Recurs every week on:** as per originally scheduled 5. **Start:** keep the existing date 6. **End:** add 40 years to end date (i.e. 01/01/2066) 7. **Preferred Start Time:** as per originally scheduled 2. Click **Save** . ### Updates to Page Layouts The Flame Tree ‘25 Release includes the following enhancements to the Page Layouts. To update the Page Layouts, please follow the steps below: Configuration steps: 1. Assignment (Optional) 2. Assignment Rate (Compulsory) 3. Interpretation Rule & Interpretation Breakpoint (Optional) 4. Employment Cost (Optional) 5. Leave (Optional) 6. Schedule (Optional) 7. Timesheet (Optional) 8. Timesheet Entry (Optional) #### Assignment (Optional) The following Page Layout updates are Optional: Go to **Setup** > **Object Manager** > **Assignment** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout used for the Temp Record Type. 2. Add the following fields to the Page Layout: 1. **Assignment Rate Matching Mode** 3. Click **Save** . #### Assignment Rate (Compulsory) The following Page Layout updates are Compulsory: Go to **Setup** > **Object Manager** > **Assignment Rate** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout used for the Timesheet Record Type or select **Time2Pay Assignment Rate - Timesheet** . 2. Remove the following fields from the Page Layout: 1. Auto Pay 2. Auto Pay Calculation Basis 3. Pro Rata Method 4. Reason 5. Pay Rate Frequency 6. Regular Units per Period 3. Remove the following sections from the Page Layout: 1. TEST 2. DO NOT PACKAGE 4. Click **Save** . #### Interpretation Rule & Interpretation Breakpoint The following Page Layout updates are Optional: **Interpretation Rule (Optional)** Go to **Setup** > **Object Manager** > **Interpretation Rule** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout used for the Shift Start Time Record Type. 2. Add the following fields to the Page Layout: 1. **Penalty Based on Std Time End** (added under the field Apply Shift Based Interpretation). 3. Click **Save** . 4. Repeat steps 1-3 above for the Page Layouts assigned to the Shift End Time and the Interpretation Variation Rule Record Types. **Interpretation Breakpoint (Optional)** Go to **Setup** > **Object Manager** > **Interpretation Breakpoint** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout used for the Pay Code Cap Record Type. 2. Add the following fields to the Page Layout: 1. **Shift Pay Code Cap** (added under the checkbox No Cap Required in the section Breakpoint Details). 3. Click **Save** and then select the Page Layout used for the Allowance Breakpoint Record Type. 4. Add the following fields to the Page Layout next to the Pay Code field: 1. Saturday Pay Code 2. Sunday Pay Code 3. Public Holiday Pay Code 5. Add the following field to the Page Layout under the Breakpoint Type Picklist: 1. Overtime Hours Type 6. Click **Save** . #### Employment Cost (Optional) The following Page Layout updates are Optional: Go to **Setup** > **Object Manager** > **Employment Cost** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout used for all Record Types except Superannuation or select **Time2Pay Employment Cost - Non Superannuation** . 2. Remove the following fields from the Page Layout: 1. Last Date Rate Calc Update Completed 2. Last Date Rate Calc Update Required 3. Click **Save** . #### Leave The following Page Layout updates are Optional: **Payee Leave Event (Optional)** Go to **Setup** > **Object Manager** > **Payee Leave Event** > **Page Layouts** > **Page Layout Assignments** 1. Select the Page Layout assigned to the Record Type of Leave Takes. 2. Add the following fields to the Page Layout for all Users: 1. **Start Time** 2. **End Time** 3. **Timesheet Entry Last Updated** 4. **Timesheet Entry Creation Status** 5. **Source Leave Event** 3. Click **Save** . 4. Repeat steps 2 and 3 for any remaining Page Layouts assigned to the Leave Takes Record Type. **Leave Rule (Optional)** Go to **Setup** > **Object Manager** > **Leave Rule** > **Page Layouts** 1. Select **TC9PR Leave Rule Layout** . 2. Add the following fields to the Page Layout: 1. **Public Holiday Not Worked Leave Rule** 3. Click **Save** . 4. Repeat steps 2-3 for any other Custom Page Layouts which might be used within your Org. #### Schedule (Optional) A default number of earlier Pay Calendar Periods can now be defined on a Pay Schedule record, which will be used to limit the number of prior Calendar Periods considered when creating a new Pay Batch. The configuration below is Optional and based on the requirements of the Org. To add the Maximum Earlier Pay Calendar Periods to the Pay Schedule Page Layout(s), follow these steps: 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. **TC9PR Pay Schedule Layout** ). 3. Add the following fields to the Page Layout, at the bottom right of the Contact Information section: 1. Maximum Earlier Pay Calendar Periods 4. Click **Save** . 5. Repeat for any other Custom Page Layouts assigned to the Record Type of Pay Schedule. #### Timesheet Entry (Optional) The following Page Layout updates are Optional: Go to **Setup** > **Object Manager** > **Timesheet Entry** > **Page Layouts** 1. Select **Time2Pay Timesheet Entry** . 2. Add the following fields to the Page Layout under the field Payee Leave Event: 1. **Source Leave Event** 3. Add the following fields to the Page Layout under the field Public Holiday Calendar: 1. **Public Holiday Calendar Override** . 4. Click **Save** . 5. Repeat steps 2-3 for any other custom Page Layouts which might be used within your Org. ### 2cloudnine Agreements Package The Flame Tree Upgrade Guide doesn’t cover any configuration for the new 2cloudnine Agreements Package. The Agreements package will contain a stand-alone Configuration and Implementation Guide, which will be available on request. If you need any assistance, please contact your 2cloudnine Administrator. ### Updates to Pay Schedule Records The configuration to add the new field called Maximum Earlier Pay Calendar Periods on Pay Schedules has been provided above. Once the configuration has been completed, updates need to be made to each of the existing Pay Schedules to populate this new field. The configuration given below is Optional. To update the existing records, follow the steps below: Go to **App Launcher > Schedules > List View > Payroll Schedules** 1. Open a Pay Schedule. 2. Select **Edit** . 3. Populate the desired number of periods in the **Maximum Earlier Pay Calendar Periods** field. 4. Select **Save** . 5. Repeat for each Pay Schedule. **NOTE** : Alternatively, Pay Schedules can be updated via inline editing instead of individual updates. ### Picklist Values #### Create new Global Picklist Values and add to the Interpretation Breakpoint (Optional) The configuration below is Optional. New Picklist Values need to be created for the Interpretation Breakpoint Object and assigned to the Allowance Breakpoint Record Type, for the new Standard Hours Allowances to work. To add and assign the new values, follow the steps below: Go to **Setup** > **Picklist Value Sets** > **Threshold Type Picklists** . 1. Scroll down to the section ‘Values’ and select the **New** button. 2. Enter the new value **Standard Hours** in the textbox. 3. Go to **Object Manager** - **Interpretation Breakpoint** - **Record Types** - **Allowance Breakpoint** . 4. Select **Edit** next to Start Threshold Type. 5. Select **Standard Hours** in Available Values, and select the **Add** - button to move it to the Selected Values section. 6. Click **Save** . ### Archive Employment Cost Exception Record Types (Optional) The configuration below to deactivate the Record Types of Employment Cost Exception is Optional. To deactivate the obsolete Record Types, please follow the steps below: Go to **Setup** > **Object Manager** > **Employment Cost Exception** > **Record Types** 1. Make the following Record Types Inactive from the Employment Cost Exception Object by selecting each Record Type detailed below, clicking the **Edit** button, deselecting the **Active** checkbox, and then clicking the **Save** button: 1. **Assignment Custom Cost 1**2.\*\* Assignment Custom Cost 2**3.** Assignment Custom Cost 3**4.** Assignment Custom Cost 4**5.** Assignment Insurance\*\* 2. **Assignment Payroll Tax** 3. **Assignment Post Custom Cost 1**8.\*\* Assignment Post Custom Cost 2**9.** Assignment Post Custom Cost 3**10.** Assignment Post Custom Cost 4**11.** Assignment WHS\*\* 4. **Assignment WorkCover** 5. **Client Custom Cost 1**14.\*\* Client Custom Cost 2**15.** Client Custom Cost 3**16.** Client Custom Cost 4**17.** Client Custom Post Cost 1**18.** Client Custom Post Cost 2**19.** Client Custom Post Cost 3**20.** Client Custom Post Cost 4**21.** Client Insurance\*\* 6. **Client Payroll Tax** 7. **Client WHS** 8. **Client WorkCover** 9. **Payee Custom Cost 1**26.\*\* Payee Custom Cost 2\*\* aa.\*\* Payee Custom Cost 3\*\* bb.\*\* Payee Custom Cost 4\*\* cc.\*\* Payee Custom Post Cost 1\*\* dd.\*\* Payee Custom Post Cost 2\*\* ee.\*\* Payee Custom Post Cost 3\*\* ff.\*\* Payee Custom Post Cost 4\*\* gg.\*\* Payee Insurance\*\* hh. **Payee Payroll Tax** 1. **Payee WHS** jj. **Payee WorkCover** 2. Once completed, please refresh the page and ensure the Employment Cost Exception Object has only the following Record Types available: 1. **Pay Code Custom Cost 1**2.\*\* Pay Code Custom Cost 2**3.** Pay Code Custom Cost 3**4.** Pay Code Custom Cost 4**5.** Pay Code Insurance\*\* 2. **Pay Code Payroll Tax** 3. **Pay Code Post Custom Cost 1**8.\*\* Pay Code Post Custom Cost 2**9.** Pay Code Post Custom Cost 3**10.** Pay Code Post Custom Cost 4**11.** Pay Code Superannuation\*\* 4. **Pay Code WHS** 5. **Pay Code WorkCover** ### STP Lodgement Status (Compulsory) The following configuration (script) is Compulsory, however, this first step of deactivating the Workflow Rule only needs to be followed if the Workflow Rule is currently active. Go to **Setup** > **Workflow Rules** > **STP Email - Processed by ATO** 1. Select **Deactivate** . #### Schedule Job Script The configuration below is Compulsory. To run the script, please follow the steps below: 1. Copy the block of scripts to be run. 2. Select **Setup > Developer Console** 3. **Debug > Open Execute Anonymous Window** 4. Delete or comment out any code that is in the window 5. Paste in the copied script from below. 6. Click the **Execute** button. 7. Repeat the above steps until the last script. #### Script to update STP Lodgement AU Status to ‘Completed’ Screenshot from 2cloudnine Payroll v1.244 Flame Tree _25 - Upgrade Guide\*\* IMPORTANT\*\* : This may have to be executed multiple times as it is limited to updating 200 records in each execution, due to Salesforce governor limits. If the Org has more than 200 STP Lodgement AU records to be updated to Completed, you will have to run this multiple times until they are all updated. You can review the log after each execution to see how many Lodgement AU records were selected and updated. If the STP Email - Processed by ATO Workflow Rule WAS active at the start of this process, please reactivate it after all remaining Lodgement AU records have been updated. ### Bulk User and Service Resource Creation (Conditionally Compulsory) Due to the number of scheduled jobs within our system, we recommend scheduling one job every hour. Only one operation should be executed at a time. There is a requirement to automatically create the Service Resource from the Payee record. A scheduled job is the method of choice for such requirements, as it avoids a User from manually selecting records and clicking on an action item/button. #### Script for Bulk User and Service Resource Creation ### Resource Absence creation - Bulk creation (Conditionally Compulsory) The Resource Absence creation is triggered when a User updates the Payee Leave Event to meet a certain criteria. This will only occur if the User updating and saving the Payee Leave Event record has the correct security for the Resource Absence (RA). We have found that Payroll Users may need to trigger the creation of a Resource Absence when they create the Payee Leave Event (PLE), but do not need access to the Resource Absence record. Therefore, we now have a scheduled job that runs and creates the Resource Absence in the background after the PLE is created. The configuration below is Conditionally Compulsory: #### Schedule Job Script Below are the different scripts required to set up the various scheduled jobs. To run scripts: 1. Copy the block of scripts to be run. 2. Select **Setup > Developer Console** 3. **Debug > Open Execute Anonymous Window** 4. Delete or comment out any code that is in the window 5. Paste in the copied script from below. 6. Click the **Execute** button. 7. Repeat the above steps until the last script. #### Script to bulk Create Resource Absence #### Create Service Resource Button #### List View Layout update There is a new Custom button that needs to be added to the List View for the Payee Object, by following these steps: Go to **Setup** > **Object Manager** > **Payee** > **List View Button Layout** 1. Select the drop-down arrow at the far right of the List View layout. 2. Select the **Edit** option. 3. In the Available Buttons list, select **Create Service Resource**, and select the **Add** button, to add it to the Selected Buttons list. 4. Select the **Save** button. Once added to the List View buttons, Users can select this button to manually enable the integration for creating Resource Absence records. This is especially useful if the limit of the Scheduled Job is reached. ### 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. * **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 \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------ | ------------------------------------ | ------ | ------ | ------ | ------ | | Object: | [Schedule](#schedule-optional) | -- | -- | -- | | | Custom
Field: | Maximum Earlier Pay Calendar Periods | R/E | R/E | R | | ### Appendix 2 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to the Interpretation Rules. * **User 1** - Users who are Payroll Users and will create and edit the Interpretation Rules \* **User 2** - Users who are System Administrators and will create and edit the Interpretation Rules \* **User 3** - Users who will view the Interpretation Rules \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------- | ------------------------------------------- | ------ | ------ | ------ | ------ | | Object: | Interpretation Field | -- | -- | -- | | | Custom
Field: | Penalty Based on Std Time End | R/E | R/E | R | | | Object: | Interpretation Breakpoint | -- | -- | -- | | | Custom
Fields: | Shift Pay Code Cap
Overtime Hours Type | R/E | R/E | R | | ### Appendix 3 The table below defines the access that must be granted to Internal Users for new components introduced to provide further enhancements to the Assignments. * **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 \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------- | ---------------------------------- | ------ | ------ | ------ | ------ | | Object: | [Assignment](#assignment-optional) | -- | -- | -- | | | Custom
Fields: | Assignment Rate Matching Mode | R/E | R/E | R | | ### 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 Leave functionality. * **User 1** - Users who are Payroll Users and will create and edit Leave \* **User 2** - Users who are System Administrators and will create and edit Leave \* **User 3** - Users who will view Leave \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------ | ------ | | Object: | Leave Rule | -- | -- | -- | | | Custom
Field: | Public Holiday Not Worked Leave Rule | R/E | R/E | R | | | Object: | [Timesheet Entry](#timesheet-entry-optional) | -- | -- | -- | | | Custom
Field: | Public Holiday Calendar Override
Source Leave Event | R/E | R/E | R | | | Object: | Payee Leave Event | -- | -- | -- | | | Fields: | Start Time
End Time
Timesheet Entry Last Updated
Source Leave Event
Timesheet Entry Creation Status | R/E
| R/E
| R
| | | Record
Type | Pre Approval | Pre Approval | Pre Approval | Pre Approval | | ### 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 various settings and Picklist values. * **User 1** - Users who are Payroll Users and will create and edit a Picklist value \* **User 2** - Users who are System Administrators and will create and edit a Picklist value \* **User 3** - Users who will view a Picklist value \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | --------------------------------------------------- | --------------------------------------------------------------------------------- | ------- | ------- | ------- | ------ | | Global
Picklist | Overtime Hours Type
Record Creation Status | R/E | R/E | R | | | Lightning
Component
Bundle | customMultiPicklist
customInputCell | R/E | R/E | R | | | Object: | Threshold Type Picklists | -- | -- | -- | | | Picklist
Value (for
Global
Picklist) | Standard Hours | R/E | R/E | R | | | Apex Class | InterpretationCalcHelper | Enabled | Enabled | Enabled | | | Custom
Labels | VMSG\_Schedule\_MaxEarlierCPLessThanOne
VMSG\_Schedule\_MaxEarlierCPTooLarge | 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 the Field Service. * **User 1** - Users who are Payroll Users and will create and edit Field Service \* **User 2** - Users who are System Administrators and will create and edit Field Service \* **User 3** - Users who will view Field Service \* **R** - Read \* **C** - Create \* **E** - Edit \* **A** - Assigned | Type | Name | User 1 | User 2 | User 3 | User 4 | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | ------- | ------ | | Object: | Field\_Service\_Batch\_Size\_\_mdt | -- | -- | -- | | | Custom
Metadata: | Batch\_CreateServiceResource
Batch\_CreateResourceAbsence | R/E | R/E | R | | | Custom
Tab: | Create Service Resource
Create Resource Absence | R/E | R/E | R | | | Flexipage: | Create\_Service\_Resource
Create\_Resource\_Absence | R/E | R/E | R | | | LightningC
omponent
Bundle | createServiceResourceProgress
createResourceAbsenceProgress | R/E | R/E | R | | | Object: | Payee | -- | -- | -- | | | Button or
Link: | [Create Service Resource](#create-service-resource-button) | R/E | R/E | R | | | Object: | Payee Leave Event | -- | -- | -- | | | Button or
Link: | Create Resource Absence | R/E | R/E | R | | | Object: | Integration Configuration | -- | -- | -- | Col6 | | Custom
Field: | Payee Leave Event Maximum Week | R/E | R/E | R | | | Apex Class | AsyncApexJobUtil
AsyncJobStatusService
Batch\_CreateServiceResource
BatchApexInvoker
BatchLogHelper
Constants
CreateServiceResourceController
CreateServiceResourceInvoker
ErrorLoggingQueueable
FieldServiceValidator
FSIntegrationConfigurationService
ScheduleBatch\_CreateServiceResource
Test\_AsyncApexJobUtil
Test\_AsyncJobStatusService
Test\_Batch\_CreateServiceResource
Test\_CreateServiceResourceController
Test\_CreateServiceResourceInvoker
Test\_ErrorLoggingQueueable
Test\_FieldServiceValidator
Test\_FSIntegrationConfigurationService
Test\_ScheduleBatch\_CreateServiceResource
UtilClass | Enabled | Enabled | Enabled | |