Change Package Properties

Properties

The following properties are available for Change Packages. User's with the proper access rights can change these properties.

Name

Displays the textual identification of the change package. The name must be unique among all other change packages for the same target view. By default, StarTeam generates a name that contains a timestamp, which helps prevent duplicate names. This property is the change package object’s primary descriptor.

Description

Provides a full description of the change package. A typical use of the description property is to provide documentation not available in the change package’s process item such as notes to testers, reviewers, or developers.

Session Type

Defines the change package’s basic type. The type is set when the change package is first created and cannot be changed thereafter. It has the same values as VCM: Rebase, Replicate, and Promote.

Target View

Displays the name of the change package’s target view.

Source View

Displays the name of the change package’s source view.

Commit Time

Indicates the timestamp at which the change package was committed, or null if it has not yet been committed. This property cannot be directly modified by the user. Change packages that have been committed cannot be modified (except for the revision comment).

State

Indicates the current workflow state of the change package. This property will not be directly user-modifiable nor user-customizable. Furthermore, change packages will not be integrated with user-customizable workflow, hence the values of this property are defined by actions performed to the change package as it evolves. The initial enumeration values of the state property are:

New

This is the state that every change package receives when it is first created, but before any updates are defined for it.

Committed

This state indicates that the change package has been committed, hence its changes have been applied. A committed change package and can no longer be modified (except for the revision comment).

Transaction ID

Holds the ID of the transaction in which the change package’s updates were applied. Prior to the Committed state, its value is null. Otherwise, the value can be used to query audit records in the Audit tab or commands used in the transaction by way of the StarTeam Server command trace file.

Pre-commit View Label

Displays the name of the post-modification label that was created in the target view. This property is null if this label type was not created.

Pre-commit Revision Label

Displays the name of the post-modification label that was created in the target view. This property is null if this label type was not created.

Post-commit View Label

Displays the name of the post-modification label that was created in the target view. This property is null if this label type was not created.

Post-commit Revision Label

Displays the name of the post-modification label that was created in the target view. This property is null if this label type was not created.

Committed by

Displays the name of the user who committed the change package or null if it has not yet been committed.

Committed In Build

Displays the name of the first build label created in the same view after the change package is committed of null if it has not yet been committed.

When a change package is committed, this property displays Next Build until a new build label is created.

Responsibility

Displays the name of the user who is currently responsible for the change package. It is initially set to the user that first creates the change package.

If responsibility is changed to another user, and email notifications are enabled, the new user is notified of the change.

Other Server Services

In addition to the StarTeam Server’s persistence and versioning service, change packages also use the StarTeam Server’s locking service. This means that a change package can be locked exclusively or with a shared lock. An exclusive lock is automatically applied to a saved change session when it is opened for editing. A change session can also be opened in read-only mode, though a non-exclusive lock is not applied for this use.