9.4. Adding Objects to Version Control

EKM provides you with the capability to control changes that are made to objects in a repository using version control. You place an object under version control using the Add to Version Control action. You must have Modify permission on all objects you want to add to version control.

Once version control is enabled, you can check out the object, modify it, and check it back in. When you check it in, the version gets automatically incremented. You can also choose to “undo the checkout” which reverts the version of the object back to the previous one. When an object is under version control and “checked out” to you, no other user with modify permission can modify the object until it is checked back in. The object will appear to be “locked” when viewed by other users and “unlocked” to you. Only versioned objects that are checked in (and not under “exclusive control by someone else) are available for modification.

In summary, placing an object under version control does two things:

  1. Allows only one user at a time to modify the object. To modify an object under version control, you place the object in an exclusive editing mode with the check out action. The check in action releases the exclusive editing mode.

    The exception to this is when you choose to allow a checked-out object to be edited by other users.

  2. When you are done modifying the object, the check in action is performed, and a non-editable copy of the object is stored. This copy is called a version.


Important:  You cannot add a folder to version control if it contains an object already under version control.


To place objects under version control:

  1. Select the objects, then select   (Edit) > Versioning > Add to Version Control. This opens the Add to Version Control dialog box.

  2. If you want to start modifying the objects immediately, select the Check out option. When you enable this option, you may optionally choose to allow other users to modify the object by enabling the Allow editing by other users check box. This means that other users will be able to check out the object while you have it checked out, and make modifications to it.

  3. Click OK. A new version will be created for the object (for example, 1.1) and the version control tool tip will either indicate that the object is checked out (open lock icon) or not checked out (lock and key icon) as shown below.

    Figure 9.2:  Under Version Control and “Checked Out”

    Under Version Control and “Checked Out”

    Figure 9.3:  Under Version Control and “Not Checked Out”

    Under Version Control and “Not Checked Out”


Note:  Only objects in My Data and Shared Data can be put under version control.



Release 18.2 - © ANSYS, Inc. All rights reserved.