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

# Granting access to the Restriction Planning tool

To use the Restriction Planning tool you must grant access to the appropriate roles and parties. For example, you can make the tool available to all planners by granting access to the role PLANNERS and the party ALL PARTIES.

**Step 1**

In the [https://rubiconwater.atlassian.net/wiki/spaces/UMNC/pages/1979449436](https://rubiconwater.atlassian.net/wiki/spaces/UMNC/pages/1979449436), ensure that the role/party has access to the [https://rubiconwater.atlassian.net/wiki/spaces/PNC/pages/2018672858](https://rubiconwater.atlassian.net/wiki/spaces/PNC/pages/2018672858). To do this:

- In the Security Manager tree view, select the **Plan History** module (you can find this, for example, in Security Manager > All > Tools).
- On the **Authority** tab of the properties pane, confirm that access to Plan History is configured for the required roles and party.

**Step 2**

In the Security Manager tree view, under **Functions**, select **Plans – Create**. Ensure that the role/party has access to this function.

> ℹ️ **Note**
> ℹ️ 
> ℹ️ This step can be omitted if you do not need the role to have access to create new plans, but just to edit existing plans.

**Step 3**

In the Security Manager tree view, under Functions, select the **Restriction Tool – Enable** function.

**Step 4**

In the **Authority** tab of the properties pane, click **Insert**. The Inserting Authority screen pops up.

**Step 5**

Specify the **Role** and **Party** to which you want to grant access and click **Save**. For example, to grant access to all planners, choose PLANNERS for the role and ALL PARTIES for the party.

# Configuring the attribute for flow sharing

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

# Setting the Flow Share for a Property

The restriction planning 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.

1. In the [Planning Schematic](https://rubiconwater.atlassian.net/wiki/spaces/PNC/pages/2051866972), 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.

# Setting the precision of the flow rate calculation

When restriction rates are calculated, the flow rate is rounded down as determined by the **Restriction Flow Rate Rounding** parameter. 

This parameter must be applied to an object type. If the value is not set for a specific object type, the object type will inherit the value of its closest parent.

1. In the [https://rubiconwater.atlassian.net/wiki/spaces/DMS/pages/2018607120](https://rubiconwater.atlassian.net/wiki/spaces/DMS/pages/2018607120), click **Add**. The Inserting Parameter value screen opens.
2. Select the **Restriction Flow Rate Rounding** parameter from the drop-down list.
3. Select the object type for which you want to set the parameter.
4. Set the parameter value. For example, if the parameter value is 0.5, the restricted flow rate will be rounded down to the nearest 0.5.
5. Click **Save** to save your changes.

# Setting the default start time and order privilege

Default start times and order privileges control when flows can change at a site. See <u>[Using Default Start Time and Order Privileges](https://rubiconwater.atlassian.net/wiki/pages/createpage.action?spaceKey=pnc&title=Using%20Default%20Start%20Time%20and%20Order%20Privileges%20old&linkCreation=true&fromPageId=2051899964)</u> for details of the attributes used to configure these settings.

---