• InfoWorks WS Pro

Using check in/check out

Use the Check In/Check Out version control system.


Tutorial resources

These downloadable resources will be used to complete this tutorial:

iwsp2023M03U06_Using_Check_In_Check_Out.wspt

Step-by-step Guide

While InfoWorks WS Pro encourages use of the newer merge method for updating models, it still offers the lock method, better known as Check In/Check Out. However, Check In/Check Out can get messy with multiple users making changes to the same model, so there are ways to convert them into models that can use the merge method, also known as the commit approach.

To use the Check-In/Check-Out method:

  1. In the Model Group window, expand the Session 03 -- Lock model group.

Notice the subgroup icons are a different color (yellow) than those for the commit approach.

  1. Drag-and-drop the LockNetwork into the workspace to open the GeoPlan.

At the top of the window, notice the R/O in parentheses to indicate the network is currently read-only, meaning it cannot be edited until it is checked out.

The InfoWorks WS Pro interface, Model Group window, with Session 03 – Lock expanded to show subgroups with yellow icons; and in the workspace, the network GeoPlan open with R/O in the title bar to indicate read-only.

  1. In the Model Group window, right-click LockNetwork and select Check Out.

The LockNetwork shortcut menu with Check out called out and selected.

  1. In the New Name – Network dialog box, leave the default name of LockNetwork#1.
  2. Click OK, creating a branching version of the file that you can now edit.

In this example, the diameter of a pipe is resized by opening its properties in the branched version of the network.

  1. In the Model Group window, right-click LockNetwork#1 and select Check in.

The network shortcut menu with the Check In option called out and selected.

  1. In the confirmation dialog box, click Yes to validate the model.
  2. In the Check In Comment dialog box, in the text box, enter comments, if necessary.
  3. Click OK.

Note: It is recommended that you use the newer commit approach, as it is more flexible when you make mistakes, and it supports scenarios.

To turn a Check In/Check Out model into one that can be used with the commit method, first, delete any newly created networks, so that only the original LockNetwork remains:

  1. In the Model Group window, right-click the newly created network, such as LockNetwork#1, and from the shortcut menu, select Delete.
  2. Click Yes to confirm.

Now, convert the model:

  1. Right-click Session 03 – Lock and select Copy.
  2. Right-click the Database and select Advanced > Paste: Session 03 – Lock and convert to merge model.

The Database shortcut menu with the Advanced flyout displayed and Paste: Session 03 – Lock and convert to merge model called out and selected.

The new commit model now appears in the Model Group window. Any new branches that are checked in will appear below it as new versions of the model, using the commit approach.