Revision Scheme Administration

Note: This feature is available in Autodesk Vault Workgroup, Collaboration, and Professional editions.

Products have defined lifecycles from inception through production. Product development and enhancement introduces changes to the product files. These changes must be tracked and managed to provide a complete history of the changes and modifications as the product develops. Revision management provides consistency throughout the product lifecycle by applying a common definition and behavior to files and items in a vault.

Revision schemes are used to manage versioning during product development.

Out of the Box Revision Scheme Definitions

The following revision scheme definitions are provided.

Name Description Delimiter Primary Secondary Tertiary Categories
Standard Alphabetic Format Only characters are permitted within the primary format A period (.) Alphabetic Numeric Numeric Engineering, Standard
Standard Numeric Format Sequential numbering starting from 1 A period (.). Numeric Numeric Numeric Office
<None> Null revision scheme for opt-out condition none none none none none

Out of the Box Revision Scheme Formats

The following revision scheme formats are provided.

Format Name Values
Alphabetic A,B,C,D,E,F,...Z,AA,AB,AC,...,BA,BB,...,ZZ
Numeric 1,2,3,...,99

Manage Revision Schemes and Category Assignments

You can assign or remove one or more revision schemes to a category using the Assign command. You can also assign a revision scheme to <Base>, creating a default scheme for files and items not assigned to a category.

Important: In the Filter list, do not select <All revision Schemes> when assigning or removing a revision scheme.

Assign a Revision Scheme to a Category

  1. Click Tools  Administration  Vault Settings.
  2. In the Vault Settings dialog box, select the Behaviors tab Revisions.
  3. In the Revision Scheme Definitions dialog box, select the category from the Filter list that you want to assign the revision scheme to or remove a revision scheme from.
  4. On the Revision Scheme Definitions dialog box toolbar, click Assign. 

Add a Revision Scheme to the Category

  1. In the Assign Category dialog box, select one or more revision schemes from the All Revision Schemes list on the left, and then click Add to add the schemes to the Assigned Revision Schemes list on the right. 

Remove a Revision Scheme from the Category

  1. In the Assign Category dialog box, select one or more revision schemes from the Assigned Revision Schemes list on the right, and then click Remove to remove the schemes from the category. The selected schemes then appear in the All Revision schemes list on the left.
  2. Select a revision scheme from the Assigned Revision Schemes list on the right to assign it as the default, and then click Default.
  3. Click OK.
Note: Select <Base> to assign a revision scheme to files that are not currently categorized.

Change a Revision Scheme Definition

You can change the revision scheme of a file or item . You must have Administrative rights to use this feature.

Change the Revision Scheme Definition of a File

  1. From either the relationships grid or the preview pane, select one or more files to revise.
  2. Click Actions   Revise.
  3. In the Revise dialog box, select Primary, Secondary, or Tertiary from the Select Next Revision list.
  4. Using the relationships grid, select parent and child files to revise. All files that are checked in the relationships grid are affected. Clear the check box for any file you do not want to change.
  5. Click (...) to view the list of available revision scheme definitions. By default, only those revision schemes associated with the file category are listed. To view revision schemes not associated with a category, select the Show definitions not associated with a category check box.
  6. Do one of the following:
    • In the Change Revision Scheme Definition dialog box, select the new revision scheme that you want to assign to the selected file. Click OK.
    • In the Change Revision Scheme Definition dialog box, select <None> to remove the selected file from Revision Management. Click OK.
  7. In the Revise dialog box, optionally, enter comments in the Enter Comments box. Click OK.

Change the Revision Scheme Definition of an Item

  1. From the item master or the preview pane, select one or more items to revise.
  2. Click Actions  Change Revision.
  3. In the Choose Next Revision dialog box, select Primary, Secondary, or Tertiary from the Select a Revision list.

    You may also customize the next revision level by selecting User Specified and entering a value.

  4. Click Scheme to view the list of available revision scheme definitions. Only those revision schemes associated with the item category are listed.
  5. In the Change Revision Scheme Definition dialog box, select the new revision scheme that you want to assign to the selected item. Click OK.
  6. In the Choose Next Revision dialog box, click OK.

Copy a Revision Scheme

You can create a new revision scheme by copying an existing revision scheme. The standard schemes cannot be modified, but can be copied and then modified to make a new revision scheme.

Copy a revision scheme

  1. Click Tools  Administration Vault Settings.
  2. In the Vault Settings dialog box, select the Behaviors tab Revisions.
  3. From the revision schemes table, select the revision scheme, and then click Copy.
  4. In the Revision Scheme Definition dialog box, the default name Copy of <original scheme name>, appears in the Definition Name box. The Scheme Values are copied from the original scheme to the new scheme.
  5. Revise any of the following as needed:
  6. Edit the name of the scheme in the Definition Name box.
  7. Edit the description of the scheme in the Description box.
  8. Edit the category assignment using the Category list to select or clear categories.
  9. Edit the scheme values for the primary, secondary, tertiary, or delimiter types by selecting the corresponding value field from the Scheme Values table and then selecting from the value list that appears.
  10. Click OK.

Create a New Revision Scheme

You can create a new revision scheme by copying an existing revision scheme. The standard schemes cannot be modified, but can be copied and then modified to make a new revision scheme.

Create a New Revision Scheme

  1. Click Tools  Administration  Vault Settings.
  2. On the Vault Settings dialog box, select the Behaviors tab  Revisions.
  3. In the Category list, do one of the following:
    • Select a category to assign to the new scheme. Or, select <Base> to assign a default revision scheme to files that are not currently categorized.
    • Select <All Categories> to create the new scheme without assigning a category at this time.
  4. Click New. In the Revision Scheme Definition dialog box, the default name New Revision, appears in the Definition Name box.
  5. Enter another name for the scheme in the Definition Name box.
  6. Enter a description of the scheme in the Description box.
  7. If the scheme was assigned a category in the previous dialog box, that category appears in the Category list. Select one or more categories to assign the new revision scheme to.
  8. Do one of the following:
    • Click OK to accept the default scheme format shown on the Preview tab, and close the dialog box.
    • Click New to define a new revision scheme format.
    • Click Copy to copy a revision scheme format from another revision scheme. 

Define a New Revision Scheme Format

  1. Click the Scheme Format tab New.
  2. In the List Scheme Format dialog box, enter a name in the Scheme Format Name box.
  3. Click Add to add a row for a scheme value, and then enter the value in the row.
  4. Optionally, re-prioritize values by selecting a value and clicking the move up arrow or move down arrow.
  5. Optionally, select a value that is not checked to assign it as the default, and then click Set as Default.
  6. Click OK.

Copy a Format from Another Revision Scheme

  1. Click the Scheme Format tab, select the scheme format to copy, and then click Copy.
  2. In the List Scheme Format dialog box, the default name Copy of <original scheme name> appears in The Scheme format Name box. Change the name by replacing it with a name you enter.
  3. Re-prioritize values by selecting a value and clicking the move up arrow or move down arrow.
  4. Select a value that is not checked to assign it as the default, and then click Set as Default.
  5. Add a new row by clicking Add, and then enter the value in the List Values list.
  6. Select a value to remove, and then click Remove.
  7. Click OK.

Delete a Revision Scheme

You can delete an existing revision scheme that meets the following criteria:

A revision scheme is in use if the current version of a file is using the scheme, or if the scheme is assigned to a category. If a previous version of a file used the revision scheme, the scheme is not considered to be in use.

Delete a Revision Scheme

  1. Click Tools Administration Vault Settings.
  2. In the Vault Settings dialog box select the Behaviors tab  Revisions.
  3. In the Revision Scheme Definitions dialog box, select the scheme, and then click Delete.

Delete a Revision Format

Once you have deleted the revision scheme, you must also delete its revision format.

  1. In the Revision Scheme Definitions dialog box, click New.
  2. Select the Scheme Format tab.
  3. Select the scheme format that you want to delete and click Delete. Then clickYeson the confirmation dialog box.
  4. Click Cancel to exit the Revision Scheme Definitions - New Revision dialog box.

Edit a Revision Scheme

You can edit an existing revision scheme, including an imported scheme. The standard schemes cannot be modified, but can be copied and then modified to make a new revision scheme.

Details that can be edited are the revision scheme format and comments. The revision scheme format consists of the primary, secondary, and tertiary variables, and the delimiter that separates them. You cannot edit a revision scheme format if it is in use. If you attempt to edit a revision scheme format that is in use, you will receive a message explaining that the revision scheme format is in use. The editing area for revision scheme details is located in the Scheme Details group.

Edit a Revision Scheme

  1. Click Tools  Administration Vault Settings.
  2. On the Vault Settings dialog box select the Behaviors tab  Revisions.
  3. In the Revision Scheme Definitions dialog box, select the revision scheme from the Scheme Name column, and then click Edit.
  4. In the Revision Scheme Definition dialog box, edit the Definition Name or Description by replacing the existing text with the new text.
  5. In the Category list, select or clear category name check boxes to assign or remove the scheme from the respective category.

Edit a Revision Scheme Format

The Scheme Details group is located on the lower portion of the Revision Scheme Definition dialog box. In the Scheme Values table, the Type column lists the delimiter, primary, secondary, or tertiary component of the revision scheme format. The Value column lists the properties of the corresponding Type.

In the Scheme Values table, select the Type, and then select a Value from the list

Add Comments to a Revision Scheme

  1. In the Scheme Details group, select the Commentstab   Add.
  2. In the Comment for dialog box, enter comments in the area provided, and then click OK.
  3. Click OK to commit all edits and close the dialog box.

Import a Revision Scheme

You can import a revision scheme definition from an external text file, or from another Vault Professional environment. Once the revision scheme is imported, a revision format is created with the same name as the imported scheme.

Important: Each line in the text file must contain only one value.

  1. Click Tools  Administration Vault Settings.
  2. In the Vault Settings dialog box select the Behaviors tab   Revisions.
  3. On the Revision Scheme Definitions dialog box toolbar, click Import.
  4. In the Import Revision Scheme dialog box, click (...) to locate and select the text file to import for the scheme definition.
  5. The Name box fills with the imported file name. Edit the name of the revision scheme or accept the name as imported.
  6. Enter a description in the Description box.
  7. To change the character used for the delimiter between revision levels, select a character from the Delimiter list.
  8. From the Categories list, select one or more categories to assign to the revision scheme. Or, select <Base> to assign a revision scheme to files that are not currently categorized.
  9. Click OK.
Parent topic: Client Administration Tasks