I n t e g r i t y
M K S
I n t e g r i t y
2 0 0 9
Integrations User Guide
Copyright © 2001–2010 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.
C o r p o r a t e H e a d q u a r t e r s W o r l d w i d e O f f i c e s : 410 Albert Street
Waterloo, ON N2L 3V3 Canada
tel: 519 884 2251 fax: 519 884 8861
sales (toll free): 800 265 2797
www.mks.com
1815 South Meyers Rd. Suite 220
Oakbrook Terrace, IL USA 60181
tel: 630 827 4900 fax: 630 629 9167
sales (toll free): 800 633 1235 12701 Fair Lakes Circle Suite 350
Fairfax, VA USA 22033
tel: 1 703 803 3343 fax: 1 703 803 3344
sales (toll free): 1 800 637 8034 Martinstraße 42-44
73728 Esslingen Germany tel: +49 711 351775 0 fax: +49 711 351775 7555
Third Floor, Duke’s Court Duke Street, Woking Surrey
GU21 5BH United Kingdom tel: +44 (0)1483 733900 fax: +44 (0)1483 733901 sales: +44 (0)1483 733919 3 Killiney Road #07-05 Winsland House 1 Singapore 239519 tel: +65-6732-8768 fax: +65-6732-0768
5th Floor, Unosawa Tokyu Building 1-19-15, Ebisu, Shibuya-ku, Tokyo 150-0013, Japan tel: +81-3-5422-9503 fax: +81-3-5422-9509
Table of Contents
1 Introduction . . . 1
About This Guide. . . 2
Roles. . . 2
Assumptions. . . 3
New MKS Integrity 2009 Integrations . . . 3
Supported MKS Integrity Integrations . . . 4
Dropped Integrations . . . 5
Before You Begin . . . 6
Configuring Integrations . . . 7
Before Using an Integration . . . 8
Where To Go From Here . . . 10
P
ARTI: C
ODEG
EAR. . . .11
2 CodeGear Delphi Architect . . . 13
Key Considerations . . . 14
Configuring the CodeGear Delphi Integration . . . 14
Using the CodeGear Delphi Integration. . . 14
Delphi Architect Commit Browser . . . 16
Creating an MKS Integrity Project . . . 17
Creating a Sandbox . . . 17
Adding a Member to an MKS Integrity Project. . . 18
Checking Out Members . . . 18
Checking In Members . . . 18
3 CodeGear JBuilder . . . 19
P
ARTII: IBM . . . .21
4 IBM Rational Eclipse Platform . . . 23
Overview. . . 24
Supported Versions . . . 24
Before You Start . . . 25
Configuring the IBM Rational Eclipse Integration . . . 25
Setting the MKS Integrity Server Connection Policy . . . 26
Enabling the Integration . . . 27
Setting Preferences. . . 29
Deactivating the Integration. . . 31
Using the Integration. . . 32
Online and Offline Mode . . . 32
Setting Up an Integrated Workspace . . . 33
Working in an Integrated Workspace. . . 39
MKS Integrity Commands . . . 46
Refactoring . . . 52
Comparing Revisions . . . 53
Team Synchronizing . . . 54
Best Practices . . . 61
Limitations . . . 62
5 IBM Rational Rose . . . 65
Configuring the Rational Rose Integration . . . 66
Using the Rational Rose Integration . . . 66
Creating an MKS Integrity Project . . . 67
Creating a Sandbox . . . 68
Adding Members to an MKS Integrity Project . . . 68
Checking Out Members . . . 69
Checking In Members . . . 69
P
ARTIII: M
ICROSOFT. . . .71
6 Microsoft Visual Studio (SDK) . . . 73
Before You Start . . . 74
Setting Up and Configuring the Integration . . . 76
Enabling the Integration in the MKS Integrity Client . . . 76
Enabling the MKS Source Plug-In in Microsoft Visual Studio . 76 Toggling the MKS Toolbar . . . 77
Setting Preferences. . . 78
Working With Keywords . . . 78
Configuring the Location of Visual Studio Solutions and Projects in the MKS Repository . . . 79
Online and Offline Mode . . . 80
Working With Active Change Packages . . . 82
MKS Integrity Glyphs in Visual Studio . . . 83
Managing Work In Progress . . . 84
Managing Assigned Work . . . 89
Placing Visual Studio Solutions Under MKS Source Control . . . 90
Sharing a Visual Studio Solution. . . 90
Importing a Visual Studio Solution. . . 93
Migrating a Visual Studio Solution from the
MKS SCC Visual Studio Integration . . . 99
Ignoring Visual Studio Entities From MKS Source Control . . . 99
Branching a Visual Studio Solution . . . 101
Resynchronizing a Visual Studio Solution. . . 102
Reverting a Visual Studio Solution . . . 103
Checkpointing a Visual Studio Solution . . . 103
Viewing a Sandbox for a Visual Studio Solution . . . 104
Working With Visual Studio Files. . . 104
Adding Members to an MKS Integrity Project . . . 105
Dropping Members From an MKS Integrity Project . . . 105
Checking Out Members . . . 106
Checking In Members . . . 106
Renaming Members. . . 107
Moving Members. . . 108
Advanced MKS Integrity Commands . . . 109
Best Practices . . . 110
Limitations . . . 113
Troubleshooting . . . 114
7 Microsoft Visual Studio .NET . . . 115
Implementing the Integration . . . 116
Assumptions. . . 116
Required Permissions . . . 116
Implementing the New Project Structure. . . 117
Setting Up Projects to Reuse Code . . . 118
Setting Preferences. . . 120
Parallel Development Considerations . . . 121
Optimistic Locking . . . 121
Development Paths . . . 123
Building Projects . . . 124
Command Functionality. . . 124
Adding a Solution to MKS Integrity . . . 128
Adding a New Project to Source Control. . . 130
Joining Development of a Solution . . . 131
Adding Members to an MKS Integrity Project . . . 132
Checking Out Members . . . 132
Checking In Members . . . 133
8 Microsoft Visual Basic . . . 137
Using the Microsoft Visual Basic Integration . . . 138
Creating an MKS Integrity Project . . . 139
Creating a Sandbox . . . 140
Adding Members to an MKS Integrity Project . . . 140
Checking Out Members . . . 140
Checking In Members . . . 141
9 Microsoft Visual C++ . . . 143
Configuring the Visual C++ Integration . . . 144
Using the Microsoft Visual C++ Integration . . . 144
Creating an MKS Integrity Project . . . 145
Creating a Sandbox . . . 146
Adding Members to an MKS Integrity Project . . . 146
Checking Out Members . . . 146
Checking In Members . . . 146
10 Microsoft Project . . . 149
Overview. . . 150
Before You Start . . . 151
MKS Integrity Server Requirements . . . 151
Client Requirements . . . 151
Integration Components . . . 152
Assumptions. . . 152
Key Considerations . . . 152
Pre-installation Administration . . . 154
Configuring the MKS Integrity Server . . . 154
Configuring MKS Integrity . . . 156
Setting Permissions . . . 157
Modifying the Integration XML Mapping Template . . . 157
Installing the Microsoft Project Integration . . . 158
Repairing or Removing the Integration . . . 160
Microsoft Project Configuration . . . 160
MKS Custom Project Properties . . . 161
MKS Custom Project Fields . . . 162
Using Microsoft Project Server and Enterprise Resources . . . 163
Enabling SSL Communication . . . 164
Logging Configuration . . . 165
Using the Microsoft Project Integration . . . 165
Specifying Task Types. . . 167
Setting Task Relationships . . . 168
Synchronizing Selected Tasks . . . 171
Detecting Conflicts. . . 172
11 Microsoft Word . . . 173
Assumptions. . . 174
Overview of the Integration . . . 174
System Requirements . . . 176
Configuring the MKS Integrity Server . . . 177
Installing and Uninstalling the Integration . . . 178
Importing Document Structure Definitions. . . 179
Exporting Word Documents to MKS Integrity . . . 179
Troubleshooting . . . 182
Integration Errors. . . 182
Creating a Custom DSD for Other Document Types . . . 182
12 Microsoft Excel . . . 185
Overview. . . 186
Before You Start . . . 186
MKS Integrity Server Requirements . . . 187
Client Requirements . . . 187
Integration Components. . . 187
Assumptions. . . 188
Key Considerations . . . 188
Setting the MKS Integrity Server Connection Policy . . . 188
Installing the Microsoft Excel Integration . . . 189
Repairing or Removing the Integration . . . 191
Customizing the Microsoft Excel Integration . . . 191
XML Mapping Template . . . 191
MKS Custom Properties . . . 193
Logging . . . 194
Using the Microsoft Excel Integration . . . 194
Importing the XML Mapping Template. . . 195
Creating a New List. . . 196
Retrieving Items From MKS Integrity . . . 197
Synchronizing Data . . . 198
Synchronizing Using Queries . . . 199
Working With Requirement Documents . . . 200
Detecting Conflicts. . . 203
P
ARTIV: O
THER. . . .205
13 Sybase PowerBuilder . . . 207
Configuring the PowerBuilder Integration . . . 208
Using the PowerBuilder Integration . . . 208
Creating an MKS Integrity Project . . . 211
Creating a Sandbox . . . 211
Adding Members to an MKS Integrity Project . . . 211
Checking Out Members . . . 212
Checking In Members . . . 212
14 HP Quality Center Requirements and Defect Modules . 213 Integration Overview . . . 214
Assumptions. . . 215
System Requirements . . . 216
Integration Installation and Configuration Overview . . . 216
Step 1: Configuring the MKS Integrity Server. . . 217
Step 2: Configuring Quality Center. . . 219
Creating and Editing Projects . . . 219
Creating MKS ID Field for Requirements and Defects . . . 219
Creating Additional Requirements User Fields . . . 221
Setting the MKS Type in Quality Center . . . 222
Step 3: Configuring MKS Integrity . . . 222
Step 4: Installing the Integration . . . 223
Step 5: Configuring the Integration. . . 224
Modifying Process Configuration and Mapping Files . . . 226
Setting Up E-mail Notification. . . 228
Setting Up Attachment Handling . . . 229
Step 6: Running the Integration. . . 230
Troubleshooting . . . 231
15 Computer Associates AllFusion Endevor . . . 233
Understanding the Endevor Integration . . . 234
MKS Integrity Commands . . . 234
P
ARTV: A
PPENDIX. . . .237
A Configuring a Mapping Template . . . 239
Overview. . . 240
Mapping Template XML Elements . . . 241
1
C
H A P T E R
O
N E
Introduction
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
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 e-mail 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
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
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++ 6.0
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
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
6.0
IBM WebSphere Development Studio Client (WDSC) Advanced Edition for iSeries
6.0
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
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/
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.
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.
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 MKS Integrity 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
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 and Defect Modules” on page 213
HP Quality Center—Requirements Module “HP Quality Center Requirements and Defect Modules” on page 213
CA Endevor “Computer Associates AllFusion Endevor” on page 233
CodeGear
2
C
H A P T E R
T
W O
CodeGear Delphi Architect
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
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
The following table summarizes the available commands:
Command Function
Check Out Files Equivalent to the MKS Integrity Member > Check Out command. Checks out the selected file.
The MKS Integrity Check Out dialog box displays.
Check In Files Equivalent to the MKS Integrity Member > Check In command. Checks in the selected file.
The MKS Integrity Check In dialog box displays.
Add Files 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.
Remove Files 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.
Undo Check Out Files 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.
Commit Browser 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 > Createcommand.
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 Equivalent to the MKS Integrity Sandbox > Create command. Creates a Sandbox from a project on the server.
Run SCC Integration 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.
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:
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.
Action Function
No Activity No MKS Integrity command performed on the member.
Commit Equivalent to the MKS Integrity Member > Check In command. Checks in the member, updating the head revision.
Check Out Equivalent to the MKS Integrity Member > Check Out command. Checks out the head revision of the member.
Undo Check Out Equivalent to the MKS Integrity Member > Revert command. Reverts deferred operations.
Add Equivalent to the MKS Integrity Member > Add command. Adds members to a project.
Remove Equivalent to the MKS Integrity Member > Drop command. Drops members from a project.
Get Latest Equivalent to the MKS Integrity Member > Resynchronize command.
Gets the latest version of the selected file and puts it in your working directory.
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.
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.
3
C
H A P T E R
T
H R E E
CodeGear JBuilder
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 23.
IBM
4
C
H A P T E R
F
O U R
IBM Rational Eclipse Platform
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
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:
http://www.eclipse.org
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 www.ibm.com/developerworks/rational. 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.
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.
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.
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 3.4
1 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.
5 Restart the Eclipse workbench to enable the integration.
NOTE You can also use Eclipse drop-ins to add a plug-in. For more information on drop-ins, consult the Eclipse product documentation.
To enable the MKS Integrity integration with Eclipse 3.5
1 In Eclipse, select Window > Preferences > General > Capabilities and then choose the option for Classic Update. To accept the changes, click OK.
2 In Eclipse, select Help > Software Updates > Find and Install. The Install/Update dialog box displays.
3 Choose the option for Search for new features to install and click Next. The Install dialog box displays.
4 Click New Local Site and then navigate to the following directory:
<MKS Integrity Client installdir>/integrations/IBM/eclipse_3.2/ eclipse
where <MKS Integrity Client installdir> is the path to the directory where you installed the MKS Integrity Client.
5 Click OK and then Finish. The Updates panel displays. 6 Click OK. The Edit Local Site dialog box displays.
7 Click OK. The eclipse_3.2/eclipse site displays in the list. Ensure that it is
selected and click Finish. The Updates panel displays.
8 Select eclipse_3.2/eclipse, click Next, and follow the remaining steps of the installation.
9 To enable the integration, restart the Eclipse workbench.
NOTE If the preceding steps are not completed, the installation fails due to an error (“one or more required items can not be found”).
In some versions of Eclipse 3.5, the Capabilities menu may not be available. You can still enable the Classic Update option by performing the following steps:
1 Exit Eclipse and navigate to following folder:
<workspace>/.metadata/.plugins/org.eclipse.core.runtime/.settings/ 2 In a text editor, open org.eclipse.ui.workbench.prefs and add the following line:
Setting Preferences
Integration specific preferences allow you to select settings for MKS Integrity commands. The MKS Integrity preferences become the default.
In addition, the File Content and Ignored Resources preferences affect functions in your workspace related to the integration.
File Content preferences allow you to specify a file type and the type of content in that particular file (binary or ASCII content).
Ignored Resources preferences allow you to specify resource name patterns that you do not want to add to MKS version control. In addition, any file that is marked derived is ignored by MKS Integrity. To see if a file is marked derived, check the file’s properties.
Click Restore Defaults at any time to clear changes you made. To set MKS Integrity preferences
1 In your workspace, select Window > Preferences. The Preferences dialog box displays. 2 Under Team, select MKS Source. The MKS Source panel displays.
3 Make the necessary changes to the preferences:
NOTE Any modifications to change package preferences will require that you restart
your Eclipse workspace.
Updating non-locked files
Lock file performs the MKS Integrity Lock command, allowing you to edit the file. Enable this option to implicitly check out a file while editing it. This option is enabled by default.
NOTE If you are using non-exclusive locks, you can lock a file; however, other users
are not prevented from locking the same file.
Make file writeable performs the MKS Integrity Make Working File Writable command, allowing you to edit the working file, but not preventing other users from locking the file. Enable this option to edit a file locked by another user when you have no intention of checking the file back in. If you intend to check the file in later on, you can lock the file or associate the modified working file with a change package, and then submit your changes.
Use active Change Package specifies to use a default change package when performing MKS Integrity commands that use a change package. This option is enabled by default.
When performing MKS Integrity commands that require a change package, prompt for an active change package provides for prompting when performing any software configuration management operation that requires a change package, if there is no active change package context. The default setting for this option is false (disabled).
When this property is enabled, you are prompted to choose or create a change package if active change package tracking is enabled and there is no active change package set. If you do not choose or create a change package when first prompted, you are re-prompted when you attempt further file operations that normally require a change package (such as additional edits or saving the file). You are also prompted when creating or dropping subprojects, when moving or renaming files, when adding or dropping files, and when running the Sharing Wizard to add files. IMPORTANT To ensure the expected prompt messages when obtaining locks and
change packages, MKS recommends that change package options are configured consistently between the MKS Integrity Server and Eclipse (that is, if change packages are mandatory in Eclipse, then they are also configured as mandatory on the MKS Integrity Server). If the change package policies are not consistent, prompting may not occur as expected when locking and changing members.
Drop MKS Sandbox when Eclipse project is deleted specifies that if your Eclipse project is deleted, the associated MKS Sandbox is also dropped. The default setting for this option is false (disabled).
4 To set additional MKS Integrity preferences, click MKS Preferences. The Preferences Configuration dialog box displays.
5 Click Apply to save the changes.
6 Click OK to close the Preferences dialog box. To set File Content preferences
1 In your workspace, select Window > Preferences. The Preferences dialog box displays. 2 Under Team, select File Content. The File Content preferences display.
3 To add a file type, click Add Extension. To add a file type via a file name, click Add Name. To delete a file type from the list, click Remove. To modify the file type content, click Change.
4 To save the changes, click Apply.
5 To close the Preferences dialog box, click OK. To set Ignored Resources preferences
3 To add a pattern, click Add Pattern. To delete a pattern from the list, click Remove. 4 To save the changes, click Apply.
5 To close the Preferences dialog box, click OK.
Configuring Change Package Options
Once the integration is enabled, you can also configure the Show Successful Submit on the MKS Integrity Client. The Show Successful Submit option controls whether or not a confirmer dialog box is displayed to indicate the successful submission of a change package. By default, the Show Successful Submit option is cleared and the MKS Integrity Client GUI no longer displays the confirmer dialog box after successful submission of a change package. The confirmer dialog box is also suppressed by default in the MKS API.
NOTE The MKS Integrity Client command line interface continues to display the confirmer dialog box by default.
To modify the Show Successful Submit property in the MKS Integrity Client graphical user interface, select File > Edit Preferences and in the Preferences Configuration panel, edit the property under Configuration Management > Commands > Submit Change Package. To have the confirmer dialog box displayed in the GUI, select the option for Show Successful Submit. In the client command line interface, the syntax for this option is
--[no]showSubmitSuccessful.
Deactivating the Integration
To deactivate the MKS integration with Eclipse IBM platform, you remove the installed MKS software plugin.
For example, to deactivate the integration in Eclipse 3.5, select Help > About Eclipse SDK. In the About Eclipse SDK dialog box, click the Installation Details button. The Eclipse SDK Installation Details dialog box displays. Under the Installed Software tab, highlight the installed MKS software plugin and click Uninstall.
TIP You may also remove your integration update sites by selecting Windows > Preferences and under the Install/Update node, choosing Available Software Sites. In the Available Software Sites panel, highlight the MKS plugin
Using the Integration
This section provides information on how to use the MKS Integrity integration with Eclipse. The following topics are discussed:
“Online and Offline Mode” on page 32
“Setting Up an Integrated Workspace” on page 33 “Working in an Integrated Workspace” on page 39 “MKS Integrity Commands” on page 46
“Refactoring” on page 52
“Comparing Revisions” on page 53 “Team Synchronizing” on page 54
Online and Offline Mode
When you start Eclipse, the MKS Integrity Client automatically attempts to establish a connection with the MKS Integrity Server. If the client establishes a connection with the server, the integration is in online mode and all MKS commands and views are available. If the MKS Integrity Client cannot establish a connection with the MKS Integrity Server, or the previously established connection is lost, or the MKS Integrity Client becomes
unresponsive, you are prompted to switch to offline mode. Clicking Yes switches the integration to offline mode. Clicking No keeps the integration working in online mode without a connection to the server.
Offline mode allows you to continue working in Eclipse, performing only the MKS Integrity commands that do not require a connection to the MKS Integrity Server, such as editing a file (the file is made writable, but is not locked). With the exception of MKS > Work Online and MKS > Open MKS Client, all MKS views and commands that affect the MKS repository are disabled. When the server connection is re-established, you must manually switch from offline mode to online mode. Working in offline mode is recommended when you know that you do not have access to the server for long periods of time. For example, if you are working remotely without an Internet connection, you can work in Eclipse and then later connect to the server when an Internet connection is available, allowing you to synchronize your changes with the MKS repository.
Working in online mode without a connection to the MKS Integrity Server behaves similarly to offline mode, except that you do not need to manually switch from offline mode to online mode when the server connection is re-established. All MKS views and commands appear
on your desktop computer and the server suddenly goes down or there is a poor network connection, you can continue to work online in Eclipse without a server connection. When the server connection is re-established, all MKS commands and views automatically become active again, allowing you to resynchronize your changes with the MKS repository.
In the workbench, the MKS trim indicates online ( ) or offline ( ) status. For more information on the MKS trim, see “Working With Active Change Packages” on page 43. To toggle online and offline mode, select MKS > Work Online/Offline, or click the online or offline icons in the MKS trim.
In offline mode, note the following:
Switching from offline to online mode refreshes the entire workspace, resynchronizing all resources in the Eclipse project and retrieving the latest decorators. Depending on how many files or Eclipse projects are visible, this process may take a long time; however, it occurs in the background and does not prevent you from working in Eclipse. Depending on the information available in your resource cache before you switch to
offline mode, file decorators may not update correctly or at all when you select files or make changes to them. Locks made by other users, new revisions, and incoming changes do not update file decorators.
Outgoing changes can only be moved to change packages in online mode. You can refactor (add, drop, rename, or move) ignored resources.
MKS Integrity information does not display in Properties dialog boxes.
If the MKS Integrity Client becomes unavailable, for example, the process is terminated, the integration automatically switches to permanent offline mode. In this mode, no MKS menus, icons, or views are enabled, and you are forced to restart Eclipse to switch the integration to online mode.
Setting Up an Integrated Workspace
This section discusses the specific details of setting up projects in your integrated workspace, including placing projects under MKS version control, and working with Project Sets.
Placing Eclipse Projects Under MKS Version Control
Projects must be placed under MKS version control, which requires an MKS Integrity project and Sandbox. Using the Team Support approach, you can work through a wizard that creates the MKS Integrity projects and Sandboxes, and adds existing project files as members.
IMPORTANT When you create an MKS Integrity project and Sandbox, the project can
reside anywhere on the MKS Integrity Server, but the Sandbox must reside in the same directory as the Eclipse project.
Once an Eclipse project is under MKS version control, you can perform MKS Integrity operations, such as checking in files and checkpointing projects.
To create an MKS configuration management project and Sandbox in your workspace 1 In your workspace, select the Eclipse project you want to place under MKS version
control.
2 Right click and select Team > Share Project. The Share Project panel displays. 3 Select MKS as the repository type.
4 Click Next. The MKS Sharing Wizard displays. 5 Select one of the following options:
Activate the integration for an existing MKS Source Sandbox initiates MKS Integrity and opens the Sandbox you previously created in your workspace. This option is selected by default. If a Sandbox does not exist, this option is disabled.
Create a new Sandbox for an existing MKS Source project creates a new Sandbox for an existing MKS Integrity project under MKS version control. If you select this option, you are prompted to choose an MKS Integrity project and, optionally, a development path.
Create a new MKS Source project and Sandbox creates a new MKS Integrity project accessible to all users and a Sandbox in your Eclipse workspace.
6 By default, the option for Add all files when creating the new MKS Source project is enabled. You can disable this option if you want to manually add each file in your project to MKS version control.
This option is only available if you selected the Create a new MKS Source project and Sandbox option in step 5.
7 Click Next. The options for creating an MKS Integrity project display. 8 For the option you selected in step 5, choose one of the available options:
Create a new top-level MKS Source project and click Finish. The Specify Project dialog box displays. In the File name field, specify the name of the project you want to create on the MKS Integrity Server.
Create a new subproject of an existing MKS Source project and click Next. Choose the project to create the subproject against. Optionally, you can select one of the project’s development path. To create the subproject, click Finish.
9 If your project contains files and you are using change packages, you are prompted to specify a change package to associate with the files. Select an existing change package, or click Create to create a new change package, then click OK.
If you are not using change packages, proceed to the next step. The Create Archive dialog box displays.
10 Modify the Create Archive options.
NOTE If MKS Integrity finds an existing archive, the Existing archive detected
dialog displays.
MKS Integrity automatically creates a Sandbox with the project name in your Eclipse workspace.
11 If your project contains files and you associated them with a change package, you must commit them to the MKS repository by submitting the change package associated with the files via the Synchronize view. For more information, see “Team Synchronizing” on page 54. If your project contains file and you are not using change packages, submit the changes by selecting MKS > Submit Changes. For more information, see “MKS Integrity Commands” on page 46.
To import a project from MKS Integrity
If you want to start using an existing MKS project, you can import it to create a Sandbox in your workspace.
NOTE This is the only method of sharing a project that allows you to rename the project in your workspace. This enables you to import multiple versions of the same project.
1 In your workspace, select File > Import. The Select panel of the Import wizard displays. 2 Under MKS, select Projects from MKS.
3 Click Next. The Choose the MKS project to import panel displays.
4 Select the project to import. All Eclipse projects currently under MKS version control are listed.You can use the Filter field to filter the projects by name.
NOTE If an Eclipse project is missing from this list, it means that the project descriptor file (.project file) has not been put under MKS version control.
5 Specify the configuration of the project to import. If importing a variant project, specify the Development Path Name where the project is located. If importing a build project, specify the Revision number or Label applied to the project.
NOTE If you are importing a variant or build configuration of a project that you already have in your workspace, you must edit the project name in the Project Name
field since you cannot have two projects with the same name in the same workspace.
6 Specify the location to import the project to. This can either be the default workspace location or a location specified by you.
In either case, the projects are placed in:
selectedLocation/projectName
where projectName is the name of the project as specified in the Project Name field. NOTE The relative paths of imported projects are not maintained.
7 Edit the Project Name if required.
NOTE
If there are dependencies between projects, renaming the project will result in
compile errors.
The name in the .project file is not changed when you edit the project name in this field.
8 Click Finish.
A directory is created for the project in the specified location, a Sandbox is created within that directory and the Eclipse project files are added.
Importing an MKS Integrity project results in an identical Eclipse project structure and information within your workspace.
NOTE The Import wizard is only available if the Eclipse integration is connected to an MKS Integrity Server that uses the database repository option. If the integration is connected to a server that uses the RCS-style repository option, the Import wizard is not available and an error message displays when attempting to the run the wizard.
Sharing Projects With Project Sets
This includes the creation and population of the necessary Sandboxes, based on the
MKS Integrity projects referenced in the Project Set. Project sets provide a simple method for team members to share their workspaces.
Key Considerations
The Eclipse project must be under MKS version control before you create a Project Set. Once the .psf is created, do not attempt to edit this file.
You can export subSandboxes with Team Project Sets. Developers can share workspaces in their entirety. Importing a Team Project Set results in identical Eclipse project structure and information within the new workspace, and creates corresponding common root Sandboxes. For example, if a top level Sandbox and a subsandbox are exported using the Team Project Set feature, they are recreated in the same hierarchy when the Team Project Set is imported.
If a .project file is not under MKS version control and you attempt to export a Project Set, an error message displays (the .psf file is created, but is mostly empty). If the .project file is under MKS version control, but has been modified since it was last checked in, exporting the Project Set displays a warning message; however, the .psf file still exports. As long as the .project file exists, the import should complete
successfully.
If the .classpath file is not under MKS version control, any imported Java projects fail to compile because the build path does not include the JRE System Library. Once the .classpath file is in the project, subsequent imports include the new file.
To create a Project Set in your workspace
1 In your workspace, select File > Export. The Export wizard displays. 2 Under Team, select Team Project Set.
3 Click Next. The Team Project Set dialog box displays.
4 From the list, select the projects you want to include in the Project Set.
5 In the File name field, provide the path and file name for the .psf, or click Browse, to browse to a location.
6 Click Finish. The Project Set is created. The .psf is ready for distribution to other team members who can import it into their workspaces.
To import a Project Set
1 In your workspace, select File > Import. The Import wizard displays. 2 Under Team, select Team Project Set.
