Developer Tool Guide

Back Next

Versioned Object Management

When the Model repository is integrated with a version control system, you can manage versions of objects. For example, you can check out and check in objects, undo checkouts, and view objects that you have checked out.

You can perform the following actions:

Check out an object.: When you check out an object, it maintains a checked-out state until you check it in or undo the checkout. You can view objects that you have checked out in the
Checked Out Objects
view. To check out an object, you can begin to edit it, or you can right-click the object in the Object Explorer and select Check Out.
Undo a checkout of an object.: When you undo a checkout, you check in the object without changes and without incrementing the version number or version history. All changes that you made to the object after you checked it out are lost. To undo a checkout, you can use the
Checked Out Objects
view or the object right-click menu. For example, you might want to undo a checkout to delete changes to an object.
If a user moved an object while it was checked out and you undo the checkout, the object remains in its current location, and its version history restarts. Undoing the checkout does not restore it to its pre-checkout location.
Check in an object.: When you check in an object, the version control system updates the version history and increments the version number. You can add check-in comments up to a 4 KB limit. To check in an object, you can use the
Checked Out Objects
view or the object right-click menu.; The Perforce and SVN version control systems limit file path lengths due to a Windows restriction that restricts path lengths to 260 bytes. If you attempt to check in a file with a path that exceeds the limitation, Perforce returns an error. A 260 byte path length results in varying path lengths depending on the character set of your system.
Delete an object.: A versioned object must be checked out before you can delete it. If it is not checked out when you perform the delete action, the Model repository checks the object out to you and marks it for delete. To complete the delete action, you must check in the object.
When you delete a versioned object, the version control system deletes all versions.
To delete an object, you can use the
Checked Out Objects
view or the object right-click menu.