Flame Tree '25 - Upgrade Guide

​

Overview

​

Important Information

​

Pre-Installation Checklist

​

Icons

​

Package Installation

​

Dependencies

​

Configuration Checklist

​

Configuration Items

​

Page Layouts updates to Superannuation Fund (Compulsory) New

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

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.

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.

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:

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.

List<tc9_pr__Superannuation_Fund__c> 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.

// 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

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)

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)

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

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.

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)

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

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.

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)

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)

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

​

Updates to Pay Schedule Records

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.

​

Picklist Values

​

Create new Global Picklist Values and add to the Interpretation Breakpoint (Optional)

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)

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 12.** Assignment Custom Cost 23. Assignment Custom Cost 34. Assignment Custom Cost 45. Assignment Insurance**
   2. Assignment Payroll Tax
   3. Assignment Post Custom Cost 18.** Assignment Post Custom Cost 29. Assignment Post Custom Cost 310. Assignment Post Custom Cost 411. Assignment WHS**
   4. Assignment WorkCover
   5. Client Custom Cost 114.** Client Custom Cost 215. Client Custom Cost 316. Client Custom Cost 417. Client Custom Post Cost 118. Client Custom Post Cost 219. Client Custom Post Cost 320. Client Custom Post Cost 421. Client Insurance**
   6. Client Payroll Tax
   7. Client WHS
   8. Client WorkCover
   9. Payee Custom Cost 126.** 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 12.** Pay Code Custom Cost 23. Pay Code Custom Cost 34. Pay Code Custom Cost 45. Pay Code Insurance**
   2. Pay Code Payroll Tax
   3. Pay Code Post Custom Cost 18.** Pay Code Post Custom Cost 29. Pay Code Post Custom Cost 310. Pay Code Post Custom Cost 411. Pay Code Superannuation**
   4. Pay Code WHS
   5. Pay Code WorkCover

​

STP Lodgement Status (Compulsory)

1. Select Deactivate .

​

Schedule Job Script

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’

** 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.

​

Bulk User and Service Resource Creation (Conditionally Compulsory)

​

Script for Bulk User and Service Resource Creation

​

Resource Absence creation - Bulk creation (Conditionally Compulsory)

​

Schedule Job Script

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

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.

​

Appendix 1

​

Appendix 2

​

Appendix 3

​

Appendix 4

​

Appendix 5

​

Appendix 6