ESP Alchemist Version 5.3.1 SCC Client Interface User’s Guide AL-5.3.1-SCCUG-01 First Edition (October 2005) This edition applies to Version 5 Release 3 Maintenance Revision 1 of ESP Alchemist. The software and related manuals are protected by copyright law. ESP Alchemist Documentation © Copyright 2000-2005 Cybermation International Distribution SRL All rights reserved. No portion of this publication may be reproduced, stored in a retrieval system or transmitted in any form or by any means without the express written permission of Cybermation International Distribution SRL www.cybermation.com U.S. Government Users. RESTRICTED RIGHTS - Use, Duplication or Disclosure restricted by the GSA ADP Schedule Contract with Cybermation USA, Inc., a subsidiary of Cybermation International Distribution SRL. Trademark Notice ESP Alchemist is a registered trademark of Cybermation International Inc. Cybermation is a registered trademark of Cybermation, Inc. z/OS and Visual Age for Java are registered trademarks of IBM Corporation. Windows, Visual Studio, and Visual Studio .NET are registered trademarks of Microsoft Corporation. All other brand and product names are trademarks or registered trademarks of their respective companies. Contents Who should use this guide ................................................................................. 2 IDE application developers .......................................................................... 2 Alchemist administrators.............................................................................. 2 Conventions and terminology ............................................................................ 2 Related documentation ...................................................................................... 3 Documentation updates..................................................................................... 3 1 Using the Installation Wizard 5 Before you start.................................................................................................. 6 Verify software versions................................................................................ 6 Gather required information ........................................................................ 6 Record this information as you install .......................................................... 7 Installing the Alchemist plug-in and Data Transfer Server.................................. 7 Installing the software from a CD-ROM...................................................... 7 Installing the software from the Cybermation website.................................. 7 Configuring the DTS connection to Alchemist.................................................. 7 DTS initialization file syntax and parameters ............................................... 8 Establishing alternate Alchemist host connections........................................ 8 Uninstalling the software.................................................................................... 9 Changing the Default Source-Code Control Provider........................................ 9 Logging in to Alchemist through the SCC Client Interface.............................. 10 Login fields ................................................................................................ 11 Changing your Alchemist password.................................................................. 11 AL-5.3.1-SCCUG-01 iii Alchemist change password fields ............................................................... 12 2 Using the Alchemist SCC Client Interface 13 Alchemist function summary............................................................................ 14 Using the SCC Client Interface with a standard IDE....................................... 14 Setting up your project............................................................................... 14 Sharing your project................................................................................... 15 Adding projects or files to source control.................................................... 22 Checking in files ........................................................................................ 23 Checking out files ...................................................................................... 23 Undoing the checkout................................................................................ 23 Getting latest version.................................................................................. 23 Refreshing status ........................................................................................ 23 Using the SCC Client Interface with VisualAge for Java .................................. 24 Setting up your project............................................................................... 24 Adding projects to Alchemist ..................................................................... 25 Refreshing projects..................................................................................... 26 Sharing projects in VisualAge for Java ........................................................ 26 Using the SCC Client Interface with Visual Studio .NET................................ 27 Setting up your project............................................................................... 27 Adding solutions to Alchemist.................................................................... 29 Checking out an existing solution for the first time.................................... 30 Working with an Alchemist-controlled solution......................................... 30 Checkout on edit ....................................................................................... 30 Refreshing projects..................................................................................... 31 Working with previous file versions............................................................ 31 Sharing projects in Visual Studio .NET ..................................................... 31 Changing how Alchemist processes your files ............................................. 32 3 Basic Concepts in Alchemist 33 SCC API.......................................................................................................... 34 What Alchemist does ....................................................................................... 34 Preserves code assets ................................................................................... 34 Manages change ......................................................................................... 34 Automates builds ....................................................................................... 35 Zones............................................................................................................... 35 Division by purpose ................................................................................... 35 Zone hierarchy........................................................................................... 35 Files and entities............................................................................................... 35 Entity lifecycle............................................................................................ 36 Change Requests.............................................................................................. 36 Entity locking ............................................................................................ 37 Alchemist Agents.............................................................................................. 37 4 Error Messages 39 Alchemist SCC Client Interface messages......................................................... 40 iv AL-5.3.1-SCCUG-01 Contents IDE-generated error messages .......................................................................... 41 Alchemist Server error messages ....................................................................... 41 AL-5.3.1-SCCUG-01 v vi AL-5.3.1-SCCUG-01 About This Guide The SCC Client Interface User’s Guide explains the concepts behind Alchemist’s organization and its SCC interface. It also describes the actions you carry out in the SCC Client Interface. AL-5.3.1-SCCUG-01 1 Section–Who should use this guide Who should use this guide This guide is intended for application developers who use Alchemist SCC Client Interface to perform source-code control tasks, IDE application developers, and Alchemist Administrators who configure and troubleshoot the interface. IDE application developers To effectively use the Alchemist SCC Client Interface to perform source-code control tasks, you must be familiar with: • Your Integrated Development Environment (IDE) source-code control conventions • Windows conventions You do not need to be familiar with Alchemist’s user or administrative functions. Alchemist administrators To effectively use this guide to assist in SCC Client Interface trouble-shooting, you must be familiar with: • Alchemist administrative and user functions • Alchemist operational environment It will also be helpful to be familiar with the Windows operating-system conventions and general IDE source-code-control conventions. Conventions and terminology Typographical conventions Convention Usage Bold Indicates a menu item, field name, or other text you see on the screen. Courier Indicates text that you type in a field or on a command line, a path or URL name, or syntax of a command, definition file, or script. italics Indicates variables that you define. Product terms Term Usage ISPF Interface Refers