CollabNet Desktop - Microsoft Windows Edition

Transcription

1 CollabNet Desktop - Microsoft Windows Edition User Guide 2009 CollabNet Inc.

2

3 CollabNet Desktop - Microsoft Windows Edition TOC 3 Contents Legal fine print...7 CollabNet, Inc. Trademark and Logos...7 Chapter 1: Get started...9 Customize your Start Page...10 Open the Site Explorer...10 Add a CollabNet site...11 Add an item to your Favorites...12 Find project resources...12 Open a Desktop item...13 Connect using a proxy...13 Chapter 2: Work with CollabNet community sites...15 Search a CollabNet community site...16 Add a pre-configured CollabNet community site...16 Chapter 3: Work with CollabNet TeamForge...19 Add a TeamForge site...20 Plan and track anything...20 Add a tracker artifact query...20 Create a tracker artifact...21 Associate a tracker artifact with other items...22 Associate a tracker artifact with a code commit...23 Make a tracker artifact depend on another artifact...23 Add an attachment...24 Release products...24 Create a package...24 Create a release...25 Add files to a release...25 Update release attributes...25 Work on tasks...26 Add a task query...26 Create a task folder...26 Create a task...26 Associate a task with other items...27 Make a task depend on another task...27 Document your work...28 Create a document folder...28 Create a document...28

4 4 CollabNet Desktop - Microsoft Windows Edition TOC Download a document...29 Edit a document...29 Export a document folder tree...31 View a document review...31 Export query results...31 Chapter 4: Work with CollabNet Enterprise Edition...33 Add a CollabNet Enterprise Edition site...34 Work with Issue Tracker...34 Find Issue Tracker issues...34 Create an issue...35 Edit an issue...36 Make an issue depend on another issue...36 Add attachments to an issue...37 Associate an issue with a code commit...37 Work with Project Tracker...37 Find Project Tracker artifacts...37 Create a Project Tracker artifact...38 Relate a Project Tracker artifact to another artifact...38 Associate a Project Tracker artifact with a code commit...39 Work with attachments to a Project Tracker artifact...39 Chapter 5: Work with source code...41 Open a folder in the repository browser...42 Connect to an external Subversion repository...42 Chapter 6: Merge tracker artifact and task changes...43 Chapter 7: Work with CollabNet Lab Management...45 Get a Lab Management API key...46 Add a Lab Management site...46 Configure an external client...47 View host details...47 Chapter 8: Log Desktop operations...49 Chapter 9: Frequently Asked Questions...51 What can I do in Favorites?...52 What terms and wildcards can I use to narrow my search?...52 Can I store my recent Desktop activities?...53 What is the Desktop editor?...53

5 CollabNet Desktop - Microsoft Windows Edition TOC 5 What is Changeset Merge?...54 CollabNet TeamForge concepts...55 What is a tracker?...55 What is a task?...55 What is a document?...55 What is a release?...55 CollabNet Enterprise Edition concepts...55 What is Project Tracker?...55 How do I manage Project Tracker artifacts?...56 How do I search for Project Tracker artifacts?...56 What is Issue Tracker?...56 Lab Management concepts...56 What is CollabNet Lab Management?...56 What does the Lab Management integration provide?...57 What is the Lab Management Domain?...57 What is the Lab Management Manager?...57 What is a Client Node?...57 What is a Lab Management host?...57 What are Lab Management user roles?...57 What is a Lab Management project?...58 What is a Lab Management profile?...58 How does tunneling work?...58 Chapter 10: Reference information...59 Issue Tracker attributes...60 Issue Tracker fields for queries...60

6 6 CollabNet Desktop - Microsoft Windows Edition TOC

7 Legal fine print Copyright 2007 CollabNet, Inc. All rights reserved. CollabNet is a trademark or registered trademark of CollabNet, Inc., in the U.S. and other countries. All other trademarks, brand names, or product names belong to their respective holders. CollabNet makes no representation with respect to accuracy or completeness of document, and specifically disclaims any implied warranties for any purpose and shall in no event be liable for any loss of profit or any other commercial damage, including but not limited to special, incidental, consequential, or other damages. Please submit comments and questions at CollabNet, Inc. Trademark and Logos These trademarks are trademarks or registered trademarks of CollabNet, Inc. or its licensors in the United States and other countries. CollabNet OpenCollabNet CollabNet TeamForge CollabNet SourceForge Enterprise SourceForge Enterprise Edition Powered by CollabNet collabxchange This list will be updated from time to time to reflect additional trademarks and changes in registration status. If you have questions or would like further information regarding CollabNet's trademarks, please contact the CollabNet, Inc., Legal Department at trademarks@collab.net. Subversion is a registered trademark of the Subversion Corporation. All other trademarks, logos, brand names, or product names belong to their respective holders.

8

9 Chapter 1 Get started Topics: Customize your Start Page Open the Site Explorer Add a CollabNet site Add an item to your Favorites Find project resources Open a Desktop item Connect using a proxy

10 10 CollabNet Desktop - Microsoft Windows Edition Get started Customize your Start Page You can redesign the appearance and content of your Start Page to suit your needs and preferences. Note: The display of your Start Page is controlled by a setting in Tools Preferences General. By default, your Start Page is displayed. 1. To customize your Start Page, edit the StartUp.html file in the location where you installed CollabNet Desktop. The default installation location is C:\Program Files\CollabNet\CollabNet Desktop - Microsoft Windows Edition. 2. Restart CollabNet Desktop. Open the Site Explorer The Site Explorer view lets you add and work with CollabNet Enterprise Edition, TeamForge and Lab Management sites. In CollabNet Desktop - Microsoft Windows Edition, select View Site Explorer. The tree view is displayed.

11 CollabNet Desktop - Microsoft Windows Edition Get started 11 Folders containing tracker artifacts and tasks assigned to you, and submitted by you, are automatically displayed. You can work on a specific item in the tree, such as a TeamForge tracker artifact or a task, by double-clicking it. In the CollabNet TeamForge tree, an application folder is displayed if you have the requisite view permission. The "Project-wide queries" node is displayed if you have view permission for trackers or task groups folders. Tree items have a Refresh option for synchronization with the CollabNet site. Add a CollabNet site To start working with your CollabNet site in your Desktop, you must first add it to the Site Explorer. Follow these instructions to add your CollabNet site: Add a TeamForge site on page 20 Add a CollabNet Enterprise Edition site on page 34 Add a Lab Management site on page 46

12 12 CollabNet Desktop - Microsoft Windows Edition Get started Add an item to your Favorites The TeamForge items you can add to your Favorites include tracker and task queries, and document folders and reviews. By default, the Favorites pane appears when you add a new site. It displays the tracker artifacts and tasks you submitted, and the tracker artifacts, tasks and document reviews assigned to you. Your Favorites display is controlled by a setting in Tool Preferences General. To pull a TeamForge item from the Site Explorer to your Favorites, use one of the following methods: Drag and drop the item. Right-click the item and select Add to favorites. The item is added to your Favorites. Here's an example of a tracker artifact query where the columns are grouped by status: Find project resources To find something quickly, use the Search option. 1. Start your search in one of these ways. From the main menu, select Tools Search and specify a site. In your Favorites, click Search. 2. In the Search dialog, select a TeamForge project. By default, all projects are searched.

13 CollabNet Desktop - Microsoft Windows Edition Get started Enter the string to search for. Tip: You can include wildcards in the string. 4. Select the project applications to search. You can include tracker artifacts, tasks, discussion messages and documents. 5. Specify whether you want to search attachments to the project applications. For Documents, document folders do not have attachments, but document reviews could have them. 6. Specify whether you want to search only current versions of documents. Searching only current (active) versions allows you to eliminate search results for outdated documents. Tip: To search for a different string without changing other parameters, enter it in the Search Results view and re-run your search. Open a Desktop item There are several ways to bring up a CollabNet Enterprise Edition or TeamForge item. When you add a CollabNet site, main menu and Site Explorer options are available to open CollabNet Enterprise Edition and TeamForge items. Additionally, you can open TeamForge items from a list of recent site activities as well as the Favorites pane. To open an item, do one of the following: In the main menu, select File Open and follow the directions in the wizard. In the Site Explorer, double-click an item. In the Site Explorer, right-click an item and select to open it in the integrated browser or Desktop editor. Note: This context menu option is not available for all items. If you know the ID of your TeamForge item, enter it in the text box in your Favorites and click Open item. Double-click an item in your Favorites table for TeamForge tracker query results, task query results or documents. In the Site Explorer, right-click a TeamForge site, and select an item from Recent Activities.. Note: The number of items available in Recent Activities depends on its Tools Preferences setting Connect using a proxy The Desktop uses Internet Explorer's proxy settings by default. You can override this and configure your own proxy settings. The Desktop relies on the automatic proxy configuration of the.net 2.0 framework which shares registry settings with Internet Explorer. If a proxy is defined through Internet Explorer, it is used, even if you don't specify one. 1. In the main menu, open Tools Preferences. 2. In General preferences, click Connection Settings. 3. To ignore proxy settings, even if defined through internet Explorer, select Bypass proxy for CollabNet Desktop connections.

14 14 CollabNet Desktop - Microsoft Windows Edition Get started 4. To configure your proxy settings, select Static proxy. a) Enter the proxy address and port. For example, " if your server is secure. b) If your proxy server requires authentication, supply your credentials and URL for the server. c) Select Bypass on local if you do not want the proxy server to be used when you connect to a computer on your local network. 5. Click OK.

15 Chapter 2 Work with CollabNet community sites Topics: Search a CollabNet community site Add a pre-configured CollabNet community site

16 16 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet community sites Search a CollabNet community site In the opencollabnet Search window, you can select a pre-configured site such as or add a new CollabNet community site, and search for content. 1. In CollabNet Desktop - Microsoft Windows Edition, select View opencollabnet Search Window. 2. Select the site you want to search. 3. Enter what you want to search for and click Go. Your search results are returned in the integrated browser. Add a pre-configured CollabNet community site The Site Explorer provides some pre-configured CollabNet community sites where you can keep up with product updates, latest downloads and more. The opencollabnet, CollabNet OnDemand and CollabNet TeamForge Community sites are included in the Site Explorer. If you have already registered at any of these sites, you can connect to it by supplying your credentials. If you have not registered, you can set up a new acoount. Follow these steps if you discarded one of these sites, and want to add it again: 1. In the Site Explorer, click the Add CollabNet Site icon. 2. In the Add a CollabNet Site dialog, select a CollabNet site under "Add a pre-configured site" and click Next. The site's URL, description and type are populated. 3. Click Next. 4. Enter your account details.

17 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet community sites 17 If you have already registered at the site, supply your credentials. To register, click Create new account and enter the required information. 5. Click Finish. The site appears in the Site Explorer. Expand it to explore the site.

18

19 Chapter 3 Work with CollabNet TeamForge Topics: Add a TeamForge site Plan and track anything Release products Work on tasks Document your work Export query results

20 20 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge Add a TeamForge site When you add a TeamForge site, you can access its projects and tools in the Site Explorer, and work with them using the Desktop editor. 1. In your Desktop, do one of the following: Select File New CollabNet Site. In the Site Explorer, click the Add CollabNet Site icon. 2. Select CollabNet TeamForge for the site type and click Next. 3. Specify a title and the URL for the site. For example, 4. Provide your username and password to access the site. 5. If the root directory URL for your Subversion repository is not the default value displayed, select Custom and enter the value. Suppose you have a repository called "myrepo", the path template to the repository is "/svnroot/myrepo". The value you specify here is used to replace "/svnroot/" for all repositories in all projects on the site unless it is overridden at a lower project or repository level. 6. Select a timezone for the CollabNet TeamForge server. 7. Click Finish. Your TeamForge site appears in the Site Explorer. You can expand it to see the projects, and project application folders for which you have view permission. Plan and track anything Use the issue tracking system to track and manage issues such as product defects, feature requirements, and support requests. Add a tracker artifact query To work with tracker artifacts, start by gathering the relevant artifacts with a query.

21 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge In the Site Explorer, select a level for your query: Site-wide queries Project-wide queries under a specific project A specific tracker 2. Right-click and select New Tracker Query. 3. In the New Tracker Query window, enter a name for your query. Name is a required field. 4. Select the project and tracker whose artifacts you want to search. 5. Select other artifact elements to include in the query. Note: For the Assigned To and Submitted By fields, enter the user's User Name. 6. If this is a tracker-wide query, you can include user-defined fields. Click Advanced. a) In the Flex Fields window, select Include in query and enter a value for each field you want to include. b) Click OK. 7. If this is a query you expect to use frequently, select Add to Favorites. If you add this query to your Favorites, the query results table will display the user-defined fields you included. Tip: You can display additional fields such as Description by selecting them from the Column Chooser. 8. Click OK. Your query appears in the Sites Explorer view. Create a tracker artifact Create a tracker artifact whenever you need to report and track a bug, feature request, support request, or other type of issue. Individual tracker entries are referred to as tracker artifacts or tracker items. 1. In the Site Explorer view, right-click a TeamForge tracker and select Create Artifact. The Status tab of the Artifact page is displayed in the artifact editor. Note: The fields on this page can vary based on your administrator's selection of required, optional, and user-defined fields. Here's an example.

22 22 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge 2. In the Status tab on the Artifact page, write a title and description for the artifact. Title and description are always required fields. 3. Complete all other required fields (identified by red asterisks) and any appropriate optional fields. 4. If the artifact represents a bug or other issue that was discovered in a file release, such as a bug in a product release, choose the release from the drop-down list under Reported in Release. Note: The drop-down list does not include releases assigned a pending status. 5. Under Estimated Effort, enter the time required to complete the activity described in the artifact. Note: On sites running TeamForge 5.2 or earlier, this field is called Estimated Hours. 6. Assign the artifact to a project member by choosing a name from the Assigned To drop-down list. Note: If your project administrator has configured the tracker to automatically assign artifacts to individuals based on artifact criteria, skip this step. 7. Add a file attachment, if appropriate. Browse to locate the file. 8. Click Submit to save your changes. The artifact is assigned an ID and displayed in the artifact editor with your changes. Associate a tracker artifact with other items When a tracker artifact is related to other CollabNet TeamForge items, such as tasks, documents, or discussions, you can connect the tracker artifact to the other item by creating an association.

23 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge 23 Creating associations between items enables you to define relationships, track dependencies, and enforce workflow rules. 1. Double-click a tracker artifact in the Site Explorer to open it in the artifact editor. 2. In the artifact editor, click the Associations tab. The list of existing associations appears. 3. Associate an item in one of these ways: Drag an item from the Site Explorer and drop it onto the Associations table. Click Add. 4. In the Enter Target window, enter the ID of the item you want to associate with the artifact. For example, "artf1001". Note: If you used drag-and-drop, the ID of the item is already populated. 5. Add a comment describing the reason for your association. 6. Click OK. The item appears in the list of associations. To view the item, double-click the entry. 7. Click Submit in the artifact editor to submit your changes to the server and save your work. Associate a tracker artifact with a code commit When checking in files to your SCM repository, you can create links to one or more tracker artifacts or other CollabNet TeamForge items. Associations track the relationship between code and the bugs, feature requests, or other tracker artifacts that the code addresses. You can also associate code commits with other CollabNet TeamForge items, such as tasks or documents. A project administrator can make associations mandatory for all code commits. 1. Before making a code commit, select the artifact in the Site Explorer. 2. Right-click and select Create log message. The artifact ID and title are copied to the clipboard in the format [artfid]: title. For example, "[artf1001]: Test for user-select field". 3. When making a code commit, paste the text into the appropriate location, such as the Subversion log message text area. The artifact gets associated with the commit. Make a tracker artifact depend on another artifact To organize your work with tracker artifacts, you can make an artifact a "child" or a "parent" of another artifact. A child artifact can have only one parent. A parent artifact can have any number of children. A parent artifact cannot be closed if a child is open. 1. Open an artifact in the artifact editor and click the Dependencies tab. To specify a parent artifact, click Set Parent. If you know the artifact ID, click Add Child to specify it as a child artifact. To specify a child artifact, you can also drag it from the Site Explorer and drop it onto the Children artifacts table. Note: If Set Parent is not visible, the artifact already has a parent artifact. 2. In the Enter Target window, enter the ID of the artifact which you're relating as the parent or child.

24 24 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge Note: If you used drag-and-drop, the artifact ID is already populated. 3. Add a comment that describes the relationship. 4. Click OK. Details about the parent and child artifacts are displayed in the Dependencies tab. To view the parent or child artifact, double-click the corresponding "plus" icon. 5. Click Submit in the artifact editor to submit your changes to the server and save your work. The parent-child relationship between the artifacts is established. To cancel a parent dependency, click Delete Parent. To cancel a child dependency, click Remove Child. Add an attachment To attach a file to a tracker artifact, you can drag-and-drop it, or browse to it in the artifact editor. 1. In the Site Explorer view, double-click a TeamForge tracker artifact to open it in the artifact editor. 2. Click the Attachments tab, and select the file to attach, in one of these ways. Drag a system file and drop it onto the Attachments tab. Click Add and browse to the desired file. 3. Click Submit in the artifact editor to submit your changes to the server and save your work. The attachment is listed in the Attachments tab. Double-click an attachment to open it. Note: If you are using a version earlier than SourceForge 4.4 SP1, attachments are not listed here. To view attachments in the integrated web browser, click the Manage attachment list on server link. Release products Publish the ouput of your project to selected audiences as packages and releases. Create a package A package is a folder into which one or more related releases are published. For example, you might create a package to represent a product deliverable or major component. You can then create releases within the package for product builds or other groups of files. Note: A package must exist before you create the releases and individual files that will go into the package. 1. In the Site Explorer window, go to the File Releases folder where you want to add a new package. 2. Right-click, and select Create Package. 3. In the Create Package window, provide a name and description for the package. 4. Select the Show Download Link in Project List option if you want to publish a package in the Project Categories list so that users can directly download it. 5. Click OK. The package is created. When you have created a package, you can publish a release into the package.

25 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge 25 Create a release A release is a group of one or more files that are published as a unit. Before creating a release, you must have a package into which your release will go. 1. In the Site Explorer window, go to the package where you want to add a new release. 2. Right-click, and select Create Release. 3. On the Create Release page, write a name and description for the release. 4. Set the status value for the release. Pending - Releases with pending status are not visible in the drop-down lists displayed when you set Reported In Release and Fixed In Release fields in an artifact. Use Pending status when you have created a release but have not yet finished adding files. Active - Releases with active status are visible in the drop-down lists displayed when you set Reported In Release and Fixed In Release fields in an artifact. 5. Identify the maturity level of this release. Use one of these predefined values: Development build Alpha Beta General availability 6. Click OK. The release is created. After you have created the release, you can begin adding files. Add files to a release After you have created a release, you can add one or more files. All files in a release are published as a unit. 1. In the Site Explorer, you can add a file to a release in either of these ways: Right-click a TeamForge file release folder and select Add Release File. Drag one or more system files and drop them within a TeamForge release folder. Note: You cannot upload a directory within a release. Instead, you can upload the files as a ZIP archive. 2. If you used drag-and drop, the files are listed in the Add Release File window. If not, click Add file and browse to the desired file. 3. Click OK. After you have added all your files, you might wish to change the status of the release from pending to active. This will allow users with appropriate permissions to select the release when entering or updating an artifact. You can also change the maturity level if needed. Update release attributes As your release progresses, you should update its maturity level and status. You can also update its name or description if required. 1. In the Site Explorer window, right-click a TeamForge release and select Edit Release Data. 2. In the Update Release window, make your changes. a) Update the name or description as required.

26 26 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge b) Identify the maturity level of the release by selecting a predefined value such as "Early Access" or "Pre-general Availability". c) Choose a new status for the release. A release can be in Active or Pending status. d) Click OK. The release attributes are now updated. Work on tasks Manage your project plan by defining units of work and assigning them to project members. Add a task query To work with your TeamForge tasks, start by gathering the relevant tasks with a query. 1. In the Site Explorer view, select a level for your query: Site-wide queries Project-wide queries under a specific project A specific task folder 2. Right-click and select New Task Query. 3. In the New Task Query window, enter a name for your query. Name is a required field. 4. Select the project whose tasks you want to query. 5. Select other task attributes to include in the query. Note: For the Assigned To and Submitted By fields, enter the user's User Name. 6. Click OK. Your query appears in the Site Explorer view. Tip: If this is a query you expect to use frequently, drag and drop it to your Favorites. Create a task folder Set up a task folder to contain tasks that are related to each other. Task folders, like file directories, let you organize your tasks in a logical, hierarchical manner with labels that are meaningful to you and your organization. You can create folders in the root folder or as subfolders in any other folder. There is no limit to the number of folders you can create. 1. In the Site Explorer view, go to the task or task folder where you want to add a new folder. 2. Right-click, and select Create Task Folder. 3. In the Create Task Folder window, provide a name and description for the task folder. 4. Click OK. The task folder is created. Create a task Create a task when you identify a unit of work that you want to track to completion as part of your project.

27 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge In the Site Explorer view, right-click a TeamForge task folder and select Create Task. 2. In the task editor, provide a title and description for the task. 3. Assign the task a priority between 1 (highest) and 5 (lowest). 4. Assign the task to an individual. Click the Assigned To button to list the project members to whom you can assign the task. 5. Assign the task a status. Not Started OK Warning Alert Complete 6. Give the task a start and end date. Click the calendar icon to select dates. 7. In the Estimated Effort field, write the time you think is needed to complete the task. Note: On sites running TeamForge 5.2 or earlier, this field is called Estimated Hours. 8. Specify whether the time estimate is based on a five-day or seven-day calendar. Note: Choose a seven-day calendar to assign a start or end date that falls on on a weekend. 9. Click Submit to submit your changes to the server and save your work. Associate a task with other items When a task is related to other CollabNet TeamForge items, such as tracker artifacts, documents, or discussions, you can connect the task to the other item by creating an association. Creating associations between items enables you to define relationships, track dependencies, and enforce workflow rules. 1. Double-click a task in the Site Explorer to open it in the task editor. 2. In the task editor, click the Associations tab. The list of existing associations appears. 3. Associate an item to the task in one of these ways: Drag an item from the Site Explorer and drop it onto the Associations table. Click Add. 4. In the Enter Target window, enter the ID of the item you want to associate with the artifact. For example, "artf1001". Note: If you used drag-and-drop, the ID of the item is already populated. 5. Add a comment describing the reason for your association. 6. Click OK. The item appears in the list of associations. To view the item, double-click its entry in the list. 7. Click Submit in the task editor to submit your changes to the server and save your work. Make a task depend on another task When one task cannot be done unless another task is done first, set up a dependency to track the relationship between the two tasks.

28 28 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge 1. In the Site Explorer view, right-click a TeamForge task and select Edit. 2. In the task editor, click the Dependencies tab. The list of existing dependencies appears. 3. Add a predecessor or successor task. Drag a task from the Site Explorer tree and drop it in the Predecessors or Successors section. If you know the task ID, enter it in the Predecessors or Successors section and click Add. The Predecessor or the Successor section lists the dependency you added. To view the predecessor or successor task, double-click the corresponding entry. 4. Click Submit to save your changes. Document your work The document management system is a centralized repository for creating, storing, and managing information about a project. Create a document folder Document folders, like file directories, allow you to organize your documents in a logical, hierarchical manner using labels that are meaningful to you and your organization. You can create folders in the root folder or as subfolders in any other folder. There is no limit to the number of folders you can create. You can create a document folder using the context menu option or using drag-and-drop. Note: With drag-and drop you can create multiple folders at a time. In the Site Explorer, right-click Documents or a folder within it. 1. Select Create Document Folder. 2. In the Create Document Folder window, provide a name and description. 3. Click OK. To upload a directory and its files, drag it from your local drive and drop it in the appropriate Documents location. Note: If you select multiple directories, a document folder is created for each directory following the structure in the file system. A TeamForge document is created for each file in the directory. Tip: If you expect to work with the documents in this folder frequently, drag and drop the folder to your Favorites. Create a document To create a document, you upload a file in the root folder or any other document folder. You can create documents using the context menu option or using drag-and-drop. Note: It is possible to drag multiple files and drop them in a document folder. Each file gets added as an individual TeamForge document. 1. Start with either of these steps: In the Site Explorer, right-click a TeamForge document folder and select Create Document. Drag a system file and drop it onto a TeamForge document folder.

29 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge In the Create Document window, provide a description for the document. 3. Identify the status of the document. Draft - The document is not yet completed. Final - The document is finished. 4. If you want to prevent others from editing the document, select Lock Document. 5. If you used drag-and-drop, the file is listed in the File Name field. If not, select the document creation method: Click Add and browse to the desired file. Specify the document URL. 6. Write any comments you may have about this version of the document. 7. If you want to associate the document with another TeamForge item, enter the ID of that item. For example, artf Enter a description explaining the association. 9. Click OK. Download a document When you want to work on a document on your local system, or using a specific application, you can download it from your TeamForge site. 1. In the Site Explorer or your Favorites, right-click a TeamForge document folder or document, and select Download. Note: From your Favorites, you can also select multiple documents to download. 2. Browse to the location where you want to download it. 3. Click OK. Edit a document While editing a document, you can update its data and associate it with other TeamForge items. Edit a Microsoft Office document Within CollabNet Desktop, you can directly update a Microsoft Word, Excel, PowerPoint or Visio document and upload it to your TeamForge site. Note: This feature is supported for Microsoft Office versions 2003 or higher. 1. In the Site Explorer window, right-click a Microsoft Word or Excel document in a TeamForge document folder, and select Edit Document. The document opens. 2. Edit the document in the Microsoft Office application and click Save when you are done. The Update Document dialog appears. 3. Provide any comments you may have about this version of the document, and click Upload. Your changes are saved and the document is uploaded to your TeamForge site. If you clicked Cancel to continue working on your document without uploading it, you will be prompted to upload when you choose to save it. You can observe your changes in the web browser by double-clicking the document in the Site Explorer. Update document data When updating a document, you can upload a new file, or change the document's name, description, or lock status.. 1. In the Site Explorer window, right-click a TeamForge document and select Edit Document Data.

30 30 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge 2. In the Update Document window, make your changes. a) Update the name or description by entering new text in the appropriate field. b) Change the status value if appropriate. c) To prevent others from editing the document, select Lock Document. d) Select a file to upload, by browsing to it or entering its URL. Note: When updating, you can only select a single file at a time. e) Enter a version comment to describe the changes made, if appropriate. f) Click OK. The document is now updated. Lock a document While you are working on a document, you can lock it to prevent others from editing it and then posting new versions to your TeamForge site. When a document is locked, any user with the document view permission can view or download the document, but only document administrators and the document creator can post new versions to TeamForge. You can lock a document when you create it or at any time afterward. Note: Locking a document does not prevent it from being edited in its native application. 1. In the Site Explorer window, right-click a TeamForge document and select Edit Document Data. 2. In the Update Document window, confirm that the lock status is currently Unlocked. 3. Select Lock Document. 4. Click OK. The document is now locked. Unlock a document To work with a document that someone else has locked, you must unlock the document. Only a document administrator and the document creator can unlock a document. 1. In the Site Explorer window, right-click a TeamForge document and select Edit Document Data. 2. In the Update Document window, confirm that the lock status is currently Locked. 3. Clear Lock Document. 4. Click OK. The document is now unlocked. All project members with the Document Edit permission can now update the document. Associate a document with other items When a document is related to other CollabNet TeamForge items such as tasks, tracker artifacts or file releases, you can connect the document to the other item by creating an association. Creating associations between items enables you to define relationships, track dependencies, and enforce workflow rules. Some example uses for document associations include: Associating a requirements document with supporting feature requests or bugs in the tracker. Associating a document, or a document review, with the task that requires it as a deliverable. Associating a master document, such as a product plan, with other supporting documents such as a test plan or beta plan. Associating a product announcement document with a file release. 1. In the Site Explorer window, right-click a TeamForge document and select Edit Document Data.

31 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet TeamForge In the Associate With section of the Update Document window, enter the ID of the item you want to associate with the document. For example, "artf1001".. 3. Add a comment describing the reason for your association. 4. Click OK. Export a document folder tree To capture the properties of a TeamForge document folder tree, you can export the tree to a CSV or Microsoft Excel file. 1. In the Site Explorer or your Favorites, right-click a TeamForge document folder, and select Export Folder Tree. 2. Specify the filename, type and location, and click Save. The file contains details such as the document ID, title, description, version, author, creation and modification dates for each document in the tree. You may find this useful, for example, when creating document reports. View a document review Expand a document in the Site Explorer tree to check on its review. If there is a review for a document, expanding it in the tree view displays its TeamForge Review Name. Double-click the review name. Review details are displayed in the integrated browser. Export query results To use tracker artifacts, tasks or documents in other applications, export the corresponding query results to a.csv or.xls file. 1. In your Favorites, click the Export to icon for the query results table you want to export. 2. Select the export format: Excel file or CSV file. 3. Specify the name and location for the file.

32

33 Chapter 4 Work with CollabNet Enterprise Edition Topics: Add a CollabNet Enterprise Edition site Work with Issue Tracker Work with Project Tracker

34 34 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition Add a CollabNet Enterprise Edition site When you add a CollabNet Enterprise Edition site, you can access its projects and Project Tracker and Issue Tracker tools in the Site Explorer. 1. In the Site Explorer, click the Add CollabNet Site icon. 2. Select CollabNet Enterprise Edition for the site type and click Next. 3. Specify the domain URL for the site. For example, 4. Enter a suitable title for the site and click Next. 5. Provide your username and password to access the site. 6. Click Finish. Your CollabNet Enterprise Edition site appears in the Site Explorer. You can expand it to access your projects and their trackers. Work with Issue Tracker In the Site Explorer, you can define and run queries on Issue Tracker issues, create and edit issues, and add attachments to issues. Find Issue Tracker issues To search for Issue Trrcker issues, create and run a query. 1. In the Site Explorer, click a CollabNet Issue Tracker project node. 2. Right-click either of the following and select New Query: Project-wide queries an issue type under Issue Tracker The New Tracker Query window appears.

35 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition Enter a name for the query. 4. Specify the parameters you want to include in the query and click OK. 5. Expand the query in the view to see the corresponding issues. Create an issue Add a new issue when you want to report a defect, or request and track a task, feature or enhancement. There are five types of issues: Defect: a problem with an existing feature that is not developed according to specifications, or does not work as designed. These are often referred to as "bugs." Enhancement: an improvement to an existing feature. Feature: an addition to the software to add a piece of functionality that does not yet exist. Task: an activity to be done on behalf or in support of a feature or enhancement. Tasks do not typically require direct changes to the code base. Patch: a special kind of issue - a section of code to be applied or attached to existing software. Often, a patch fixes a defect. 1. In the Site Explorer view, click the Issue Tracker node under a CollabNet Enterprise Edition project. 2. Right-click on an issue type and select Create Issue. The Select Component dialog appears. 3. Select the area within the project that this issue is associated with, and click OK. Note: Only one selection is permitted. The Status tab is displayed in the issue editor. 4. For Title, enter a brief, specific statement to identify the issue. 5. For Description, provide a full description of the issue including any pertinent history or activity around this issue.

36 36 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition 6. Select the hardware platform and operating system on which the issue was identified. 7. For Version, select the release where the issue was found. 8. Select a type for the issue. 9. In the Assigned To field, enter the username of the individual in charge of resolving the issue. 10. Select a subcomponent within the project, where this issue occurs. 11. Assign a priority to the issue. Note: Priority can be a value from P1 to P5, where P1 denotes the highest importance and P5 the lowest importance. 12. Enter a URL for the issue. Here are some guidelines on how to use this field: For defects, the URL leads to a fairly stable system where the the problem is obvious or can be easily reproduced. For enhancements, the URL provides details pertaining to the improvement, such as mockups. For features, the URL links to web-based material explaining the improvement, such as mockups or design specifications. For tasks, the URL could include links to the associated feature or enhancement. 13. Click Submit to submit your changes to the server and save them. Edit an issue After you create an issue, you can edit it to update existing information, specify additional fields such as the target milestone, and add attachments or dependencies. 1. In the Site Explorer view, click the Issue Tracker node under a CollabNet Enterprise Edition project. 2. Right-click on an issue and select Edit. The issue is displayed in the issue editor. 3. Update any field that was specified when the issue was created. When creating an issue, these are the fields you can specify: title, description, component, subcomponent, platform, operating system, issue type, version, the person assigned to the issue, priority and URL. 4. Set the Target Milestone to associate the issue with a release version for the product. 5. For QA Contact, enter the address of the person responsible for quality control of this issue. 6. Specify a Keyword for the issue. Note: This field appears only if the project administrator has defined one or more keywords for the project. For example, the keyword "CLIENT" could be used to denote that the issue was found on a customer site. 7. In Add CC, include other project members' addresses to alert them when issue activity occurs. 8. In the Status Whiteboard field, enter a one-line note about the issue, or a user-defined term. For example, "[RN]" could be used to denote that the issue requires a release note. 9. Click Submit to submit your changes to the server and save them. Make an issue depend on another issue When one issue cannot be completed unless another issue is done first, set up a dependency to track the relationship between the two issues. 1. In the Site Explorer view, right-click a CollabNet Enterprise Edition isssue and select Edit. 2. In the issue editor, click the Dependencies tab. The list of existing dependencies appears. 3. Add an issue that this issue depends on, or blocks.

37 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition 37 Drag a task from the Site Explorer tree and drop it in the depends On or Blockssection. If you know the issue ID, enter it in the Depends On or Blocks section and click Add. The Depends On or the Blocks section lists the dependency you added. To view the dependent task, double-click the corresponding entry. 4. Click Submit to save your changes. Add attachments to an issue To attach a file to an Issue Tracker issue, browse to it or drag and drop it in the issue. 1. In the Site Explorer view, do one of the following: Right-click an issue under a project that uses Issue Tracker and select Add Attachment. Drag a system file and drop it into an Issue Tracker issue. The Add Attachment window appears. Note: If you used drag-and-drop, the File field is populated. 2. Enter a description for the attachment. 3. Select Patch if the attachment is a proposed patch to the issue. 4. Click OK. 5. Click Submit to save your changes. The attachment is listed in the Attachments tab. Double-click an atachment to open it. Note: In this release, you cannot remove an attachment using the issue editor. Associate an issue with a code commit When checking in files to your SCM repository, you can create links to one or more Issue Tracker issues. Associations track the relationship between code and the bugs, feature requests, or other issues that the code addresses. 1. Before making a code commit, select the issue in the Site Explorer. 2. Right-click and select Create log message. The issue ID and title are copied to the clipboard in the format Issue ID : title. For example, "Issue 1234: Test for user-select field". 3. When making a code commit, paste the text into the appropriate location, such as the Subversion log message text area. The issue gets associated with the commit. Work with Project Tracker In the Site Explorer, you can create new artifacts and run queries. Find Project Tracker artifacts To search for Project Tracker artifacts, run a pre-defined query. In this release, you can only run a query that has been defined and saved outside Visual Studio. 1. In the Site Explorer view, click a CollabNet Project Tracker project node. 2. Expand a query node to see the corresponding artifacts.

38 38 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition Tip: You can run a query from a list of saved queries for the project, or a query that specifically returns your artifacts for a particular artifact type. Double-click an artifact returned by the query to open it in the artifact editor. To open the artifact in the integrated browser, click the icon. Create a Project Tracker artifact To create a Project Tracker artifact, select the artifact type, and enter the artifact attributes. A Project Tracker artifact type is a template that provides a set of unique attributes and options to describe an artifact. Individual entries of a particular type are referred to as artifacts. 1. In the Site Explorer view, select Project Tracker under a CollabNet Enterprise Edition project. 2. Right-click on an artifact type and select Create artifact. The Status tab is displayed in the artifact editor. 3. For Title, enter a brief, specific statement to identify the artifact. 4. Entter the other attributes for the artifact. Note: The attributes available depend on the configuration of the artifact type. 5. Click Submit to submit your changes to the server and save them. When you successfully submit an artifact, other tabs - Comments, Subversion Commits, Related Artifacts and Attachments - are displayed in the artifact editor, and can be ediited. Relate a Project Tracker artifact to another artifact To organize your work with Project Tracker artifacts, you can make an artifact depend on another artifact. You can set up several types of artifact dependencies within Project Tracker: Blocking - Blocking artifacts prevent the artifact being blocked, from being resolved. The blocking artifact must be addressed before the blocked artifact can be resolved. Duplicating - Sometimes duplicate artifacts may be entered and need to be tracked separately. Marking an artifact as a duplicate allows you to track efforts on both artifacts. Duplicates may be in different projects or the same project. Non-blocking - Marking artifacts as non-blocking dependencies also allows you to simultaneously track efforts on two or more artifacts. Parent-Child - Artifacts can be grouped under a single tracking artifact to allow you to monitor the progress of a group of artifacts. 1. Open an artifact in the artifact editor and click the Related Artifacts tab. 2. Select a relationship from the dropdown list. For example, to mark the current artifact as blocking another attribute, select blocking from the dropdown list. 3. Add the dependent atrtifact in one of these ways: In the text box adjacent to the dropdown list, enter the ID of the artifact you're relating. Drag-and-drop a Project Tracker artifact from the Collabnet Site Browser tree. 4. Click Add. The related artifact is displayed in the Related Artifacts tab. To view the related artifact, double-click the corresponding entry. 5. Click Submit in the artifact editor to submit your changes to the server and save your work. The relationship between the artifacts is established. To cancel a dependency, select the related artifact and click Delete.

39 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Enterprise Edition 39 Associate a Project Tracker artifact with a code commit When checking in files to your SCM repository, you can create links to one or more Project Tracker artifacts. Associations track the relationship between code and the bugs, feature requests, or other artifacts that the code addresses. 1. Before making a code commit, select the artifact in the Site Explorer. 2. Right-click and select Create log message. The artifact ID and title are copied to the clipboard in the format artifact ID: title. For example, "SC1234: Test for user-select field". 3. When making a code commit, paste the text into the appropriate location, such as the Subversion log message text area. The artifact gets associated with the commit. Work with attachments to a Project Tracker artifact In the Project Tracker artifact editor, you can view attachments and delete them. Note: In this release, it is not possible to add attachments to a Project Tracker artifact using the artifact editor. To add an attachment, open the artifact in the integrated browser, and use the Add attachment option in the Attachments section. 1. In the Site Explorer view, do one of the following: Double-click a Project Tracker artifact and select the Attachments tab in the artifact editor. Right-click a Project Tracker artifact, select Edit and click the Attachments tab in the artifact editor. The artifact's attachments are displayed. Double-click an attachment to open it. 2. To delete an attachment, select it and click Delete. 3. Click Submit to save your changes.

40

41 Chapter 5 Work with source code Topics: Open a folder in the repository browser Connect to an external Subversion repository

42 42 CollabNet Desktop - Microsoft Windows Edition Work with source code Open a folder in the repository browser From the CollabNet Site Browser, you can easily browse a project's Subversion repository and view author, revision and other details about project files. 1. In the Site Explorer view, select a Subversion folder in a CollabNet Enterprise Edition or TeamForge project. 2. To browse version control information, do one of the following: Double-click the folder. Right-click the folder and select Open in Repository Browser. If you have TortoiseSVN installed, the TortoiseSVN repository browser opens. If not, the repository browser opens in the integrated web browser. Connect to an external Subversion repository To manage a CollabNet TeamForge project's source code on an external repository, specify the URL of that Subversion server for the Source Code node. Suppose you have a repository called "myrepo" defined on a TeamForge server at The path template to the repository is "/svnroot/myrepo". For the example, the default value of "/svnroot/" is " So the default path to the repository is " The Desktop allows you to specify "/svnroot/" at different levels: Site level - The value of "SVN Repository URL" you define while adding or editing a site, is used to replace "/svnroot/" for all repositories in all projects on the site unless it is overridden at a lower level. Note: For this feature, you need you need Development build or a later release. Project level - This value is used to replace "/svnroot/" for all the repositories in the project unless overridden at the repository level. Repository level - This value is used to replace "/svnroot/" for the repository. To define the SVN repository URL at the project or repository level, follow these instructions. 1. In the Site Explorer tree, right-click the Source Code node for a CollabNet TeamForge product and select Manage SVN Urls. The Manage SVN Connection URLs window appears. 2. To change the path across the project's repositories, specify the Subversion root directory in the Custom field. Example: 3. To change the path for an individual repository, follow these steps: a) Select the repository in the table, and click Change. b) Specify the Subversion root directory and click OK. 4. Click OK.

43 Chapter 6 Merge tracker artifact and task changes The option to merge changesets is available for CollabNet TeamForge sites, tracker artifacts and tasks, and Project Tracker projects and artifacts. 1. Right-click a tracker artifact in the Site Explorer and select Merge. The CollabNet Change-Set Merge wizard is invoked. 2. In the Working Copy field, point to the area of the repository where you want the merge results to be committed. Click Next. 3. In the Merge From field, enter or select the repository location of the source for the merge. 4. Specify the artifact repository and artifact ID for the changeset. Note: The Artifact Repository and Artifacts fields contain default values based on the artifact you selected. To select additional artifacts, click Select, and include them from the Artifact Selection dialog. Here's an example:

44 44 CollabNet Desktop - Microsoft Windows Edition Merge tracker artifact and task changes Note: If you know the IDs of the artifacts you want to include, you can directly enter them, using commas for separation. 5. Click Next in the CollabNet Change-Set Merge window where you specified the Change Sets information. The merge client retrieves all of the Subversion commits associated with the selected artifacts. The revision information is also retrieved, and then displayed. 6. Select the revisions you want to include in the merge. 7. If you want to specify options for the merge, such as how conflicts are to be resolved, click Next and make your selections from the merge options. 8. Click Finish. The merge process proceeds and changes are merged to the target location. If you selected to resolve conflicts during the merge, you will be prompted to do so as conflicts occur.

45 Chapter 7 Work with CollabNet Lab Management Topics: Get a Lab Management API key Add a Lab Management site Configure an external client View host details

46 46 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Lab Management Get a Lab Management API key To access Lab Management Web Services, you must first get a Lab Management API key. 1. Log in to your Lab Management site using a Web browser. 2. On your Lab Management home page, click Create API Key in the Lab Management Web Service API Key section. Note: If you already have an API key, click Show API Key to display it. 3. Copy the key to the clipboard. You will need it when adding or specifying a Lab Management Manager site. Add a Lab Management site Add a Lab Management site in the CollabNet Site Browser, and access and manage your Lab Management hosts. 1. In your Desktop, do one of the following: Select File New CollabNet Site. In the Site Explorer, click the Add CollabNet Site icon. 2. Select CollabNet TeamForge Lab Management for the site type and click Next. 3. Specify a title and the URL for the site. For example, Click Next 4. Provide your username to access the site. 5. Enter your Lab Management Web Service API key. Note: Log in to your Lab Management site using a web browser, and copy and paste your Lab Management Web Service API Key from the home page. 6. For SSH settings, find out how your site is deployed from the administrator, and enter the appropriate values.

47 CollabNet Desktop - Microsoft Windows Edition Work with CollabNet Lab Management Click Finish. Site Explorer. Configure an external client You can specify and store commands to connect to a Linux or Solaris host using SSH, and to a Windows host using the Remote Desktop Protocol. 1. From the main menu, select Tools Preferences Lab Management. 2. To connect to an external client using SSH, enter the corresponding command in the SSH field. For example, if you are on a Windows system and want to connect to a Linux host using PuTTY, enter a command in this format: putty.exe {-ssh -P $PORT $USER@$HOST}. 3. To connect to an external client using RDP, enter the corresponding command in the RDP field. For example, if you are on a Windows system and want to connect to a Windows XP host, enter a command in this format: mstsc.exe {/v:$host:$port}. 4. Select the Prompt option if you want the corresponding command to be displayed every time you try to open the cilent. 5. Click OK. When you right-click on a Lab Management host and try to connect to an external client, the stored command is used. View host details Details about your Lab Management host are available in the Properties window. In the Site Explorer, select a Lab Management site and click View Properties Window. Note: You can also use the F4 key. Various hardware and operating system details, and information such as the Lab Management profile and whether the host is allocated or free, are displayed.

48

49 Chapter 8 Log Desktop operations Desktop versions and higher use the log4net library for logging. By default, logging is disabled. To enable logging, follow the steps in the Desktop project wiki.

50

51 Chapter 9 Frequently Asked Questions Topics: What can I do in Favorites? What terms and wildcards can I use to narrow my search? Can I store my recent Desktop activities? What is the Desktop editor? What is Changeset Merge? CollabNet TeamForge concepts CollabNet Enterprise Edition concepts Lab Management concepts

52 52 CollabNet Desktop - Microsoft Windows Edition Frequently Asked Questions What can I do in Favorites? Your Favorites is a place where you can work with TeamForge documents, tracker artifacts and tasks you use frequently. You might be a member of multiple CollabNet projects, have a number of queries to track your issues and tasks, and work with various documents across projects. You can find all of these in the Site Explorer. However, you may be interested only in a few custom queries or documents on a daily basis. Your Favorites is a location where you can drag and drop these items from the Site Explorer. Once you've done that, you could even close the Site Explorer and other views, and do all your work in your Favorites. You can add tracker and task queries and document folders to your Favorites. When you click on a query, or document folder or review, the corresponding query results or documents are displayed in a table. Table items have the same context menu options as Site Explorer items. In addition, you can - Open a tracker artifact, task or document by double-clicking its table entry Add or remove table columns using the Columns feature Sort table columns and group them by dragging column headers above the table Sometimes you may want to open a TeamForge item that's not in your Favorites table. If you know the ID of the TeamForge item, enter it in the text field under Site Information to open it. The Download option lets you download document folders from your TeamForge site and work with them locally. You can also right-click a Microsoft Office document, work with it in the corresponding application,and save it, without having to download it from your site and then uploading it. The Export option lets you export query results to a Microsoft Excel CSV file or Microsoft Excel worksheet. What terms and wildcards can I use to narrow my search? Use these guidelines to help create effective searches. Single term Multiple terms Single-term searches look for all search results that match the search text. For example, a search entry of doc only returns search results of "doc". Multiple-term searches look for all search results that match any of the words in the search text. For example, a search entry of document plan returns search results of "document", "test plan", and "document plan".