> ## 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.
# QRG Rate Calculators - Preview, Clone & Save as Template
## Purpose
The purpose of this quick reference guide is to step through the process of creating Rate Calculator
Previews, Clones, and Save as Template record updates. The intended audience for this document is
System Administrators / Standard Users.
## Steps
To open an existing Rate Calculator record, please follow the steps below:
1. Click on the **App Launcher** icon (see Figure 1).
2. Go to the **Rate Calculators** object by using the Search function (see Figure 2).
3. Open an existing Rate Calculator record (see Figure 3).
### Preview Rate Calculators
Previews allow Rate Calculators to be modified without applying changes to the active Rate Calculator or
any of its related records. Changes made in Preview will be reflected in the Rate Calculator Lines
displayed in the Preview, but no changes will be applied to the original record.
1. Click on the **Edit** button (see Figure 4).
2. Click on the **Preview** button located at the top of the Rate Calculator (see Figure 5).
3. In the window that appears, ensure the **Save as Preview Name** field is populated with a unique
identifier for the Preview, and click on the **Continue** button (see Figure 6).
4. Click on the new **Preview** tab along the top of the screen and make the necessary changes to the
record (see Figure 7).
5. Once all the necessary updates have been made to the Preview, select one of the following actions
available (see Figure 8):
1. Click on the **Save Rate Calculator** button to transfer the changes made in the Preview tab.
2. Click on the **Preview** button to create a new Preview which will be populated with the values
of the current Preview.
3. Click on the **Undo** button to undo the most recent change made in the Preview tab.
4. Click on the **Clone** button to create a new Rate Calculator record populated with the values of
the current Preview.
5. Click on the **Delete** button to discard the Preview and all changes made.
**Important Notes**\
*(Figure 4)*
*There are no restrictions on the number of Previews that can be created, but Previews should be*
*deleted once they are no longer required, to avoid consuming too much data space.*
**Clone Rate Calculator**
Unlike the Preview or Save as Template functionality, Cloning is used to make an exact copy of the Rate
Calculator and all related records with the exception of the Rate Calculator Lines and Account to Rate
Calculator Junctions.
To Clone an existing Rate Calculator record:
1. Click on the **Clone** button located at the top of the Rate Calculator (see Figure 9).
2. To access the new cloned Rate Calculator, click on the **Cloned Rate Calculator** link that is
displayed in the notification banner (see Figure 10).
### Save as Template
The Save as Template feature provides a way to clone an Employee Specific Rate Calculator as a Rate
Calculator Template. This feature allows the new Template to either be applied to the same
Client/Payment Entity that the original record has or to be Globally enabled.
To save a Rate Calculator as a Template:
1. Click on the **Edit** button available on the top right side of the page (see Figure 11).
2. Click on the **Save as Template** button (see Figure 12).
3. Follow this step in the sequence given below:
1. In the window that appears, ensure the following required fields are populated with the
appropriate values (see Figure 13):
1. **Rate Calculator Name**
2. **Effective Date**
2. Populate the following optional fields, as required:
1. **Expiry Date**
2. **Status**
3. To allow the Rate Calculator Template to be related to an Assignment regardless of whether
the same related Client Account or Payment Entity records are shared, check the
**Global Template** checkbox.
**OR**
To determine that the Rate Calculator Template should only be available for the
Client/Payment Entity applied to the existing record, check the
**Create the same Client/Payment Entity** checkbox.
4. To automatically open the Rate Calculator Template upon creation of the new record, check the
**Navigate to the new rate calculator template once created** checkbox.
4. Click on the **Continue** button (see Figure 13).
The new Rate Calculator Template has now been created (see Figure 14).
**Important Notes**\
*(Figure 20)*
*If the checkboxes 'Global Template' or 'Navigate to the new rate calculator template once created'*
*were NOT selected during Rate Calculator Template creation, follow the instructions in step 11 of QRG*
*Rate Calculator Template - Initial Setup to apply the Rate Calculator Template to a different*
*Client/Payment Entity.*
## Field descriptions
| Field Name | Description |
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Award Classification | Defines the Award Classification of the Minimum Pay Rate associated with this Rate Calculator. |
| Award Level | Defines the Award Level of the Minimum Pay Rate associated with this Rate Calculator. |
| Create the same Client/Payment Entity | Determines that the new Rate Calculator Template is created with the same Client/Payment Entity applied as the original Employee Specific Rate Calculator. |
| Define Markup Margin Per Pay Code | Enables the creation of different Mark Up / Margins for each Pay Code. |
| Effective Date | Defines the Effective Date of the Rate Calculator Template. |
| Enable Project Code | Indicates whether Project Codes may be applied to the Rate Calculator Template. |
| Expiry Date | Defines the Expiry Date of the Rate Calculator Template. If blank, no expiry date applies. |
| Global Template | Indicates whether a Rate Calculator Template may be related to Assignments at a Global Level. If unchecked, the Rate Calculator Template will only be available to the related Client or Payment Entity. |
| Industry | Indicates the Industry related to the Rate Calculator. |
| Insurance | Defines the Insurance Employment Cost that applies to the Rate Calculator. |
| Interpretation Rule | Defines the Interpretation Rule that applies to the Rate Calculator. |
| Invoice Tax ID | Defines the Invoice Tax ID that applies to the Rate Calculator. |
| Location | Indicates the Location associated with the Rate Calculator. |
| Navigate to the new rate calculator template once created | Determines that the new Rate Calculator Template record will be opened as soon as it is created. |
| Pay Code | Defines the Pay Code that will be used in the Assignment Rate records which are created. |
| Payroll Tax | Defines the Payroll Tax Employment Cost that applies to the Rate Calculator. |
| Risk Classification | Indicates the Risk Classification associated with the Rate Calculator. |
| Rate Calculator Name | Indicates the short name given to the Rate Calculator for identification. |
| Status | Defines the Status of the Rate Calculator Template. |
| Superannuation | Defines the Superannuation Employment Cost that applies to the Rate Calculator. |
| Update with Employment Costs | Defines whether the Rate Calculator Lines will update automatically when changes are made to a related Employment Costs. Rate Calculators with overrides applied will not automatically update. |
| Update with MPR | Identifies whether the Rate Calculator will automatically create and update associated Rate records according to changes made within the related Minimum Pay Rate records. |
| Update with Parent | Identifies whether child Rate Calculator records will be automatically updated if the Parent Rate Calculator is updated. |
| WHS | Defines the WHS Employment Cost that applies to the Rate Calculator. |
| WorkCover | Defines the WorkCover Employment Cost that applies to the Rate Calculator. |
## Further information
| Document | Document Type | Description |
| ------------------------------------------------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| QRG Rate Calculator Key Information | Information Quick Reference | Outlines useful information relevant to the Rate Calculator functionality. The document includes definitions, prerequisites, and other non-instructional information. |
| QRG Create a Location record | Task Instructions | How to create a Location record used for Rate Calculators. |
| QRG Create a Calculation Method | Task Instructions | How to create Calculation Methods to define the calculation type and unit of calculation for Rate Calculator records. |
| QRG Create an Employment Cost Record | Task Instructions | How to create Employment Cost records used for applying costs to the Rate Calculator. |
| QRG Manage Employment Cost Items using ECM | Task Instructions | How to manage Employment Cost Items using the Employment Cost Manager. |
| QRG Create an Employment Cost Exception | Task Instructions | How to apply Employment Cost Exceptions to Clients, Payees & Pay Codes. |
| QRG Create Pay Rate Loadings | Task Instructions | How to create Pay Rate Loadings used for Casual Loading or Shift Loading. |
| QRG Create Rate Calculators - Templates - Initial Setup | Task Instructions | How to create Rate Calculator Templates - Initial Setup. |
| QRG Create Rate Calculator Templates - Final Setup | Task Instructions | How to create Rate Calculator Templates - Final Setup. |
| QRG Create Rate Calculators - Employee Specific | Task Instructions | How to create an Employee Specific Rate Calculator using Template automation. |