Chapter 2 - Getting Started

In order to get yourself ready for working with a Teamwork project, it is important to know how to checkout a project from the server, and familiar yourself with the Teamwork Client, a dialog box that enables you to browse the project and version detail and to perform various teamwork operations. This chapter provides everything you will need to know about getting started with the Teamwork Server environment.

• Checkout a project from the server the first time
• Introduction to the Teamwork Client

Getting Started

In order to work with a Teamwork project, you must checkout a copy from the server, and work with that copy. To checkout a project from the server:

1. Open the Teamwork Client by selecting Tools > Teamwork > Open Teamwork Client... from the main menu. This shows the Login dialog box.

   Figure 2.1 - To open Teamwork Client

   For SDE and DBVA with IDE, right-click on the project node and select SDE-EC Project > Open Teamwork Client... from the popup menu. (The label of popup menu items may vary for different products)

2. Enter the User name and enter the Password. Fill in the host name or IP address of the Teamwork Server in Server host. Enter the Port number. Click Login to login to the server.

   Figure 2.2 - Login to the Teamwork Server dialog

3. If the login success, the Teamwork Client appears. The accessible projects are listed under the Projects list. Select the project to work with.

   Figure 2.3 - Selecting a project to work with

4. Checkout the selected project by performing any of the following:
   • Select Action > Checkout Project from the menu.
   • Click on the Checkout Project button on the toolbar.
   • Click on the Open Project button at the bottom right-hand corner.

     Figure 2.4 - To checkout a teamwork project

   Once the project is checked out, the Teamwork Client will be closed and the project will be opened immediately.

Introduction to the Teamwork Client Dialog Box

Besides checking out a project as described in the previous section, the Teamwork Client (dialog box) can also perform other kinds of teamwork operation such as versioning and committing projects. This section will describe the functionality of Teamwork Client by focusing on different parts of the Teamwork Client dialog box.

Figure 2.5 - Teamwork Client

Main Menu and Toolbar

The Teamwork Client window has a main menu bar and a toolbar for performing teamwork operations like login, checkout project, checkin project, check for update, refresh project list, import/export teamwork project and logout.

Figure 2.6 - Main menu bar and toolbar

Project List

It displays a list of projects assigned to the user.

Figure 2.7 - Project List

Project Detail

It displays the detailed information of the selected project.

Figure 2.8 - Project Detail

Field	Description
Project name	The name of the project.
File path	The local file path of the project. This field is empty if the project is not yet checked out.
Checkout time	The last checkout time of the project. This field is empty if the project is not yet checked out.
Version	The teamwork project version. This field is empty if the project is not yet checked-out.
Status	The project status. Possible status are: Not checked out - The project is not yet checked out. Up-to-date (local project not modified) - The project is up-to-date, and the local project file is not modified since the last checkout. Up-to-date (local project modified) - The project is up-to-date, and the local project file is modified since the last checkout. Has update (local project not modified) - A newer version of the project is available on the server, and the local project file is not modified since the last checkout. Has update (local project modified) - A newer version of the project is available on the server, and the local project file is modified since the last checkout. Error in checking project status - The project status cannot be determined. You should check out the project again if you see this status. Not connected to the teamwork server - The current client session is no longer valid. You should re-connect to the Teamwork Server if you see this status. The project status is refreshed automatically when a project is selected in the project list.
Description	Displays the project description.
Delete local project file when logout	Delete the local project file when logged out of the Teamwork Server.
Open Project	Click this button to open the project in VP-UML/SDE/DB-VA/BP-VA for viewing or editing.

Versions

It displays the version history of the selected project.

Figure 2.9 - Versions

Status Bar

The status bar displays information or error messages generated by the Teamwork Client.

Figure 2.10 - Status Bar

Visual Paradigm International Limited Website: www.visual-paradigm.com E-mail: support@visual-paradigm.com