• InfoWorks ICM

Committing changes to a shared network

Commit and update network changes to the ICM database in a multi-user environment.


Tutorial resources

These downloadable resources will be used to complete this tutorial:

Valdtng_Network.icmt

Step-by-step guide

When you are ready to save or share network changes that you have made locally, you can commit them. With the commit, your changes are uploaded to the database and merged with other users' changes as a new version.

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

The InfoWorks ICM Explorer window with a highlight around an icon with a red circle exclamation badge, indicating a change was made that needs to be committed to the database.

To commit changes:

  1. Right-click the network in the Explorer window and select Commit changes to database.

The InfoWorks ICM interface, with Commit changes to database highlighted for selection in the submenu.

  1. In the Commit change to server dialog box is a summary of the changes that you are committing. Add a meaningful comment about the changes.
  2. Click OK.

The Commit changes to server dialog box showing a note entered about the changes that were made and OK being selected.

Note: The File toolbar > Save tool or the Network, Version control menu can also be used to commit changes.

Every time a change to the network is committed, a new version of the network is created. The Commit history details each version of the network. From a Commit history, you can view, compare, and roll back changes. Even if you are working alone, you can benefit from the commit history.

To view the commit history:

  1. Right-click the network in the Explorer window and select Show Commit History.

The Explorer window, with Show commit history being selected from the submenu.

In the Commit history dialog box, for every commit, there is a corresponding version number, date, user, and the number of changes that were made.

  1. Select an available version.
  2. Click Details to see the commit details.

The Commit history dialog box with a change selected and the Details button being clicked.

 

Note: To compare the differences between two versions, multi-select two versions and then click Diff.

The Commit history dialog box showing two versions selected and Diff being selected.

Note: To revert to a previous version, use Branch or Copy. Branching a subnetwork from an existing model maintains the history between both networks. Copying starts a new network, which resets the history to version 1.

The Commit history dialog box showing the Branch and Copy commands for network scenarios.

In a multi-user environment, there may be a situation where the same asset is modified by two users. If this happens, a conflict will occur.

The conflict is discovered when a commit is initiated or when one of the users selects Update (get changes made by others).

If conflicts are found:

  1. Right-click the network and select Resolve conflicts.

IMPORTANT: Check with the other users involved before confirming a resolution.

The network submenu showing Resolve conflicts being selected.

To view the commit history of individual objects:

  1. In the GeoPlan toolbar, click Find in GeoPlan to locate a specific node.
  2. Double-click the node to open the Object Properties window.
  3. Click Commit history.

A node is selected in the GeoPlan, its properties are showing in the Properties window, and Commit History is being selected in the toolbar at the top of the Properties window.

  1. In the Commit history dialog box, select a version.
  2. Click Details.

The Commit history dialog box showing a node object highlighted and Details being selected.

  1. The Object commit details dialog box displays all the information for the different versions of the object. Select Full history to display a color-coded table of when each item was last edited.

The Object commit details dialog box showing the full detail history for the selected node, with the Full history option enabled.

Note: Recent changes are highlighted in dark red.

Note: Similar to the network history, to view the differences between two object versions, multi-select the versions in the Commit history dialog box, and then click Diff to open the Object version comparison dialog box.

The Object version comparison dialog box showing the differences between two nodes that were selected in the Commit history dialog box, shown in the background, with Diff having been selected.