Visual Studio Plugin

Visual Studio Plugin

Introduction

StarTeam Visual Studio Plugin Overview

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

Tour of the UI

StarTeam Visual Studio Plugin UI Overview

Embedded Client Overview

StarTeam Folders Pane

StarTeam Items Pane

StarTeam Visual Studio Plugin Embedded Client

StarTeam Visual Studio Plugin Check In Dialog Boxes

File Compare/Merge UI

Main File Compare/Merge

Standalone File Compare/Merge

StarTeam Toolbar

Accessing Projects and Items

StarTeam Basics

Artifacts Versus Items

Folders and Views

Change Requests

Change Request Tracking System Model

Built-in Workflow for Change Requests

Links: Internal and External

Branching, Merging and Dot Notation

Sharing and Cheap Copies

Promotion States

Audit Log

Audit Log Events

Table of Common Operations

Personal Options

Workspace Options

StarTeamMPX Options

Change Request Options

Requirements Options

Logging on to and off of a Server

Logging on to StarTeam in Microsoft Visual Studio and Starting a Project

Automatically Logon to StarTeam When a Solution Opens

Logging on to StarTeam Server and Creating or Opening a Project

Configuring Your Client

Connecting to a Server Configuration

Changing the Default Language and Locale

Changing Your Password

Auto Client Update

Configuring an Alternate Editor, Merge, or Comparison Utility

Configuring the Display Order of Component Tabs in the Client

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

Sample Folder Template

Sample File Template

Sample Change Request Template

Sample Task Template

Sample Topic Template

Sample Requirement Template

Sample Change Package Template

Visual Studio (.NET) Tasks

Adding Files (.NET only)

Adding Webprojects to StarTeam (.NET only)

Associating Server Configurations with Visual Studio Solutions (.NET Only)

Associating Shortcuts and Active Process Items to Files (.NET Only)

Checking In Files (.NET only)

Checking Out Files (.NET only)

Creating Log Files for Customer Support

Managing Non-relative Paths (.NET Only)

Managing Project Associations (.NET Only)

Moving Files (.NET only)

Placing Solutions or Projects (.NET Only)

Pulling Solutions or Projects (.NET Only)

Renaming and Deleting Local Files (.NET only)

Reverting Files (.NET only)

Selecting Out-of-view Process Items

Specifying Files to Check In (.NET)

Specifying Files to Check Out (.NET)

Updating and Committing Solutions and Projects (.NET only)

Updating a Solution or Project

Committing a Project

Viewing Historical Differences (.NET only)

Projects

Project Structure

How to Handle Cross-Project File Dependencies

Guidelines for Keeping Projects Autonomous

Cross-Project Activity Support

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

Configuring Projects to Use Alternate Property Editors

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)

Deleting Projects

Displaying Location References

Enabling Keyword Expansion

Establishing Process Rules for Projects

Requiring Exclusive Locks for Check-ins

Requiring Revision Comments

Saving Projects as Shortcuts

Viewing Connection Properties

Viewing or Modifying Project Properties

View Configuration and Management

Overview of Views

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

Change Management within a View

Creating and Configuring Views

View Configuration Options

View Type Options and Settings

Creating View Labels

Copying View Labels

Switching Views

Changing a View's Default and Alternate Working Folders

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

Folders and Items

Overview of Folders and Paths

Understanding Default and Alternate Working Folders

Granting Folder-Level Access Rights

Folder Access Rights

Child Folder Access Rights

Folder Properties

Adding Folders to Views

Adding a New Folder to a View

Adding Not-in-View Folders to a Project

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

Changing a View's Default and Alternate Working Folders

Changing Name or Description of Folders and Items

Configuring (Rolling Back) Folders and Items

Creating a Working Folder

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

Excluding Files from a Project

Hiding Folders and Files

Highlighting Items of Interest

Locking and Unlocking Items

Locking an Item Using the Menu

Locking an Item Using the Toolbar

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

Opening a Local Folder

Opening a Local Folder from a Folder Selection

Opening a Local Folder from a File Selected in StarTeam

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

Files

Check-in and Check-out Operations

Check-in and Check-out Overview

Achieving Consistent Check-ins and Check-outs

Pending Check-ins and Check-outs

Atomic Check-ins

Optimizing File Check-outs Over a Slow Connection

Checking In Files

Checking Out Files

Checking Out Historical Versions of Files

Editing Check-in Comments

Effects of Status on Check-ins and Check-outs

Adding Files to Projects

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

Opening and Editing Files

Changing the Default Editor

Selecting Linked Files

Setting File Storage Options

Setting File Status Storage for all Files

Setting File Status Storage for a Specific View

Setting the File Executable Bit for UNIX

Specifying Files to Check In or Out (.NET Only)

To Review and Work with Files Pending a Check-in

To Review and Work With Files Pending a Check-out

Viewing Previous File Revisions

Change Requests

Creating Change Requests

Specifying Change Request Summary Information

Specifying Change Request Descriptions

Specifying Change Request Solutions

Modifying Custom Options for Change Requests

Adding Change Request Comments

Assigning Change Requests

Closing Verified Change Requests

Moving Change Requests

Resolve Open Change Requests

Reviewing Linked Change Requests

Customizing Change Request Filters

Customizing Change Request Reports

Displaying Change Requests

Sorting and Grouping Change Requests

Showing Fields in a Change Request

Selecting Change Requests Using a Query

Verifying Resolved Change Requests

Viewing Unread Change Requests

Change Request Fields

Default and Required Change Request Fields

Change Request Properties

Requirements

Creating Requirements

Requirement Fields

Requirement Properties

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

Topics

Creating Topics

Working with Attachments

Responding to Topics or Responses

Marking Item Threads Read or Unread

Topic Properties

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

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

Links: Internal and External

Linking Items Internally or Externally

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

Checking Linked Files In and Out

Customizing Link Item Properties

Customizing Link Properties

External Link Access Rights

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

Branching

Branching Options

Branching Behavior of Items

Effects on Change Requests When Branched, Moved, and Shared

Configuring a View to Display Non-Branched Files

Configuring the Branching Behavior of Shared Items

Creating a Branching View

Reviewing or Changing Branching Behavior

References Overview

Understanding References

References Created by Branching Views

References Created by Manually Sharing Objects

References Created by Adding Items to Views

References Created by Moving Objects

Process Items and Process Rules

Process Items and Workspace Change Packages

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

Audit Log

Audit Log Events

Filtering Audit Log Entries

Searching for Log Entries

Sorting Audit Log Entries

Sending Log Entries Through E-mail

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

Resetting Filters

Sorting and Grouping Data

Performing a Primary Sort on One Column

Performing Up to a Fourth-Order Sort

Change Request Filters

Requirement Filters

Individual Filter Access Rights

Setting Access Rights for a Filter

Classic Reports

Creating Classic Reports

Customizing Fields in Classic Report Templates

Customizing Classic Report Templates

Printing ClassicReports

Configuring the Output Path for Classic Reports

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

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