Copyright: Copyright© 1992-1997, StarBase Corporation
Citation: Copyright© 1992-1997, StarBase Corporation. All rights reserved.


New... (item on StarTeam Workstation Project menu)
 New Project
See Also

 Dialog Box Options

Project name
(Required.) Type a name for your project using a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

Properties
Allows you to set project properties.

Working directory
(Required.) Type the path to the working directory or browse to locate the directory.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory. For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, StarTeam Workstation or Versions can create the directory for you.

Browse...
Click to browse for the name of the working directory.

Force default working directory
Select to require every user to store working files on his or her workstation in the working directory specified above. For example, if the default working directory is C:\COOL PROJECT, all users store the working copies of the files attached to the root subproject in the C:\COOL PROJECT directory on their individual workstations.
Clear to allow each user to select a working directory for the project's working files.

Configure subdirectories as subprojects
Select so that StarTeam Workstation or Versions automatically makes subprojects of all the specified directory’s subdirectories. For example, if the working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, StarTeam Workstation or Versions creates subprojects named COMPONENT1. Similarly subdirectories of COMPONENT1 becomes subprojects of COMPONENT1.
Clear to keep StarTeam Workstation or Versions from creating any subprojects at this time.

Force default working directory for subprojects
This check box is enabled only when you select Configure Subdirectories As Subprojects.
Select to require every user to store each subproject's working files on his or her workstation in the working directory specified by the default working directory and the path from it to the subdirectory. For example, if the default working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, all users store the working copies of the files in the COMPONENT1 subproject in the C:\COOL PROJECT\COMPONENT1 directory on their individual workstations.
Clear to allow each user to select a working directory for each subproject's working files.

Security
Select to require a password for the project and to reserve certain functions for administrators only. Clear to allow anyone to access the files in the project. (If you select Remote as the type of connection, security becomes checked automatically.)

Audit log
Select to generate audit entries about actions performed on the project, subprojects, files, and users. The entries appear in the audit log and audit trail.

Advanced...
Click to set more project properties.

Save new project using
Indicates how the team can connect to this project.

Local access (file server)	Click if the new project is only for local access.

Remote access (via StarTeam Server)	Click if the new project is to be accessed remotely using StarTeam Server.

File name (.stp)
(Required.) Type the name (with the extension .stp) for the project database file.

File path
If you are using local access to this project database file, type (or browse for) the path to that file. If a directory in the path does not exist, StarTeam Workstation or Versions can create it for you.
Put the project database file in a network location that is accessible to all team members or in a public directory on your local workstation.
StarTeam Workstation or Versions creates the project vault, which stores versions of files, in this same location.

Browse...
Click to browse for the path for the project database file.

StarTeam Server
Select a server description from this drop-down list box.

Servers...
Click to add a server description to the Server drop-down list box.


Defaults Tab for New Project
Description Tab for New Project
Commands Tab for New Project
Exclude Tab for New Project


Defaults tab (for project)
 Defaults tab
See Also

Use this property page to set or modify options for the project. You can override these default settings for individual files as you add them to the project or, later, by modifying their file properties.

 Property Page Options

Maximum versions
Set options for files based on their type of storage: delta or omega.

Delta (text)
Select the appropriate option button for text files using delta storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Omega (binary)
Select the appropriate option button for binary or text files using omega storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Time stamp working file with check-out time
Select to stamp working files with the time the version is copied to the working directory.
Clear so that working files retain the time stamp of the copied versions.
(The difference is whether the working file appears to be more recent than the copied version immediately or only after it has been updated.)

Use mail
Select to use a MAPI-compliant mail system from within StarTeam Workstation or Versions. For example, if you are logged on to e-mail, others are notified if you break their locks on files, add new topics for discussion in StarTeam Workstation, etc.

Keyword expansion
Select to use keywords in your text files. The keywords will be replaced with information stored by StarTeam Workstation or Versions. For example, $Author: JIsenbarger$ is replaced with the name of the user who checked in the version.

Use compression
Select to compress all the files stored in the vault.


New Project
Description Tab for New Project
Commands Tab for New Project
Exclude Tab for New Project


Description tab (for subproject)
 Description tab
See Also

Use the Description tab to create or modify the description for a subproject.

 Property Page Options

Description
(Optional.) Provide a description for the subproject using a maximum of 255 characters.


New Project
Defaults Tab for New Project
Commands Tab for New Project
Exclude Tab for New Project


Commands tab (for project or subproject)
 Commands tab
See Also

Use this property page to specify build command and test commands for a subproject.

 Property Page Options

Build command
Type or browse for a build command using a maximum of 1024 characters. For example, the command c:\online help\hcw nproduct would build a Windows help file named nproduct.hlp.

Browse...
Click to browse for a build command.

Test command
Type or browse for a test command using a maximum of 1024 characters.

Browse...
Click to browse for a test command.


New Project
Defaults Tab for New Project
Description Tab for New Project
Exclude Tab for New Project


Exclude tab (for project or subproject)
 Exclude tab
See Also

Use this property page to exclude certain types of files from the files list when using the Files Not In Project filter. For example, you may want to use source control for .rtf files, but not for .doc files, in a help subproject. Therefore, you exclude *.doc from the help subproject using this property page. Then, when you add files to the project using the Files Not In Project filter, .doc files never appear.

Exclude lists apply only to the specified subproject. Exclusions are not inherited by subprojects at lower levels in the project tree.

 Property Page Options

Use exclude list
Select to use or clear to stop using the exclude list.

Exclude list
A list of filenames (using wildcards, for example, *.doc) separated by semicolons or commas.


New Project
Defaults Tab for New Project
Description Tab for New Project
Commands Tab for New Project


 Technical support

If you have a question about StarTeam Workstation or Versions, you can:

1.	Consult the on-line help and written documentation.

2.	See the readme.wri file that came with StarTeam Workstation or Versions.

3.	Post a message to our CompuServe forum. Log on to CompuServe and type GO STARBASE, then visit the StarTeam message and library sections.

4.	Send an e-mail message to support@starbasecorp.com.

5.	Access our web site at http://www.starbasecorp.com and check for new support questions and answers.

If you can’t find the answer from any of these sources, or if you require information about product registration or replacement disks, call StarBase Technical Support Services at (714) 442-4460 between 9 A.M. and 5 P.M. Pacific time, Monday through Friday.

When you call StarBase Corporation Technical Support Services, please have the following information:

•	The version number of the software you are using.
(select Help š About)

•	The exact error message you received, if any.

•	A precise explanation of what you were doing when the error occurred.

•	The version of Windows you are using.
(Select Start · Settings · Control Panel. Then select the System icon. The version appears on the General property page.)

•	The type of hardware you are using.

•	The network operating system you are using, if any.

StarBase support services are subject to StarBase prices, terms, and conditions in place at the time the service is used.

For information about product upgrades and pricing, call StarBase Corporation at 1-888-STAR700 or (714) 442-4500 between 9 A.M. and 5 P.M. Pacific time, Monday through Friday.


 Provide Visual Basic Projects with Source Control

Using StarTeam Workstation and Versions provides you with more than just source control for your Visual Basic projects. For example, with StarTeam Workstation, you have defect tracking and threaded conversations. In addition, StarTeam Workstation and Versions can create an audit log that records users’ actions within the scope of the project.

With StarTeam Workstation or Versions you can:

•	Provide new or existing Visual Basic projects with source control.

•	Set source control options on your workstation that automate source control.

•	Use the Tools and Add-Ins menus check files in and out and so forth.


Source Code Control Options dialog
 Source Code Control Options

After adding a Visual Basic project to a StarTeam Workstation or Versions project, you can use this dialog box to control whether files are automatically added, retrieved, checked in, and/or removed from source control on your workstation.

To change source control options:

•	Select Add-Ins · StarTeam/Versions... · Options… from the menu bar.
The Source Code Control Options dialog box opens.

 Dialog Box Options

Get latest checked in versions of project files when opening a project?
From the drop-down list box, select one of the following:

•	Yes to get files as part of opening a Visual Basic project. These files are copied from the StarTeam or Versions project vault to your working directory as read-only files.

•	No to get the latest versions only after selecting the Get command from the Tools menu.

•	Ask (the default) to be prompted about getting the latest files as you open a Visual Basic project.

Check in files when closing the project?
From the drop-down list box, select one of the following:

•	Yes to check in files as part of closing a Visual Basic project. The current working files become new versions in the StarTeam or Versions project vault.

•	No to check in files only after selecting the Check In command from the Tools menu.

•	Ask (the default) to be prompted about checking in files as you close a Visual Basic project.

Add files to source code control when adding them to Visual Basic?
From the drop-down list box, select one of the following:

•	Yes to add files to StarTeam Workstation or Versions as they are added to a Visual Basic project that is under source control. These working files are copied to the StarTeam or Versions project vault as “first versions” and the working files become read-only.

•	No to add files to a StarTeam Workstation or Versions project only after selecting the Add Files to StarTeam/Versions… or Add Project to StarTeam/Versions… command from the Add-Ins menu.

•	Ask (the default) to be prompted about adding files to StarTeam Workstation or Versions as you add them to a Visual Basic project.

Remove files from source code control when deleting them from Visual Basic?
From the drop-down list box, select one of the following:

•	Yes to remove files from StarTeam Workstation or Versions as you delete them from a Visual Basic project. All the versions of these files are deleted from the project vault and most of the information about them is deleted from the project database file (.stp).

•	No to remove files from source control only from within StarTeam Workstation or Versions.

•	Ask (the default) to be prompted about removing files from StarTeam Workstation or Versions as you delete them from a Visual Basic project.


 Add this project to source code control?

Use this dialog box to decide whether to add this project to StarTeam Workstation or Versions.

In most cases, click Yes to keep the Visual Basic and source code control files synchronized. You may want to click No if you are experimenting with a file that you may add at a later date, or a file that you do not want to add.

 Dialog Box Options

Yes
Click to add this Visual Basic project and its files to StarTeam Workstation or Versions. This keeps the Visual Basic and source control projects synchronized.

No
Click to avoid adding this Visual Basic project and its files to StarTeam Workstation or Versions.


 Undo Check Out from StarTeam/Versions

Use this dialog box to recopy the latest checked-in versions of the selected files to your working directory. They are checked out and ready for editing. This overwrites any changes you made to those files after you checked them out the first time and lets you start over.

To undo a check out:

•	Select Tools · Undo Check Out from the Visual Basic menu bar.

 Dialog Box Options

Files to un-check out
Lists the currently checked out files. Check the boxes in front of the files to be overwritten or click Select All to select all the files.

Select All
Click to select all the files in the list.


 Get from StarTeam/Versions

Use this dialog box to copy the latest versions of the selected files from the StarTeam Workstation or Versions project vault to your working directory. These files are read-only files. You get files to review them, not to edit them. If you decide to edit a file, you must check it out.

To get read-only versions of files:

•	Select Tools · Get from the Visual Basic menu bar.

 Dialog Box Options

Files to Get
Lists the files currently under source control in this Visual Basic project. Check the boxes in front of the files to be copied to your workstation or click Select All to select all the files.

Select All
Click to select all the files in the list.


Check In File(s) from StarTeam/Versions
 Check In File(s) to StarTeam/Versions

Use this dialog box to create new versions of the files selected from your working directory. The new versions are stored in the StarTeam Workstation or Versions project vault.

To create new versions of files:

•	Select Tools · Check In from the Visual Basic menu bar.

 Dialog Box Options

Files to be Checked In
Lists the files currently under source control in this Visual Basic project that have been checked out by you and edited. Check the boxes in front of the files to be checked in or click Select All to select all the files.

Comment
Type an optional comment. Usually, you explain the changes you made.

Keep Checked Out
Select this check box to keeps the files checked out to you. Clear it to make the files read-only now that you are through with them.

Select All
Click to select all the files in the list.


 Check Out File(s) from StarTeam/Versions

Use this dialog box to check out files from the StarTeam Workstation or Versions project vault. Editable copies of the latest versions of the selected files go your working directory.

To check out files for editing:

•	Select Tools · Check Out from the Visual Basic menu bar.

 Dialog Box Options

Files to be Checked In
Lists the files currently under source control in this Visual Basic project you can check out and edit. Check the boxes in front of the files to be checked out or click Select All to select all the files.

Comment
Comments entered into this text box are ignored in the current implementation.

Select All
Click to select all the files in the list.


 Add to StarTeam/Versions

Use this dialog box to put files under source control by adding them to a StarTeam Workstation or Versions project.

To put files under source control:

•	Select Add-Ins · StarTeam/Versions... · Add Project to StarTeam/Versions from the menu bar.
After selecting a StarTeam or Versions project file, you see the Add to StarTeam/Versions dialog box.

 Dialog Box Options

Files to be added
Lists the files in the project that is being added to source control. Check the boxes in front of the files to be added or click Select All to select all the files.

Comment
Type an optional comment. This will be used as the file’s description in the project.

Select All
Click to select all the files in the list.


 Would you like to check in all changed files now?

If you have Ask as the setting for the source control option about checking in files as you close the project, you can use this dialog box to check in or defer checking in the files you have checked out and changed.

 Dialog Box Options

Yes
Click to check in all files.

No
Click to defer check in until a later time.


Would you like to save your files before proceeding with this StarTeam/Versions operation?
 Would you like to save your files before proceeding with the StarTeam/Versions operation?

If you have not saved all the files in a Visual Basic project, Visual Basic can save them for you.

 Dialog Box Options

Yes
Click to save all unsaved files.

No
Click to avoid saving all the unsaved files.


 Would you like to add file <filename> to the current source code control project?

If you have Ask as the setting for the source control option about adding files, you can use this dialog box to add a file (or decline to add a file) to the StarTeam or Versions project at the same time that you add it to the Visual Basic project.

 Dialog Box Options

Yes
Click to place the file under source control.

No
Click to keep the file separate from source control.


Would you like to get the latest check in copy of the files in this project?
 Would you like to get the latest checked in copy of the files in this project?

If you have Ask as the setting for the source control option about getting files, you can use this dialog box to get updated read-only copies of files (or decline to get them) from the StarTeam or Versions project as you open the Visual Basic project to which they belong.

 Dialog Box Options

Yes
Click to get updated read-only copies of the files.

No
Click to keep the files currently in your working directory.


Would you like to remove file <filename> to the current source code control project?
 Would you like to remove the file from source code control?

If you have Ask as the setting for the source control option about removing files, you can use this dialog box to remove a file from the StarTeam or Versions project as you remove it the Visual Basic project to which it belongs.

 Dialog Box Options

Yes
Click to remove the file from source control.

No
Click to keep the file under source control.


 Select a Source Code Control Project

Use this dialog box to indicate whether you are adding the current Visual Basic project to a new or existing StarTeam or Versions project.

 Dialog Box Options

Open
Click to add the files from this Visual Basic project to an existing StarTeam/Versions project.

New
Click to add the files from this Visual Basic project to a new StarTeam/Versions project.

&&&currently no help button


Show Differences
 Show Differences…

Use this command to compare a working file with the most recently checked in version of it. This command starts the Visual Diff application that comes with StarTeam Workstation and Versions.

To compare the working file with the most recent version:

•	Select Add-Ins · StarTeam/Versions... · Show Differences… from the menu bar.


 Add Files to StarTeam/Versions…

Use this command to add files to the StarTeam or Versions project that stores the source code information for the current Visual Basic project. The command is available only when files in the Visual Basic project are not yet under source control.

To add files to a StarTeam or Versions project:

•	Select Add-Ins · StarTeam/Versions... · Add Files to StarTeam/Versions… from the menu bar.


Run StarTeam/Versions
 Open New StarTeam/Versions Project

Use this command to copy the project’s files to your workstation the first time you access an existing VB project that is under StarTeam Workstation or Versions source control.

To copy the project’s files as working files on your workstation:

•	Select Add-Ins · StarTeam/Versions... · Open New StarTeam/Versions Project from the menu bar.


 Run StarTeam/Versions

Use this command to start StarTeam Workstation or Versions and use the StarTeam or Versions project that stores the source control information about the current Visual Basic project.

To start StarTeam Workstation or Versions:

•	Select Add-Ins · StarTeam/Versions... · Run StarTeam/Versions from the menu bar.


 Options…

Use this command to set source control options to automatically get, add, check in, and remove files from source control while you are performing Visual Basic functions such as opening and closing projects or adding and deleting files.

To set source control options:

•	Select Add-Ins · StarTeam/Versions... · Options… from the menu bar.
The Source Code Control Options dialog box opens.


 Refresh File Status

Use this command to update file status so you can tell what needs to be checked in and so forth.

To refresh file status:

•	Select Add-Ins · StarTeam/Versions... · Refresh File Status from the menu bar.


Add Projects to StarTeam/Versions…
 Add Project to StarTeam/Versions…

Use this command to add the current Visual Basic project to source control (using either a new or existing StarTeam Workstation or Versions project). This command is available only when you select a project not already under source code control.  Each selected file is automatically added at this time.

To add a Visual Basic project to source control:

•	Select Add-Ins · StarTeam/Versions... · Add Project to StarTeam/Versions… from the menu bar.


 No additional Help is available on this item.
See Also

If the cause of the problem is not clear from the message, please call Technical Support for more assistance.


Technical Support


Unable to add this project to source code control.
 Unable to add the new project to source code control.

This error has the following causes:

•	You are not authorized to add to this StarTeam Workstation or Versions project.

•	You clicked Cancel during the add process.

Ask your StarTeam or Versions administrator to increase your rights and try again, or add the Visual Basic project to a different StarTeam or Versions project.


 Your project file has not been saved.

Your project file has not been saved. Save your Visual Basic project file to disk before you try source code control operations.

This error has the following cause and solution:

•	You must save your project file to disk because it is currently only in memory. StarTeam Workstation and Versions need a true file to work with.


 All available files have already been checked out.

This error has the following cause:

•	You attempted to check out a file for this Visual Basic project, but all the files under source control are already checked out.


 Add Files command failed: The files were not added to source code control.

This error has the following solution:

•	Run StarTeam Workstation or Versions and manually add the files to the project.


 138093

Error trying to connect source code control project to the current Visual Basic project.


 138098

The project no longer exists in StarTeam/Versions. You must either recover or re-create the project before you can use this project with source code control.


 Providing Source Control for a Visual Basic Project

You can provide source control for a Visual Basic project by:

•	Installing the integration components shipped to you with StarTeam Workstation or Versions. See the installation information in the StarBase user’s guide for IDE integrations.

•	Setting up Visual Basic to use a source control provider

•	Adding the Visual Basic project to an existing StarTeam or Versions project or by creating a new StarTeam or Versions project for it.

To set up Visual Basic to use a source control provider::

1.	Start Visual Basic.

2.	Select Add-Ins · Add-In Manager….
The Add-Ins Manager dialog opens.

3.	Select SccAddIn.SourceCodeAddIn.
A check mark appears in front of your selection.

To add an existing Visual Basic project that is not under source control to a StarTeam or Versions project:

1.	Start Visual Basic.

2.	Select File · Open Project... from the menu bar.
Depending on your source control options, you might see the message:
 “Add this project to Source Code Control?”

3.	If so, click Yes.
If not, select Add-Ins · StarTeam/Versions · Add Project to StarTeam/Versions….
The Select A Source Code Control Project dialog opens.

4.	Click Open to use an existing StarTeam or Versions project
Or,
Click New to create a new StarTeam or Versions project

To create a new Visual Basic project to add to a StarTeam or Versions project:

1.	Start Visual Basic.

2.	Select File · New Project... from the menu bar.

3.	Select File · Save Project... from the menu bar.
After you save the project, you see the message:
“Add this project to Source Code Control?”

4.	Click Yes.
The Select A Source Code Control Project dialog appears.

5.	Click Open to use an existing StarTeam or Versions project
Or,
Click New to create a new StarTeam or Versions project


 Using an Existing StarTeam or Versions Project

To use an existing StarTeam Workstation or Versions project:

1.	From the Select A Source Code Control Project dialog, click Open.
If you are using StarTeam Workstation, the Client Server Or Local StarTeam Project dialog opens.

2.	Click the Local StarTeam Project or the Remote StarTeam Server Project option button then click OK.
StarTeam Workstation projects can be access locally (in file server mode) or remotely (in client/server mode) using StarTeam Server. Versions projects can be accessed only locally.

3.	Select the existing StarTeam Workstation/Versions .stp file (using the Select a Versions Project File dialog) or the remote project name (using the Open Remote Project dialog box).
The Log On dialog opens.

4.	Type your User Name and Password in the appropriate text boxes then click OK.
The Add to StarTeam/Versions dialog opens.

5.	Clear the check boxes for any files not to be added.

6.	In the Comment text box, type an optional comment about the files.

7.	Click OK.


 Creating a New StarTeam or Versions Project

The steps for remote projects do not apply to Versions projects.

To create a new StarTeam Workstation or Versions project:

1.	From the Select A Source Code Control Project dialog, click New.
The New Project dialog opens.

2.	Type a name for the project in the Project Name text box. The project name should reflect the nature of the project.
Use a maximum of 228 characters. Do not use forward slashes (/), backward slashes (\), or exclamation points (!).
(The Project Name defaults to the Visual Basic project name.)

NOTE:	The StarTeam Workstation or Versions subproject must have the Visual Basic project’s location as its working directory. Therefore, the Default Working Directory text box is disabled.

3.	Select the Force Default Working Directory check box to require all users to use the root subproject’s default working directory for working files on their workstations.
Clear this box to allow users to specify their own working directories for these files.

4.	Select the Configure Subdirectories As Subprojects check box so that all subdirectories of the project’s working directory become the default working directories of subprojects. The names of the subdirectories become the names of the subprojects.
Clear this box to create no subprojects at this time.

5.	The Force Default Working Directory For Subprojects check box is enabled only when you select Configure Subdirectories As Subprojects. Select this box to require all users to use each subproject’s default working directory for working files on their workstations.
Clear this box to allow users to specify their own working directories for these subprojects.

6.	The Security check box is selected by default, requiring passwords to log on to the project and security privileges to perform certain actions. Clear it to allow anyone complete access to the project. (Projects created remotely always use security.)

7.	The Audit Log check box is selected by default so that all actions performed on the project will be logged. Clear it to disable logging events.

8	If you have StarTeam Server and plan to access this project remotely (for example, over a WAN), select the Remote Access (via StarTeam Server) option button. (Security becomes selected automatically.)
For the file server access provided by StarTeam Workstation and Versions, select the Local Access (File Server) option button.

9.	Type name of the project database file in the File Name text box. By default, the file name has the extension .stp.

10.	If you are using local access, type the path to the directory where you will store the project database file. StarTeam Workstation and Versions also store the project vault there.
Or,
Click Browse... to simplify this process.
Usually the project database file is on a network drive in a location that is accessible to all team members.

11.	If you are creating this project remotely, select a server from the Server drop-down list box.
If you need to define the server:

a.	Click Servers....
The Remote Servers dialog opens.

b.	Click New....
The Remote Server dialog opens.

c.	Type a description in the Server Description text box.
This is a unique descriptive name for the server. It is case-insensitive and cannot contain colons (:).

d.	Type the address in the Server Address text box.
For example, COM_SVR may be the address for a server using the named pipe or NetBIOS Over NetBEUI protocols, and 204.30.36.5 may be the address for a server using TCP/IP. If you have a Domain Name System (DNS) server appropriately configured, you can use its name for the TCP/IP address.

e.	Type the endpoint in the Endpoint text box.

f.	Select the correct protocol from the Protocol drop-down list box.

12.	Click Advanced... to set additional options.
The Advanced Projects Settings dialog opens.
Use it to specify:

•	Defaults for the project and for project files

•	Build and test commands

•	Files never to be added to the root subproject

•	A project description

13.	Click OK.
The New User dialog opens.

To finish creating a project that will be accessed locally:

1.	In the User Name text box, type the name you will use to log on to this project or the name Administrator (to create a first user that can be used by anyone performing administrative functions).
Select this name carefully, because it cannot be changed. (Usually people use their network logon name.)

2.	In the Full Name text box, type your e-mail name if you are using e-mail within StarTeam Workstation or Versions.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the StarTeam project. If this occurs, create a new Exchange profile with the same name as your StarTeam full name.

3.	If you enabled project security, you must also type and confirm a password.
Passwords are case-sensitive and must contain at least six characters.

4.	Click OK again.
The Add to StarTeam/Versions dialog opens.

5.	Clear the check boxes for any files not to be added.

6.	In the Comment text box, type an optional comment about the files.

7.	Click OK.

To finish creating a project that will be accessed remotely:

1.	If StarTeam Server is running, the New User dialog opens. (Otherwise, you see an error message.)

2.	Type the word Administrator in the User Name text box.
This is the predefined administrator name for StarTeam Server.

NOTE:	If this is the first user of a remote StarTeam Server project, the user name must be “Administrator” and the password must match that of the StarTeam Server.

3.	Type anything in the Full Name text box.

4.	Type and confirm the password defined in StarTeam Server. (The default is “password.”)
The default password is the word password (all lowercase). Passwords are case-sensitive.

5.	Click OK again.
The Add to StarTeam/Versions dialog opens.

6.	Clear the check boxes for any files not to be added.

7.	In the Comment text box, type an optional comment about the files.

8.	Click OK.


 Specifying Defaults

Use the defaults tab to specify defaults such as the maximum number of non-permanent versions to be stored for each type of file.

To specify defaults:

1.	Select the Defaults tab.
The Defaults property page opens.
StarTeam Workstation and Versions store a maximum of 32767 versions of files using either delta storage or omega storage.

2.	Select the Maximum or Limited option button for one of the storage types.

3.	If you selected Limited, type a number of versions in the Limited text box.

4.	Repeat steps 2 and 3 for the other type of storage, if applicable.

5.	To stamp working files with the time the version is copied to the working directory, select Time Stamp Working File With Check-Out Time.
Clear this box to copy the time stamp of the version along with the version.

6.	Select the Use Mail check box to use a MAPI-compliant mail system from StarTeam Workstation or Versions. For example, if you are logged on to e-mail, others are notified if you break their locks on files, add new topics for discussion in StarTeam Workstation, etc.

7.	Select the Keyword Expansion check box to use keywords in your text files. The keywords will be replaced with information stored by StarTeam Workstation or Versions. For example, $Author: JIsenbarger$ is replaced with the name of the user who checked in the version.

8.	Select the Use Compression check box to compress all the files stored in the vault.


 Specifying Build and Test Commands

To specify build and test commands:

1.	Select the Commands tab.

2.	Type the path to the command executable or batch file in the Build Command and/or Test Command text box.
Or,
Click Browse to locate the executable or batch file within your system environment and enter its name into the text box automatically.


 Excluding Certain Files from the Root Subproject

To exclude certain files:

1	Select the Exclude tab.

2	Select the Use Exclude List check box.

3	Type the file specifications in the Exclude List text box. Separate the specifications with semicolons or commas. For example, use “*.obj, *.bak” and StarTeam Workstation and Versions ignore all the *.obj and *.bak files in the working directory. They never appear in the list of files that are not in the project.


 Providing a Project Description

To provide a description:

1.	Select the Description tab.

2.	Type a project description of up to 255 characters.


 Adding Visual Basic Files to Source Control
See Also

You place Visual Basic files under source control by adding them to a StarTeam or Versions project. You add files:

•	As you add the Visual Basic project to a StarTeam or Versions project

•	Manually from StarTeam Workstation or Versions (see the application’s online help for details)

•	Automatically as you add each file to the Visual Basic project (if the Add Files To Source Control When Adding Them To Visual Basic option is set to Yes or Ask)

•	From the menu bar by selecting Add-Ins · StarTeam/Versions · Add Files To StarTeam/Versions…


Providing Source Control for a Visual Basic Project

Adding Visual Basic Files to Source Control Automatically

Adding Visual Basic Files to Source Control Via Menu Commands


 Adding Visual Basic Files to Source Control Automatically

To add Visual Basic files to StarTeam or Versions projects automatically, you must set the source control option that controls that functionality.

To set up the automatic source control of files:

1.	Select Add-Ins · StarTeam/Versions… · Options….
The Source Code Control Options dialog box opens.

2.	Select Yes or Ask from the Add Files To Source Control When Adding Them To Visual Basic drop-down list box.

To add files to a StarTeam or Versions project automatically:

1.	Select Add File… from the File menu or the project window’s context menu.
The Add File dialog opens.

2.	Select the file to be added then click Open.

3.	(Optional) If the Add Files options is set to Ask or Yes, you see the message:
“Would you like to add file <filename> to the current source code control project?”
Click Yes.
The Add To StarTeam/Versions dialog opens.

4.	Click OK to add the selected file to the StarTeam or Versions project to which the Visual Basic project belongs.

Or,

1.	Select Save… or Save As… from the File menu or the project window’s context menu.

2.	(Optional) If the Add Files options is set to Ask or Yes, you see the message:
“Would you like to add file <filename> to the current source code control project?”
Click Yes.
The Add To StarTeam/Versions dialog opens.

3.	Click OK to add the selected file to the StarTeam or Versions project to which the Visual Basic project belongs.


 Getting Initial Copies of Project Files

The first time you access an existing VB project that is under StarTeam Workstation or Versions source control, you need to copy the project’s files to your workstation.

To copy project files to your workstation:

1.	Select Add-Ins · StarTeam/Versions · Open New StarTeam/Versions Project from the menu bar.

If you are using StarTeam Workstation, the Client Server Or Local StarTeam Workstation project dialog opens.

2.	Click the Local StarTeam Project or the Remote StarTeam Server Project option button then click OK.

StarTeam projects can be accessed locally (in file server mode) or remotely (in client/server mode) using StarTeam Server. Versions projects can be accessed only locally.

3.	Select the existing StarTeam Workstation or Versions .stp file or the remote project name and click OK.

The Log On dialog opens.

4.	Type and confirm your password.

NOTE:	Contact the project administrator for your password.

The Visual Basic project opens and you can either Get or Check Out files.


 Adding Visual Basic Files to Source Control Via Menu Commands

As long at the Visual Basic project is under source control, you can add its files to a StarTeam or Versions project at any time from the menu bar.

To add files to a StarTeam or Versions project:

1.	Select Add-Ins · StarTeam/Versions... · Add Files to StarTeam/Versions… from the menu bar.
The Add To StarTeam/Versions dialog box lists the files that are not yet under source control.

2.	Select or clear check boxes if appropriate then click OK.


 Checking In Visual Basic Files
See Also

You can check in Visual Basic files to a StarTeam or Versions project:

•	Manually from StarTeam Workstation or Versions (see the application’s online help for details)

•	Automatically as you close the Visual Basic project (if the Check In Files When Closing Project option is set to Yes or Ask)

•	From the menu bar by selecting Tools · Check In

•	From the project window’s context menu by selecting Check In


Checking In Visual Basic Files to Source Control Automatically

Checking In Visual Basic Files to Source Control Via Menu Commands


 Checking In Visual Basic Files Automatically

To check in Visual Basic files to StarTeam or Versions projects automatically, you must set the source control option that control that functionality.

To set up the automatic source control of files:

1.	Select Add-Ins · StarTeam/Versions… · Options….
The Source Code Control Options dialog box opens.

2.	Select Yes or Ask from the Check In Files When Closing Project drop-down list box.

To check in files to a StarTeam or Versions project automatically:

1.	Select File · New Project…, File · Open Project…, or File · Exit from the menu bar.
You might see a number of dialogs depending on the state of the project you are exiting.

2.	(Optional) If the Check In Files When Closing Project option is set to Ask, you see the message:
“Would you like to check in all changed files now?”
Click Yes.
The Check In File(s) To StarTeam/Versions dialog lists the files that have been changed.

3.	Select the check boxes in front of the files to be checked in. Clear them to prevent them from being checked in. Click OK to add the new version of the selected files to the StarTeam or Versions project.


 Checking In Visual Basic Files Via Menu Commands

As long at the Visual Basic project is under source control and you have checked out its files, you can check those files back in to a StarTeam or Versions project at any time from the menu bar.

To check in files to a StarTeam or Versions project:

1.	Select Check In from the Tools menu or the project window’s context menu.
 The Check In File(s) to StarTeam/Versions dialog box lists the files that have been changed..

2.	Select or clear check boxes if appropriate then click OK.


Checking In Visual Basic Files
 Getting Read-only Versions of Files
See Also

You can get read-only copies of the latest versions of the files in a Visual Basic project:

•	Manually from StarTeam Workstation or Versions (see the application’s online help for details)

•	Automatically as you open the Visual Basic project (if the Get Latest Checked In Versions Of Project Files When Opening A Project options is set to Yes or Ask)

•	From the menu bar by selecting Tools · Get


Getting The Latest Versions Automatically

Getting The Latest Versions Via Menu Commands


 Getting the Latest Version Automatically

To get read-only copies of the latest checked in versions of files automatically, you must set the source control option that control that functionality.

To set up the automatic source control of files:

1.	Select Add-Ins · StarTeam/Versions… · Options….
The Source Code Control Options dialog box opens.

2.	Select Yes or Ask from the Get Latest Checked In Versions Of Project Files When Opening A Project drop-down list box.

To get read-only copies of the latest checked in versions automatically:

1.	Select File · Open Project… from the menu bar.
The Open Project dialog opens.

2.	Select the project to be opened then click Open.
The Log On dialog opens.

3.	Log on to the project.

4.	(Optional) If the Get Files option is set to Ask, you see the message:
“Would you like to get the latest checked in copy of the files in this project?”
Click Yes..


 Getting Read-only Versions of Files Via Menu Commands

As long at the Visual Basic project is under source control, you can get read-only copies of the latest file versions from a StarTeam or Versions project using the menu bar.

To get read-only copies of files:

1.	Select Tools · Get from the menu bar.
The Get From StarTeam/Versions dialog box lists the files that have checked in versions.

2.	Select or clear check boxes if appropriate then click OK.


 Checking Out Visual Basic Files
See Also

You can check out an editable copy of the most recent version of a Visual Basic file:

•	Manually from StarTeam Workstation or Versions (see the application’s online help for details)

•	From the menu bar by selecting Tools · Check Out

•	From the project window’s context menu by selecting Check Out

To check out files:

1.	Select Check Out from the Tools menu or the project window’s context menu.
The Check Out File(s) From StarTeam/Versions dialog box lists the files that can be checked out.
For example, only user can checked out a particular file at a time.

2.	Select or clear check boxes if appropriate then click OK.


Undoing a Check Out


 Undoing a Check Out

If you are unhappy with the edits you have made to a checked out file, you can revert to the latest checked in version.

To lose all the edits made since you checked out (or last checked in)a file:

1.	Select Tools · Undo Check Out from the menu bar.
The Undo Check Out From StarTeam/Versions dialog box lists the files which have checked out.

2.	Select or clear check boxes if appropriate then click OK.


 Comparing a Working Text File with its Latest Version

You can compare the working copy of a text file with its latest checked in version using StarBase’s Visual Diff application. For example, you might want to review the changes you made to the working file.

To compare the working file with the most recent version:

•	Select Add-Ins · StarTeam/Versions... · Show Differences… from the menu bar.
The Visual Diff main window opens.


 Starting StarTeam Workstation or Versions from Visual Basic

You can start StarTeam Workstation or Versions from Visual Basic. For example, you might want to review the audit log for the project.

To start StarTeam Workstation or Versions:

•	Select Add-Ins · StarTeam/Versions... · Run StarTeam/Versions from the menu bar.
The StarTeam Workstation or Versions main window displays the current project.


 Refreshing File Status

To update the source control status of your working files:

•	Select Add-Ins · StarTeam/Versions... · Refresh File Status from the menu bar.


 add files

The process of placing files under version control by adding them to a StarTeam or Versions project.


 administrator

A functional role in the operation of Versions. To become a project administrator, you must be the first user created for the project, import the project, or have another administrator change your user properties to designate you as an administrator.
When project security is enabled, only project administrators can create or branch subprojects, change project properties, break locks, manage team member information, modify the number of versions for a file, and so forth.


 audit log

A chronological record kept by StarTeam Workstation showing all actions performed on StarTeam projects, subprojects, files, defects, topics, and users.


 audit trail

A chronological record kept by StarTeam Workstation showing all actions performed on a project, subproject, file, defect, or user. A tab for a project, or subproject, file, defect, or user's properties.


 binary file

Any file that is not strictly an ASCII text file. Binary files contain programs or data in machine code. Examples of binary files and their respective file name extensions are executables (.exe), resources (.res), word processing documents (.doc in Word for Windows), spreadsheets (.xls in Excel), object files (.obj) and bitmaps (.bmp).


 build

The process of compiling, assembling, and linking all project files in proper sequence to produce the project’s product. StarTeam Workstation or Versions uses the build command provided as a project or subproject property to create the build.
Also an event in the life cycle of a product chosen to represent a quantifiable step in progress for a project. For example, a software product may deliver a new build every few days to the team members who test the product. Designating a build creates a set of non-permanent versions at the project level. Each version of a file in the build uses the name of the build as its label. When project security is enabled, only an administrator can designate a build. A build cannot be designated at the subproject level.


 build command

A command that you specify so that StarTeam Workstation or Versions can, with a single operation, compile, assemble, and link all project files in proper sequence to produce the project or subproject's product.


 build label

The name or number given to a specific build. StarTeam Workstation or Versions stores the build label in the version of each file in the project that was built.


check in
 check-in

The operation performed on a file that has undergone revision that stores the new file version in the StarTeam or Versions project vault.
StarTeam Workstation or Versions permits a number of individuals to work on a common set of files by allowing only one team member to revise a project file at a time. Check-in marks the end of one revision. The team member who checks in the file can keep it locked or release the file to others by unlocking it.


check out
 check-out

The operation that copies a version of a file from the StarTeam or Versions project vault to a team member’s working directory. A team member can check out a file with or without the intention to alter that file. StarTeam Workstation or Versions permits a number of individuals to work on a common set of files by allowing only one team member to revise a project file at a time. Locking the file marks the beginning of one author's revision.


delta
 delta storage

A method of computing differences between progressive versions of a file.

StarTeam Workstation or Versions implements reverse deltas for text files, which means that only the latest version of the file is saved in its entirety. Delta storage reduces the disk space necessary to store the version information of a file by comparing new and previous versions of the file and storing only the differences.


 e-mail

An organized system for delivery of paperless, "electronic" messages, named for its similarities to the postal mail system. StarTeam Workstation or Versions provides advantages (such as mailing files, defect information, and announcements of new topics and responses) for teams that use a MAPI-compliant e-mail system.


 endpoint

A unique identifier for a server, based on the protocol being used. The endpoint is a port number for TCP/IP and NetBIOS Over NetBEUI protocols. It is the name of the pipe for a Named Pipe.
Valid ranges are:
NetBEUI over NETBIOS:  Number from 1 to 255.
TCP/IP:  Number from 1024 to 65535.
Named Pipes:  String containing 1 to 32 character. It can have embedded spaces.


 file compression

A technique for reducing the size of a file by removing redundant information from it. Most disk files contain repetitions of common sequences of characters. Compression algorithms remove the additional occurrences of these sequences and save information that permits their restoration. By selecting compression of files, you may reduce vault space requirements as well as improve performance.


 files list

The list of files for the StarTeam or Versions subproject.


 keyword

Reserved words beginning and ending with a dollar sign ($). When used in a text file, StarTeam Workstation replaces them with the data that they represent. For example $Author: JIsenbarger$ is replaced by the name of the user who checked in the file.

 Related Topics


 keyword expansion

A technique used to insert information in a text file in which keywords are replaced by the data they represent. For example $Author: JIsenbarger$ is replaced by the name of the user who checked in the file.


local
 local access

Using file server mode to access a StarTeam or Versions project database.

 Related Topics


 local project

A project that is accessed locally using Project · Open....

 Related Topics


 lock

The process of making others aware of the fact that you are revising a file. Others can check out a file you have locked, but they cannot check it in unless they break your lock. When project security is enabled, only an administrator can break your lock.
Optionally, team members can have unlocked files marked read-only, which prevents them from making any changes to files that may be locked by others.
A file must be locked before you can check it in, delete it or one of its versions, change its number of maximum non-permanent versions, purge its non-permanent versions, or change a version from non-permanent to permanent or vice versa. When security is enabled, you must be an administrator (and lock the file) to perform any of the above except check-in.


 MAPI

Acronym for Mail Application Programming Interface. A programming interface that permits an application to send and receive electronic mail via the Microsoft Mail messaging system or any other MAPI-compliant system.


 NetBIOS over NetBEUI

A common network protocol for PC LANs that provides session and transfer services. NetBEUI is an acronym for NetBIOS Extended User Interface and provides a standardized transport frame for NetBIOS.


non-permanent version
 non-permanent (also temporary or interim)

A designation applied to any version of a file included in a StarTeam or Versions project that has not been defined as permanent. The oldest non-permanent version is automatically deleted when the maximum number of versions is exceeded.

To purge a file of its non-permanent versions, change the status of a file version from non-permanent to permanent, or change the maximum number of non-permanent versions to be stored, the file must be locked. When project security is enabled, only an administrator can perform these operations.


omega
 omega storage

A method of file version storage in which all versions of a file are saved in their entirety. Omega storage eliminates the long processing times necessary to reconstruct complex binary files stored in delta or reverse delta format and can actually consume less disk space than other storage methods used on binary files.

StarTeam Workstation or Versions stores all binary files in omega format. You can also store text files in omega format. This is a time and often a space-saving decision for large, rapidly changing text files such as Windows help files (.rtf).


permanent version
 permanent

A designation applied to a specific version of a file included in a StarTeam or Versions project. Making a version permanent prevents StarTeam Workstation or Versions from deleting it from the project vault when the maximum number of non-permanent versions has been reached or when the file is purged. Permanent file versions can only be deleted using History · Delete.
To delete a version, or to change its status from permanent to non-permanent (or vice versa), the file containing that version must be locked. When project security is enabled, only an administrator can perform these actions.


 project

A set of related files, defects, and topics comprising a single product under StarTeam Workstation or Versions version control.


 protocol

A set of rules governing how something is done.


 project database file

Also referred to as the project file. The database file, designated during the creation of a project, that stores project information. By default, it ends with an .stp extension. See also (but do not confuse with) project file.


 project file

A file under version control; therefore, a file that is in a StarTeam or Versions project. See also (but do not confuse with) project database file.


remote
 remote access

Using StarTeam Server to access a project. This is usually over a WAN using direct dial up or the Internet.

 Related Topics


 remote project

A project that is accessed remotely using Project · Open Remote....

 Related Topics


remove (from version control)
 remove from version control

To delete all information about a file or subproject from the project database file (.stp) and the vault. To remove a file, the file must be locked. When project security is enabled, only an administrator can perform either of these operations.


 server

A computer or system that provides services to clients. The clients may be other computers.


 subproject

A set of related files, defects, and topics comprising a discreet portion of a product under StarTeam Workstation or Versions version control.


 TCP/IP

A protocol for communication between computers used by the Internet. Acronym for Transmission Control Protocol/Internet Protocol.


 team member

Any of the project users. Sometimes used to denote a user that does not have administrator status.


 test command

A command that you specify so that StarTeam Workstation or Versions can perform, in proper sequence, an automated test procedure for a project or subproject's product.


text file
 text file or ASCII file

A file that contains only printable text characters, spaces, carriage returns, and sometimes tabs and an end-of-file marker, without any formatting codes.


 unlock

The process of releasing a locked file so that others can check it in.


 user

An individual identified to StarTeam Workstation or Versions and given access to one or more projects and their component subprojects and files. When project security is enabled, that access is protected by password. A user is also referred to as a team member.


 vault

A directory where versions of the files that are under version control are stored. This directory’s name ends with a .vlt extension and is a subdirectory of the directory where the project database file (.stp) is stored.


 vault file

A file in the project vault that stores versions of a project file.


version
 version or revision

A copy of a file stored in the project vault. One or more of these versions may exist.


 version control

Version control is the process of storing and tracking the various changes (versions or revisions) to one or more files. A version control system maintains the version history generated as the files evolve into their final forms.

The main advantage of using an automated version control system is fast, easy recall of previous versions. If you are on a network, StarTeam Workstation or Versions also provides a quick, easy-to-use method of obtaining versions of files being generated and maintained by other users working on a project with you.


 version control system

Application software to help manage multiple versions of the same file.


 Visual Diff

A companion program to StarTeam Workstation or Versions. Visual Diff compares two text files or two versions of one text file and shows the differences (if any) between them.


 working directory

The directory designated to hold the working copies of files that have been checked out of the StarTeam or Versions project vault. It is also the directory from which files are added to or checked in to a subproject.


 working file

A copy of a file under version control which has been checked out of the vault so it can be reviewed or edited. StarTeam Workstation or Versions copies working files to the designated working directory on a workstation. This is in contrast to the stored file versions that are located in the vault.


 workstation database

Stwork20a.db is the workstation database file. The database contains information about what versions of files are in your working directories and so forth. For example, StarTeam Workstation or Versions uses it to determine what needs to be checked in or out.