While working in collaborative cloud databases, Runs can be flagged as Reserved to enable testing of model changes with protected control of iterations.
Runs and all version-controlled objects (e.g. Networks and Controls) can be reserved by a single user for editing. When a Run is reserved, the user is prompted to reserve any related Network and Controls if desired. Reserved objects can be viewed by other users, but edits are only allowed by the person that reserved the object.
The Reserved status is indicated by the following:
- Reserved by field in the Object Page of the Properties dialog shows the username of the reserving user.
- When a run is Reserved, the username of the reserving user is indicated in the Run context menu.
- The tooltip shows Reserved by field, displaying the username of the reserving user.
- An orange border in the icon
of Runs and version-controlled objects appears in the
tree view when they are reserved.
Reserved Runs can use the latest uncommitted changes to the Network and/or Controls to allow testing simulations prior to committing changes to the database. When in use, the Network and Controls objects in the Run window will indicate "latest version" rather than specifying an explicit version number. In addition, the icon will indicate when uncommitted changes are present
.
Reserved Runs support easy re-runs with the latest changes to support simple iterative testing of model edits. Right-click on a Reserved Run to re-run with the latest changes. While doing so, you can choose whether to commit your latest changes in the process, or use the latest changes without committing.
Reserved Runs enable a checkbox option to Run Locally. Depending on model size, network connection, and local hardware, running simulations locally can be faster. This option is possible for reserved runs in which results do not need to be uploaded to the cloud.
The options to Reserve for Testing and to Run Locally are available in the Schedule Hydraulic Run dialog.
Reserve for Testing
- Only available in cloud runs that have not been run in the cloud.
- Checking this option reserves a run for the private use of the current user. No other user may edit the run, re-run it, or open its results.
- A dialog appears showing the option to reserve the Network and Control.
- The reserving user may edit and re-run as often as desired.
- Validation is turned off when a run is reserved. You can re-enable validation in the run dialog, and validation can always be performed via the network validation dialog. The reason for disabling validation is to improve the throughput of re-runs.
Run Locally
- This is applicable when the Reserve for Testing option is checked.
- This option is only available in cloud database, and is only available for the reserving user.
- Selecting this option will cause the simulation to run on the client PC. This option will improve the throughput of re-runs for simpler cases such as normal and water quality runs, but cloud resources should be used for multi-runs, such as CLA, GMR, and Fire Flow.
Run or Re‑Run
- If a run is Reserved for Testing, then a run is always possible for the reserving user. This supports a constant cycle of edit > run > edit > run.
- If a run is reserved to a different user, then the simulation engine cannot be invoked.
Unreserving a Run
When you clear the Reserve for Testing option in the Schedule Hydraulic Run dialog:
- Unchecking the option makes the run read-only.
- The results are publicly available.
- A dialog appears showing the option to unreserve Network and Control.
- The Run Locally option becomes unchecked, if it was checked.
- Also, a prompt will appear:
- When a reserved local run is unreserved, you will be asked to re-run in the cloud so that all users can have access to the results.
- If a reserved run has uncommitted changes in the network or control, then it is necessary to commit the changes when removing the reservation. If you click No, then the run remains reserved and no commit occurs.