Commit changes and use scenarios to save network variations

Commit network changes and create scenarios to model variations of your network.


Commit changes and use scenarios to save network variations

Step-by-step guide

Changes made to a version-controlled database object are continually and automatically saved locally in the working folder until they are committed. When changes are ready to be saved or shared, commit them to upload the changes to the database and merge them with changes from other users as a new version.

An uncommitted network has a red circle at the bottom of the network icon and needs to be committed before changes can be used in a model.

In the Explorer window, an uncommitted network with the red circle icon called out with a red arrow.

Best practice is to commit changes after any major editing or updating of the network, even when working alone.

To commit changes:

  1. In the Explorer window, right-click the network and select Commit changes to database.
    The Explorer window, with the context menu for the network expanded, and Commit changes to database being selected and called out with a red arrow.

The Commit change to server dialog includes a summary of the changes being committed.

The Commit change to server dialog, with the summary of changes highlighted in red.

  1. In the Comments section, add a comment about the changes, such as “2 nodes inserted in north east zone”.
  2. Click OK.
    The Commit change to server dialog, with a comment added and highlighted in red, and OK being selected and highlighted in red.
  3. Alternatively, on the File toolbar, click Save or use the Network > Version control menu to commit changes.
    On the left, the File toolbar, with the Save tool called out with a red arrow. On the right, the Network menu expanded, with Version control selected, and in the flyout, Commit changes to database called out with a red arrow.

While committing changes is an easy way to save data, scenarios can be used for several reasons, such as:

  • Modeling variations of a network simultaneously, without the need to create separate branch networks.
  • Investigating the impact of different parameters, such as increasing pipe sizes.
  • Performing quality assurance, allowing multiple users to work independently in their own scenario until the work has been checked and reviewed.

Once work has been reviewed and signed off, scenarios can be integrated into the Base network, making changes available to all users.

Because scenarios are derived from a Base network, they do not appear in the Explorer window as separate entities. Instead, they are saved within the Base network.

To view a scenario:

  1. Open the Base network.
  2. From the Scenarios toolbar, select the scenario.
    The Scenarios toolbar, with the Scenario selection drop-down highlighted in red.

To create a scenario:

  1. On the Scenarios toolbar, click Create scenario.
    The Scenarios toolbar, with Create scenario being selected and called out with a red arrow.
  2. Alternatively, in the Network menu, select Scenarios > Create scenario.
    The Network menu expanded, with Scenarios selected, and in the flyout, Create scenarios being selected and called out with a red arrow.
  3. In the Create new scenario dialog, add a New Scenario Name, such as “NE Zone Update”.
  4. Add any meaningful Notes, such as “Upsizing pipes in NE zone”.
  5. Click OK to save the scenario.
    The Create New Scenario dialog, with a name entered, notes added, and OK being selected, all highlighted in red.

Changes can be made to the elements in the scenario without affecting the Base network.

Each scenario is a copy of the Base network, unless a scenario is created as a copy of another. All changes made to a scenario are independent. Scenarios can be made to construct unique situations, which can then be analyzed and compared.

  1. To Delete, Rename, or Manage scenarios, use the corresponding tools in the Scenarios toolbar.
    The Scenarios toolbar, with the Delete, Rename and Manage scenarios tools highlighted in red.
  2. Select Manage scenarios to open the Manage scenarios dialog and access additional tools, such as a tool to compare scenarios.
    The Manage scenarios dialog, with buttons for several tools, including Diff, Reintegrate, Duplicate, and Edit notes.