Checkin and checkout objects

The information in this chapter only applies to multi-user workspaces (see chapter "Types of workspaces").

The checkin / checkout mechanism in multi-user workspaces ensures that users don't interfere with each others work:

  • Checkout objects you want to work on. These objects are now locked; other users can't modify them for as long as they are checked out.

  • Checkin objects once you're finished with them. This frees them up for other users.

You can also update your workspace or view checkout and change information on the objects in your workspace.

Additionally, administrators can revoke checkouts and reject changes.

Checkout objects

When you open a multi-user workspace, all elements in the project tree appear dimmed which means that you can't work on them. To changes this, you need to checkout the objects that you want to work on.

You can checkout the following objects:

  • Individual elements that constitute a work unit, for example a single TestCase, Module, or ExecutionList.

  • Entire trees, for example folder structures.

You can checkout your objects in the following ways:

  • To checkout an individual element, select it and click on Checkout in the Home menu or in the mini toolbar.

  • To checkout an entire tree, select it and click on Checkout Tree in the Home menu or in the mini toolbar.

Checked-out elements don't appear dimmed and have a green block on their left side. This means that the objects are locked by you and other users can't modify them until you check them in. Objects with a red block are checked out by another user.

If you create a new object in a workspace, for instance a new TestCase, Tosca Commander marks this object with a white block.

Project tree in a multi-user workspace

Checkin elements

To checkin your objects and make them available to other users, click on Checkin all in the Home menu.

Alternatively, you can just close the workspace. Tosca Commander automatically asks whether you want to checkin all checked-out objects.

Update the workspace

When you checkout objects, Tosca Commander automatically runs an update on these objects. This ensures that you work on the most current version of an object.

However, other users may make changes that are not directly connected to the objects you checkout. If you want to have these changes in your workspace, you need to update your workspace manually.

To do so, click on Update all in the Home menu.

View checkout and change information

You can get the following information on objects in a multi-user workspace:

  • Checkout information on objects that are checked out by other users

  • Change information on the latest changes to an object

Get checkout information

To get detailed information on a checked-out object, right-click it and select Show Checkout Details from the context menu.

The subsequent dialog displays the following information:

  • Name of the checked-out object

  • Date and time of the checkout

  • Name of the user who checked out the object

  • Windows user name

  • Host name

Get change information

To view changes to a particular object, right-click it and select Show latest change details from the context menu.

The subsequent dialog displays the following information:

  • Name of the selected object

  • Date and time of the change

  • Name of the user who made the change

  • Windows user name

  • Host name

The Show latest change details dialog doesn't display changes that only affect the sub-objects of a checked-out object. For example, while there is change information if you check out a TestCase and add or delete a TestSteps from it, there is no change information if you only rename or disable a TestStep itself.

Alternatively, you can always check an object's properties for information on who modified it and when.

Revoke checkouts

Only administrators can revoke checkouts and reject changes.

You can only revoke checkouts in the master branch workspace.

Revoking a checkout has the following results:

  • Checked-out elements are available to all users again.

  • Changes made by the user who checked out the objects are not transferred to the repository.

  • Any new elements that the user created in the workspace are not transferred to the repository.

To revoke a checkout, follow the steps below:

  1. Ensure that you are logged in to the repository with a user account that has admin rights.

  2. Right-click the checked-out object(s) you want to revoke and select Revoke Checkout from the context menu.

  3. Inform the user. Once you have revoked the checkout, the user whose checkout you revoked has to update their workspace.