Integrity. MKS Integrity Integrations User Guide

Transcription

1 Integrity MKS Integrity 2009 Integrations User Guide

2 MKS Integrity 2009 Integrations User Guide Copyright MKS Software Inc.; in Canada copyright owned by MKS Inc. All rights reserved. MKS makes no warranty of any kind with regard to this material, including, but not limited to the implied warranties of merchant ability, performance, or fitness for a particular purpose. MKS shall not be liable for errors contained herein, or for any direct, indirect, incidental, or consequential damages resulting from the use of this material. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means, without written permission from MKS. MKS, Implementer, MKS Toolkit, Sandbox, NuTCRACKER, and MKS Federated Server are trademarks of MKS Inc. All other trademarks are the property of their respective holders. Corporate Headquarters 410 Albert Street Waterloo, ON N2L 3V3 Canada tel: fax: sales (toll free): Worldwide Offices: 1815 South Meyers Rd. Suite 220 Oakbrook Terrace, IL USA tel: fax: sales (toll free): Fair Lakes Circle Suite 350 Fairfax, VA USA tel: fax: sales (toll free): Martinstraße Esslingen Germany tel: fax: Third Floor, Duke s Court Duke Street, Woking Surrey GU21 5BH United Kingdom tel: +44 (0) fax: +44 (0) sales: +44 (0) Killiney Road #07-05 Winsland House 1 Singapore tel: fax: th Floor, Unosawa Tokyu Building , Ebisu, Shibuya-ku, Tokyo , Japan tel: fax: This document is uncontrolled when printed or copied. MKS2009SP4

3 Table of Contents 1 Introduction About This Guide Roles Assumptions New MKS Integrity 2009 Integrations Supported MKS Integrity Integrations Dropped Integrations Before You Begin Configuring Integrations Before Using an Integration Where To Go From Here PART I: CODEGEAR CodeGear Delphi Architect Key Considerations Configuring the CodeGear Delphi Integration Using the CodeGear Delphi Integration Delphi Architect Commit Browser Creating an MKS Integrity Project Creating a Sandbox Adding a Member to an MKS Integrity Project Checking Out Members Checking In Members CodeGear JBuilder PART II: IBM IBM Rational Eclipse Platform Overview Supported Versions Before You Start Configuring the IBM Rational Eclipse Integration Setting the MKS Integrity Server Connection Policy Enabling the Integration Setting Preferences Configuring Change Package Options I

4 Table of Contents Deactivating the Integration Using the Integration Online and Offline Mode Setting Up an Integrated Workspace Working in an Integrated Workspace MKS Integrity Commands Refactoring Comparing Revisions Team Synchronizing Best Practices Limitations IBM Rational Rose Configuring the Rational Rose Integration Using the Rational Rose Integration Creating an MKS Integrity Project Creating a Sandbox Adding Members to an MKS Integrity Project Checking Out Members Checking In Members PART III: MICROSOFT Microsoft Visual Studio (SDK) Before You Start Setting Up and Configuring the Integration Enabling the Integration in the MKS Integrity Client Enabling the MKS Source Plug-In in Microsoft Visual Studio. 76 Toggling the MKS Toolbar Setting Preferences Working With Keywords Configuring the Location of Visual Studio Solutions and Projects in the MKS Repository Online and Offline Mode Working With Active Change Packages MKS Integrity Glyphs in Visual Studio Managing Work In Progress Managing Assigned Work Placing Visual Studio Solutions Under MKS Source Control Sharing a Visual Studio Solution Importing a Visual Studio Solution Adding a Visual Studio Project to a Shared Solution Dropping a Visual Studio Project From a Shared Solution Importing a Visual Studio Project II

5 Table of Contents Migrating a Visual Studio Solution from the MKS SCC Visual Studio Integration Ignoring Visual Studio Entities From MKS Source Control Branching a Visual Studio Solution Resynchronizing a Visual Studio Solution Reverting a Visual Studio Solution Checkpointing a Visual Studio Solution Viewing a Sandbox for a Visual Studio Solution Working With Visual Studio Files Adding Members to an MKS Integrity Project Dropping Members From an MKS Integrity Project Checking Out Members Checking In Members Renaming Members Moving Members Advanced MKS Integrity Commands Best Practices Limitations Troubleshooting Microsoft Visual Studio.NET Implementing the Integration Assumptions Required Permissions Implementing the New Project Structure Setting Up Projects to Reuse Code Setting Preferences Parallel Development Considerations Optimistic Locking Development Paths Building Projects Command Functionality Adding a Solution to MKS Integrity Adding a New Project to Source Control Joining Development of a Solution Adding Members to an MKS Integrity Project Checking Out Members Checking In Members Troubleshooting III

6 Table of Contents 8 Microsoft Visual Basic Using the Microsoft Visual Basic Integration Creating an MKS Integrity Project Creating a Sandbox Adding Members to an MKS Integrity Project Checking Out Members Checking In Members Microsoft Visual C Configuring the Visual C++ Integration Using the Microsoft Visual C++ Integration Creating an MKS Integrity Project Creating a Sandbox Adding Members to an MKS Integrity Project Checking Out Members Checking In Members Microsoft Project Overview Before You Start MKS Integrity Server Requirements Client Requirements Integration Components Assumptions Key Considerations Pre-installation Administration Configuring the MKS Integrity Server Configuring MKS Integrity Setting Permissions Modifying the Integration XML Mapping Template Installing the Microsoft Project Integration Repairing or Removing the Integration Microsoft Project Configuration MKS Custom Project Properties MKS Custom Project Fields Using Microsoft Project Server and Enterprise Resources Enabling SSL Communication Logging Configuration Using the Microsoft Project Integration Specifying Task Types Setting Task Relationships Synchronizing Resources Synchronizing All Tasks Synchronizing Tasks By Query Synchronizing Linked Tasks IV

7 Table of Contents Synchronizing Selected Tasks Detecting Conflicts Microsoft Word Assumptions Overview of the Integration System Requirements Configuring the MKS Integrity Server Installing and Uninstalling the Integration Importing Document Structure Definitions Exporting Word Documents to MKS Integrity Troubleshooting Integration Errors Creating a Custom DSD for Other Document Types Microsoft Excel Overview Before You Start MKS Integrity Server Requirements Client Requirements Integration Components Assumptions Key Considerations Setting the MKS Integrity Server Connection Policy Installing the Microsoft Excel Integration Repairing or Removing the Integration Customizing the Microsoft Excel Integration XML Mapping Template MKS Custom Properties Logging Using the Microsoft Excel Integration Importing the XML Mapping Template Creating a New List Retrieving Items From MKS Integrity Synchronizing Data Synchronizing Using Queries Working With Requirement Documents Detecting Conflicts Working With Special Fields V

8 Table of Contents PART IV: OTHER Sybase PowerBuilder Configuring the PowerBuilder Integration Using the PowerBuilder Integration Creating an MKS Integrity Project Creating a Sandbox Adding Members to an MKS Integrity Project Checking Out Members Checking In Members HP Quality Center Requirements and Defect Modules. 213 Integration Overview Assumptions System Requirements Integration Installation and Configuration Overview Step 1: Configuring the MKS Integrity Server Step 2: Configuring Quality Center Creating and Editing Projects Creating MKS ID Field for Requirements and Defects Creating Additional Requirements User Fields Setting the MKS Type in Quality Center Step 3: Configuring MKS Integrity Step 4: Installing the Integration Step 5: Configuring the Integration Modifying Process Configuration and Mapping Files Setting Up Notification Setting Up Attachment Handling Step 6: Running the Integration Troubleshooting Computer Associates AllFusion Endevor Understanding the Endevor Integration MKS Integrity Commands PART V: APPENDIX A Configuring a Mapping Template Overview Mapping Template XML Elements Mapping Template Example Index VI

9 C HAPTER ONE Introduction 1 For configuration management, MKS Integrity provides a number of integrations for industry leading Integrated Development Environments (IDEs), such as IBM Rational Software Development/Eclipse Platform and Microsoft Visual Studio. For workflows and documents, MKS Integrity integrates into HP Quality Center and Microsoft Office applications (Project, Word, and Excel). MKS Integrity blends transparently into your tools, providing you with access to MKS Integrity core functionality from within your host environment. When using MKS Integrity for configuration management, commands such as creating an MKS Integrity project or checking out a member are available from within your IDE. More advanced commands (such as setting the member revision) that cannot be performed within the integrations, can be performed in the MKS Integrity Client graphical user interface (GUI). Typically, the MKS Integrity Client GUI can be opened from within the tool you are working in. When using MKS Integrity for workflows and documents, you can create new items from within your chosen tool with a one-to-one mapping of fields, configured specifically for your workflow. This chapter provides information on the following topics: About This Guide on page 2 Roles on page 2 Assumptions on page 3 New MKS Integrity 2009 Integrations on page 3 Supported MKS Integrity Integrations on page 4 Dropped Integrations on page 5 Before You Begin on page 6 Configuring Integrations on page 7 Before Using an Integration on page 8 Where To Go From Here on page 10 1

10 Chapter 1: Introduction About This Guide For content that is essential and applicable to all guides, MKS provides a single location for you to access the information. See the MKS Integrity 2009 Getting Started Guide for information on the following topics: a complete list of related documentation descriptions of the typographical conventions used in this guide getting help from MKS Customer Care consulting MKS Professional Services how to provide feedback on this documentation detailed descriptions for base concepts used in MKS Integrity installing and configuring the MKS Integrity Client an overview of the interfaces available for the MKS Integrity Client Most procedures in this guide are documented using menu-based commands; however, toolbar buttons, shortcut menus, and shortcut keys exist for most procedures. For more information, refer to descriptive tooltips and menu items in the interface. For detailed information on wizards, views, and dialog box options, see the online help. NOTE For this release, instances of the term issue appearing on the interface and in configuration files, refer to MKS Integrity items, and therefore have the same meaning. Roles There are two primary roles to consider when using MKS Integrity the administrator and the user. The administrator installs the MKS Integrity database on a network, defines and customizes item types and workflow, manages groups, creates projects and assigns groups to them, manages notification for users and groups, creates additional user accounts, and assigns permissions that allow users access to specific MKS Integrity operations. The user is anyone who needs to work with MKS Integrity. Users are assigned user permissions by the administrator. Users are also assigned to groups that have specific MKS Integrity group permissions assigned by the administrator. 2

11 Assumptions Assumptions Before using MKS Integrity, MKS assumes that you have experience with the following: the operating systems used in your work environment (whether Windows, Solaris, Linux, IBM-AIX, or HP-UX) your chosen application (for example, Microsoft Project if you are using the Microsoft Project integration or Microsoft Visual Studio if you are using an IDE application) NOTE At this time, only Windows-based IDEs are supported for workflow management, the search operators and syntax for the database used by MKS Integrity (that is, the MS SQL Server, DB2, or Oracle database) HTML (if you are creating and editing report templates) XML (if you are modifying integration templates for the Microsoft Project integration) New MKS Integrity 2009 Integrations The following table summarizes integrations that are new for this release of MKS Integrity: Integration Versions IBM Rational Developer for System i (RDi) 7.5 Microsoft Visual Studio (SDK-based integration) 2005, 2008 Microsoft Word (Export) 2003,

12 Chapter 1: Introduction Supported MKS Integrity Integrations The following table summarizes all integrations currently supported for MKS Integrity: Integration Versions CodeGear Delphi Architect 2005 CodeGear JBuilder 2007, 2008 Eclipse (open source) 3.2.x, 3.3.x, 3.4.x IBM Rational Rose Enterprise Edition 2003 v6.13 IBM Rational Application Developer (RAD) 7.0, 7.5 IBM Rational Software Architect (RSA) 7.0 IBM Rational Software Architect (RSA) for Websphere Software 7.5 IBM Rational Software Modeler (RSM) 7.0, 7.5 IBM Rational Developer for System i (RDi) 7.1, 7.5 IBM WebSphere Development Studio Client for System i (iseries) 7.0 Microsoft Visual Basic 6.0 Microsoft Visual C Microsoft Visual Studio.NET (SCC) 2003 Microsoft Visual Studio (SDK-based) 2005, 2008 Sybase PowerBuilder 10.5 AUTOSAR Requirements Interchange Format 1.0, 1.1a Computer Associates AllFusion Endevor Change Manager 4.0 HP Quality Center (Defect Module) 9.2 HP Quality Center (Requirements Module) 9.2 Microsoft Excel (Import/Export) 2003 Professional Edition, 2007 Microsoft Project 2003, 2007 Microsoft Windows Explorer Microsoft Word (Import/Export) 2003, 2007 MKS Gateway MKS Worktray Eclipse 3.2.x, 3.3.x, 3.4.x 4

13 Dropped Integrations Dropped Integrations The following summarizes the integrations that are dropped for this release of MKS Integrity: Integration Versions Borland/CodeGear JBuilder Enterprise 2006 Eclipse (open source) 3.1.x IBM Rational Application Developer (RAD) 6.0 IBM Rational Software Architect (RSA) 6.0 IBM Rational Software Modeler (RSM) 6.0 IBM Rational Web Developer (RWD) 6.0 IBM WebSphere Studio Application Developer (WSAD) 4.0.x, 5.1 IBM WebSphere Studio Enterprise Developer (WSED) 5.1 IBM WebSphere Integration Developer (WID) 6.0 IBM WebSphere Development Studio Client (WDSC) for iseries IBM WebSphere Development Studio Client (WDSC) Advanced Edition for iseries HP Quality Center (Test Plan Module) 8.x HP Quality Center (Requirements Module) 9.0 Mercury TestDirector for Quality Center (Defect Module) 8.0, 8.2 Microsoft Word (Import) 2000/XP/2003 Microsoft Visual Studio (SCC-based) 2005/2008 MKS Worktray Visual Studio.NET Worktray Sybase Powerbuilder 9.0 Telelogic DOORS 8.0 5

14 Chapter 1: Introduction Before You Begin Some integrations have specific requirements that must be completed before enabling the integration itself. The following is a list of pre-conditions required for certain integrations: If you are using Change Package Reviews in MKS Integrity, some integrations may require you to use MKS Integrity directly to complete tasks. For more information, see the MKS Integrity Client 2009 User Guide. If you are using a pre-2006 MKS Integrity Client, you cannot view subproject change package entries. If you are upgrading from Eclipse Platform 1.0.0/WebSphere Studio Family 4.0.x products, see Configuring the IBM Rational Eclipse Integration on page 25, before enabling the integration. To use the HP Quality Center integration, the MKS Integrity Client and Quality Center server must reside on the same machine. For Eclipse 3.1/3.2, system variables must be set as follows: ECLIPSE_INSTALL_ROOT=<Eclipse installdir> where <Eclipse installdir> is the root location of the product you want to integrate with MKS Integrity. SI_ECLIPSE_FEATURE=<MKS Integrity Client installdir>/ integrations/ibm/<eclipse version> where <MKS Integrity Client installdir> is the path to the directory where you installed MKS Integrity, and <Eclipse version> is the following text string: eclipse_32 IMPORTANT When setting system variables for Eclipse, use only forward slashes (/) or double back slashes (\\). Do not use a single backslash (\). To have the new environment variables take effect, restart your computer. To use MKS Worktray for Visual Studio.NET 2003, it must be enabled as an integration from the MKS Integrity Client. In addition, you must also run the VSIP Interop Assembly Redist.msi file located in the following directory: <client install directory>/integrations/microsoft/ Visual Studio Worktray 6

15 Configuring Integrations Configuring Integrations The MKS Integrity Client includes the Edit Integrations menu action for enabling and disabling most supported integrations. You can select from a list of available integrations and enable or disable them, as required to work with your preferred application. There is no requirement to re-install the MKS Integrity Client. NOTE Using the Enable/Disable Integrations dialog box, you can always restore an available IDE integration at a later date. Certain supported integrations cannot be enabled using the Edit Integrations menu action. These include the MKS Integrity integrations with IBM/WebSphere/Rational 7.0/7.5 series and Eclipse 3.2.x, 3.3.x, and 3.4.x. Included are integrations with IBM RAD, RSM, RSA, WDSC, and WDSC AE. For more information on enabling these integrations, see Configuring the IBM Rational Eclipse Integration on page 25. The following sections provide instructions on how to enable and disable the available MKS Integrity IDE integrations using the graphical user interface. You can also enable or disable integrations using the si integrations command in the CLI. For more information on the si integrations command, see the MKS Integrity 2009 CLI Reference Guide for Configuration Management. To enable integrations for MKS Integrity using the graphical user interface 1 Open the MKS Integrity Client and select File > Edit Integrations. IMPORTANT If the command is not visible, you must enable it in the active viewset. For information on viewsets, see the MKS Integrity Client 2009 Getting Started Guide. The Enable/Disable Integrations dialog box displays. 2 In the Disabled Integrations list, select the available integration(s) that you want to enable. 3 To move the selected integrations to the Enabled Integrations list, click. To move all disabled integrations to the Enabled Integrations list, click. TIP You can select multiple integrations by using CTRL + click. The selected integration is moved to the Enabled Integrations list and displays in bold type. 4 To activate the selected integration(s), click OK. The selected integration is activated. 5 To complete the activation, restart your computer. 7

16 Chapter 1: Introduction To disable integrations for MKS Integrity using the graphical user interface 1 Open the MKS Integrity Client and select File > Edit Integrations. IMPORTANT If the command is not visible, you must enable it in the active viewset. For information on viewsets, see the MKS Integrity Client 2009 Getting Started Guide. The Enable/Disable Integrations dialog box displays. 2 In the Enabled Integrations list, select the integration(s) that you want to disable. TIP You can select multiple integrations by using CTRL + click. 3 To move the selected integration(s) to the Disabled Integrations list, click. To move all enabled integrations to the Disabled Integrations list, click. The selected integration is moved to the Disabled Integrations list. 4 To disable the selected integration, click OK. The selected integration is disabled. 5 To complete the process, restart your computer. Before Using an Integration Note the following when using MKS Integrity integrations for configuration management: This guide assumes you know how to use your chosen IDE. For more information on using your tool and its version control features, refer to the product s documentation. When you select a version control command in your IDE, you may be prompted to provide the name and port number of the MKS Integrity Server you want to connect to. Most integrations provide version control features and indicators. For example, in Sybase PowerBuilder, a green check mark beside a file indicates that the file is currently checked out. In addition, most integrated tools support version control commands through shortcut menus when you right click a file. MKS Integrity integrations only work in the graphical user interface. At this time, only Windows-based IDEs for MKS Integrity are supported. Do not create more than one MKS Integrity Sandbox in a directory. The integrations use implicit Sandbox detection, so version control commands may fail if there is more than one Sandbox in a directory. When you create an MKS Integrity configuration management project and Sandbox, the project can reside anywhere on the MKS Integrity Server. Any files operated on by the integration must be in a directory with a Sandbox, or the IDE project file must be in the 8

17 Before Using an Integration tree that is visible to the Sandbox, for example, c:/projects/vc/project.dsp. and c:/projects/project.pj. When you add members to an MKS Integrity configuration management project, the integration may prompt you to add a description for each member. Adding a description is optional, since the description appears in the Create Archive dialog box. MKS recommends that you do not create or use sparse Sandboxes in MKS Integrity when using an integration. To access advanced configuration management functionality, such as checkpointing a project, open the Sandbox in the MKSIntegrity graphical user interface. When you perform a version control operation in an IDE, the focus shifts to an MKS Integrity dialog box or window; however, you may have to manually shift the focus back to the IDE. Subprojects are not automatically created by integrations. To use subprojects, create your project structure in MKS Integrity, without adding any members, and use existing Sandboxes for the project. IDE Integration Tips To manually force the storage of archives in binary format 1 Locate your IntegrityClient.rc file in the following Windows directory: C:/Documents and Settings/UserDirectory 2 Add the following line to the file: integrations.defaultbinaryfileextensionlist=value where value specifies the file extensions you want stored in binary format, separated by the symbol. For example: integrations.defaultbinaryfileextensionlist= exe ocx frx doc bmp jpg gif wri apf 3 Save the IntegrityClient.rc file and restart the MKS Integrity Client. 9

18 Chapter 1: Introduction Where To Go From Here To Use the Integration With See Borland Delphi Architect CodeGear Delphi Architect on page 13 Borland JBuilder CodeGear JBuilder on page 19 IBM - Eclipse Platform IBM Rational Eclipse Platform on page 23 IBM Rational Rose IBM Rational Rose on page 65 Microsoft Visual Studio (SDK) Microsoft Visual Studio (SDK) on page 73 Microsoft Visual Studio.NET Microsoft Visual Studio.NET on page 115 Microsoft Visual Basic Microsoft Visual Basic on page 137 Microsoft Visual C++ Microsoft Visual C++ on page 143 Microsoft Project Microsoft Project on page 149 Microsoft Word Microsoft Word on page 173 Microsoft Excel Microsoft Excel on page 185 Sybase PowerBuilder Sybase PowerBuilder on page 207 HP Quality Center Defect Module HP Quality Center Requirements Module CA Endevor HP Quality Center Requirements and Defect Modules on page 213 HP Quality Center Requirements and Defect Modules on page 213 Computer Associates AllFusion Endevor on page

19 PART I CodeGear

20

21 C HAPTER TWO CodeGear Delphi Architect 2 This chapter provides information on using the MKS Integrity integration with CodeGear Delphi Architect 2005 (Delphi), including key considerations and the various MKS Integrity operations and actions you can perform using the Delphi Commit Browser. This chapter provides information on following: Key Considerations on page 14 Configuring the CodeGear Delphi Integration on page 14 Using the CodeGear Delphi Integration on page 14 Delphi Architect Commit Browser on page 16 Creating an MKS Integrity Project on page 17 Creating a Sandbox on page 17 Adding a Member to an MKS Integrity Project on page 18 Checking Out Members on page 18 Checking In Members on page 18 13

22 Chapter 2: CodeGear Delphi Architect Key Considerations Note the following when using the Delphi integration: When you add a project to source control, the Sandbox location you specify in MKS Integrity must be the original path the project was saved to in Delphi. You must not edit this location. Do not rename files in Delphi. Instead, in MKS Integrity, use the Rename command, then use the Resynchronize Member command in Delphi. When performing a check out, check in, add member, drop member, resynchronize, or revert operation, if the file is a form or its associated.pas file, the operation is performed on both the DFM and PAS files. Similarly, when performing an MKS Integrity operation on a Delphi project file (DPR), its associated RES files are included in the operation. You cannot double click a Delphi member revision in the MKS Integrity Member History view to open it. Instead, open the revision from within a Delphi session. If the MKS Integrity GUI is already running when you run a command from the integration that launches an MKS Integrity GUI dialog box, the dialog box is not active in the application window. You must press ALT + TAB to make the dialog box active. Configuring the CodeGear Delphi Integration The MKS Integrity Client includes the Edit Integrations menu action for enabling and disabling the integration with CodeGear Delphi Architect. You can select from a list of available integrations and enable or disable them, as required to work with your preferred application. For more information, see Configuring Integrations on page 7. Using the CodeGear Delphi Integration When you select a source control command in your IDE, you may be prompted to provide the name and port number of the MKS Integrity Server you want to connect to. You can access basic MKS Integrity configuration management functionality from within Delphi by selecting one or more files in the Project Manager window and opening the files for viewing/ editing. Then select Tools > Team from the menu to access the available commands. For detailed information on using MKS Integrity configuration management commands, see the MKS Integrity Client 2009 User Guide. 14

23 Using the CodeGear Delphi Integration The following table summarizes the available commands: Command Check Out Files Check In Files Add Files Remove Files Undo Check Out Files Commit Browser Function Equivalent to the MKS Integrity Member > Check Out command. Checks out the selected file. The MKS Integrity Check Out dialog box displays. Equivalent to the MKS Integrity Member > Check In command. Checks in the selected file. The MKS Integrity Check In dialog box displays. Equivalent to the MKS Integrity Member > Add command. Adds the selected file to the MKS Integrity configuration management project. The MKS Integrity Create Archive dialog box displays. Equivalent to the MKS Integrity Member > Drop command. Drops the selected file from the MKS Integrity configuration management project. The MKS Integrity Drop Member dialog box displays. Equivalent to the MKS Integrity Member > Revert command. Replaces the selected working file with the revision that was checked out, as it appeared prior to modification, and unlocks the file. The MKS Integrity Overwrite dialog box may appear. Launches the Commit Browser dialog box for the open Delphi project that is under source control with MKS Integrity. For available command operations, see Delphi Architect Commit Browser on page 16. Place Project into Source Control Equivalent to the MKS Integrity Project > Create and Sandbox > Create command. Creates an MKS Integrity configuration management project and Sandbox from the selected Delphi project. Note: This command can be performed only once. Pull Project from Source Control Run SCC Integration Equivalent to the MKS Integrity Sandbox > Create command. Creates a Sandbox from a project on the server. Equivalent to launching the MKS Integrity graphical user interface if there is no project open that is currently under source control. If a project under source control is open, the Run SCC Integration command displays the Sandbox view. 15

24 Chapter 2: CodeGear Delphi Architect Delphi Architect Commit Browser The integration also provides MKS Integrity functionality from the Delphi Commit Browser, available from Tools > Team > Commit Browser. For detailed information on the Commit Browser, consult the CodeGear Delphi product documentation. For detailed information on the MKS Integrity configuration management commands, see the MKS Integrity Client 2009 User Guide. The following table summarizes the available actions you can perform on members through the Commit Browser: Action No Activity Commit Check Out Undo Check Out Add Remove Get Latest Function No MKS Integrity command performed on the member. Equivalent to the MKS Integrity Member > Check In command. Checks in the member, updating the head revision. Equivalent to the MKS Integrity Member > Check Out command. Checks out the head revision of the member. Equivalent to the MKS Integrity Member > Revert command. Reverts deferred operations. Equivalent to the MKS Integrity Member > Add command. Adds members to a project. Equivalent to the MKS Integrity Member > Drop command. Drops members from a project. Equivalent to the MKS Integrity Member > Resynchronize command. Gets the latest version of the selected file and puts it in your working directory. The MKS Integrity Overwrite dialog box may appear. MKS Integrity information is also available from the following Commit Browser tabs: Summary Content specifies revision description for all members. Individual Comment specifies the revision description for the selected member. Local Source displays the working file contents of the selected member. Diff and History Show Differences launches the difference tool specified in the MKS Integrity Client preferences. Show History displays the member history in MKS Integrity. 16

25 Creating an MKS Integrity Project Creating an MKS Integrity Project To create an MKS Integrity configuration management project in Delphi 1 In Delphi, select the project you want to put under version control. 2 Open the project file. 3 Select Tools > Team > Place Project Into Source Control. The Specify the Project to Create dialog box displays. NOTE If you are using an existing project, click Cancel and select that project from the Create Sandbox Wizard in step 5. 4 Create a project as described in the MKS Integrity Client 2009 User Guide. The Create Sandbox Wizard displays. 5 Create a Sandbox as described in the MKS Integrity Client 2009 User Guide. The Create Archive dialog box displays. 6 Modify the Create Archive options as necessary as described in the MKS Integrity Client 2009 User Guide. Creating a Sandbox To create a Sandbox in Delphi 1 In Delphi, select the project under version control that you want to create a Sandbox from. IMPORTANT When you add a project to source control, the Sandbox location you specify in MKS Integrity must be the original path the project was saved to in Delphi. You must not edit this location. 2 Open the project file. TIP You can also create a Sandbox directly from MKS Integrity. 3 Select Tools > Team > Pull Project From Source Control. The Create Sandbox Wizard displays. 4 Create a Sandbox as described in the MKS Integrity Client 2009 User Guide. 17

26 Chapter 2: CodeGear Delphi Architect Adding a Member to an MKS Integrity Project To add a member to an MKS Integrity configuration management project in Delphi NOTE You can only add one member at a time to an MKS Integrity project in Delphi. Select Tools > Team > Add Files. The Add File(s) dialog box displays. Select the files you want to add, then click OK. The Create Archive dialog box displays. Modify the Create Archive options as necessary as described in the MKS Integrity Client 2009 User Guide. Checking Out Members To check out members in Delphi Select Tools > Team > Check Out Files. The Check Out File(s) dialog box displays. Select the files you want to check out, then click OK. The Check Out dialog box displays. Check out each member as described in the MKS Integrity Client 2009 User Guide. Checking In Members To check in members in Delphi To check in one file, select Tools > Team > Check In Files. The Check In File(s) dialog box displays. Select the files you want to check in, then click OK. The Check In dialog box displays. Check in each member as described in the MKS Integrity Client 2009 User Guide. 18

27 C HAPTER THREE CodeGear JBuilder 3 The MKS Integrity integration with CodeGear JBuilder Enterprise 2007 and 2008 allows you to access the configuration management functionality of MKS Integrity through your JBuilder development environment. CodeGear JBuilder Enterprise 2007/2008 is based on the Eclipse Platform. For detailed information on configuring and using an Eclipse-based integration, see IBM Rational Eclipse Platform on page

28 Chapter 3: CodeGear JBuilder 20

29 PART II IBM

30

31 C HAPTER FOUR IBM Rational Eclipse Platform 4 The MKS Integrity integration with Eclipse Platform 3.2.x/3.3.x/3.4/3.5 and the IBM Rational Software Development Platform 7.0/7.5 series allows you to access MKS version control commands through several IBM products that use the IBM Rational Platform technology, based on the Eclipse open source initiative. IMPORTANT Integrations with the IBM Rational Eclipse platform work only on Windows operating systems supported for the MKS Integrity Client. For more information on supported Windows operating systems, see the MKS Integrity Getting Started Guide. Eclipse Team Support provides flexibility in designing and implementing support of the repository on the workbench. In turn, the MKS Integrity integration is easier to use and provides greater control. To assist you in using the integration, this chapter discusses the following topics: Overview on page 24 Supported Versions on page 24 Before You Start on page 25 Configuring the IBM Rational Eclipse Integration on page 25 Using the Integration on page 32 Best Practices on page 61 Limitations on page 62 23

32 Chapter 4: IBM Rational Eclipse Platform Overview The MKS Integrity integration with Eclipse Platform 3.2.x/3.3.x/3.4/3.5 and the IBM Rational Software Development Platform 7.0/7.5 allows you to access MKS version control commands through several IBM products that use the IBM Rational Platform technology, based on the Eclipse open source initiative. Eclipse Team Support provides flexibility in designing and implementing support of the repository on the workbench. In turn, the MKS Integrity integration is easier to use, and provides greater control. The integration also allows you to access MKS version control commands through several open source and commercially available development products, built as Eclipse Platform 3.2/3.3/3.4/3.5 plug-ins. The integration includes software developed by the Eclipse Project. For more information on the Eclipse Project, browse to: Supported Versions The integration with Eclipse Platform and IBM Rational Software Development Platform is designed to work with the following: A licensed IBM Rational Software Development Platform product, including IBM Rational Application Developer (RAD) 7.0 and Rational Architecture Management and Construction 7.5 solutions (including RAD, RSW, and RSM 7.5) A product built on the Open Source Eclipse Platform 3.2/3.3/3.4/3.5 Any commercial development tool, certified as Ready for IBM Rational, built on the Eclipse Platform 3.2/3.3/3.4/3.5 MKS no longer supports an integration with Eclipse 1.0 based products. Depending on the product version you currently have, the migration path is completed in stages from WebSphere Studio Family 4.0 to 5.0, and then from IBM Rational Application Developer 6.0 to 7.0 series. For more information on the migration path, consult your IBM Rational product documentation. For additional details, refer to Once the software upgrade is complete, you can migrate your projects using the MKS Sharing Wizard. For more information on the MKS Sharing Wizard, see Placing Eclipse Projects Under MKS Version Control on page 33. Contact MKS Customer Care for information on migrating your projects to Eclipse 3.2.x/ 3.3.x/3.4/3.5 based products for use with the MKS Integrity integration. 24

33 Before You Start Before You Start Before you use the integration, note the following: This guide assumes you know how to use Eclipse/IBM Rational Software Development Platform products, MKS Integrity, and MKS Implementer (if working with MKS Implementer change packages). For more information about using a product, refer to the appropriate documentation from the product vendor. The integration works with MKS Integrity 2009 or higher and MKS Integrity 2007 Service Pack 5 or higher. Java Development Kit (JDK) 1.5 or higher must be installed. Your administrator must grant you the ShareArchive permission through the MKS Integrity access control lists (ACLs). For more information, contact your administrator. MKS recommends that you read Best Practices on page 61 for best practices on using the Eclipse integration. If the MKS Integrity Client is shut down and you run a command that requires MKS Integrity, the MKS Integrity Client automatically initializes. Configuring the IBM Rational Eclipse Integration With the release of the IBM RAD 7.0 series, integrations with IBM Rational products cannot be enabled using the Edit Integrations menu action from within the MKS Integrity Client. For IBM RAD 7.0 series applications, including IBM RAD, RSM, RSA, WDSC, and WDSC AE, integrations with MKS Integrity must be enabled using the Add Extension Location function from within the IDE application. This method also applies for integrations with Eclipse 3.2 and 3.3. For integrations based on Eclipse Platform 3.4 and 3.5, including IBM s Rational Architecture Management and Construction 7.5 solutions, such as RAD, RSA, and RSM, you enable the integration using the Add Site function. For more information, see To enable the MKS Integrity integration with Eclipse 3.4 on page 27. IMPORTANT To make use of a new version of the Eclipse integration, you must either configure Eclipse to perform updates automatically, or force a manual update to pick up the new version of the integration. In general, you can configure updates by selecting Help > Check for Updates. For more information on updating software, see the Eclipse product documentation. In addition to enabling the integration, the MKS Integrity Server must be configured to allow remote API connections to the server. 25

34 Chapter 4: IBM Rational Eclipse Platform After enabling the integration, you can also set general preferences and additional options related to change packages. This section discusses the following topics: Setting the MKS Integrity Server Connection Policy on page 26 Enabling the Integration on page 27 Setting Preferences on page 29 Configuring Change Package Options on page 31 Deactivating the Integration on page 31 Setting the MKS Integrity Server Connection Policy Before users can work with the IBM Rational Eclipse Platform integration, the administrator must configure the MKS Integrity Server to allow remote API connections to the server. This enables integration users to connect to and run commands on the server. The default connection policy allows only a specific set of IP addresses to connect. The required setting allows all clients to connect. The connection policy is specified in the following file on the MKS Integrity Server: <installdir>/config/client/integrityclientsite.rc where <installdir> is the path to the directory where you installed the MKS Integrity Server. To set the MKS Integrity Server connection policy 1 In a text editor, open the IntegrityClientSite.rc file. 2 Comment out the following default policy: daemon.connectionpolicy=mks.ic.common.policy. ICAllowSpecificConnectionPolicy 3 Uncomment the following policy: daemon.connectionpolicy=mks.ic.common.policy. ICAllowAllConnectionPolicy TIP To comment out a policy, insert a # symbol as the first letter of the property. To uncomment a policy, remove the # symbol. This allows all clients to request an API connection; however, all connecting clients still require the proper authentication. If there is a requirement to specify individual users who are allowed to connect, use a comma-delimited list of the user IDs to define the property for 26

35 Configuring the IBM Rational Eclipse Integration daemon.validuserslist. Using a comma-delimited list does not change the connection policy setting. 4 To have the changes take effect, restart the MKS Integrity Server. NOTE For more information on configuring the MKS Integrity Server to allow remote API connections, see the MKS Integrity 2009 Integrations Builder Guide. Enabling the Integration To enable the MKS Integrity integration with Eclipse 3.2/3.3, including IBM RAD 7.0 series 1 In Eclipse, select Help > Software Updates > Manage Configuration. 2 In the right display pane of the Product Configuration view, click the link for Add an Extension Location. 3 In the Browse for Folder directory, navigate to the following directory: <MKS Integrity Client installdir>/integrations/ibm/eclipse_3.2 4 where <MKS Integrity Client installdir> is the path to the directory where you installed the MKS Integrity Client. 5 Choose the eclipse directory and restart the workbench to enable the integration. NOTE To disable the MKS Integrity integration with IBM RAD or Eclipse, you must disable the extension location within IBM RAD 7.0 or Eclipse. To enable the MKS Integrity integration with Eclipse In Eclipse, select Help > Software Updates. The Software Updates and Add-ons dialog box displays. 2 Under the Available Software tab, click Add Site. The Add Site dialog box displays. 3 To select the directory where you placed your plug-ins as an extension location, click Local and navigate to the following directory: <MKS Integrity Client installdir>/integrations/ibm/eclipse_3.2 where <MKS Integrity Client installdir> is the path to the directory where you installed the MKS Integrity Client. 4 To enable the integration, check the box next to the newly-added integration and then click Install. Eclipse copies the selected plug-in to the Eclipse Features and Plugins directory. 27