Creating Version Labels

Version Labels are simply placeholders. Any revision of a file can have an unlimited number of Version Labels attached to it. Version Labels are useful when you want to mark a particular revision of a file for use later in the context of multiple files.

To modify or create new Version Labels, display the Version Manager dialog by selecting Tools / Version Labels... from the main menu:

This dialog box lists all Version Labels defined in the current repository. In this dialog you can define the visibility of labels using the checkboxes. If a label is unchecked it will not appear in normal Version Label selection boxes, but will still be available for selection through other means. This helps to reduce the number of Version Labels that build up over time being listed, while still maintaining them for historical integrity.

Note that only Admin users can change the visibility of labels

Selecting a label allows you to modify its properties by clicking on the Modify... button.

To delete a Version Label, select it and press the Delete button. If you delete a Version Label, this label will be removed from all revisions containing it and, potentially, Views may become undefined.

A new label can be created by clicking on the New... button:

Enter the name for the Version Label. Anything can be entered here, but should describe the purpose of the label. You can also enter a description of the label in the Comments box.

The Label Root field allows you to specify a Project that will be the owner of the Label. Click on the button with the ellipsis (...) to choose an existing project, or click on the G button to make the label Global to the repository. By default, all new labels will be global.

The Label Root field specifies what labels are accessible when labels are assigned. Depending on the scope of the action, only labels within the selected Project, and labels marked as Global will be visible in the drop-down lists.

Changing the scope (Label Root) of a label will not affect instances where the label has already been applied outside of the new scope.

The Branch Base Label field allows you to create a special branching label. When the Version Label is initially applied to a file, both the Label and the Branch Base Label will be applied at the same time to the same revision. If, subsequently, this label is applied during a checkin, and both the Label and the Branch Base Label are attached to the same revision, a Branch revision will be created and the Label will be moved to the new revision.

For more information on Branch Base Labels, see Version Labels.

Version Labels can be modified at any time and all changes will be applied to all files containing the Version Label.

The Security page of this dialog box allows you to define who is allowed to Modify the label as well as who can assign or remove the label:

By default, the label is created so that All users can carry out all actions. The settings are as follows:

Access: The users and groups listed here can specify who is allowed to do what.

Modify/Delete: The users and groups listed here are allowed to modify the label and can also permanently delete the label.

Assign/Remove: The users and groups listed here can assign the label to files and can also remove/move labels.