PTC Integrity Integration With Microsoft Visual Studio (SDK) PTC provides a number of integrations for Integrated Development Environments (IDEs). IDE integrations allow you to access the workflow and configuration management functionality of Integrity while working within your favorite development environment. The PTC Integrity integration with Microsoft® Visual Studio® 2005/2008/2010/2012 (SDK) allows users to access Integrity commands through Visual Studio, providing a seamless development and configuration management experience. This guide discusses the following topics: “Before You Start” on page 2 “Setting Up and Configuring the Integration” on page 3 “Online and Offline Mode” on page 7 “Working With Active Change Packages” on page 8 “Integrity Glyphs in Visual Studio” on page 9 “Managing Work In Progress” on page 10 “Managing Assigned Work” on page 13 “Placing Visual Studio Solutions Under Integrity Source Control” on page 15 “Working With Visual Studio Files” on page 26 “Best Practices” on page 30 “Limitations” on page 32 “Troubleshooting” on page 33 “Getting Help” on page 33 IMPORTANT This release of Integrity changes the default installation directory of the Integrity Client, which affects integrations that were installed with earlier versions of the client. For more information, see the Integrity Integrations User Guide. Copyright © 2013 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved. 1 Before You Start Before you set up or use the integration, note the following: This guide assumes you know how to use Microsoft Visual Studio and Integrity. For more information about using a product, refer to the appropriate documentation. For suggested best practices on using the Visual Studio integration, you should read “Best Practices” on page 30. The integration works with the following: Windows 7, Windows Vista, Windows XP, Windows Server 2008/2003 Microsoft Visual Studio 2005, 2008, 2010, and 2012 Integrity 10 The Visual Studio integration is designed to use change packages for submitting source code changes to the Integrity repository. Ensure that change packages are enabled on the Integrity Server. To use change packages, the administrator must also enable Integrity for startup on the Integrity Server (mksis.startup.im=true). If change packages are mandatory, Integrity for workflows and documents functionality must be enabled (that is, the policy for IntegrityManagerEnabled must be set to true). For more information on setting properties and policies on the Integrity Server, see the Integrity Server Installation and Configuration Guide. The following Integrity Server configurations are supported per Visual Studio solution: one Integrity Server configured for workflows and documents, and for configuration management one Integrity Server configured for Integrity configuration management one Integrity Server configured for configuration management and one Integrity Server configured for workflows and documents Ensure that the Integrity Client path is set correctly for the PATH environment variable (that is, the Integrity Client’s <installdir>/bin path appears first). Failure to set the path correctly displays a Package Load Failure error in Visual Studio. In addition, do not disable packages in Visual Studio. Disabling packages prevents you from selecting Integrity as the source control provider. If you are using an older version of the Visual Studio integration, disable the integration in Visual Studio and the Integrity Client before you upgrade to the new Visual Studio integration. To enable the new integration, see “Setting Up and Configuring the Integration” on page 3. If you have a Visual Studio solution that was placed under Integrity source control using the previous SCC-based Visual Studio integration, you can migrate it for use with this version of the integration. For more information, see “Migrating a Visual Studio Solution from the MKS SCC Visual Studio Integration” on page 21. If you are upgrading from MKS Integrity 2007 SP 4 or earlier, this release of the Visual Studio integration does not use the MKS Worktray and MKS Change Package view found in previous releases of the Visual Studio integration. To improve management of work in progress and assigned work, this release uses Integrity Work In Progress and Integrity Items views. To use the Integrity Items view, one of your Integrity Servers must be configured for 2 workflows and documents. For more information, see “Managing Work In Progress” on page 10 and “Managing Assigned Work” on page 13. When using the Integrity integration with Microsoft Visual Studio, ensure that the necessary Access Control List (ACL) permissions are granted to users. For example, users adding Visual Studio solutions to Integrity source control require the following permissions: CreateProject ModifyProjectAttribute CreateSubproject For more information on configuring ACLs for Integrity, see the Integrity Server Installation and Configuration Guide. If you are working in a single Integrity Server environment, you should disable prompts for server information and credentials in the Integrity Client. This provides a more seamless experience with the Visual Studio integration. If you are working in a multi-server environment, you should disable prompting for credentials, but enabling server prompting so that you can connect to the appropriate Integrity Server. If you do not disable prompting, Visual Studio displays prompts for server information and credentials when you perform Integrity commands. Failure to disable prompting for credentials may display errors when attempting to share a Visual Studio solution. To disable prompting in the Integrity Client, see the Integrity Getting Started Guide. To avoid potential focus problems when using Visual Studio, close the Integrity Client window, but do not shut down the client. Setting Up and Configuring the Integration This section describes how to set up and configure the Microsoft Visual Studio integration for use with Integrity. Installing the Visual Studio Integration Supported versions of Visual Studio that are currently installed are registered for use with Integrity when you run the Visual Studio integration installer. NOTE If you install another supported version of Visual Studio after you install the integration, you can register the version of Visual Studio by doing the following: From the Control Panel > Add or Remove Programs list, select Integrity Integration for Microsoft Visual Studio and click the link for Click here for support information. Click Repair. The Visual Studio integration registers the version of Visual Studio you installed. Before you install the integration, ensure that: A supported version of Integrity is installed (“Before You Start” on page 2). Visual Studio is shut down. If Visual Studio is running during the installation, it must be restarted after the installation completes to take effect. 3 If you are currently using the Visual Studio integration available in Integrity Client 2007 SP5 or 2009, disable the integration in the Integrity Client. To remove the Visual Studio integration on Windows Vista Enterprise, you must run the Integrity Client as an administrator, and then disable the integration. To install the Visual Studio integration 1 Run Integrity_VS_Integration.msi. The Integrity Integration for Microsoft Visual Studio Setup wizard displays. 2 Click Next. 3 Choose a directory to install the integration in. By default, the integration is installed in C:\Program Files\Integrity\Integrations\Visual Studio. 4 Click Next. 5 To install the integration click Install. 6 To exit the Setup Wizard, click Finish. Enabling the Integrity Plug-In in Microsoft Visual Studio Visual Studio supports various source control providers. You must specify Integrity as the source control provider. 1 In Visual Studio, select Tools > Options. The Options dialog box displays. 2 Select Source Control > Plug-in Selection. 3 From the Current source control plug-in list, select Integrity. 4 Click OK. The Integrity toolbar, Integrity Items, and Integrity Work In Progress views display. If desired, dock the views to a location of your choice in Visual Studio. For more information on the Integrity toolbar, see “Working With Active Change Packages” on page 8. For more information on using the Integrity Items view, see “Managing Work In Progress” on page 10. For more information on using the Integrity Work In Progress view, see “Managing Assigned Work” on page 13. Toggling the Integrity Toolbar The Integrity toolbar displays connection status, a change package list, and toolbar buttons for managing changes to Visual Studio solutions and managing change packages. By default, the Integrity toolbar appears docked when you select Integrity as the source control provider. 4 To toggle the Integrity toolbar 1 In Visual Studio, select Tools > Customize. The Customize dialog box displays. 2 From the Toolbars tab, toggle Source Control - Integrity. The Integrity toolbar disappears or displays in Visual Studio. 3 Click Close. Once an open solution is under Integrity source control (see “Sharing a Visual Studio Solution” on page 15), the toolbar buttons in the Integrity toolbar become active. For more information on connection status, see “Online and Offline Mode” on page 7. For more information on managing change packages, see “Working With Active Change Packages” on page 8. For more information on managing changes to Visual Studio solutions, see “Resynchronizing a Visual Studio Solution” on page