Define version branch names

In the Administration Console, you can define and update valid version branch names within the base database.

To add, modify, or delete version branch names, you need the Manage Version Branch Definitions privilege.

Add a version branch

Define a valid version branch name to enable users to select specific development branches for their item operations in a project.

To define a valid version branch name:

  1. In the Administration Console, navigate to Configuration Object Management > Version branch names.

  2. In the Version Branch Names window, click New on the toolbar.

  3. In the New Version Branch dialog box, enter the branch details:

    Field Description
    Version Branch Name Enter a unique name for the version branch, up to 25 characters long. Use only alphanumeric characters or underscores.
    Description (Optional) Provide a description for this branch, up to 240 characters long.
    Is Locked (Optional) Select this option if you want to lock the named branch against such operations as item revision updates or deletions.

  4. Click OK.

Back to top

Edit or delete version branches

You can modify or remove a valid version branch name from the base database.

Note: You cannot delete a version branch name that is used to label any item pedigree trees.

To edit or delete a valid version branch:

  1. In the Administration Console, navigate to Configuration Object Management > Version branch names.

  2. To modify a version branch, in the Version Branch Names content pane, select the version branch and click the Edit button.

  3. In the Edit Version Branch dialog box, update the version branch details:

    Field Description
    Version Branch Name Enter a unique name for the version branch, up to 25 characters long. Use only alphanumeric characters or underscores.
    Description (Optional) Provide a description for this branch, up to 240 characters long.
    Is Locked (Optional) Select this option to lock the named branch against such operations as item revision updates or deletions.

    Owner Site

    (Optional) If using Dimensions CM Replicator, select the primary base database site that owns this branch.

    Note: You can select from the sites that have been defined as part of the Dimensions CM network in Administration Console > Network Administration.

    The base database site consists of a physical network node name, the Dimensions CM base database name, and the database connection string.

    Only users of the base database that owns this branch can modify the branch, such as add or delete item revisions to/from it.

    Leave this field empty to indicate that the branch is owned by the current base database site.

    Note: Typically, you do not set this field, as it is maintained by Replicator. For details, see Administration.

  4. To delete version branches, select one or more version branches in the content pane. On the toolbar, click Delete, and confirm the deletion.

Back to top

See also: