Adding version control labels to objects


To identify and retrieve a collection of versioned objects, you can apply version control labels to any object listed in the object modification log (the AR System Version Control: Object Modification Log form).  For example, you might apply a Patch 003 label to objects used in the final build for that patch. You can then retrieve a list of those objects and using information provided in the list, download the definition file for each of the objects in the patch.

You can add version control labels only to the current version of the object. You cannot add them to earlier versions, even if those versions are listed in the log. If an object does not have at least one entry in the AR System Version Control: Object Modification Log form, you cannot add a version control label to it.

Each version of an object can have multiple version control labels. Each version control label can be added to multiple objects.

To enable version control labeling

  1. On the Version Control tab of the AR System Administration: Server Information form, set the following options:
  2. Click OK.

To add a version control label to a new object

When you save an object for the first time, enter a version control label name and, optionally, a label description in the Save objectType As dialog box:

151_new_object_label.GIF

To use an existing label, select it from the Version Control Label list.

The Version Control Label and Label Description fields are also available when you perform the following operations: Rename, Edit > Rename (available only when multiple objects are selected), Save As, and Delete.

To add a version control label to one or more existing objects

  1. In Developer Studio, open the appropriate object list.
  2. Select one or more objects.
  3. Right-click one of the selected objects, and select Add Version Control Label.
  4. In the Add Version Control Label dialog box, enter the label name in the Version Control Label field.
    The name can have up to 254 characters. It must be unique on the server.
  5. (Optional) In the Label Description field, enter a description that explains why objects are grouped under this label.
    For example, they might be part of a particular product build.
  6. Click OK.
  7. Click OK in the confirmation message.

To add a version control label to all objects on a server

  1. In Developer Studio, right-click the appropriate server in the AR System Navigator, and select Add Version Control Label.
  2. In the Add Version Control Label dialog box, enter the label name in the Version Control Label field.
    The name can have up to 254 characters. It must be unique on the server.
  3. (Optional) In the Label Description field, enter a description that explains why objects are grouped under this label.
    For example, they might be part of a particular product build.
  4. Click OK.
  5. Click OK in the warning message.

    Warning

    If an object on the server does not have at least one entry in the AR System Version Control: Object Modification Log form, a version control label is not added to it.

To add a version control label to all objects imported in a definition file

During the import process, enter a label name and, optionally, a label description in the Import File page of the Import wizard:

image2023-1-5_12-32-15.png

To use an existing label, select it from the Version Control Label list.

For more information about importing definition files, see Exporting-and-importing-definitions.

To find objects with a specified version control label

  1. In Developer Studio , select Search > Search.
  2. On the Label Search tab, enter the search criteria.
    The search is not case sensitive.
  3. Click OK.
    The search results appear in the Label Search Results tab at the bottom of the editing pane. For example, a search for the version control label "build" returned two labels, Build 001 and Build 002: 
    151_label_search_results.GIF
  4. In the Label Search Results tab, click a label to display the objects that have that label.
    For example, in the preceding figure, all the objects that have the Build 002 label are listed in the top panel.

Label name limitations

If you use the following characters in a version control label name, the search results for the label might be inaccurate.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*