Triggers are used to initiate or cancel certain actions for an account, account host, account type or system in a resource assessment system. This page provides details of the different types of triggers available in Resource Assessment systems, along with types of actions that can be initiated.
Figure 1 shows the general layout of triggers in the Resource Assessment Explorer.
Figure 1. Triggers, general layout
Adding a trigger
To add a trigger, right click on an annual accounting system, the account type or account and choose Add trigger. NoteYou can rename or delete an existing trigger by right clicking the trigger and choosing the appropriate context menu option.
As shown in Figure 1, configure the following parameters for each trigger:
- Condition - the type of condition that will trigger the action. The parameters displayed in the Condition Configuration panel will change depending on which condition is chosen, see Table 1.
- Execution - when to execute the trigger (either at the beginning or end of the time-step). You can also prioritise the order of triggers relative to each other on the Trigger Priority tab for the annual accounting system, see Annual Accounting - Trigger Priority.
- Action - the action to occur as a result of the trigger condition being met. The Action Configuration panel will change depending on what action is chosen. See Trigger actions.
Table 1. Types of conditions
| Condition | Description |
|---|---|
| End of water year | Triggers an action at the end of the water year. |
| Function | Triggers an action using a defined function. The format of a function should be as follows: if( A > B,1,0), where “1” indicates the action will occur and “0” means the action will not happen. |
| Monthly trigger | Tiggers an action for a particular month. You must specify whether to offset from the start or end of the month, along with the number of days. |
| Per-timestep | Triggers an action per a specified number of time-steps. You can choose to reset the repeat interval at the start of each water year. |
| Season | Triggers an action for a specified season. You must define and start and end dates. |
| Specified date | Triggers an action on a specified date. |
| Start of water year | Triggers an action at the start of the water year. You can choose to repeat the action at a specified number of timesteps, and whether to reset the repeat interval at the start of each water year. |
| Storage level | Trigger based on a specified storage level. You must specify the storage, the level and whether the level is rising or falling. |
Trigger actions
There are a total of nine trigger actions available in Source, each having an individual set of definable parameters. All triggers can be applied at the system, account type, or account level. The exceptions are the reassessment and the Vic Carryover triggers, which are available at the system level only.
Once an action is selected, action-specific parameters are displayed. The general process of configuring an action is:
- Select a Source, that is, the account type(s), account(s) or account host(s) that the trigger applies to. The sources available depend on the level that the trigger is applied at. At the system level, all sources are available. At the Account Type level, you can select an account or account type, and at the Account level you can select an account.
- For Carryover, Transfer and Transfer Use triggers, select a Destination system, and account type(s), account host(s) or account(s). For these triggers, you can select sources and destinations using Independent or One-to-One Mapping, see Carryover.
- Define parameters unique to that action (see each trigger, below). When a trigger has a Type parameter, you can select percentage or volume.
Figure AA. Example Trigger, Carryover with independent mapping
| Action | Definition | Mapping(s) | From/to or Level | Type | Unique Parameters | ||||
|---|---|---|---|---|---|---|---|---|---|
| Independent | One-to-one | System | Account Type | Account Host | Account | Percentage or Volumentric | |||
| Adjustment |
|  | | | | ||||
| Assign Balance |
| | | | |||||
| Carryover | | | | | | | | ||
| Reassessment | |||||||||
| Transfer | | | | | | | | ||
| Transfer Use | | | | | | | | ||
| Truncate Total Water | | | | | |||||
| Unit Share Allocation | | | | | |||||
| Vic Carryover |
| | |||||||
| Write-off | | | | | |||||
Adjustment
This trigger adjusts one of several parameters (eg. account balance, or available water) based on a specified percentage or volume. The available methods of adjusting are shown in Table X. A positive value indicates an addition; a negative values represents a deduction. The example shown in Figure 2 represents an evaporation loss of 5% of available water. This will reduce 5% of available water, so 95% of available water is left in available water balance.
When adjusting from available water, use the priority specified for the account in the water user node (the Priority field as shown here).
For crediting (ie. incoming water), add this to the account you want to hold the water in. The priorities in this case would be in the reverse order to which they appear in the water user node. Consider a water user with one account and a single carry over; the priority of use is carryover first, then account balance. This trigger then deducts the desired volume from carryover first; if insufficient water is available, the residual is subtracted from the account balance.
Figure 2. Adjustment trigger
| Adjust Value | |
|---|---|
| Account Balance | The remaining volume/share of water available to an account holder (not including carryover). The sum of all of the credits to an account minus the sum of all the debits. |
| Available Account Balance | Balance + carryover - minimum balance |
| Available Water in Account Balance | When not spilling: Balance - minimum balance |
| Available Carryover | |
| Available Water | |
| Carryover | |
| Carryover Start of Water Year | |
| Volumetric |
Assign balance
As its name suggests, this trigger assigns the account balance to a specified volume. The original account balance will be replaced by the new assigned value. This can be done for an account type, account host or for an account.
Figure 3. Assign balance trigger
Carryover
A specified proportion or a certain amount of water can be carried over from an account type, account host or account to another account type, account host or account within the same or another accounting system. This is in addition to the water in the carryover account balance, which is automatically carried over. The amount of water carried over can be defined as a function of:
- Account Balance -
- Available Water in Account Balance -
- Entitlement -
This trigger is usually set at end of water year to carry over unused water from previous water year to the next new water year.
Figure 4. Carryover trigger
| Account Balance | |
| Available Water in Account Balance | |
| Entitlement |
Mapping
For Carryover, Transfer and Transfer Use you can choose between Independent or One-to-One Mapping. This affects how the Source and Destination accounts, account hosts or account types are selected.
In Figure X...
In Figure Y...
Transfer
Transfers a specified proportion or volume of account balance, available water or carryover between different account types, account hosts or accounts. For a positive transfer, water moves from source to destination; in a negative transfer, it moves in the reverse direction. For transfer from available water, the operation is similar of an adjustment trigger (uses the Priority set at the water user).
For crediting (ie. incoming water), transfer to the account you want to hold water in. For example, for two water users, both with one account and carry over. Priority of use for both users is carryover first, then account balance. This trigger transfers the desired volume from carryover first, if insufficient water is available, the residual would be subtracted from the account balance. The transferred volume would be added to water user 'account balance' up to max balance. Any extra water would be added to the carryover balance.
Figure 6. Transfer trigger
| Account Balance | |
| Available Water | |
| Carryover | |
| Entitlement | Percentage of only |
Transfer use
Supports transfer of use between two accounts (ie. re-credits originating account and debits the destination account). A positive value represents a transfer out, which increases the account balance; a negative value indicates that use is incoming and reduces the account balance.
Figure 7. Transfer use trigger
| Order/Use Debit | |
| Total Usage Water Year |
Truncate Total Water
Truncates a specified parameter of an account or account type to a specified ratio or volume of another parameter. For example, in Figure 8, the total water for this account is limited to 50% entitlement. If the total water in this account is less than 50% entitlement, such as only 40% entitlement, then nothing is truncated, the total water in the account will remain as 40% entitlement.
| Parameter | Definition |
| Account Balance | |
| Available Carryover | |
| Available Water | |
| Available Water in Account Balance | |
| Carryover | |
| Carryover Start of Water Year | Truncate only |
| Total Water | |
| Entitlement | Account truncation based on only. |
Figure 8. Truncate total water trigger
XXX
Unit share allocation
This trigger is used to reset allocation to a specified new volume.
Figure 5. Per unit share allocation trigger
Re-assessment
This trigger is only available at the accounting system level. It reassesses the available resources based on the specified time-step. After available resources reassessment, the system will assign new allocation to water user based on this new re-assessed available resources.
The trigger is used to control the following behaviour:
- How many times the reassessment is called - this field (on the right side) allows resource assessment to be performed multiple times. For each time, all the ticked Resource Assessment Systems will have their reassessment routines called in the order in which they appear in the trigger action configuration. This is important to note as it does not necessarily reflect the order they appear in the tree to the left.
- Which system's re-assessments are called - you can choose which Resource Assessment Systems to reassess by enabling the appropriate checkbox;
- The order in which re-assessment is called - change the order in which the reassessments are performed by dragging and dropping to the desired position.
Figure 9. Re-assessment trigger
Write off accounts
Resets the account balance to zero. This trigger is usually set at end of water year to clear up account for this water year and give a fresh new start for the next water year.
Figure 10. Write-off trigger
