Folder Fields

This section lists all the folder fields in alphabetical order.

Branch On Change (Advanced)

Values: No, Yes.

Internal Identifier: BranchOnChange.

Indicates whether the item will branch when it changes.

The value is No if the item's behavior is not set to Branch On Change. Reasons for this may be:

• The item is in the root or a reference view and the Branch On Change feature is disabled.
• The item is in a branching view but has already branched as a result of a change, which, in turn, results in the Branch On Change feature becoming disabled.
• The item is in a branching view, but its behavior currently does not permit it to branch on change. This means that modifications are checked into the parent view.

Note: If the value is No, the value of the Branch State explains the No.

Branch State (Advanced)

Values: Branched, Not Branched, Root.

Internal Identifier: BranchState.

Indicates whether an item has branched in the child view, is still unbranched (and therefore is part of the parent view), or was created in the view in which it resides.

The values Branched and Not Branched apply to items in branching views. The value Root applies to items created in the view in which the item currently resides.

If the view is a reference view, it reflects the state of the item in the reference view’s parent.

Comment

Values: text.

Internal Identifier: Comment.

The initial 2000 characters provided as the reason for changing an item's properties or contents are stored in the Short Comment field. The Comment field stores those 2000 characters and any additional text. Changing an item's properties causes the application to create a new revision.

Note: To include a Link comment, the Comment field is the value to use in an HTML report.

CommentID (Advanced)

Values: number.

Internal Identifier: CommentID.

The ID number assigned to the revision comment. Displays -1 if no revision comment was supplied.

Configuration Time

Values: date/time.

Internal Identifier: ConfigurationTime.

Indicates the time to which an item is configured. If you configure an item to a specific time, this field contains that time. If you configure an item to a label or promotion state, this field shows either the time at which the label was created, or the time at which the label associated with the promotion state was created.

Created By

Values: list of users, <None>.

Internal Identifier: CreatedUserID.

The name of the user who created the first revision in the view. This is either the user who added the item to the project, or the user who checked in the revision that branched.

Created Time

Values: date/time.

Internal Identifier: CreatedTime

The time at which the first revision in the view was created.

Creating Project

Values:

Internal Identifier: CreatingProject

Deleted By

Values: list of users, <None>.

Internal Identifier: DeletedUserID.

The name of the user who deleted the item. Because deleted items do not appear in the list, this information is unavailable to users. Internal Use Only.

Deleted Time

Values: date/time.

Internal Identifier: DeletedTime.

The time at which an item was deleted. Because deleted items do not appear in the list, this information is unavailable to users. Internal Use Only.

Description

Values: text.

Internal Identifier: Description.

The description provided for an item at the time it was added to the view, including any later edits to it.

Dot Notation

Values: text.

Internal Identifier: DotNotation.

The branch revision number, for example, 1.2.1.0.

Dot Notation ID (Advanced)

Values: number.

Internal Identifier: DotNotationID.

The ID assigned to a particular branch revision number. For example, if a folder was added to the current view (as opposed to inherited by the current view), its branch revision number is 1.x and its branch revision ID is 0. If a folder was branched in the current view, its branch revision ID is dependent on the revision number in the parent view and the number of IDs already assigned in the current view. For example, if a folder’s revision number in the parent view is 1.7 at the time of the branch, and another folder with that same parent revision number was given the Branch Revision ID 6, this folder will also be given the Branch Revision ID 6.

End Modified Time (Advanced)

Values: date/time.

Internal Identifier: EndModifiedTime.

The date and time at which a revision ceased to be the tip revision. Although this field can be displayed in the upper pane, its value is always blank. This is because, at any given configuration time, the item is still the tip revision.

Exclude Flags

Values: Inherit and Local Exclude List, Local Exclude List, No Exclude List.

Internal Identifier: ExcludeFlags.

The flag which specifies the types of filse to be excluded from the folder.

Exclude Spec

Values: text.

Internal Identifier: ExcludeSpec.

The file specification (using the standard * and ? wild cards), separated by commas, spaces or semicolons. To include a comma, space, or semicolon as part of the specification, enclose the specification in double quotes.

Folder Path

Values: text.

Internal Identifier: Folder Path (contains spaces).

The path to the folder. This is not the path to the working folder.

Is Action Overidden?

Values: No, Yes.

Internal Identifier: Is Action Overidden? (contains spaces).

Local Path

Values: text.

Internal Identifier: Local Path (contains spaces).

The local path to the folder. This is the path to the working folder.

Locked By

Values: list of users, <None>.

Internal Identifier: ExclusiveLocker.

The name of the user who has exclusively locked a folder.

Modified By

Values: list of users, <None>.

Internal Identifier: ModifiedUserID.

The name of the user who last modified the item.

Modified Time

Values: date/time.

Internal Identifier: ModifiedTime.

The time at which an item was last modified. The item may have been checked in or had its properties changed. For folders, this has nothing to do with the working folder. Use Local Time Stamp for the time a working folder was last modified.

Name

Values: text.

Internal Identifier: Name.

Displays the name of the item.

Non-Exclusive Lockers

Values: text.

Internal Identifier: NonExclusiveLockers.

The names of the users who have locked the folder non-exclusively.

Object ID

Values: number.

Internal Identifier: ID.

Each item is assigned an object ID when it is added to a view. For applicable items, when it is branched in a child view, it is assigned another object ID. The original ID belongs to the folder in the parent view.

Parent Branch Revision (Advanced)

Values: number.

Internal Identifier: ParentRevision.

The last digit in the branch revision number before an item branched. For example, if this number is 7, the branch revision was 1.7 at the time the item branched (becoming 1.7.1.0, as seen in the item’s history). This number is -1 if an item was not inherited from the parent view.

Parent ID (Advanced)

Values: number.

Internal Identifier: ParentID.

The object ID of an item in the parent view. The Parent ID is -1 if this view has no parent view.

Parent Revision (Advanced)

Values: number.

Internal Identifier: PathRevision.

The revision number at which an item branched. For example, if this number is 8, this item’s revision number in the parent view was 8 at the time the item branched. The history should show that revision 9 in the first revision in the current view. This number is 0 if this item was not inherited from the parent view.

Read Only (Advanced)

Values: No, Yes.

Internal Identifier: ReadOnly.

Indicates whether the item’s configuration is read-only (as in a rollback configuration of a view)/its behavior does not allow it to branch on modification. For folders, do not confuse a read-only configuration (an application issue) with a read-only folder (an operating system issue). A read-only folder cannot be edited and saved to disk. A folder whose configuration is read-only can be edited and saved to disk; it just cannot be checked in.

Revision Flags (Advanced)

Values: 0.

Internal Identifier: RevisionFlags.

Internal use only.

Root Object ID (Advanced)

Values: number.

Internal Identifier: RootObjectID.

The object ID of the oldest ancestor of an item. For example, if an item was not inherited from a parent view, the root object ID is the same as its object ID. If it was inherited from a parent view, the root object ID is the Parent ID, or the item’s Parent ID.

Share State

Values: DerivedShare, Not Shared, Root Share.

Internal Identifier: ShareState

Indicates whether this item is shared. Not Shared means that the item is not shared. Root Share means that the item is shared and this item is the original (or root) reference. DerivedShare means that the item is shared, but this item is not the original (or root) reference.

Short Comment

Values: text.

Internal Identifier: ShortComment.

Stores the initial 2000 characters provided as the reason for changing an item’s properties or contents. Additional text is stored in the Comment field.

Status

Values: Current, Deleted on Disk, Deleted on Server, Merge, Missing, Modified, Not In View, Out Of Date, Unknown.

Internal Identifier: Status.

Indicates the relationship between the copy of an item in your working folder and the tip revision in the repository.

Version (Advanced)

Values: number.

Internal Identifier: RevisionNumber.

The last number in the branch revision number. For example, if the branch revision number is 1.3.1.2, the version is 2.

View

Values: list of views, <None>.

Internal Identifier: ViewID.

The name of the view in which the item last branched. For example, if an item is inherited from a parent view but is branched in a child view, the value of this field in the child view changes from the name of the parent view to the name of the child view for the revision that branched and subsequent revisions in the child view.

***Working Folder

Values: number.

Internal Identifier: WorkingFolder.

The name of the working folder.