Requirement Fields
The following table lists all the Requirement fields in alphabetical order.
Note: Client-calculated fields cannot be used in custom email notifications or StarTeam Notification Agent . Reports can use any field name.
Am I Responsible? |
Values:
Internal Identifier:
Indicates whether the logged-on user is responsible for a requirement. This is a client-calculated field. |
Ambiguities Found |
Values:
Internal Identifier:
Indicates the number of ambiguities found in the requirement. |
Attachment Count |
Values: number. Internal Identifier: AttachmentCount. The number of files attached to an item. |
Attachment IDs (Advanced) |
Values: byte array. Displayed as a bracketed series of numbers in hex format. For example: [00 00 00 00 02 00 00 00] indicates two specific attachments. Internal Identifier: AttachmentCount. Cannot be used in queries. The ID numbers assigned to attachments. For example, the first attachment within a project is 00 00 00 00. |
Attachment Names |
Values: text containing a series of file names separated by spaces. Internal Identifier: AttachmentNames. The names of the files attached to an item. |
Children Count |
Values: number. Internal Identifier: ChildrenCount. The number of items that are children of this item. This is a client-calculated field. |
ChildType |
Values:
Internal Identifier:
Indicates whether the requirement is the root of a requirement tree or a child of another requirement. This is a client-calculated field. |
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. |
Comments |
Values:
Internal Identifier:
Provides comments about the revised description created because of ambiguities found in the original description or for other reasons. |
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. |
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. |
Disabled |
Values:
Internal Identifier:
Indicates whether the requirement is disabled. |
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. |
Expected Effort |
Values:
Internal Identifier:
Indicates the expected case estimate for how long it will take to implement the requirement fully. If you are publishing requirements from CaliberRM to StarTeam, these fields will already be filled with data based on a specific unit, such as hours or days. Otherwise, the units are arbitrary, but should be the same for the Low Effort and the High Effort fields, and should be used consistently for all requirements. |
External Reference |
Values:
Internal Identifier:
Usually provides the name of an external customer who asked for this requirement. |
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 Path |
Values: text. Internal Identifier: Folder Path (contains spaces). The path to the folder. This is not the path to the working folder. |
High Effort |
Values:
Internal Identifier:
Indicates the worst case estimate for how long it will take to implement the requirement fully. If you are publishing requirements from CaliberRM to StarTeam, these fields will already be filled with data based on a specific unit, such as hours or days. Otherwise, the units are arbitrary, but should be the same for the Low Effort and the Expected Effort fields, and should be used consistently for all requirements. |
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. |
Locked By |
Values: list of users, <None>. Internal Identifier: ExclusiveLocker. The name of the user who has exclusively locked a folder. |
Low Effort |
Values:
Internal Identifier:
Indicates the best case estimate for how long it will take to implement the requirement fully. If you are publishing requirements from CaliberRM to StarTeam, these fields will already be filled with data based on a specific unit, such as hours or days. Otherwise, the units are arbitrary, but should be the same for the Expected Effort and the High Effort fields, and should be used consistently for all requirements. |
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. |
Notes |
Values: text. Internal Identifier: Notes. Text comments on the effort levels for this item. |
Number |
Values:
Internal Identifier:
Number identifying the requirement. For example, if the Object ID is 0, the requirement number is 1. |
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. |
Owner |
Values: list of users,
Internal Identifier:
Indicates who is ultimately responsible for this requirement. |
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. |
Priority |
Values:
Internal Identifier:
The value of the Priority field. You can use repository customization to change the names of these values or include other values. |
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. |
Read Status |
Values: Read, Unread. Internal Identifier: ReadStatus. Indicates whether an item is considered read or not read. This is a client-calculated field. |
Read Status User List |
Values: text displayed as a list of user names. For example: [Greg,Sam] indicates user names. Internal Identifier: ReadStatusUserList. Can be used in queries. Identifies users for whom a given item’s status is Unread. |
Responsible Count |
Values:
Internal Identifier:
The number of users who are responsible for a requirement. |
Responsible IDs |
Values:
Internal Identifier:
Can not be used in queries. The ID numbers assigned to the users who are responsible for the requirement. |
Responsible Names |
Values:
Internal Identifier:
The names of the users responsible for this requirement. |
Reviewed By |
Values:
Internal Identifier:
Can not be used in queries. Should not be used at all. |
Revised Description |
Values:
Internal Identifier:
Provides a new, revised description because of ambiguities found in the original description or for other reasons. |
Revision Flags (Advanced) |
Values: 0. Internal Identifier: RevisionFlags. Internal use only. |
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: Accepted, Approved, Complete, Deferred, Draft, Pending, ReadyForCCB, Rejected, Review, Submitted. Internal Identifier:
Indicates the status of this requirement. |
Type |
Values:
Internal Identifier:
Indicates the type of requirement. |
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. |