StarTeam Cross-Platform Client
Welcome to StarTeam
Introduction
Installation and Licensing for StarTeam
Products Included with StarTeam Enterprise Licenses
Products Included with StarTeam Enterprise Advantage Licenses
About Source Control
Standard StarTeam Architecture Overview
Contacting Support
StarTeam Basics
Containers
Artifacts
Artifacts Versus Items
Folders
Folders and Views
Files
Change Requests
Change Request Tracking System Model
Built-in Workflow for Change Requests
Requirements
Tasks
Topics
Links: Internal and External
Labels
Branching, Merging and Dot Notation
Sharing and Cheap Copies
Setting Access Rights
General Access Rights Rules
Group Privileges and Access Rights
Denying Access Rights
Creating a Deny Record to Handle Access Right Exceptions
Promotion States
Audit Log
Audit Log Events
Audit Fields
Table of Common Operations
Testing and Reporting Overview
Change Requests
Queries
Classic Reports
Charts
Filters
Fields
Data Export with Datamart
Tour of the UI
Cross-Platform Client UI
Project Menu
View Menu
Folder Tree Menu
Folder Menu
File Menu
Change Request Menu
Requirement Menu
Task Menu
Topic Menu
Audit Menu
Tools Menu
Window Menu
Help Menu
Client Keyboard Shortcuts
Change Perspective UI
Chart Window
View Compare/Merge
View Compare/Merge Status Icons
Logging on to and off of a Server
Logging on to StarTeam Server and Creating or Opening a Project
Logging on as a Different User
Logging Off
Accessing Projects and Items
Search
Copying and Opening URLs
Copying a URL to the Clipboard
Opening a URL
Creating Shortcuts
Opening StarTeam Agile
Configuring Your Client
Connecting to a Server Configuration
Changing Your Password
Auto Client Update
Configuring an Alternate Editor, Merge, or Comparison Utility
Configuring the Display Order of Component Tabs in the Client
Show Advanced Menus
Controlling How File Status Information is Stored
Distribute starteam-client-options.xml through StarFlow Extensions
Customizing Personal Options
Customizing the Detail Pane
Displaying Additional Fields
Displaying and Customizing Logging Options
Displaying Notifications in the StarTeam Cross-Platform Client
Editing Your Account Information
User-Defined Property Fields
Modifications to Existing Fields
Translation of Display Names and Enumerated Values
Translating Display Names
Translating Enumerated Values
Displaying Custom Property Fields
Displaying Custom Property Fields for an Item on the Properties Dialog Box
Displaying Custom Property Fields in the Upper Pane
Creating Boolean Fields
Creating Content Fields
Creating Date and Time Fields
Creating Enumerated Fields
Creating Group and Group List Fields
Creating Map Fields
Creating Rich Content Fields
Creating Text Fields
Creating Time Span Fields
Creating User and User List Fields
Customizing the Detail Pane
Configuring Projects to Use Alternate Property Editors
Activating Forms
Projects
Project Structure
Guidelines for Keeping Projects Autonomous
Cross-Project Activity Support
How to Handle Cross-Project File Dependencies
Creating Projects
Name (Project Properties Dialog Box)
Options (Project Properties Dialog Box)
Default Types (Project Properties Dialog Box)
Process Rules (Project Properties Dialog Box)
Editors (Project Properties Dialog Box)
Assigning Access Rights to Projects
Granting Project-Level Access Rights
Project Access Rights
Opening Existing Projects
Opening Projects with Shortcuts
Changing Project Names or Descriptions
Saving Projects as Shortcuts
Viewing or Modifying Project Properties
Deleting Projects
Setting Active Process Items
Establishing Process Rules for Projects
Configuring Projects to Create Workspace Change Packages
Configuring Projects to Use Alternate Property Editors
Displaying Location References
Enabling Keyword Expansion
StarTeam Keywords
Requiring Exclusive Locks for Check-ins
Requiring Revision Comments
Viewing Connection Properties
View Configuration and Management
Overview of Views
View Types
View Roles
Main View: Home Base for Artifacts
Activity View: Isolated Team Work Area
Release View: For Post-Release Maintenance Work
Build View: Read-Only Windows for Build Scripts
Proper Use of Views
Creating and Configuring Views
View Configuration Options
View Type Options and Settings
Change Management within a View
Switching Views
Changing a View's Default and Alternate Working Folders
Deleting Views
Modifying View Names or Descriptions
Refreshing Views
Reviewing or Modifying View Properties
Rolling Back the Current View Configuration
Rolling Back a Current View
Returning to the Current Configuration
Basing a View Configuration on a Promotion State
Granting View-Level Access Rights
View Access Rights
References Overview
Understanding References
References Created by Branching Views
References Created by Adding Items to Views
References Created by Manually Sharing Objects
References Created by Moving Objects
Folders and Items
Overview of Folders and Paths
Folders
Understanding Default and Alternate Working Folders
Granting Folder-Level Access Rights
Folder Access Rights
Child Folder Access Rights
Folder Properties
Folder Fields
Adding Folders to Views
Adding a New Folder to a View
Adding Not-in-View Folders to a Project
Setting Folder Component Access Rights
Creating a Working Folder
Opening a Local Folder
Opening a Local Folder from a Folder Selection
Opening a Local Folder from a File Selected in StarTeam
Changing a View's Default and Alternate Working Folders
Changing Name or Description of Folders and Items
Displaying Historical Properties
Comparing Properties
Comparing Historical Properties
Comparing Properties of Two Non-file Items
Configuring (Rolling Back) Folders and Items
Rolling Back a Folder or Item
Returning to the Current Folder or Item Configuration
Identifying Rolled Back Items
Deleting Folders and Items
Deleting a StarTeam Folder
Deleting a Local Folder
Deleting an Item
Displaying Item Details
Displaying Location References
Viewing Folder References
Viewing References for Past Revisions of a Folder
Viewing Item References
Viewing References for Past Revisions of an Item
Emailing Item Properties
Finding Items
Floating Items
Hiding Folders and Files
Highlighting Items of Interest
Linking Items Internally or Externally
Locking and Unlocking Items
Locking an Item Using the Toolbar
Locking an Item Using the Menu
Marking Items Read or Unread
Moving Folders or Items
Moving a Folder or Item Within the Same View
Moving a Folder or Item Between Two Different Views
Restoring Folder Selection on Tab Change
Selecting Referenced Items in Other Views
Sharing Folders or Items
Sharing a Folder or Item in Two Locations in the Same View
Sharing a Folder or Item Between Two Different Views
Viewing or Modifying Item Properties
Embedded Property Editors
Using Embedded Property Editors
Dragging and Dropping Items into the Details/Embedded Editor Pane to View an Embedded Editor
Toggling Full Screen and Standard View
Granting Item-Level Access Rights
Generic Item Access Rights
Links: Internal and External
Linking Items Internally or Externally
Deleting Links
Linking Files to Process Items
Linking and Pinning a File Revision to a Process Item
Linking and Pinning a File Revision to the Active Process Item
Linking Specific Revisions
Linking to a Tip Revision
Linking to a Specific Revision
Viewing Links
Link Tab
Checking Linked Files In and Out
Customizing Link Item Properties
Customizing Link Properties
External Link Access Rights
Change Requests
Creating Change Requests
Working with Attachments
Displaying Change Requests
Viewing Unread Change Requests
Moving Change Requests
Sharing Change Requests
Updating a Group of Items
Default and Required Change Request Fields
Specifying Change Request Descriptions
Specifying Change Request Solutions
Modifying Custom Options for Change Requests
Specifying Change Request Summary Information
Assigning Change Requests
Adding Change Request Comments
Resolve Open Change Requests
Verifying Resolved Change Requests
Closing Verified Change Requests
Customizing Change Request Filters
Selecting Change Requests Using a Query
Reviewing Linked Change Requests
Sorting and Grouping Change Requests
Showing Fields in a Change Request
Customizing Change Request Reports
Change Request Properties
Change Request Fields
Requirements
Creating Requirements
Working with Attachments
Marking Item Threads Read or Unread
Updating a Group of Items
Requirement Properties
Requirement Fields
Tasks
Creating Tasks
Working with Attachments
Customizing Tasks
Adding Notes to Tasks
Assigning Task Resources
Removing Task Resources
Estimating Tasks
Adding Comments to Task Revisions
Marking Item Threads Read or Unread
Updating a Group of Items
Working with Work Records in Tasks
Adding a Work Record to a Task
Editing a Work Record for a Task
Deleting a Work Record from a Task
Task Properties
Task Fields
Topics
Creating Topics
Working with Attachments
Responding to Topics or Responses
Marking Item Threads Read or Unread
Topic Properties
Topic Fields
Files
Adding Files to Projects
Opening and Editing Files
Opening a File
Editing a File
Changing the Default Editor
Enabling Concurrent File Editing
Excluding Files from a Project
Finding Files Associated with Active Process Items
Hiding Folders and Files
Marking Unlocked Files Read-only
Renaming Files
Selecting Linked Files
Setting the File Executable Bit for UNIX
File Annotation Pane
Using the File Annotation Pane
Reviewing a Previous Version of a File
Viewing Previous File Revisions
Setting File Storage Options
Setting File Status Storage for a Specific View
Setting File Status Storage for all Files
Controlling How File Status Information is Stored
File Status Information
File Access Rights
File Properties
File Fields
Check-in and Check-out Operations
Check-in and Check-out Overview
Achieving Consistent Check-ins and Check-outs
Checking In Files
Editing Check-in Comments
Checking Out Files
Cache Agent Auto Locate Algorithm
Monitoring Check-out Statistics using the Cache Agent
Effects of Status on Check-ins and Check-outs
Checking Out Historical Versions of Files
Atomic Check-ins
EOL Conversion Handling Overview
Controlling EOL Characters
Process Items and Process Rules
Process Items
Process Items and Workspace Change Packages
Process Rules
Active Process Items
Process Tasks and Enhanced Process Links
Creating External Links
Checking Linked Files In and Out
Displaying Only Enhanced Process Links
Establishing Process Rules for Projects
Filtering Process Tasks From Other Tasks
Finding Files Associated with Active Process Items
Linking Files to Process Items
Promoting File Changes Into Baselines
View Compare/Merge (VCM)
View Compare/Merge Terminology
Full Change Package Rollback
VCM Commit with Full History
VCM Content Differences Display
VCM Process Item and Attached Revisions
VCM Skip Multiple Revisions
Access Rights Required for StarTeam View Compare/Merge Users
View Compare/Merge Session Perspectives
Compare Perspective
Merge Perspective
Test Perspective
Specifying the Initial Perspective for a View Compare/Merge Session
View Compare/Merge Session Filters
Lifecycle Scenarios in View Compare/Merge
Merge Types, Rules, and Scenarios
Rebase
Promote
Replicate
Tips for Successful Sessions
View Compare/Merge Actions
Conditions for Action Decisions
View Compare/Merge Table of Action Decisions
Understanding View Compare/Merge Difference Types
How View Compare/Merge Handles Target Folders with Floating Shares
View Compare/Merge Process
Preparing Your Files for a View Compare/Merge Session
Comparing and Merging Views
Resolving Merge Conflicts in View Compare/Merge
Changing View Compare/Merge Actions
Testing View Compare/Merge Changes
Viewing and Printing a View Compare/Merge Difference Report
Phases in the View Compare/Merge Process
View Compare/Merge Wizard
View Compare/Merge Wizard: Select Compare/Merge Type
View Compare/Merge Wizard: Include Items
View Compare/Merge Wizard: Include Selected Items
View Compare/Merge Wizard: Select Source View
View Compare/Merge Wizard: Select Target View
View Compare/Merge Wizard: Select Source Configuration
View Compare/Merge Wizard: Select Target Configuration
View Compare/Merge Wizard: Set Options
View Compare/Merge Wizard: Exclude Properties
Finding and Breaking Locks on Items with Differences
Breaking Locks Automatically When Starting a Session
Finding Locked Items with Differences
Breaking Existing Locks in a Session
Skipping a Revision in VCM
Fast (Optimized) Full Scope View Compare/Merge
Comparing a Source and Target File in View Compare/Merge
Comparing Selected Items in the Source and Target View
Comparing a Target File with the Proposed Merge Results
Scoping a Session with a Process Item in a Different View
Merging Changes Between Any Two Related Views (Replicate)
Merging Changes from a Child View to a Parent View (Promote)
Merging Changes from a Parent View to a Child View (Rebase)
Using Process Items to Merge Related Files
Resolving File Differences from a View Compare/Merge Session
Committing View Compare/Merge Change Session
View Compare/Merge Optimization
Exporting a View Compare/Merge Session
Opening a Saved or Exported View Compare/Merge Session
Restarting a View Compare/Merge Session
Viewing and Printing a View Compare/Merge Session Summary
Deleting a View Compare/Merge Session
Changing the Default Merge Type Options and Actions
Changing the View Compare/Merge Session Working Folder
Changing View Compare/Merge Perspectives
Cloning a New View Compare/Merge Merge Type From One Server Configuration to Another
Filtering Items in a View Compare/Merge Session
Using a Predefined Filter
Saving the Current Arrangement as a Filter
Running View Compare/Merge from the Command-line
Setting Locking Options for a View Compare/Merge Session
Versioning Object Properties
Change Packages in View Compare/Merge
Understanding Change Packages in View Compare/Merge
The Change Package Object
View Compare/Merge Sessions
Advantages of Change Packages
Change Package Access Rights
Creating a View Compare/Merge Change Package
Naming a Change Package
Saving a View Compare/Merge Session to a Change Package
Changing Access Rights for a Change Package
Deleting a Change Package
Disabling a Change within a Change Package
Editing a Change Package
Change Package Properties
Editing Change Package Properties
Linking Change Packages to Other Items
Opening a Change Package in a View Compare/Merge Session
Opening a Change Package in Read-Only Mode for Review
Replaying a Change Package to Another View
Using Filters and Queries in Change Packages
Viewing the Change Perspective
Viewing Change Package Details, History and Labels
Viewing Changes in a Change Package
Promotion States
Configuring Promotion States
Creating a New Promotion State
Editing or Deleting a Promotion State
Moving the Promotion State Up or Down
Modifying Access Rights of a Promotion State
Promoting View Labels
Promotion State Access Rights
Setting Promotion State Access Rights at the Project or View Level
Setting Access Rights for Individual Promotion States
Labels
View Labels
Creating Revision Labels
Creating View Labels
Configuring or Viewing Label Properties
Displaying View or Revision Label Properties for Editing
Displaying Folder Label Properties
Displaying Label Properties from the Label Pane
Attaching Labels to Folders
Creating a New Revision Label and Attaching it to a Folder and its Contents
Attaching an Existing View or Revision Label to a Folder and its Contents
Reviewing the Labels Attached to a Folder's Revisions
Moving a Revision Label from one Folder Revision to Another
Attaching Labels to Items
Creating a New Revision Label for Selected Items
Attaching an Existing View or Revision Label to Selected Items
Attaching an Existing View or Revision Label to a Specific Item Revision
Reviewing All Labels Attached to Item Revisions
Moving a Revision Label from One Item Revision to Another
Demoting View Labels
Promoting View Labels
Copying Revision Labels
Copying View Labels
Deleting Labels
Detaching a Label from a Rolled-back View
Detaching a Label from a Specific Revision
Detaching Labels from Folders
Detaching Labels from Items
Freezing or Unfreezing Labels
Reviewing and Moving Labels
Reviewing All Labels Attached to Item Revisions
Moving a Revision Label from One Item Revision to Another
Reviewing the Labels Attached to a Folder's Revisions
Moving a Revision Label from one Folder Revision to Another
Sorting Labels Alphabetically
Sorting Labels for Folders
Sorting Labels for Items
Branching
Branching Options
Branching Behavior of Items
Creating a Branching View
Effects on Change Requests When Branched, Moved, and Shared
Configuring a View to Display Non-Branched Files
Configuring the Branching Behavior of Shared Items
Reviewing or Changing Branching Behavior
Personal Options
Workspace Options
StarTeamMPX Options
File Options
Folder Options
Change Request Options
Requirements Options
Task Options
Topic Options
Sprint Options
Story Options
Custom Component Options (Personal Options Dialog Box)
Audit Log
Audit Log Events
Filtering Audit Log Entries
Searching for Log Entries
Sorting Audit Log Entries
Sending Log Entries Through E-mail
Audit Fields
Queries
Creating Queries
Creating "Me" Queries
Applying Queries
Applying an Existing Query to Items in the Upper Pane
Selecting Items in the Upper Pane that Match an Existing Query
Queries Options
New Query Options
Relational Operators Used in Queries
Copying Queries
Editing Queries
Deleting Queries
Predefined Queries
Individual Query Access Rights
Setting Access Rights for a Query
Filters
Creating Filters
Creating a New Filter
Creating a New Filter from the Current Arrangement
Applying Predefined Filters
Editing Filters
Copying Filters
Copying a Filter
Copying a Private Filter and Changing its Status
Changing a Private Filter to a Public Filter
Deleting Filters
Filtering Process Tasks From Other Tasks
Filtering StarTeam Agile Tasks From Other Tasks
Resetting Filters
Sorting and Grouping Data
Performing a Primary Sort on One Column
Performing Up to a Fourth-Order Sort
File Filters
Change Request Filters
Requirement Filters
Folder Filters
Task Filters
Topic Filters
Audit Filters
View Compare/Merge Session Filters
Individual Filter Access Rights
Setting Access Rights for a Filter
Exporting
Exporting Data
Export Dialog Box Options
Reports
Rich Reports
Creating a New Report Structure
Create the Data Source
Create the Data Set
Classic Reports
Creating Classic Reports
Customizing Fields in Classic Report Templates
Customizing Classic Report Templates
Printing ClassicReports
Configuring the Output Path for Classic Reports
Templates
Classic Reports for the Audit Component
Classic Reports for the Change Request Component
Classic Reports for the File Component
Classic Reports for the Folder Component
Classic Reports for the Requirement Component
Classic Reports for the Task Component
Classic Reports for the Topic Component
Charts
Choosing the Chart Type
Chart Types
File Chart Fields
Change Request Chart Fields
Requirement Chart Fields
Task Chart Fields
Topic Chart Fields
Audit Chart Fields
Configuring Chart Colors
Customizing Chart Titles
Exporting a Chart as an Image
Generating Correlation Charts
Generating Distribution Charts
Generating Simple Charts
Generating Time-series Charts
Working with Charts
Toggling a 3D and a 2D Chart
Zooming in on a Chart
Displaying the Chart Data on which the Table is Based
Displaying a Legend on a Chart
Displaying a Horizontal or Vertical Grid on a Chart
Default Chart Views and Zoom/Rotate Capabilities