> ## Documentation Index
> Fetch the complete documentation index at: https://docs.2cloudnine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# User Guide Configure Conditional Pay Rules - Utilities

> Create Conditional Pay Rules that pay a premium for missed, short or late meal and rest breaks.

> [!WARNING]
>
> **Draft for review.** Field labels and picklist values were checked against a live Org. The Add Rule and Save Rule button labels, the default values on a new row, and the error and warning messages have not been verified on screen yet.

## Purpose

The purpose of this user guide is to step through creating Conditional Pay Rules in Conditional Rule Setup, as part of the Utility Extension. The intended audience for this document is System Administrators.

A Conditional Pay Rule sets the premium paid when break capture records a missed, short or late meal or rest break. Each rule prices one Condition Type and one Condition Outcome under one Interpretation Rule. When a Timesheet reaches Processed, a premium Pay Transaction is created on the rule's Pay Code. Conditional Pay prices the outcome that break capture recorded and never changes it.

> [!NOTE]
>
> **Important Notes** (Before you start)
>
> * Break capture must be set up on the Interpretation Rule, and workers must be completing the break attestation. Only Timesheet Entries with a Break Attestation Status of Complete are priced.
> * Each premium needs its own dedicated Pay Code, and each Assignment needs an active Timesheet Assignment Rate for that Pay Code. Without the Assignment Rate, no premium is created.
> * The **2cloudnine Conditional Pay Config** permission set is needed to configure rules. Every user who moves a Timesheet to Processed needs **2cloudnine Conditional Pay Runtime**.
> * There is no enable switch. An Active rule turns the feature on for that Interpretation Rule.

## Steps

1. [Open Conditional Rule Setup](#open-conditional-rule-setup)
2. [Add a Conditional Pay Rule](#add-a-conditional-pay-rule)
3. [Save the Rules](#save-the-rules)
4. [Switch the Rules On](#switch-the-rules-on)

### Open Conditional Rule Setup

1. Within the **Interpretation Rule** for the jurisdiction being configured, click on the **Conditional Rules** tab (see Figure 1). The Interpretation Rule is taken from the record, so there is nothing to select.
   * **Alternatively**, click on the **App Launcher** icon and go to **Conditional Rule Setup** by using the Search function. When using this option, populate the **Interpretation Rule** field with the Interpretation Rule for the jurisdiction being configured.

Figure 1

![Screenshot from User Guide Configure Conditional Pay Rules - Utilities](https://mintcdn.com/2cloudnine-2edf05eb/n5PioWp-Ewe9dY_T/images/generated/reference-guides/utilities/user-guide-configure-conditional-pay-rules-utilities/user-guide-configure-conditional-pay-rules-utilities-v2-figure-1.png?fit=max\&auto=format\&n=n5PioWp-Ewe9dY_T\&q=85\&s=f1cc883030b871131ae031752877278d)

### Add a Conditional Pay Rule

1. Click the **Add Rule** button. A new row appears.
2. Populate the following required fields (see Figure 2):
   * **Condition type**: Meal or Rest.
   * **Condition outcome**: Missed, Short, Late or Not Captured.
   * **Quantity basis**: Fixed Hours or Shortfall.
   * **Pay code**: the dedicated premium Pay Code.
   * **Cap basis**: One Per Window or None.
   * **Active**: Yes or No.
3. Where **Quantity basis** is Fixed Hours, populate the **Quantity** field with the additional hours owed, not the statutory total. The field is hidden when Shortfall is selected.
4. To record the statute or case the rule is based on, populate the **Legal citation** field.
5. Repeat steps 1 to 4 for each further Condition Type and Condition Outcome to be priced.

Figure 2

![Screenshot from User Guide Configure Conditional Pay Rules - Utilities](https://mintcdn.com/2cloudnine-2edf05eb/n5PioWp-Ewe9dY_T/images/generated/reference-guides/utilities/user-guide-configure-conditional-pay-rules-utilities/user-guide-configure-conditional-pay-rules-utilities-figure-3.png?fit=max\&auto=format\&n=n5PioWp-Ewe9dY_T\&q=85\&s=bddcbf63847f3684856c6b1e9b62a5c0)

> [!NOTE]
>
> **Important Notes**
>
> * Only one Active rule is allowed per Interpretation Rule, Condition Type and Condition Outcome.
> * Rest cannot be paired with Late or Not Captured. Break capture never records those outcomes for rest.
> * Use Fixed Hours for Rest with Short, and for Meal with Late. Shortfall cannot price either, so no premium is created and a Debug Log entry records why.

### Save the Rules

1. Click the **Save Rule** button (see Figure 3).
2. Review any messages shown above the rows:
   * **Errors** stop the save, and nothing is written. Correct the rows listed and save again.
   * **Warnings** do not stop the save. Review each one, as a warning usually means a rule that can never pay.

Figure 3

![Screenshot from User Guide Configure Conditional Pay Rules - Utilities](https://mintcdn.com/2cloudnine-2edf05eb/n5PioWp-Ewe9dY_T/images/generated/reference-guides/utilities/user-guide-configure-conditional-pay-rules-utilities/user-guide-configure-conditional-pay-rules-utilities-figure-4.png?fit=max\&auto=format\&n=n5PioWp-Ewe9dY_T\&q=85\&s=7e21a64a0d8cbca298930971308067e8)

### Switch the Rules On

1. When the jurisdiction is ready to pay, set **Active** to Yes on each rule (see Figure 4).

Figure 4

![Screenshot from User Guide Configure Conditional Pay Rules - Utilities](https://mintcdn.com/2cloudnine-2edf05eb/n5PioWp-Ewe9dY_T/images/generated/reference-guides/utilities/user-guide-configure-conditional-pay-rules-utilities/user-guide-configure-conditional-pay-rules-utilities-figure-5.png?fit=max\&auto=format\&n=n5PioWp-Ewe9dY_T\&q=85\&s=0c5aa3f1bfe639d3da3a3732be6e9bf2)

2. Click the **Save Rule** button. The saved rules are shown for the Interpretation Rule (see Figure 5).
3. A premium is created on the rule's Pay Code when a Timesheet with a matching break outcome reaches Processed.

Figure 5

![Screenshot from User Guide Configure Conditional Pay Rules - Utilities](https://mintcdn.com/2cloudnine-2edf05eb/n5PioWp-Ewe9dY_T/images/generated/reference-guides/utilities/user-guide-configure-conditional-pay-rules-utilities/user-guide-configure-conditional-pay-rules-utilities-figure-6.png?fit=max\&auto=format\&n=n5PioWp-Ewe9dY_T\&q=85\&s=11c0ba23461f5f7f4747a63396152300)

## Field Descriptions

| Field Name | Description |
| - | - |
| Active | Whether the rule is evaluated. Only Active rules create premiums. Set to No to configure a jurisdiction ahead of switching it on. |
| Cap basis | How many premiums of this Condition Type one shift can pay. One Per Window: at most one, taking the highest-value violation. None: every violation is paid. |
| Condition outcome | The break outcome recorded by break capture that this rule prices. Missed, Short or Late: for a meal. Missed or Short: for rest. Not Captured: a missed meal on a shift that break capture never evaluated. Meal only. |
| Condition type | The break entitlement this rule prices: Meal or Rest. Meal and Rest are capped independently, so one shift can owe one of each. |
| Interpretation Rule | The Interpretation Rule the pricing applies under, which identifies the jurisdiction. Set automatically when Conditional Rule Setup is on the Interpretation Rule record page. Required. |
| Legal citation | The statute or case the rule is based on, recorded for audit. It does not change what is paid. |
| Pay code | The dedicated Pay Code the premium is paid on. Each Assignment needs an active Timesheet Assignment Rate for it, which supplies the pay rate, invoice rate and tax treatment. Required. |
| Quantity | The hours to pay, from 0.01 to 999.99, for Fixed Hours only. Enter the additional hours owed, not the statutory total. Hidden when Shortfall is selected. |
| Quantity basis | How the premium's hours are worked out. Fixed Hours: a flat quantity, whatever the length of the break. Shortfall: the unserved time, calculated as required minutes less minutes taken, divided by 60. |

## Further Information

| Document | Document Type | Description |
| - | - | - |
| [QRG Create an Assignment Rate record - Timesheet](https://documentation.2cloudnine.com/qrgs/data-set-up-and-creation/qrg-create-an-assignment-rate-record-timesheet) | Task Instructions | How to create a Timesheet Assignment Rate, needed for each premium Pay Code on every Assignment. |
| [QRG Create Pay Codes - Allowance Pay Codes](https://documentation.2cloudnine.com/qrgs/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes) | Task Instructions | How to create Allowance Pay Codes, for a premium paid as an allowance. |
| [QRG Create Pay Codes - Payment Pay Codes](https://documentation.2cloudnine.com/qrgs/data-set-up-and-creation/qrg-create-pay-codes-payment-pay-codes) | Task Instructions | How to create Payment Pay Codes, for a dedicated premium Pay Code. |
| [QRG Interpretation Rule Builder - Create Breakpoints & Pay Code Caps](https://documentation.2cloudnine.com/qrgs/interpretation-rules/qrg-interpretation-rule-builder-create-breakpoints-pay-code-caps) | Task Instructions | How to create Breakpoints and Pay Code Caps on an Interpretation Rule. |
| [User Guide Complete Break Attestations - Utilities](https://documentation.2cloudnine.com/qrgs/utilities/user-guide-complete-break-attestations-utilities) | Task Instructions | How Break Rules are set up and how workers answer the break questions that Conditional Pay prices. |