---
title: "Configuring the Rationing Tool"
canonical: "https://docs.rubiconwater.com/space/PNC/2051900084/Configuring%20the%20Rationing%20Tool"
format: markdown
---
> Macro (toc)

> ℹ️ **Note**
> ℹ️ 
> ℹ️ Restart the application after updating parameters or attributes.

# System Configuration

## Granting access to the Rationing Module

Access to the Rationing Module is available by default to users who have the PLANNER role. System Administrators can view Ration Plans but cannot create or modify them.

## Configuring the system attribute for flow sharing

The flow share for each property is set in an integer attribute. By default, this is the *Delivery share* attribute, but you can use another attribute if you prefer. To specify which attribute to use, set the system parameter *Restriction Share Attribute*.

This parameter takes the attribute type number as a value.

1. In the [https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001405315](https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001405315), view the details of the attribute you want to use for flow sharing.
2. Take a note of the **Type** value on the Details tab.
3. In the [https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001012712](https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001012712), find the **Restriction Share Attribute** parameter.
4. Set the value of this parameter to the Type value you noted in step 2.

## Exclude past unscheduled orders at non-TCC outlets

Whether or not past unscheduled orders at non-TCC outlets are automatically included when you create a rationing plan is controlled by the **Planning > Reschedule unscheduled orders** parameter. This is set to *Orders will not be rescheduled* by default.

## Default settings for restrictions

Default settings for the system or for individual groups are stored in the parameters in the Irrigation Management System > Planning > Restriction section of the [https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001012712](https://rubiconwater.atlassian.net/wiki/spaces/CFGNC/pages/2001012712). These include:

- *Restriction share attribute type* - The property attribute to use as the flow share when allocating flow during a restriction. Note that this parameter takes the attribute type number as a value, not the attribute name. To find the attribute type number, locate the attribute in the **Attribute Types** module (you will need System Administrator access to do this). The number is in the **Type** field.
- *Restriction Distribution Method* - the default distribution method for new restrictions.
- *Restriction level for orders* - the default level setting for new restrictions
- *Restriction rate to check when applying level* - the attribute to use when determining the maximum flow rate of an outlet. This parameter takes the attribute name as its value.

## Generating automated order confirmation notices

You can automatically generate order confirmation notifications that will be sent after the plan is finalised. This is done by setting the *Mode of Order Confirmation* parameter which specifies the type of planning for which the notices will be generated. The options are:

1. Planning only
2. Restriction only (this is the default)
3. Planning and restriction
4. None

# Water Restriction Group Configuration

## Setting Water Restriction Groups

Properties and outlets must belong to a Water Restriction Group before you can apply rationing to their orders.

To add a customer to a Water Restriction Group:

1. In the [https://rubiconwater.atlassian.net/wiki/spaces/SMNC/pages/2001011511](https://rubiconwater.atlassian.net/wiki/spaces/SMNC/pages/2001011511) select the Water Restriction Group to which the customer will belong.
2. On the **Components** tab, click **Edit** to make the list of components editable.
3. Click **Add** to add a new group component.
4. Click **Search** to open the Object Chooser and select the objects that you want to add to the group. Note that you must add the Property AND any Outlets that belong to the group.
5. Click **Save** to save your changes.

## Adding a property to more than one group

Some properties may have outlets that belong to different groups. In this case:

- Add the property to BOTH groups.
- Add each outlet to the correct group.
- Explicitly EXCLUDE each outlet from the group to which it does not belong.

To exclude an outlet from a Water Restriction Group

1. In the [https://rubiconwater.atlassian.net/wiki/spaces/SMNC/pages/2001011511](https://rubiconwater.atlassian.net/wiki/spaces/SMNC/pages/2001011511) select the Water Restriction Group from which to exclude the outlet.
2. On the **Relations** tab, click **Insert**
3. In the **Relation Type** field, select *Exclude Component*
4. In the Sub Object field, click Search to open the Object Chooser and select the outlet that you want to exclude from the group.
5. Click **Save** to save your changes.

**Example**

Suppose a Property "Prop" has two outlets:

- Outlet 1 belongs to Water Restriction Group A
- Outlet 2 belongs to Water Restriction Group B

The relationships in each group will be as follows:

| Group A | Group B |
| --- | --- |
| Group Component | Prop | Group Component | Prop |
| Group Component | 1 | Group Component | 2 |
| Exclude Component | 2 | Exclude Component | 1 |

## Restriction Group Attributes

The participation mode controls whether a restriction is based on the flow share of an outlet, or on how recently the outlet was restricted. The mode is controlled using the **Restriction Mode** attribute on the Water Restriction Group. The options are:

- *Exclude* - Orders will either be delivered at the requested rate until no more water is available and will then be fully restricted. Outlets that were restricted more recently will be allocated the available water first.
- *Restrict* - Orders will be delivered at a restricted rate based on the flow share (or other configured) attribute.

# Property Configuration

## Setting the flow shares

The rationing calculations use the **Flow share** (or other configured) attribute of a property to calculate that property’s share of the available flow.

> ℹ️ **Caution**
> ℹ️ 
> ℹ️ If the attribute is not set for a property, the property will not receive a share of the restricted flow. In this case, you will see these properties listed in the Flow Share screen with a zero flow share and flow rate.

To set the flow share attribute for a property:

1. In the Planning Schematic, right-click on the property and choose **Details** from the pop-up menu. The Object Details screen opens.
2. In the **Attributes** tab of the Object Details screen, select the Flow share attribute and click **Modify**.
3. Set the **Flow share** value and click **Save**. You may be asked to enter a reason for the change.

> ℹ️ **Note**
> ℹ️ 
> ℹ️ The calculated flow share for a property may sometimes be rounded to zero even if the Flow share attribute is set correctly.

# Outlet Grouping

Individual outlets can be grouped so that the same participation mode can be applied to all the outlets in the group. This means that you can, for example, toggle full restriction on or off for a group of related outlets such as all the outlet in a channel.

This feature is configured by setting a RESTRICT authority for a party on the outlet. All outlets with a RESTRICT authority for the same party are treated as being in the same group. When a plan is in Exclude mode, changing the participation mode for one of these outlets sets the same mode for all the other outlets in the group.

To group outlets:

1. Set the value of the **Planning Restriction Role** parameter to the Role used for grouping outlets. This is typically the RESTRICT role.
2. For each group of outlets, create a new party of type "group". The party does not need to have any members.
3. For each outlet in the group, create an authority for the party group and the RESTRICT role.

> ℹ️ **Note**
> ℹ️ 
> ℹ️ The party group is just a mechanism for linking the outlets together in the background. In theory, you can use any unique party to create an outlet group, but to avoid confusion we recommend creating a new party specifically for each group.

## Configuring the Ration Restriction Percentage for Outlet Groups

The *Ration Restriction Percentage* is an attribute that applies to outlets. If you configure this attribute for all the outlets in an [Outlet Group](https://rubiconwater.atlassian.net/wiki/spaces/PNC/pages/edit-v2/2051900084#Outlet-Grouping) they will use *Restricted *rate by default during a restriction plan even if the overall plan mode is *Exclude*. (You will have the option to switch them back to the Requested rate if you prefer).

> ℹ️ **Note**
> ℹ️ 
> ℹ️ Outlet groups using the Restrict mode in an Exclude plan will have their water allocated first, followed by outlets using Exclude mode.

These are the constraints on the use of this attribute:

- The value of the attribute must be between 0 and 100.
- ALL outlets in the outlet group MUST have the same attribute value.

## Configuring the Ration Restriction Percentage for Outlets

The *Ration Restriction Percentage* is an attribute that applies to outlets. If you configure this attribute for an outlet it will use a *Restricted *rate by default during a restriction plan even if the overall plan mode is *Exclude*. (You will have the option to switch them back to the Requested rate if you prefer).

> ℹ️ **Note**
> ℹ️ 
> ℹ️ Outlets using the Restrict mode in an Exclude plan will have their water allocated first, followed by outlets using Exclude mode.

The attribute takes a Yes/No value and the flow to the outlet will be restricted by the following percentage:

*((Restriction Value) / (Sum of requested flow rates of all orders in the plan)) x 100 *

> ℹ️ **Note**
> ℹ️ 
> ℹ️ The Restriction Value is set in the *Value* field on the rationing plan

---