Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Edit through the REST API

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.

...

ConditionDescription
End of water yearTriggers an action at the end of the water year.
FunctionTriggers 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 Triggers an action for a particular month. You must specify whether to the offset from the start or end of the month, along with the number of days.
Per-timestepTriggers an action per a specified number of time-steps. For example, if a monthly model, triggers an action per month or per several months. You can choose to reset the repeat interval at the start of each water year.
SeasonTriggers an action for a specified season. You must define and start and end dates.
Specified dateTriggers an action on a specified date.
Start of water yearTriggers 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 levelTrigger 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 (Figure 1), each having an individual set of *Note that:  since Source V4.9, for Monthly trigger condition, the offset “end of the month” is no longer being supported although this option item is in the dropdown list of the user interface. Instead, the user can use the following: Condition: Monthly Trigger; Offset From: Start Of The Month; Execution: Timestep End; Days Offset: 0.

Trigger actions

There are a total of ten trigger actions available in Source (Figure 1), 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.  Note that although Vic Carryover appears as one option item on the user interface at all levels, the interface will display the system level if this item is selected.

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 use the default 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 Parameters unique to that action (see each trigger, below).  When a trigger has a Type parameter, you can select percentage or volume. 

Many actions affect or are affected by a user-configureable configurable model parameter, such as Account Balance, Carryover or Entitlement, these are defined in Table 2.

Info

Note: When spillable water has been configured and is available to the accounts, the status of that water is maintained during the trigger action.

Figure 1. Example Trigger, Carryover with independent mapping

Image Removed




Anchor
TriggerModelParameters
TriggerModelParameters
Table 2. Triggers, model parameters
Parameter
Account BalanceThe remaining volume/proportion of water available to an account (not including carryover).

Carryover

The remaining volume/proportion of water available to an account that was carried over from the previous water year, ie. carryover balance.
Carryover Start of Water YearAt the start of the water year, the volume of water carried over from the previous water year.
Entitlement

Annual volumetric entitlement for an account.

Total WaterAccount Balance + Carryover Balance.

Available Water in Account Balance, or

Available Account Balance

For Annual Accounting systems with Carryover Type set to Spillable and Water Available While Spillable disabled*:

Max(0, Account Balance - Max(0, Spillable Water - Carryover Balance) - Minimum Balance)

Else:

Max(0, Account Balance - Minimum Balance)

Available Carryover

For Annual Accounting systems with Carryover Type set to Spillable and Water Available While Spillable disabled*:

Max (0, Carryover Balance - Spillable water)

Else:

Max (0, Carryover Balance)

Available Water

For Annual Accounting systems with Carryover Type set to Spillable and Water Available While Spillable disabled*:

Max(0, Account Balance + Carryover Balance - Spillable Water - Minimum Balance)

Else:

Max(0, Account Balance + Carryover Balance - Minimum Balance)

Order / Use DebitWater debited from an account that time step.
Total Usage Water YearWater debited from an account since the start of the water year..

...

This trigger adjusts one of several parameters (eg. account balance, available water) based on a specified percentage or volume. The available parameters that can be adjusted are shown in Figure 32, see Table 2 for explanations. 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, the priority specified for the account in the water user node (the Priority field as shown here ) is used to determine the order that the accounts are deducted from, with the highest priority (lowest number) deducted from first. For crediting (ie. incoming water), specify 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.

...

  • For a percentage adjustment, both spillable water and the remaining water are simultaneously adjusted by the specified percentage.
  • For a volumetric adjustment, the adjustment will be applied first on spillable water and then the remaining water. 
Figure

...

2. Adjustment trigger


Assign balance

As its name suggests, this trigger assigns the account balance to a specified volume (Figure 43). The original account balance will be replaced by the new assigned value. This can be done for account type(s), account host(s) or account(s).

Info
iconfalse
Note: This trigger is useful for calibration purposes only.
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 (Figure 14, Figure 5). This is in addition to the water in the carryover account balance, which is automatically carried over. When Type is percentage, the percentage of water to be carried over can be calculated as a function of Account Balance, Available Water in Account Balance or Entitlement (Figure 54), see Table 2 for definitions of these model parameters.

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

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 transferred between.

Independent mapping (Figure 1, Figure 65) allows you to map between accounts, account types or account hosts to other accounts, account types or account hosts within or between accounting systems. Note that the Source system will always be the system in which the trigger is located. The source and destinations do not need to be the same level - eg. an account type can be mapped to two accounts in another accounting system (Figure 15).

One-to-one mapping (Figure 54,Figure 6) allows you to map accounts, account types or account hosts to others of the same level - eg. you can map an accounts to other accounts. This allows you to create multiple triggers of the same type at once. When you select this option, the Source and Destination will be the same, that is, an item will map to itself. You can change the mapping by reordering either the source or destination by clicking a cell and dragging it next to the desired item. For example, in Figure 54, the Destination accounts for the HRWS account type were dragged to be next to their corresponding accounts for the LRWS account type. To enable the trigger for a mapping, toggle on the Checked box next to that entry.  

Figure 5. Example Trigger, Carryover with independent mapping

Image Added

Transfer

Transfers a specified percentage or volume of account balance, available water or carryover between different account types, account hosts or accounts (Figure 6). For a positive transfer, water moves from source to destination; in a negative transfer, it moves in the reverse direction. The percentage transferred can be a percentage of the aforementioned parameters and also entitlement, see Table 2 for parameter definitions. You can choose to map between sources and destinations using either Independent or One-to-One mapping, see Mapping.

...

Resets the account balance to zero (Figure 12). 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. 

Info

This is the only trigger type that is available in Continuous Accounting. Write-off triggers are automatically created for each High Security Group account type when a new continuous account system is added. 

...