File Fields

This section lists all the file fields in alphabetical order.

Archive Format (Advanced)

Values: Native-II.

Internal Identifier: ArchiveFormat.

Indicates whether the format in which file revisions are stored. StarTeam 2006 uses only Native-II format.

Archive Path

Values: text.

Internal Identifier: ArchivePath.

The path to the PVCS archive or VSS project containing a file.

Archive Name (Advanced)

Values: 32–digit hex string representing the MD5 value of the file.

Internal Identifier: STArchiveName.

For a file stored in a Native-II Vault, indicates the name of the file that stores the tip revision. This name is the MD5 value of that file revision's content, converted to a 32–digit hex string.

Archive Type

Values: Native, PVCS, VSS.

Internal Identifier: Type.

Indicates whether a file is stored as a StarTeam (Native), PVCS, or VSS file.

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.

Compression Level

Values: Default, Maximize Compression, Maximize Speed, None.

Internal Identifier: Compression.

Indicates a file's level of compression.

Default

A compromise between Maximize Compression and Maximize Speed.

Maximize Compression

The densest possible compression of file revisions. Used to save space on the server.

Maximize Speed

The fastest possible compression of file revisions. Used to improve server performance.

None

No compression.

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.

Content Revision

Values: number.

Internal Identifier: ContentVersion.

The number of times a file has been checked in. If the file is in a child view, it includes all the content revisions from the parent view in this number. Each revision appears in the file’s history.

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.

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.

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.

EOL Character

Values: numeric representation of ANSI character.

Internal Identifier: EOL.

For internal use only. This field is primarily used to determine an ANSI character to use when breaking up lines within files for delta storage with Native-1 Vaults.

Executable

Values: No, Yes.

Internal Identifier: Executable.

Indicates whether the executable bit should be set for a UNIX file.

Extension

Values: text.

Internal Identifier: Extension.

Displays the extension of the file. This field is client-calculated.

File Time Stamp at Check-In

Values: date/time.

Internal Identifier: Modified.

The file’s time stamp at the time it was last checked in.

File Type

Values: ASCII, Binary, Unicode.

Internal Identifier: Charset.

Indicates whether the file is an ASCII (text), binary, or Unicode.

Flag

Values: No, Yes.

Internal Identifier: Flag.

Marks or bookmarks files in the upper pane on your workstation. This is a client-calculated field.

Flag User List (Advanced)

Values: text displayed as a list of user names. For example: [Greg,Sam] indicates user names.

Internal Identifier: FlagUserList.

Can be used in queries. Identifies users who have set flags on a given item.

Folder

Values: text.

Internal Identifier: Folder.

The name of the folder that stores the item. This is a client-calculated field.

Folder Path

Values: text.

Internal Identifier: Folder Path (contains spaces).

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

Hive ID (Advanced)

Values: number assigned by the StarTeam Server.

Internal Identifier: HiveID.

Indicates the ID number of the hive that stores the tip revision for a file stored in a Native-II Vault.

Item Deleted By

Values: list of users, None.

Internal Identifier: ItemDeletedUserID.

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

Item Deleted Time

Values: date/time.

Internal Identifier: ItemDeltedTime.

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

Local Name

Values: text.

Internal Identifier: LocalName.

Name of the working file. This is a client–calculated field.

Local Path

Values: text.

Internal Identifier: LocalPath.

Path name to the folder/file. This is a client-calculated field.

Locked By

Values: list of users, <None>.

Internal Identifier: ExclusiveLocker.

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

MD5 Checksum

Values: byte array. Displayed as a bracketed series of numbers in hex format. The StarTeam client displays only significant zeroes so the 05 and 0A would become just 5 and A, and A–F as a–f.

Internal Identifier: MD5.

Cannot be used in queries. The MD5 checksum for the tip revision.

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.

My Lock

Values: Exclusively Locked By Me, Non-exclusively Locked By Me, Not Locked By Me.

Internal Identifier: MyLock.

Indicates whether the current user has the item locked and, if so, whether that lock is exclusive or not. This is a client-calculated field.

Name

Values: text.

Internal Identifier: Name.

Displays the name of the item.

New Revision Comment (Advanced)

Values: text.

Internal Identifier: NewRevisionComment.

Internal use only. The client uses this value during the item update process. The field always appears empty if added to the upper pane. This is a client-calculated field.

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.

Path

Values: text.

Internal Identifier: Path

The path to an item’s working folder. This is a client-calculated field.

Project ID (Advanced)

Values: number.

Internal Identifier: ProjectID.

The ID number assigned to a project. Within a server configuration, projects are assigned ID numbers in the order in which they are created. The first project has ID 0.

PVCS Revision (Advance)

Values: text.

Internal Identifier: PVCSRev.

The file’s revision number in PVCS’s dot notation.

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

Values: number.

Internal Identifier: ViewVersion.

The number of times a file has been checked in or had its properties changed. If the file is in a child view, it includes all the revisions from the parent view in this number. This is a client-calculated field.

Revision Flags (Advanced)

Values: 0.

Internal Identifier: RevisionFlags.

Internal use only.

Revision on Disk

Values: number.

Internal Identifier: SyncPathVersion.

The number of the revision that is currently in the working folder on your workstation. The application displays no number if the file’s status is Missing. This is a client-calculated field.

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.

Size

Values: number.

Internal Identifier: FileSize.

The tip revision’s size in bytes.

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.

Storage Type (Advanced)

Obsolete.

Sync Branch Version

Values: number.

Internal Identifier: SyncObjectVersion.

A field used to determine status. The last number of the branch revision that was most recently checked out to the working folder. This is a client-calculated field.

Sync Content Version

Values: number.

Internal Identifier: SyncContentVersion.

A field used to determine status. The revision checked out as the working file or, if the file needs to be merged, a number higher than that. This is a client-calculated field.

Sync Known

Values: No, Yes.

Internal Identifier: SyncKnown.

A field used to determine status. Indicates whether the server knows the working file’s relationship to the tip revision. This is a client-calculated field.

Sync Local Size

Values: number.

Internal Identifier: SyncSize.

A field used to determine status. The size of the working file in bytes. This is a client-calculated field.

Sync Local Time Stamp

Values: date/time.

Internal Identifier: SyncTime.

A field used to determine status. The time stamp for the working file. This is a client-calculated field.

Sync MD5

Values: byte array. Displayed as a bracketed series of numbers in hex format. The StarTeam client displays only significant zeroes, so 08, 0B, and 06 would become just 8, B, and 6, and A–F as a–f.

Internal Identifier: SyncMD5.

Can not be used in queries. A field used to determine status. The MD5 checksum of the working file. This is a client-calculated field.

Sync On Path To Root

Values: No, Yes.

Internal Identifier: SyncOnPathToRoot.

A field used to determine status. When the working file is not based on the tip revision, this field indicates whether the server knows the relationship between the two. A Yes value in this field means that the working file needs to be merged or is out of date. A No value means that the relationship cannot be determined. This is a client-calculated field.

Vault Branch Version (Advanced)

Values: number.

Internal Identifier: VaultVersion.

The number of times a file has been checked in from the current view.

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 File Executable

Values: text.

Internal Identifier: No, Yes.

Indicates whether the working file is executable. This is a client-calculated field.

Working File Exists

Values: No, Yes.

Internal Identifier: LocalFileExists.

Indicates whether a copy of a file is in its working folder. This is a client-calculated field.

Working File Size

Values: number.

Internal Identifier: LocalSize.

The size of the working file. This is a client-calculated field.

Working File Time Stamp

Values: date/time.

Internal Identifier: LocalTimestamp.

The time stamp of the working file. This is a client-calculated field.