Customer Entitlement Report

Report Description

The Customer Entitlement report lists the orders supplied to a specific property during the current season, and the types of water usage associated with those orders. This report can be run from DMS or from the Irrigator portal by the property owner.

This report may not be available in your installation. It is only used in conjunction with the Rationing Tool where customers can use certain stored allocations when water supply is restricted.

Controlling the report output

You can configure what information is displayed on the first page of the report which contains summary details. By default, all of the following property attributes are displayed in four categories:

Allocation and Usage

Attribute	Attribute type ID	Description
Construction Share	1003	Customer-specific property attribute.
Ordinary shares	1006	Customer-specific property attribute
Allocation	11	Total allocation for the season. This will be calculated to your specifications.
Total season metered usage	433	Total metered usage for the season to date
Allocation remaining	12	Total allocation less the metered usage to date

Contracted Stored Water

Attribute	Attribute type ID	Description
Contracted stored water volume	429	Allocation of stored water that a property has contracted to be available for the season.
Stored water contracted usage	609	Usage to date from the contracted stored water allocation
Contracted stored water remain	591	Volume remaining in the contracted stored water allocation
Days contract remaining	852	Number of days of contract stored water remaining. The calculation assumes that you use the maximum possible amount of stored water during those days

Stored Water

Attribute	Attribute type ID	Description
Total stored water volume	431	Volume remaining in the contracted plus additional stored water allocation
Stored days remaining	607	Estimated number of days of total stored water remaining including both contract and additional water. This is the sum of the Days Additional Remaining and the Days Contract Remaining

Additional Stored Water

Attribute	Attribute type ID	Description
Additional stored water volume	430	Allocation of stored water in addition to the contract allocation that a property can use when stored water is available.
Stored water additional usage	608	Additional stored water usage to date
Additional stored water remain	592	Volume of additional stored water remaining
Days additional remaining	853	Estimated number of days of additional stored water remaining. The calculation assumes that you use the maximum possible amount of stored water during those days.

To configure which of these attributes appear in the report for a specific property, set the value of the Attribute Types for Customer Entitlement parameter for that property. This parameter takes a comma-separated list of attribute IDs that will be included on the report.

Report Parameters and Options

Parameter	Description
Property	Property for which you want to run the report

Report Output

Header

The report header contains the following details about the property and the property owner

Parameter	Description
Property	Property for which the report was run
Customer number	Customer number of the property owner
Name	Name of the property owner
Address	Property address
Phone	Primary phone number of the property owner
Alt phone	Alternate phone number for the property owner
Fax	Fax number for the property owner

First (summary) page

The first page contains the summary details using the configurable attributes listed above.

Report body

The report body contains the details of orders for each outlet associated with the property for the season to date, and the water usage associated with those orders.

For each outlet there is a table that shows:

Field	Description
Start date/time	Start date and timeof the first order of the season, or date and time of the first meter reading of the season, whichever is first.
Order no	Order number
Order duration	Duration requested n hours
Ordered	Volume of water ordered in m3
Scheduled	Volume of water scheduled in m3
Metered usage	Total metered usage for the day in m3
Running total metered usage	Accumulated metered usage in m3 as at that day
Rate ordered	Requested flow rate in L/s
Rate scheduled	Scheduled flow rate in L/s
Average 24hr rate	Average flow rate supplied for the day
River water scheduled	Volume of river water scheduled for the order in m3
River water actual	Volume of river water supplied in m3
Stored water scheduled	Volume of stored water scheduled for the order in m3
Stored water actual	Volume of stored water supplied in m3
Stored water / Stored water %	Total amount of stored water that the customer is prepared to use to fulfil this order on a restriction day. The customer specifies this when they place the order. Depending on your rationing configuration this may be given as a maximum rate or as a maximum percentage.