Enterprise Application. Version Control Guide. Unisys. Copyright 2003 Unisys Corporation. All Rights Reserved. Release 3.3. March

Transcription

1 Enterprise Application Version Control Guide Unisys Copyright 2003 Unisys Corporation. All Rights Reserved. Release 3.3 March

2 NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THIS DOCUMENT. Any product or related information described herein is only furnished pursuant and subject to the terms and conditions of a duly executed agreement to purchase or lease equipment or to license software. The only warranties made by Unisys, if any, with respect to the products described in this document are set forth in such agreement. Unisys cannot accept any financial or other responsibility that may be the result of your use of the information in this document or software material, including direct, special, or consequential damages. You should be very careful to ensure that the use of this information and/or software material complies with the laws, rules, and regulations of the jurisdictions with respect to which it is used. The information contained herein is subject to change without notice. Revisions may be issued to advise of such changes and/or additions. Notice to Government End Users: The software and accompanying documentation are delivered and licensed as commercial computer software and commercial computer software documentation as those terms are used in 48 C.F.R and 48 C.F.R through , as applicable. The Government shall receive only those rights provided in the standard commercial software license, or where applicable, the restricted and limited rights provisions of the contract FAR or DFARS (or equivalent agency) clause. Correspondence regarding this publication should be forwarded to Unisys Corporation by addressing remarks to Product Information, Australian Centre for Unisys Software, Locked Bag 3111, Rhodes, NSW 2138, Australia. Comments about documentation can also be sent through to eae.pi@unisys.com. All terms which may be mentioned in this document that are known to be trademarks or service marks have been appropriately capitalized. Unisys Corporation cannot attest to the accuracy of this information. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark. Unisys, LINC, INFOConnect, ClearPath, and PowerClient are registered trademarks, and e-@ction Griffin are trademarks of Unisys Corporation. EPSON is a registered trademark of Seiko Epson Corporation. HP and HP-UX are registered trademarks of the Hewlett-Packard Company. IBM, DYNIX/ptx, AIX and RS/6000 are registered trademarks of International Business Machines Corporation. JADE is a trademark of Aoraki Corporation Limited. Micro Focus and Net Express are registered trademarks of Merant International Limited. Microsoft, Windows, Windows NT, and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. ORACLE and SQL*Plus are registered trademarks of Oracle Corporation. SPARC is a registered trademark of SPARC International, Inc. Products bearing SPARC trademarks are based on an architecture developed by Sun Microsystems, Inc." SQL Server is a trademark of Sybase, Inc. or its subsidiaries Sun, Java and Solaris are registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark in the U.S. and other countries, licensed exclusively through X/Open Company, Ltd. UnixWare is a registered trademark of The Santa Cruz Operation, Inc.

3 Contents Section 1. Introduction About This Guide Introduction to Version Control Version Control Features The Configuration Wizard User Maintenance Integrity Management Management of Version Bank Objects Branching Merging Labelling Release Management Reporting Import and Export Wizards Implementing Version Control Single Developer Repository Multiple Developer Repositories Section 2. Installing Version Control Software Requirements Upgrading from an earlier release of Version Control Hardware Requirements Sizing Guidelines for the Version Control Bank Overview of Installation Installing the Version Control Server Step 1: Run the Version Control Server Installation Step 2: Reboot Your Machine Step 3: Continue Installing the Version Control Server Step 4: Create the Version Control Users Step 5: Determine the Machine Name of the Version Control Server Files Installed Configuring the Version Bank Running the Configuration Wizard Welcome Page Database Page Population Page Analyze Page Database Configured Page Databases Not Configured Page Universe Page Finish Page Installing the Version Control Client iii

4 Contents Uninstalling the Version Control Server Summary Section 3. Administering Version Control The Administrator s Role Adding Users to the Version Control Bank Userids and Passwords Adding Users with UREP Version Control User Maintenance Viewing the Version Control Users List Defining a New Version Control User Version Control User Dialog Box Deleting a Version Control User Changing a Version Control User s Role Changing a Version Control User s Password Version Control Password Dialog Box Changing Your Version Control Password Specifying the Number of Users Monitoring the OSMOS Database Backup and Recovery Migrating the Version Control Bank Archiving Version Bank Data Exporting Version Bank Data Export Wizard Export Utility Importing Version Bank Data Import Wizard Import Utility SGML2XML Utility Shutting Down UREP Administrator s Workbench Summary Section 4. Security for Version Control Version Control and Developer Security Restricting Access Rights to Administrators Auditing The Audit Query Facility Setting Integrity Management Security and Integrity Management Restrictions on Load Operations Summary Section 5. Project Management with Version Control What Is Branching? Merging Branches What Is Labelling? Version Labels Branch Labels Labelling Recommendations iv

5 Contents Building a Product Release Example Project Management Project Management with Merging Independent Parallel Project Management Sequential Project Management Copying a Project Summary Section 6. Getting Started in Version Control Logging on to Version Control Version Control Login Dialog Box Setting Version Control Options Smart Check In and Smart Check Out Version Control Options Dialog Box Setting Branch Search Options Search Order Options Dialog Box Setting Multiple Check Out Options Multiple Check Out Settings Dialog Box The Version Control Explorer Explorer Icons Explorer List View Printing from the Explorer Printing a Specification of an Object Customizing Branch Information Display Branch Display Option Dialog Box Version Control Status Window Saving the Status Window Contents Version Control Logging Using the Object Count Auditor Object Count Auditor Dialog Box Select Objects Dialog Box Summary Section 7. Using Version Control What is a Versionable Object? Model Definitions Global Data Dictionary Items Business Segment Definitions Local Data Dictionary Items Global Setup Data Items Global Setup Data Item Blocks Functional Areas Activities Ispecs Keywords Global Logics Profiles Reports v

6 Contents Wildcards Adding Elements to the Version Control Bank Adding an Individual Element to Version Control Checking In an Element Checking Out an Element Getting an Element Getting the Latest Revision Getting the Latest Revision from the Main Branch Getting a Revision Getting a Revision By Label Undoing a Check Out Using Container Operations Container Operations - Adding Element(s) to Bank Container Operations - Checking In Container Operations - Checking Out Container Operations - Get Latest Revision Container Operations - Get Latest Revision From Main Branch Container Operations - Undo Check Out Managing Version Bank Objects Rolling Back to a Revision Deleting an Object Displaying Deleted Objects Changing Color for Deleted Objects Undoing a Delete for an Object Purging an Object Working with Version Labels Working with Branch Labels Working with Integrity Management Viewing Version Control Properties Version Control Properties Dialog Box (Model) Version Control Properties Dialog Box (Container) Version Control Properties Dialog Box (Revisions) Version Control Properties Dialog Box (Labels) Version Control Operations Dialog Boxes Branch/Version Label Maintenance Dialog Box Check Outs Dialog Box Colors Dialog Box Confirmation of Overwrite Dialog Box Go Dialog Box Labelling Items Dialog Box Merge Confirmation Dialog Box Select Version Label Dialog Box Undo Check Out Dialog Box Version Control Add/Check In File(s) Dialog Box Version Control Get/Checkout File(s) Dialog Box Version Control - Message Dialog Box Scope of EAE-MS SCCAPI based Version Control System EAE-MS SCCAPI Based Version Control System Overview of Version Control EAE-MS SCCAPI Based Version Control System Setting Up EAE-MS SCCAPI Based VCS vi

7 Contents Software Requirements Setting Up EAE-MS SCCAPI Based VCS for SVN Setting Up EAE-MS SCCAPI Based VCS for ClearCase Setting Up EAE-MS SCCAPI Based VCS for Team Foundation Server (TFS) Basic Operations in EAE-MS SCCAPI Based VCS Adding Element(s) to Version Control Bank Checking Out an Element Undoing a Check Out Viewing the Difference in the Developer Repository with the Source Control Before Performing Check In from the Developer Viewing the Contents of the mdl File Using Command Prompt Comparing the mdl Files Using Command Prompt Merging Two Files Using Command Prompt Viewing the Content of the File Using TortoiseSVN Viewing the Content of the File Using Visual Studio Team Explorer (TFS) Viewing the Content of the File Using Source Control Client (ClearCase) Comparing Different Revisions of an mdl File Using TortoiseSVN Comparing Different Revisions of mdl Files Using Source Control Explorer Checking In an Object Getting the Latest Revision from Version Control Bank Get Latest Revision Container Operation Other Features Enforce Integrity History Explorer Configuration for SVN on Windows Server 2003 in 32-Bit and 64-Bit Platforms Getting the Latest Revision from EAE VC Bank to EAE-MS SCCAPI Based VCS Migrating EAE Developer Repository with EAE-MS SCCAPI Based VCS to another EAE Developer Repository More on EAE-MS SCCAPI Based VCS Setup Details LINC.ini Options under VERSION CONTROL Section for SVN.7 63 LINC.ini Options under VERSION CONTROL Section for ClearCase LINC.ini Options under VERSION CONTROL Section for TFS Using the GUI to Set LINC.ini Options Creating Local SVN Repository and Synchronizing it with the Local Work Directory of SVN Synchronizing the Local Work Directory with the Server in TFS VC Operations with EAE-MS SCCAPI Based VCS Setting Up an Environment with SVN Rep on Remote Machine and Performing VC Operations Setting Up an Environment with VC Bank Remote Machine for TFS Advantages of EAE-MS SCCAPI Based VCS vii

8 Contents Limitations of EAE-MS SCCAPI based VCS Unable to Suppress the Message from Source Control Provider from TFS Unable to Cancel the Add Operation from the Source Control Provider Precaution while Using VCSameWorkspace LINC.ini Option with TFS Connection Delay with PushOk SVN SCC Features Not Available in EAE-MS SCCAPI Based VCS Summary Section 8. Using Developer Console Developer Console Startup Parameters Developer Console Window Settings Pane Log Pane Command Line Field Commands Generic Commands Developer Commands Version Control Commands Developer Console Scripting Sample Developer Console Script Comments Error and Warning Messages Error Messages Warning Messages Log File Settings Summary Section 9. Viewing Differences and Merging Introduction to the LCIF Viewer Viewing Differences Viewing the Differences Between Objects and Revisions Viewing Differences Between Files Difference Options Dialog Box View Differences Dialog Box Select an Object Dialog Box Creating a Differences Report Creating a Report on Differences between Objects Creating a Report on Differences across Specifications Viewing Specifications Viewing Objects or Revisions Viewing a Specific File Select an MDL File Dialog Box LCIF View Dialog Box Extracting To Show Differences or View Specifications Merging Merging Two Revisions viii

9 Contents Merging Revisions, Objects, or Files Merging Two Files Merge Dialog Box Merge File Options Dialog Box Merge Options Dialog Box Merge Result Dialog Box Version Control Merge Description Dialog Box Changing Display Attributes Display Attributes Dialog Box Summary Section 10. Using Version Control Queries What Can I Search For? Creating a Query Editing a Query Saving a Query Adding a Query to the Query Menu Deleting a Query Running a Query Query Scope and Results Combining Queries Creating an Advanced Query Maintaining the Query Menu Version Control Query Dialog Boxes Advanced Query Designer Dialog Box Menu/Query Maintenance Dialog Box Version Control Query Designer Dialog Box Summary Appendix A. Troubleshooting...A 1 Reporting Problems... A 3 Appendix B. Related Product Information... B 1 Index... Index ix

10 Contents x

11 Section 1 Introduction This section contains overview information about this guide and the Unisys Enterprise Application Developer Version Control software product. This section includes: About This Guide Introduction to Version Control Version Control Features Implementing Version Control About This Guide Purpose This document is prepared as a guide to all tasks relating to Developer Version Control: Installation of the Version Control Server and Client Administration of Version Control Use of Version Control Audience This document is written for: Administrators who install and maintain Developer Version Control. Engineers who use Developer to create Enterprise Application applications. Introduction to Version Control Version Control is an optional Developer feature that provides source control of versionable Enterprise Application objects such as Model definitions, data dictionary items, Ispecs, Profiles, and Reports. Version Control stores each version of an object so that you can access and use earlier versions if required

12 Introduction The hub of Version Control is the Version Control Bank. The Version Control Bank is a file storage facility that holds controlled copies of objects, but it does not replace the Developer Repository. The Version Bank supports source control services, such as locking and maintaining the history of an object, while the Repository functions as a work area where copies of the controlled objects are modified and tested before being moved back into the Version Bank. Versionable objects in the Developer Repository are not automatically protected by Version Control. You must add the objects to the Version Control Bank. You can add an individual object, or you can add a group of related objects using Container Operations. For example, a Business Segment can be added to the Version Control Bank along with all its versionable children -- Ispecs, Reports, Data Items, and Global Logics. The use of Container Operations is important because the Version Control Bank does not know about the relationships between objects. You must make sure that when you add an object to Version Control, that all its related objects are also added. Once an object is added to the Version Control Bank, if you want to modify that object and keep track of its revisions, you must check it out. The Check Out procedure loads a copy of the object from the Version Control Bank into the Repository, where you can modify it. That object is then locked under your userid in Version Control. When you check in a modified object, a new revision or version of the object is created in Version Control. You can also get an object, ie. take a copy without checking it out, but the object is not locked and can be checked out and modified by another user. Version Control also allows you to undo a check out, unlocking an object without checking it in. Only the user who checked out the object or the Version Control Administrator is permitted to undo a checkout. Version Control Features The features of Developer Version Control include: The Configuration Wizard User Maintenance Integrity Management Management of Version Bank Objects Branching Merging Labelling Release Management Reporting Import and Export Wizards

13 Introduction The Configuration Wizard After the successful installation of the Version Control Server, a default Version Control Bank is created. You must configure the default Bank for your requirements, and Version Control provides a Configuration Wizard to step you through this process. The Wizard also provides default values for the number of elements that will be used to calculate database requirements. You can accept these values or modify them. When all values have been entered and the Wizard has generated the required files, you have the option of viewing the calculated disk space allocation. You also have the option of postponing the final configuration step. This means that you can use the Configuration Wizard to enter various estimates and see the resulting space calculations before performing the actual configuration of the Version Control Bank. Once the Bank is configured, you can rerun the Wizard at any time to reconfigure the Bank. See Running the Configuration Wizard for details on using this tool. User Maintenance Following the installation of Version Control, a Version Control Administrator must define Developer users to the Version Control Bank. This can be done using UREP Administrator s Workbench, or it can be done using the VC user maintenance facilities within Developer Security. With these facilities you can: Login or logoff from the Version Bank. Change your own password. Add or delete Version Bank users, reset user passwords, or change a user s role. (These functions are available to Version Control Administrators only.) In addition, a new user can be added to Developer and to the Version Bank in the same operation. Integrity Management Integrity Management is an optional feature designed to ensure that the Developer Repository is synchronized with the Version Bank. This is accomplished by protecting controlled objects, that is, objects which have been added to the Version Bank. Protection is provided by identifying any controlled object which has not been checked out from the Version Bank as being read-only

14 Introduction If a user attempts to change an object, either directly or indirectly, when Integrity Management for the system is on, then that user will be prompted to take action to maintain the integrity of the Version Bank. For example: If a user adds a new versionable object to the Repository, a prompt will suggest that the object also be added to the Version Bank. If a user updates a local Dictionary Data Item and the Data Item is used in an Ispec, the user will be prompted to check out the Ispec before the update of the Data Item will be committed. There is a performance overhead when using Integrity Management. Management of Version Bank Objects Version Control offers standard functions for managing objects in the Version Bank, including: Rolling back changes to an object. Marking an object as deleted to exclude it from Version Control operations temporarily. Undoing a delete. Purging an object to remove it from the Version Bank permanently. See Managing Version Bank Objects for more information about these functions. Branching Branching is a feature of Version Control that allows a set of revisions to a versionable object to be kept separate from a different set of revisions for the same object. You might use branching if, for example, you are developing different versions of an Ispec for different clients. When you add an object to the Version Control Bank, a main branch is created for that object. When you check the object out, modify it, and check it in again, you are given the option of creating a new branch into which the object will be checked. Merging The merge feature in Version Control allows you to merge two objects, an object and a file, or two files. An object can be a revision in the Version Bank or an object in the Developer Repository. A Repository object can be either controlled or not controlled

15 Introduction A merge in the Version Bank can only be performed on two latest revisions of an object from different branches. To do this you specify whether revision A is to be merged into revision B, or revision B into revision A, in order to create a new revision on the branch of the target revision. See Merging Branches for more information about this type of merge. Merges between two items that are not revisions result in an LCIF format file that can be saved to a specified directory or loaded into the Repository. Labelling While Version Control automatically assigns unique numbers to branches and revisions of an object in the Version Bank, you can also define your own short names for these items. The Version Control Explorer displays branches and revisions with their labels in an expandable hierarchical structure. Release Management The ability to assign a version label to a number of objects means that Version Control can assist you with release management. To build a product release, you would: Ensure that all revisions of objects to be included in the release have been labelled with the version label identifying them for that release, for example UNIXRel2V1. Perform a Get operation to retrieve all revisions with version label UNIXRel2V1 from the Version Bank. When you perform the Get, you can opt to load all the retrieved revisions into the Repository, then use Builder to define a System and generate directly to a target host. You can alternatively create an extract file, load it to a target host, then generate the new system on the host machine. See Building a Product Release for more information about release management. Reporting The Version Control Reporting feature enables you to interrogate the Version Control Bank or the Developer Repository by building a query with an easy-to-use dialog. You can construct a query to search for objects based on the author s name, object name, object description, date last modified, status, or label. Wildcard searches are supported. The results of the search are displayed in a list window. From this window you can perform Version Control operations, direct the list to a printer, or print the specification of a versionable object. Your queries can be saved and added to a Query menu for reuse

16 Introduction Import and Export Wizards Version Control provides easy-to-use wizards for exporting data from your Version Banks and for importing data into a new or existing bank. These tools enable you to back up or recover a Version Bank as well as to migrate existing Version Banks to a newer release of Version Control. You have the option of exporting or importing part of your data, and you can also remove data from your bank following an export operation. The Export Utility and Import Utility command line tools available in earlier releases are still supported. The Version Control export tools create a file that is readable by the current and all subsequent versions of the import tools. Upgraded utilities will be included with each new release of Developer Version Control. Implementing Version Control This section shows two examples of how Version Control can be implemented at your site. With a single Developer Repository and one Version Control Bank With multiple Developer Repositories and one or more Version Control Banks Single Developer Repository Developer Repository and one or more Version Control Bank(s)

17 Introduction In this illustration: 1. Developer executables are located in an application directory on a LAN file Server. 2. The Developer Repository and Developer Server are on the same workstation. All Developer Client workstations use this Developer Repository. 3. Developer Client workstation 1 starts a Developer session and logs into a Version Control Bank on the UREP machine. 4. The Developer Repository is committed to the Version Control Bank selected by Developer Client workstation 1. When this happens, to eliminate the possibility of corrupting the relationships that exist between Enterprise Application objects, other users are warned that they should not commit the Developer Repository to any other Version Control Bank. 5. When Developer Client workstations 2 through n start their Developer sessions and need to use Version Control, they should only log into the same Version Control Bank to which the Developer Repository was committed when Developer Client workstation 1 logged into Version Control. Multiple Developer Repositories Multiple Developer Repositories and Version Control Banks In this illustration: 1. Developer executables are located in an application directory on a LAN file Server. 2. The Developer Server is located on its own dedicated workstation

18 Introduction 3. Because all Developer Client workstations, 1 through n, have individual Developer Repositories. Each user can log into a separate Version Control Bank. Therefore, when Client workstation 1 starts the Developer session and logs into a Version Control Bank, the only Developer Repository committed to that Version Control Bank is the one on that workstation. 4. When Developer Client workstations 2 through n start their Developer sessions and need to use Version Control, because their Developer Repositories are not committed to any specific Version Control Bank they are able to select any available Version Control Bank. Note: If your work environment follows this example, you should be connecting and working with the same Version Control Bank as other users working on the same Model

19 Section 2 Installing Version Control This section gives an overview of the installation process, then describes in more detail how to install and configure the Version Control Server, which supports the Version Control Bank, and how to install the Version Control Client on the user s workstation. This section includes: Software Requirements Upgrading from an earlier release of Version Control Hardware Requirements Overview of Installation Installing the Version Control Server Configuring the Version Bank Running the Configuration Wizard Installing the Version Control Client Uninstalling the Version Control Server Software Requirements The following table lists the software requirements for the Version Control Client and Server workstations. Software Requirement Operating System Windows 2000 operating systems: Windows 2000 Professional (Service Pack 1), for single users Windows 2000 Server Windows 2000 Advanced Server, for multi-users Windows 2000 DataCenter Note: You are not restricted to using the same version of Windows for the Server and Client. For example, you can run Windows 2000 Professional on the Client workstation and Windows 2000 Server on the Version Control Server

20 Installing Version Control Comms protocols and services Other Software Requirement TCP/IP (mandatory if you use a multi-user Repository, and for a single-user setup if a LAN file server is used) RPC Services Internet Information Server (IIS) or Peer Web Services (PWS) UREP 5.1 is required for Version Control Server Upgrading from an earlier release of Version Control Upgrading from any of the earlier releases of Version Control requires migration of your existing Version Control Bank to this release. See Step 1: Run the Version Control Server Installation and Migrating the Version Control Bank for more information. Hardware Requirements The Version Control Server software is installed either on the same machine as the Developer Server, or on a separate machine altogether. If Version Control and the Developer Server are on the same machine, the requirements will be greater than indicated in the specifications below. The following table lists the hardware requirements for the Version Control Server. Hardware Requirement Processor Small workgroups 2 x Pentium II 333 MHz Medium workgroups 4 x Pentium III 500 MHz Large workgroups 8 x XEON 500 MHz RAM Small workgroups MB Medium workgroups MB Large workgroups MB Disk space UREP 5.1 software requires 500 MB (minimum) The UREP runtime installation may go into an infinite loop if you attempt to install it to a hard disk with less than the required space available. You should manually check that you have adequate disk space before starting the Version Control Server installation. Version Control Bank requires 440 MB (minimum) When the OSMOS database is created, it pre-allocates the hard disk space required. As you add objects to the Bank, the pre-allocated space is used up, but more space is allocated automatically when it is required; that is, the database grows itself. This procedure is described in the Universal Repository Administration Guide

21 Installing Version Control Hardware Requirement Other Paging file 300 MB, plus an additional 10 MB per connection to Version Control Server CD-ROM Drive ISO 9660 format SVGA monitor Sizing Guidelines for the Version Control Bank These sections contain guidelines to use when planning the size of your Version Control Banks. Determining the Page File (Virtual Memory) Size Set the page file size to 300MB for medium sized Developer Repositories that are being versioned in the Version Bank. A medium sized Developer Repository would be approximately 100MB in size (the extract file for the whole Model) with about 7000 versionable objects. The table below contains guidelines for page file sizes for various Developer Repository sizes. Developer Repository Size (Measured using Developer Extract File) Recommended Page File size Number of Users Small (50MB) MB 2-6 Medium (50-100MB) MB 2-8 Medium (50-100MB) 400MB upwards 8 Add 20MB for every additional user Large (100 MB upwards) 400MB upwards 8 Add 20MB for every additional user Determining the Version Control Bank Size To determine the optimal configuration of the size of the Version Bank, see Running the Configuration Wizard. Overview of Installation Developer Version Control is a client/server application, and so the installation procedure requires two steps, in this order: 1. Install the Version Control Server 2. Install the Version Control Client on the workstation

22 Installing Version Control During the installation of the Server, which is handled by the InstallShield Wizard for Version Control Server, the Unisys Universal Repository (UREP) is installed. UREP manages the OSMOS database which is the Version Control Bank. Following the successful creation of the Version Control Bank, the Configuration Wizard runs automatically to assist you in calculating the requirements and performing the configuration of the new Bank. The Version Control Client runs on a workstation that has Developer installed. You can install the Client at the same time that you install Developer or at a later time. See Installing the Version Control Client for details of installing the Client only. Information about installing Developer can be found in your Unisys Enterprise Application Developer Installation and Configuration Guide. Note that while the Developer CD includes the Version Control software, Version Control is a separately licensed product. You will be required to input a key during the installation of the Version Control Client. Following the successful installation of the Version Control Client on your workstation, you will need to ensure that the UREP Administrator has added you as a new user to the Version Control Server. Installing the Version Control Server Follow the steps below to install the Version Control Server: Step 1: Run the Version Control Server Installation Step 2: Reboot Your Machine Step 3: Continue Installing the Version Control Server Step 4: Create the Version Control Users Step 5: Determine the Machine Name of the Version Control Server Note: The Version Control Server installation procedure does not check disk space availability. The UREP runtime installation may go into an inifinite loop if you attempt to install it to a hard disk with less than 300MB available. You should manually check that you have adequate disk space before starting the Version Control Server installation. Step 1: Run the Version Control Server Installation Notes: 1. If you decide to cancel the installation of UREP, it is recommended you cancel prior to the installation of the services. If you cancel the installation, check that there is no evidence of UREP in the registry

23 Installing Version Control 2. Installing the Version Control Server on a Kanji machine requires UREP 5.1 to be installed separately Installing where an earlier version exists If you have a previously installed earlier version of Version Control (release 2.3, 2.4, or 3.1), you must perform the following steps: 1. Ensure that no users are logged in and all Developer Clients are shut down. 2. You can verify this by checking that no instances of urepserver.exe are present in the Windows Task Manager process view. 3. Export your existing Version Bank using the Export Utility as described in the documentation of the existing version of Developer Version Control. 4. Uninstall the existing Version Control installation and UREP. 5. Install the Version Control Server by running the Unisys Installation Interface and selecting the VC Server option. This starts the InstallShield Wizard for Version Control Server. Follow the instructions on the screen. 6. Import your old Version Bank data using the Import Utility or the Import Wizard for this release. Installing for the first time Select the VC Server option from the Unisys Installation Interface. This starts the InstallShield Wizard for Version Control Server. Follow the instructions on the screen. The UREP Runtime installation is started. During the UREP installation process, you are prompted to provide Account, Domain, and Password information to the UREPinetd service. Enter an Account, Domain, and Password combination that has sufficient privileges to enable it to start a service. Normally a user in the Administrators group has the required privileges. The OSMOS installation also asks for user credentials. Note: If you change the password for this Windows user account, you will also need to change this user's password for this UREPinetd service. Step 2: Reboot Your Machine A dialog box is displayed, asking you whether you want to reboot your machine now or later. Select the Reboot now radio button and click OK to reboot your machine immediately. You cannot continue installing the Version Control Server until you have rebooted your machine

24 Installing Version Control Step 3: Continue Installing the Version Control Server Once your machine has rebooted, Server installation continues automatically (providing you have logged on as the same Windows user). During this part of the installation: The UREP ozgrfnuni setup is called to create the universe. Files for the Version Control Server are copied. Icons are created for: The Configuration Wizard Import and Export Wizards Uninstallation Program At this point in the installation the Configuration Wizard runs, and you are prompted to enter values for the Wizard to calculate and perform the Version Bank configuration. The Configuration Wizard prompts you to enter a Version Bank name. This name is also the name of the UREP Repository, and is required during installation of the Version Control Client. Note: Only standard alphanumeric characters and underscores are allowed in the Version Control Bank name. If you use spaces or other characters, the Version Control Server installation returns an error message. Click Finish to complete the Configuration Wizard. You can now create the users for the Version Control Server (see Step 4: Create the Version Control Users). If Installation Fails If this part of Version Control Server installation fails for any reason, you can restart it from the VC Server shortcut icon located in your Start menu. To restart installation: 1. Click Start in the task bar. 2. Choose Programs, then Startup. The VC Server shortcut is in the Startup menu. 3. Double-click on the VC Server shortcut to initiate the second phase of Version Control Server installation (that is, the phase described in this step). Note: The VC Server shortcut is created in the first phase of Version Control Server Installation, which is described in "Step 1: Run the Version Control Server Installation". This shortcut is deleted automatically when installation of the Version Control Server completes successfully

25 Installing Version Control Step 4: Create the Version Control Users You have three options for adding users to Version Control. If the user has already been defined to Developer you can use the Version Control user maintenance facilities to add the user to Version Control as well. Another option if the user has already been defined to Developer is to open the UREP Administrator s Workbench and add the user to Version Control. If the user has not yet been defined to Developer, you can add the user to Developer and to Version Control in one operation using Developer Security. See your Unisys Enterprise Application Developer Administration Guide for details. After you have added users to the Version Control Bank, installation and configuration of the Version Bank is complete. Continue to Step 5 below to determine the machine name of the Server. Step 5: Determine the Machine Name of the Version Control Server Follow these steps to find out the machine name of the Version Control Server: 1. Click Control Panel. 2. Double-click on Network to display the Network dialog box, and select the Protocols tab. 3. Select TCP/IP Protocol from the list of network protocols. 4. Click Properties to display the Microsoft TCP/IP Properties dialog box. 5. Select the DNS tab. The machine name is displayed in the Host Name edit box. Files Installed The following table shows the files that are installed during installation of the Version Control Server: In the Bin directory LDAVC_num.dll LDAVC_os.dll LDAVC10.dtd LDAVC20.dtd LDAVCExport.exe In the Work directory LDAVC.msg LDAVC.sec LDAVCsql.odl LoadSchema.bat copying.sp LDAVCImport.exe LDAVER.dll

26 Installing Version Control In the Bin directory In the Work directory sp130.dll LDAVC_srv.dll zlib.dll LDAVCConfigurationWizard.exe reorgvcbank.exe LDAVCServerResources.dll LDAVCImportExport.dll LDA_LCIF_COM.dll SGML2XML.EXE LCIFENG.HLP VCENG.HLP Configuring the Version Bank Version Control provides a Configuration Wizard to help you configure the Version Control Bank created during the Server installation procedure. The Wizard can also be run at any time to reconfigure existing Version Banks. Configuration relates to elements such as: Enterprise Application Objects Revisions Branches Labels Number of Users The population, or number, of these elements determine several requirements for the underlying database, such as partition size. The Configuration Wizard takes care of these database calculations for you, and asks you to provide an estimate of the population of the various elements. These estimates are used by the Wizard to determine the appropriate characteristics of the Version Bank. The Wizard guides you through each step of the configuration process, as well as providing default values which you may accept or modify. Note that the values you enter for a new Version Bank on the Population Page will restrict the number of objects that can be created in the database, so you should not reduce these values in order to reduce the size of the Griffin universe. If you want to reduce the size of the universe, modify the universe configuration file (custom_uni.cfg)

27 Installing Version Control that is generated by the configuration process. Since the universe will expand automatically, there is no need to increase the universe size, although there is no harm in doing so. You can run the Wizard and opt to postpone the final configuration step, effectively using the Wizard to calculate disk space requirements for project planning purposes. If you are a new user and do not have an existing Version Bank, it is recommended that you accept the default values calculated by the Wizard in the generated configuration files. If you are a user with an existing Version Bank, you can either accept the default values or examine your existing database and decide on appropriate values for your new bank. In either case, when your Version Bank becomes full, Version Control will give an error message, and you will need to run the Configuration Wizard again to reconfigure the bank. Running the Configuration Wizard The Configuration Wizard runs automatically as part of the Server installation procedure, as described in Installing the Version Control Server. You may also run the Configuration Wizard at any time after the installation of the Server software to reconfigure your Version Bank. Before starting the Wizard, ensure all users are logged off from Version Control. To run the Wizard: Select the Configuration Wizard from the Windows Start menu, or If you are logged on to Developer on the Server machine, select Version Control Server Tools from the Version Control menu, then select Configuration Wizard. When you run the Wizard, follow the instructions which the Wizard provides at each step of the configuration. If you need additional assistance, follow the detailed instructions below or click Help on each dialog page. Each dialog page includes a Back and Next button, where appropriate, which allows you to return to the previous page or move to the next page. A Cancel button is also provided if you wish to stop the configuration and exit from the Wizard. The first screen presented is the Welcome Page. The Wizard automates and simplifies basic configuration requirements of the UREP Repository. Detailed information on the UREP Repository can be found in the Universal Repository Administration Guide. Welcome Page The Welcome Page advises you that the Configuration Wizard has begun. Use this page to specify whether you are creating a new Version Bank or reconfiguring an existing bank

28 Installing Version Control The fields displayed are: Create a new version bank Select this radio button if you are creating a new bank. Reconfigure an existing version bank Select this radio button if you are reconfiguring a bank. Existing data will be retained. Select an option and click Next to go to the Database Page. Database Page The Database Page allows you to select an existing Version Bank or enter the name of a new one. There is only one field for the Version Bank name. The names of existing Version Banks are displayed in the drop-down list even if you chose to create a new Version Bank. If you select an existing name, the Wizard will ask if you want to overwrite the selected Version Bank. Note: Do not attempt to reconfigure databases that are not Version Banks. If you do, the Wizard will crash. After specifying the name of a Version Bank, click Next. If you are configuring a new Version Bank, the Wizard displays the Population Page. If you are reconfiguring an existing bank, the Wizard displays the Analyze Page. Population Page The Population Page contains the Object Types for which population estimates are needed for the Wizard to calculate the configuration characteristics. Default values can be accepted, or new values entered. Note that the names of the Object Types cannot be edited. Versionable Objects All objects for which versions or revisions can be made. Such objects include: Model Definitions Global Data Dictionary Items Business Segment Definitions Local Data Dictionary Items Root Global Setup Data Items Global Setup Data Item Blocks Functional Areas Activities

29 Installing Version Control Ispecs Global Logics Profiles Reports Wildcards MDL File Size Size of the.mdl file in megabytes. To edit the values displayed, double-click on an existing entry and key in the new value. Note that the values you specify on this page will restrict the number of objects that can be created in the new database, so you should not reduce these values in order to reduce the size of the universe. If you want to reduce the size of the universe, modify the universe configuration file (custom_uni.cfg) that is generated by the configuration process. Since the universe will expand automatically, there is no need to increase the universe size, although there is no harm in doing so. After you have made your selections and edited the values, click Next to move to the Database Configured Page. Analyze Page The Analyze Page is presented following the Database Page if you are reconfiguring an existing Version Bank. This page presents a table of Object Types along with their current population values, percent occupancy, and suggested new values. The new values can be edited. The columns in the table are: Object Type Objects for which population figures are displayed are: Versionable Objects Revisions Sub Branches Branch Labels Version Labels MDL File Size (MB) Current Value Current population values, or, for MDL File Size, current size in megabytes. Occupancy Percent of current maximum value that is filled. For example, if you have 1000 revisions and an occupancy rate of 50%, you could add another 1000 revisions before exceeding your maximum population limit. Note that an occupancy figure for Versionable Objects cannot be determined

30 Installing Version Control New Value Suggested new maximum population value calculated by the Wizard according to the following guidelines: If occupancy is less than 40%, then the New Value is set to half the current maximum value. If occupancy is greater than 60%, then the New Value is set to double the Current Value. If occupancy is 40% - 60%, then the New Value remains the same as the current maximum value. The New Value for Versionable Objects is always set to double the Current Value because an occupancy figure cannot be determined for Versionable Objects. The table below shows examples of new values calculated by the Wizard. Current Value Occupancy Current Maximum Value (not shown on screen) New Value % % % To edit the new values, double-click on an existing entry and key in the new value. Click Next to go to the Database Configured Page. Database Configured Page The Database Configured Page is presented: After the Population Page if you are configuring a new Version Bank. After the Analyze Page if you are reconfiguring an existing Version Bank. This page informs you that the Configuration Wizard has enough information to configure the database and asks you what action you want to take next. The fields displayed are: I want to create another version bank. Select this radio button to create another Version Bank. I want to reconfigure another version bank. Select this radio button to reconfigure another Version Bank. This option is the default if any existing Version Banks have not been configured

31 Installing Version Control I have finished configuring my version banks, and want to move to the next step. Select this radio button to configure the Griffin Universe for the (re)configured Version Banks. This option is the default if all Version Banks have been configured. After making your selection, click Next. If you chose to create or reconfigure another Version Bank, the Wizard displays the Database Page. If you chose to move to the next step and you have no unconfigured Version Banks, the Wizard displays the Universe Page. If you have Version Banks that have not been configured, the Wizard displays the Databases Not Configured Page listing these banks. Databases Not Configured Page The Databases Not Configured Page is presented after the Database Configured Page if you chose to create the Griffin Universe for your Version Bank(s) but some of your Version Banks have not yet been configured. These unconfigured banks are listed. Click Yes, if you want to proceed with creating the Griffin Universe for your configured database, leaving the configuration of the listed databases for later. The Wizard automatically saves the contents of the unconfigured databases. The Universe Page is displayed. Click No, if you want to configure the unconfigured databases now. The Wizard displays the Database Page for you to specify the name of the database to be configured. Universe Page The Universe Page contains the information and values which the Wizard needs to finalize the calculations for the configuration of the Version Control Bank. There are two parts to the Universe Page. Each part can be selected by clicking on the relevant tab. Partition Tab Contains the name and size in megabytes of the primary partition. Miscellaneous Tab Contains the size in bytes of the cache and the number of users of the Version Bank. After you have made your selections, click Next to go to the Finish Page

32 Installing Version Control Partition Tab In the Partition Tab window, the Wizard displays a primary partition for the Version Bank and its size to the nearest 10 megabytes. The partition size has been calculated from the population estimates for the objects specified in previous steps. You cannot modify the size of a partition. If you wish the size to be different from the one calculated, modify the universe configuration file (custom_uni.cfg) generated by the configuration process. You can modify the default name given to the partition by the Wizard. To do this, double-click on the partition name and key in a new name. You may also specify a different location for the partition on the Server by entering a full path name, or clicking >> to browse for the location. Note that the default location created is %GRFNDIR%\DBS\%GRFNUNI%. It is recommended that you only use a single partition to store your data, since the use of multiple partitions causes disk fragmentation and may result in the Wizard calculating insufficient space. If limited disk space makes additional partitions a requirement, however, they can be created. To create another partition, check the second disk partition check box. The Wizard will create another partition, and the size will be equally distributed between the two partitions. Additional partitions can be created by checking the last partition name in the list. Again the partition size will be equally distributed among the total number of partitions created. Miscellaneous Tab The Miscellaneous Tab window displays the cache size and the number of users for the universe (not just one Version Bank). The default values can be changed to suit your requirements. However, you should not reduce the size of the cache significantly or system speed may be compromised. To edit the default value for either the Cache Size or Number of Users, double-click on the existing entry and key in a new value. Finish Page The Finish Page advises you that the Wizard is now ready to configure your Version Bank(s) and lists the files that will be generated. At this time you are given the option to generate the files, but postpone the actual configuration until a later time. The files to be generated are: <versionbankname>_wiz.dbd file (one file for each Version Bank configured) custom_uni.cfg configure.cmd These files are generated in the directory in which the Wizard is run, which is by default the %UREPDIR%\work directory

33 Installing Version Control Check the Do not (re)configure Version Bank at this stage check box to postpone configuration. Note: If you want to go ahead with configuration, your existing universe will be dropped. Back up your data before configuring. If you wish to see the required disk space allocation that the Configuration Wizard has estimated, click Disk Space Usage. This displays a message showing disk space allocation in megabytes for the Audit Partitions, Data Partitions, and the total disk space. After you have made your selections, click Finish to complete the operation of the Wizard. If you have chosen not to configure the Version Bank at this time, the Wizard generates the required files and closes. <versionbankname>_wiz.dbd file The <versionbankname>_wiz.dbd file contains the population values for the various classes and relationships in OSMOS. The file contains the OSMOS database commands that indicate physical properties of the classes and other entities in OSMOS. custom_uni.cfg The custom_uni.cfg file is the universe configuration file shipped with Developer Version Control with the data partition information updated from the selections made during the previous steps of the Wizard. This file contains information used to create a universe, for example cache size, partitions and their sizes. configure.cmd The configure.cmd file is a Windows-based batch file that contains the commands used to perform the reorganization of the Version Bank. You can edit this file using a text editor to modify the actions carried out by the command file. For instance you may not wish to drop an existing universe at this time. If you wish to modify the file prior to the Version Bank being configured by the Wizard, ensure that you check the Do not (re)configure the Version Bank at this stage check box before clicking Finish. You may then run the command at a later time from the DOS command line. The configure.cmd file performs the following tasks: 1. Backs up existing databases (if any). 2. Drops existing universe. 3. Creates new universe. 4. Reloads backed up data. 5. Creates new Version Banks (if any). 6. Configures Version Banks to be configured

34 Installing Version Control Sample configure.cmd file Text in bold contains databases that will be operated on. Text in italics must be commented out if you do not want to not drop the off :init set configure_error=0 set databases_to_retain=a24bank1,a24bank2,a24bank3 set databases_to_create= set databases_to_reconfig=a24bank3 :backup_dbs rem backup each database in databases_to_retain grfncmd "start;" for %%i in (%databases_to_retain%) do call :backup_database %%i if not _%configure_error% == _0 goto exit_error :create_uni echo creating the universe... grfncmd "stop;" if exist %UREPDIR%\Dbs\%GRFNUNI% grfncmd "drop universe;" grfncmd "create universe custom_uni.cfg;" if not _%errorlevel% == _0 goto exit_error :restore_dbs rem restore previously backed up databases... for %%i in (%databases_to_retain%) do call :restore_database %%i grfncmd "start;" if not _%configure_error% == _0 goto exit_error :create_dbs rem create each database in databases_to_create for %%i in (%databases_to_create%) do call :create_database %%i if not _%configure_error% == _0 goto exit_error :reconfig_dbs rem reconfigure each database in databases_to_reconfig for %%i in (%databases_to_reconfig%) do call :reconfig_db %%i if not _%configure_error% == _0 goto exit_error :finish echo version bank has been reconfigured goto restart_universe :backup_database echo backing up %1 into %1.dmp... grfncmd "dump static database OZ%1, database %1 to %1.dmp;" if not _%errorlevel% == _0 set configure_error=1 goto done :restore_database echo restoring %1 from %1.dmp... grfncmd "restore database %1, database OZ%1 from %1.dmp;" if not _%errorlevel% == _0 set configure_error=1 goto done :create_database echo creating %1... urepcreate -d %1 if not _%errorlevel% == _0 set configure_error=1 urepload -d %1 -s %UREPDIR%\work\ldavc.sec -x %UREPDIR%\work\ldavc.msg -m LDAVC if not _%errorlevel% == _0 set configure_error=1 goto done :reconfig_db echo reconfiguring %

35 Installing Version Control ozutility -dg %1_wiz.dbd if not _%errorlevel% == _0 set configure_error=1 goto done :exit_error echo error configuring version banks goto restart_universe :restart_universe grfncmd "stop;" net stop "OsmosGriffin Service" > nul net start "OsmosGriffin Service" > nul pause goto done :done Postponing Configuration The option to postpone configuration of the Version Bank is specified by the check box Do not (re)configure Version Bank at this stage on the Finish screen of the Configuration Wizard. In most cases you will want the Wizard to perform the configuration. However, there may be instances when you do not want to have the Version Bank configured immediately. For example, you may wish to edit the configure.cmd file to alter the default process of the batch file. In order to postpone the configuration or reconfiguration of the Version Bank, check this check box. To perform the configuration or reconfiguration at a later time, run configure.cmd from the DOS command line. Installing the Version Control Client The instructions below assume that Developer has already been installed on your workstation. For information about installing Developer, see your Unisys Enterprise Application Developer Installation and Configuration Guide. To install Version Control Client on your workstation: 1. Run the Unisys Installation Interface and select the Developer option. 2. Click Next on the InstallShield Wizard for Enterprise Application Developer and Yes on the Licensing Agreement. 3. Select a Custom installation and click Next. 4. Select Version Control Client from the list box in the Select Components dialog box. When you select an item from the list box, a check mark appears to the left of the selected item. Uncheck all other options. Click Next. 5. In the Enter License Information dialog box, enter the Version Control license key and License expiry date. Click Next

36 Installing Version Control 6. In the Version Control Server Information dialog box: Key in the name of the machine where the Version Control Server is located. Key in the Version Control Bank name. Click Next. 7. In the Installation Configuration dialog box: Key in or browse for the installation directory where the Developer software is to be installed. Key in or browse for the working directory where the configuration files are to be installed. Key in or browse for the Repository directory where the Repository files are to be installed. Select a Single user or Multi user Repository. Click Next. 8. Select the required program folder from the list box in the Select Program Folder dialog box, or leave the displayed default. Click Next. The installation process will be initiated. After the installation has completed, a dialog box may be displayed asking whether you want to reboot your machine now or later. Select the Reboot now radio button and click OK to reboot your machine immediately. The files installed in the Developer installation directory by the Version Control Client installation are: LDAVC_com.dll LDAVC_oc.dll oncrpc.dll RSM_oc.dll zlib.dll The file ldalicense.dat is installed in the Developer working directory. This file contains the license key you entered during installation. Uninstalling the Version Control Server To uninstall the Version Control Server: 1. From the Windows Start Menu choose Version Control Server/Uninstall Version Control Server

37 Installing Version Control 2. From the Windows Start Menu choose Universal Repository/Uninstall UREP. Note: The above steps must be taken in the order in which they are listed. Any files that are not removed during the UREP and OSMOS uninstall process will need to be removed manually. Summary After completing this section you can: Understand the hardware and software requirements of Version Control. Use the Developer Installation Wizard to install the Version Control Server. Run the Version Control Configuration Wizard to configure or reconfigure a Version Control Bank. Use the Developer Installation Wizard to install the Version Control Client on a workstation. Uninstall the Version Control Server

38 Installing Version Control

39 Section 3 Administering Version Control This section describes the tasks required to administer the Version Control Server once it has been successfully installed and configured. The tools provided to assist you with these tasks are also explained. This section includes: The Administrator s Role Adding Users to the Version Control Bank Version Control User Maintenance Specifying the Number of Users Monitoring the OSMOS Database Backup and Recovery Migrating the Version Control Bank Archiving Version Bank Data Exporting Version Bank Data Importing Version Bank Data SGML2XML Utility Shutting Down UREP Administrator s Workbench The Administrator s Role Unisys recommends that you appoint a Version Control System Administrator to be responsible for setting up and maintaining your Version Control Server. Version Control uses the existing Developer extract and load processes to create.mdl files from versionable Enterprise Application objects and stores these files in the Version Control Bank. To ensure that your Version Control operations are successful, you should be familiar with the extract and load processes described in the Unisys Enterprise Application Developer Administration Guide. Because the Version Control Bank is a UREP Repository, you need to understand the UREP Repository, its underlying database OSMOS, and how to handle the routine administration of your Version Control Server. UREP documentation is listed in Related Product Information

40 Administering Version Control To prevent possible corruption of the UREP Repository, you should ensure that only the Version Control System Administrator has access to the UREP administration functions such as adding and deleting users. Adding Users to the Version Control Bank Once the Version Control Server is installed, you can connect users to the Developer Version Control Bank: Using the UREP Administrator s Workbench. Using Developer Security s Version Control User Maintenance facilities. This subsection describes how to add users with the UREP Administrator s Workbench. Userids and Passwords The user s current Developer userid should also be the userid for the Version Control Bank. The Version Bank userid is case-sensitive. Make sure this userid is set up exactly as the Windows or Developer userid, or login to Version Control will fail. When you add a user to the Version Bank, a default password that is the same as the userid is created. For example, if userid JOHN is added, the default password is JOHN. If userid John is added, the default password is John. Developer also assumes that a user s password is the same as the userid. If Version Control passwords are changed, then Developer will prompt the affected users for the new passwords when they attempt to login to the Version Control Bank. Adding Users with UREP Follow these steps to add users to the Version Bank: 1. Open the UREP Administrator s Workbench by selecting UREP Admin WB from the Programs/Universal Repository folder of the Start Menu. 2. Log in to your database using the name that you gave it on the second screen of the Version Control Configuration Wizard. Note that this name is case-sensitive. 3. Click Create on the main window. 4. Type in the Windows login id for each user to be added. If users of Version Control are administered from Developer Security, type in the usercode and password of each Developer Security user instead. 5. Click OK, and exit from the UREP Administrator s Workbench

41 Administering Version Control Version Control User Maintenance Using Developer Security you can perform a number of tasks to add Developer users to a Version Control Bank and maintain this list of users, including: View a list of Version Bank users and their assigned roles. Add a user to the Version Bank. Remove a user from the Version Bank. Change a Version Control user s role. Change a Version Control user s password. Assign multiple check out privileges to a user. To perform these functions, you must be defined as a Version Control Administrator, and you must be logged on to Version Control. All Version Control users with access to Developer Security are permitted to change their own passwords. A new user can be added to Developer and Version Control in the same operation. See Defining a User in your Unisys Enterprise Application Developer Administration Guide for details. Viewing the Version Control Users List To display a list of all users defined to your Version Bank, select the User Administration command on the Version Control menu of Developer Security. The Version Control Users List is displayed, listing the following information for each person: User Id Role Multiple Check SysAdmin for Version Control Administrator, User for other users Yes for users permitted to check out revisions that are checked out by other users, No for other users The Edit menu available from the list includes options to add or delete a user, change the user s role, change the user s password, change the user s multiple check out privileges, or to search the list for a specific usercode. These tasks are described in the following subsections

42 Administering Version Control Defining a New Version Control User To add an existing Developer user to Version Control: 1. Select the User Administration command on the Version Control menu of Developer Security. The Version Control User List is displayed. 2. Select the Add User command from the Edit menu of the list window. The Version Control User dialog box is displayed. 3. Key in a usercode in the Usercode field, or use the drop-down list to select a Developer user. 4. Leave the Usercode as password check box checked if you want the user s password to be the same as the usercode. Uncheck the Usercode as password check box to specify a different password. Key in the password in the Password field and again in the Verify field. 5. Check the Administrator check box if the new Version Control user is to have administrator privileges. 6. Check the Allow Multiple Checkout check box if the new user is to be permitted multiple check out privileges, that is, to check out objects that are already in checked out status. Note that setting multiple check outs on or off for all users of the Version Bank (using the Multiple Check Out Settings dialog box) overrides this setting for the individual user. 7. Click Next to define another user, or click OK to close the dialog. Version Control User Dialog Box Use the Version Control User dialog box to add an existing Developer user to the Version Control Bank. You must be a Version Control Administrator to do this. Selecting the Add User command from the Version Control User List displays the Version Control User dialog box. The fields on this dialog box include: Usercode Key in the new user s usercode, or use the drop-down list to select a usercode. Usercode as password Check this check box if you want the user s password to be the same as the usercode. Password If the Usercode as password check box is not checked, you must enter a password for the new user

43 Administering Version Control Verify Enter the same password that you entered in the Password field. Administrator Check this check box if the new Version Control user is to have Administrator privileges. Allow Multiple Checkout Check this check box if the new Version Control user is permitted multiple check out privileges (allowed to check out objects that are already checked out by other users). Usercode Key in the new user s usercode, or use the drop-down list to select a usercode. Usercodes for all Developer users who have not yet been added to Version Control are available on this list. Usercodes are alphanumeric with a maximum length of 20 characters. They can contain upper and lower case characters, but no spaces are permitted. Usercode as password Check this check box if you want the user s password to be the same as the usercode. Checking this check box disables the Password and Verify fields below. Leave this check box unchecked if you want to specify a password different from the usercode. By default this check box is unchecked. Password If the Usercode as password check box is not checked, you must enter a password. The entry in this field is hidden text, with each character represented by an asterisk (*). If the Usercode as password check box is checked, this field is disabled. Passwords are alphanumeric with a maximum length of 10 characters. They are casesensitive and no spaces are permitted. Verify Enter the same password that you entered in the Password field. The entry in this field is hidden text, with each character represented by an asterisk (*). If the Usercode as password check box is checked this field is disabled

44 Administering Version Control Administrator Check this check box if the new Version Control user is to have Administrator privileges. By default, this check box is unchecked. Allow Multiple Checkout Check this check box if the Version Control user is to be allowed to check out revisions of objects that are already checked out by other users. Note that setting multiple check outs on or off for all users of the Version Bank (using the Multiple Check Out Settings dialog box) overrides this setting for the individual user. Deleting a Version Control User To delete a Version Control user: 1. Select the User Administration command on the Version Control menu of Developer Security. The Version Control User List is displayed with usercodes and their roles. 2. Select the usercode you want to delete. 3. Select the Delete command on the Edit menu. The user is deleted immediately; you are not asked to confirm the delete request. Note that the system will not permit you to delete a user if that user is the only one defined as an administrator. Furthermore, if the usercode you are deleting was used to create objects which still exist in the UREP repository, you will receive this error message: Deletion of users who have created objects which still exist in the repository is not permitted. You need to delete all objects created by that usercode in the UREP Repository before you can delete the usercode. Changing a Version Control User s Role Version Control users are defined to the system as having one of two roles: user or administrator. To change a user s role: 1. Select the User Administration command on the Version Control menu of Developer Security. The Version Control User List is displayed with usercodes and their roles. 2. Select the usercode you want to modify

45 Administering Version Control 3. Select the Edit menu. If the Administrator command appears with a check mark to the left, the selected user has Version Control administrator privileges. Select the command to turn the administrator setting off or on. Note that the system will not permit you to change a user s role if that user is the only one defined as an administrator. 4. Click OK to close the list. Changing a Version Control User s Password To change a user s password: 1. Select the User Administration command on the Version Control menu of Developer Security. The Version Control User List is displayed with usercodes and their roles. 2. Select the usercode you want to modify. 3. Select the Set password command on the Edit menu. The Version Control Password dialog box is displayed with the Old Password field disabled. 4. Specify a new password: Check the Usercode as password check box if you want to set the user s new password to be the same as the usercode. This selection will disable the Password and Verify fields below. Uncheck the Usercode as password check box if you want to specify a different password. Key in a new password in the Password field and again in the Verify field. 5. Click OK to close the Change Password dialog. Version Control Password Dialog Box Use the Version Control Password dialog box to change a Version Control password. Version Control Administrators use this dialog to change a password for a user who has lost or forgotten the current password. A Version Control Administrator opens this dialog by selecting the Set Password command on the Edit menu of the Version Control Users List. All Version Control users can use this dialog to change their own passwords. They open this dialog by selecting the Change your password command on the Version Control menu. The fields on this dialog box include: Old Password Key in your current password in the Old Password field if you are changing your own password. (This field is disabled if you are an Administrator changing someone else s password.)

46 Administering Version Control Usercode as password Check this check box if you want the new password to be the same as the usercode. This selection will disable the Password and Verify fields below. Password If the Usercode as password check box is not checked, you must enter a new password in this field. Verify Enter the same password that you entered in the Password field. Click OK to close the Version Control Password dialog box. Changing Your Version Control Password All Version Control users are permitted to change their own passwords from within Developer Security. To do this: 1. Logon to Version Control by selecting the Login command from the Version Control menu of Developer Security. 2. Select the Change your password command from the Version Control menu. The Change Password dialog box is displayed. 3. Key in your current password in the Old Password field. 4. Specify a new password: Check the Usercode as password check box if you want your new password to be the same as your usercode. This selection will disable the Password and Verify fields below. Uncheck the Usercode as password check box if you want to specify a different password. Key in a new password in the Password field and again in the Verify field. 5. Click OK to close the Change Password dialog. Specifying the Number of Users The Version Control Bank that was created during the installation of the Version Control Server allows a maximum of 50 users. To alter the maximum number of users dynamically: 1. Increase the number of maximum users. Call the command grfncmd "alter universe configuration (transactions (ipc(procedure(max_open=<n>))));" where <n> is the number of users. Note: Ensure that this command occupies only one line

47 Administering Version Control 2. Increase the maximum number of concurrent transactions. As a rule of thumb, this should be three times the maximum number of users. For example, if the maximum number of users is 60, the maximum number of concurrent transactions should be 180. Call the command grfncmd "alter universe configuration (transactions(max_open=<m>));" where <m> is the maximum number of concurrent transactions. 3. Stop the universe by typing grfncmd "stop;" 4. Restart the universe by typing grfncmd "start;" The Version Control Bank will now be able to serve a maximum number of <n> users. Monitoring the OSMOS Database Ensuring effective usage of the Version Control Bank requires regular monitoring of the OSMOS database. Use the following command to monitor the database: grfncmd "select * from partitions;" This will show the percentage of the database that is still unused. If the database runs out of space, and the Version Control Client performs an operation that stores data into the database, the Client gets an error message saying that the database is out of space and will be logged out of the Version Bank. Another resource that requires monitoring is the audit_arms. OSMOS stores information about transactions in audit_arms. Refer to the Universal Repository Administration Guide for more details about audit_arms. When the database runs out of audit_arms, it issues a request for more audit_arms on the Server machine. Use the following commands to increase the number of audit_arms: grfncmd "create partition <audit partition name> (size=15m tablespace= audit );" grfncmd "create audit_arm <audit arm name> (tablespace=audit);" where <audit partition name> is the name of a new audit partition. The convention used for this name is audit_<number string>; for example, audit_nine. The value <audit arm name> is the name of a new audit_arm. The convention used for this name is audit_file<number>; for example, audit_file15. See the Universal Repository Administration Guide for information about how to make additional audit_arms available. After additional audit_arms are made available, the Version Control Client can retry the operation that caused the problem message on the Server machine

48 Administering Version Control Backup and Recovery To back up your versioned objects, use the Version Control export facilities to copy your Version Bank data to a file. To recover your Version Bank, use the import facilities to load the data back into your bank. These operations can be performed using the Export Wizard and the Import Wizard, which step you through the tasks required. You can also run the Export Utility or the Import Utility from the command line. Migrating the Version Control Bank Direct migration between Version Control releases is not possible, due to differences in Version Bank schemas. However, you can use the Version Control Export and Import utilities to export data from one Version Bank and load it to another. Two plans for migrating a Version Control Bank are described below. Note: Developer Security is not intended to, and does not, provide any facilities for migrating Version Control Banks. Plan A: Migrating an existing Version Bank to another machine 1. Export your data from the existing Version Bank to a directory on the same machine. You must use the Export Utility for the same release as your existing Version Bank. For example, if exporting from a Version Bank from release 2.4, use the Export Utility from 2.4. The Export Utility for releases 2.3 and 2.4 will create an SGML format file. 2. Make the directory that holds your exported data shareable. 3. Install the new release of the Version Control Server on a second machine. Create the Version Bank and load the schema files to the Bank by running the Version Control Configuration Wizard. Note: The new universe and Repository must be at least the same size as those created for the previous installation. 4. On the second machine, map a drive to the directory that you made shareable in step Import the data file in the shared directory into the Version Control Bank created in step 3, using the details of the user who created the Version Control Bank. If you perform this step using the Import Wizard, you can specify that the input file be converted from SGML to XML format before import begins. If you run the Import Utility from the command line you will have to perform this conversion first by running the SGML2XML Utility

49 Administering Version Control Plan B: Migrating an existing Version Bank to a directory on the same machine 1. Export your data from the existing Version Bank to a directory on the same machine. You must use the Export Utility for the same release as your existing Version Bank. For example, if exporting a Version Bank from release 2.4, use the Export Utility from 2.4. The Export Utility for releases 2.3 and 2.4 will create an SGML format file. 2. De-install the OSMOS service, UREP, and OSMOS. Refer to the documentation for the same release as your existing Version Control Server for more information about uninstalling. 3. Install the new release of the Version Control Server. Ensure that the Version Bank is created and loaded with the schema files by running the Version Control Configuration Wizard. Note: The new universe and Repository must be at least the same size as those created for the previous installation. 4. Import the data file in the shared directory into the Version Control Bank created in step 3, using the details of the user who created the Version Control Bank. If you perform this step using the Import Wizard, you can specify that the input file be converted from SGML to XML format before import begins. If you run the Import Utility from the command line you will have to perform this conversion first by running the SGML2XML Utility. See Exporting Version Bank Data and Importing Version Bank Data for details of the export and import tools. Archiving Version Bank Data You should archive older data from your Version Bank on a regular basis to minimize the size of the bank and optimize performance. Not all data can be removed from a bank, however. Key revisions -- that is, revisions that are crucial to the structure of the versioned object -- cannot be archived. Examples of key revisions are revisions that have branches, revisions used in merge operations, or revisions that are the latest on their branch. To perform an archive operation, use the Export Wizard to copy objects older than a specified date to a file, and remove them from the Version Bank. See Export Wizard for details on how to run the Wizard

50 Administering Version Control Exporting Version Bank Data Version Control offers two methods of exporting data from a Version Bank: The Export Wizard This Wizard steps you through the tasks required to perform the export and permits you to specify a subset of records to be exported and (optionally) archived from the Version Bank. The Export Utility Users familiar with the command line utility from earlier releases can continue to perform an export task in this way. However, you cannot specify a subset of records for export, and you cannot archive records using the Export Utility. To run an export operation by either method all users must be logged off from Developer Version Control. Both export methods create: An XML file containing data from the Version Bank. This file is readable by the current and all subsequent versions of the Version Control import tools. A subdirectory of LCIF files which are referenced by the XML file. Error and status messages for the export operation. As part of the export task, you must define a directory for the XML file. The export will locate the LCIF files in the same location. If you later want to move these files before performing an import task, you must move them together so that the relative path from the XML file to the LCIF files is maintained. Note: All passwords are lost during an export operation. If you import your data into a new bank, a user s password will default to the username. Export Wizard The Export Wizard is an easy-to-use tool that prompts you for the information required to export data from a Version Bank, then initiates the export task. To run the Export Wizard, all users must be logged off from Developer Version Control. The Wizard is run: By selecting the Export icon from the Start/ Programs/ VC Server menu. By selecting the Export Utility command from the Version Control menu of Developer on the Server machine. Export will fail if you are logged into Version Control. Automatically if you initiate the Export Utility from the command line and do not specify all options. (Any information you do specify on the command line will be included in the Wizard.)

51 Administering Version Control When you run the Wizard, follow the instructions which the Wizard provides at each step of the export operation. If you need additional assistance, follow the instructions below or click Help on each dialog page. Each page includes a Back and Next button, where appropriate, which allows you to return to the previous page or move to the next page. A Cancel button is also provided if you wish to stop the export and exit from the Wizard. The first screen presented is the Welcome Page. Welcome Page The Welcome Page informs you that the Export Wizard has begun. You are advised to export to a compressed directory if you are exporting a large volume of data. Click Next to go to the Login Page. Login Page On the Login Page you must enter a Version Bank name, userid, and password to log on to the appropriate Version Bank for the export or import operation. The fields on this page are: Version Bank name Select a Version Bank name from the drop-down list, or key in a name. Userid Key in a valid userid. The password is the same as the userid. Select this radio button if your password is the same as your userid. Use this password Select this radio button and key in a valid password if your password is different from your userid. For Export After providing the required information, click Next to go to the Object Selection Page. For Import If you have not already created the Version Bank, click Create Bank, to run the Version Control Configuration Wizard. You must create the bank with the same name specified in the Version Bank name field on this page, and you must be added as a user to the new bank with the userid and password specified on this page. When the Configuration Wizard closes, you are returned to the Login Page to complete the import task

52 Administering Version Control After providing the required information, click Finish to start the import operation. The Wizard displays the Version Control Output Dialog. Object Selection Page Use the Object Selection Page to specify which Version Bank objects are to be exported. On this page you can also instruct the Wizard to archive the exported objects. The fields on this page are: Export all objects Select this radio button if you want to export the entire contents of the Version Bank. Export objects created before this date Select this radio button if you want to do a partial export of objects in the Version Bank. Selecting this button activates the date field to the right. Date Select a date from the drop-down calendar. Objects created before this date will be exported; objects created on this date will not. Archive objects after exporting Check this check box if you want the objects to be removed from the Version Bank after being exported. Note that key revisions cannot be removed from the Version Bank even though they can be exported. A key revision is one which is crucial to the structure of a versioned object, for example revisions which have branches, revisions used in merge operations, or revisions that are the latest on their branch. After making your selections, click Next to go to the File Page. File Page On the File Page, specify the name and location of the output file to be created by the export operation. Key in the path and file name, or click Browse to specify this information. The default name of the output file is contents.xml. The default location of the output file is in a directory with the name of the Version Bank being exported. If you select an existing file as your output file, the contents will not be overwritten. The exported data will be inserted into the file, not appended to the end. Click Finish to start the export operation. If you specified an existing file as your output file, you will be prompted to confirm its update. If you click No, the File Page is redisplayed and you can specify a different file name. The Wizard then displays the Version Control Output Dialog

53 Administering Version Control Version Control Output Dialog The final page of the Wizard displays status messages from the export or import operation in a large list box. Scrolling By default the status messages are scrolled into view as they are added. To stop this automatic scrolling, check the Manual scrolling check box. You can use the scroll bar to view messages regardless of whether Manual scrolling is selected or not. Logging By default the status messages are not logged, but you can choose to save the messages to a log file. To do this: 1. Key in a path and file name for the log file, or click Browse to specify this information. 2. Check the Log to file check box. If the specified file already exists, you are prompted to overwrite it. When you turn logging on, all messages are saved, including the lines already in the list box when you activate logging. Logging can be started at any time while the dialog is open, even after the export or import operation is complete. Once logging starts you cannot change the log file name. A status message for the logging is displayed under the disabled Browse button. Turn logging off by uncheck the Log to file check box. Stages of export operation The export operation is a two- or three-stage process, depending on whether an existing export file is used. The stages are: 1. Read the existing exported data (if any). 2. Read the data in the Version Bank and export the data in LCIF format to disk. 3. Write the export file. Aborting an export operation You can halt an export operation during the stage in which data is being exported from the Version Bank (stage 2 above). To do this, click Abort. Note: Aborting an export operation may cause revisions to be lost if Archive objects after exporting was selected on the Object Selection Page. Aborting an export operation will not remove any files that were created; you must remove these files manually

54 Administering Version Control Stages of import operation The import operation is a one- or two-stage process, depending on whether the import file was read for Object Selection. The stages are: 1. Read the import file (if this has not yet been done). 2. Save the data in the Version Bank. Aborting an import operation You can halt an import operation during the stage in which data is being saved to the Version Bank (stage 2 above). To do this, click Abort. The import operation will stop, and all objects already loaded into the Version Bank remain there. Progress Bar The progress bar at the bottom of the dialog indicates the progress of the current stage. When the operation is complete, the Wizard replaces the Abort button with a Close button and displays a message above the progress bar. Click Close to close the Wizard. Export Utility The Export Utility is a command line tool that runs on a Developer Version Control Server. To run the Export Utility, all users must be logged off from Developer Version Control. The following table describes the Export Utility parameters: Parameter Description -r repository_name Enter -r followed by the name of the Version Control Bank to be exported. -u userid Enter -u followed by the userid of the System Administrator performing the export task. -p password Enter -p followed by the System Administrator's password. -f filename Enter -f followed by the name of the XML export file. -c Enter -c to instruct LDAVCExport to close automatically when complete. -l logfilename Enter -l followed by a logfile name to write all status messages from the export operation to the specified file

55 Administering Version Control Example: C:\UREPDIR\bin> LDAVCExport.exe -r My_Repository -u SYSADM -p password -f VCBank.xml If you do not specify the first four parameters, the Export Wizard is automatically started. Any information you do specify on the command line will be included in the Wizard. If you specify the first four parameters, the export task is started and the Export Output dialog is displayed. Importing Version Bank Data The Version Control import tools are provided to enable you to recover versioned objects in a Version Bank which have previously been backed up with the export tools, as well as to migrate existing Version Banks to a newer release of Developer Version Control. Before running an import operation, you should define the Version Bank as described in Installing Version Control. Version Control offers two methods of importing data into a Version Bank: The Import Wizard This Wizard steps you through the tasks required to perform the import and permits you to specify which items are to be imported into the Version Bank. If your input file is in SGML format, you can also direct the Wizard to convert the file to XML format before performing the import operation. The Import Utility Users familiar with the command line utility from earlier releases can continue to perform an import task in this way. However, you cannot specify items to be imported using the Import Utility. If your input file is in SGML format, you must first convert it to XML format using the SGML2XML Utility. To run an import operation by either method, all users must be logged off from Version Control Developer. When you exported your data from the Version Bank, you defined a directory for the output file. The export task also located the LCIF files created by the operation in the same location. If you want to move these files before performing an import task, you must move them together so that the relative path from the output file to the LCIF files is maintained. Note: All passwords are lost during an export operation. If you import your data into a new bank, a user s password will default to the username

56 Administering Version Control Import Wizard The Import Wizard is an easy-to-use tool that prompts you for the information required to import data into a Version Bank, then initiates the import task. The Wizard can also perform the conversion of an SGML format input file to the required XML format. To run the Import Wizard, all users must be logged off from Developer Version Control. The Import Wizard is run: By selecting the Import icon from the Start/ Programs/ VC Server menu. By selecting the Import Utility command from the Version Control menu in Developer on the Server machine. Import will fail if you are logged into Version Control. Automatically if you initiate the Import Utility from the command line and do not specify all options. (Any information you do specify on the command line will be included in the Wizard.) When you run the Wizard, follow the instructions which the Wizard provides at each step of the import operation. If you need additional assistance, follow the instructions below or click Help on each dialog page. Each page includes a Back and Next button, where appropriate, which allows you to return to the previous page or move to the next page. A Cancel button is also provided if you wish to stop the import and exit from the Wizard. The first screen presented is the Welcome Page. Welcome Page The Welcome Page informs you that the Import Wizard has begun. You are advised that data can be imported into a new or existing Version Bank. Click Next to go to the File Page. File Page On the File Page, specify the name and location of an existing file of exported data to be used as input to the import operation. Key in the path and file name, or click Browse to specify this information. If your input file was created in a Developer release prior to 3.1, you must convert the file to XML format. To do this, click Convert. The Wizard will create an XML version of the file that can be used by this import operation. Note: You cannot import files that are located on a CD-ROM or that are writeprotected. You must have write-access to any file you want to import. Click Next to go to the Object Selection Page

57 Administering Version Control Object Selection Page Use the Object Selection Page to specify which items are to be imported from the specified file. The fields on this page are: Import all items Select this radio button if you want to import the entire contents of the input file. Only import the items I select Select this radio button if you want to specify items from the input file to be imported. If you choose to select import items, the Wizard reads the import file and presents a tree view of the data in the scrollable window. Each item has a check box to the left of it. Check the check box to include the item in the import operation. Selecting a node with children will automatically select the children as well. Right-click on a node to display a pop-up menu with options that may include Expand, Collapse, Select for Import, and View LCIF Data. View LCIF Data is available only for revision nodes and will call the LCIF Viewer to display the selected version. Click Zoom to open a resizable dialog with the tree view. After making your selections, click Next to go to the Login Page. If you click Back to return to the File Page and change the input file name, your object selection is not saved. Login Page On the Login Page you must enter a Version Bank name, userid, and password to log on to the appropriate Version Bank for the export or import operation. The fields on this page are: Version Bank name Select a Version Bank name from the drop-down list, or key in a name. Userid Key in a valid userid. The password is the same as the userid. Select this radio button if your password is the same as your userid. Use this password Select this radio button and key in a valid password if your password is different from your userid

58 Administering Version Control For Export After providing the required information, click Next to go to the Object Selection Page. For Import If you have not already created the Version Bank, click Create Bank to run the Version Control Configuration Wizard. You must create the bank with the same name specified in the Version Bank name field on this page, and you must be added as a user to the new bank with the userid and password specified on this page. When the Configuration Wizard closes, you are returned to the Login Page to complete the import task. After providing the required information, click Finish to start the import operation. The Wizard displays the Version Control Output Dialog. Version Control Output Dialog The final page of the Wizard displays status messages from the export or import operation in a large list box. Scrolling By default the status messages are scrolled into view as they are added. To stop this automatic scrolling, Check the Manual scrolling check box. You can use the scroll bar to view messages regardless of whether Manual scrolling is selected or not. Logging By default the status messages are not logged, but you can choose to save the messages to a log file. To do this: 1. Key in a path and file name for the log file, or click Browse to specify this information. 2. Check the Log to file check box. If the specified file already exists, you are prompted to overwrite it. When you turn logging on, all messages are saved, including the lines already in the list box when you activate logging. Logging can be started at any time while the dialog is open, even after the export or import operation is complete. Once logging starts you cannot change the log file name. A status message for the logging is displayed under the disabled Browse button. Turn logging off by uncheck the Log to file check box. Stages of export operation The export operation is a two- or three-stage process, depending on whether an existing export file is used. The stages are: 1. Read the existing exported data (if any)

59 Administering Version Control 2. Read the data in the Version Bank and export the data in LCIF format to disk. 3. Write the export file. Aborting an export operation You can halt an export operation during the stage in which data is being exported from the Version Bank (stage 2 above). To do this, click Abort. Note: Aborting an export operation may cause revisions to be lost if Archive objects after exporting was selected on the Object Selection Page. Aborting an export operation will not remove any files that were created; you must remove these files manually. Stages of import operation The import operation is a one- or two-stage process, depending on whether the import file was read for Object Selection. The stages are: 1. Read the import file (if this has not yet been done). 2. Save the data in the Version Bank. Aborting an import operation You can halt an import operation during the stage in which data is being saved to the Version Bank (stage 2 above). To do this, click Abort. The import operation will stop, and all objects already loaded into the Version Bank remain there. Progress Bar The progress bar at the bottom of the dialog indicates the progress of the current stage. When the operation is complete, the Wizard replaces the Abort button with a Close button and displays a message above the progress bar. Click Close to close the Wizard. Import Utility The Import Utility is a command line tool that loads an XML format file into a Version Control Bank. To run the Import Utility, all users must be logged off from Developer Version Control. The following table describes the Import Utility parameters. Parameter Description -r repository_name Enter -r followed by the name of the Version Control Bank to be imported

60 Administering Version Control Parameter Description -u userid Enter -u followed by the userid of the System Administrator performing the import task. -p password Enter -p followed by the System Administrator's password. -f filename Enter -f followed by the name of the XML file to be imported. -c Enter -c to instruct LDAVCImport to close automatically when complete. -l logfilename Enter -l followed by a logfile name to write all status messages from the import operation to the specified file. Example: C:\UREPDIR\bin > LDAVCImport.exe -r My_Repository -u SYSADM -p password -f VCBank.xml If you do not specify the first four parameters, the Import Wizard is automatically started. Any information you do specify on the command line will be included in the Wizard. If you specify the first four parameters, the import task is started and the Import Output dialog is displayed. SGML2XML Utility The SGML2XML Utility converts an SGML format file created by an Export Utility from a release prior to 3.1 to an XML format file, which is required for the current release. The converted file is then available as an input file for an import operation for release 3.1, or as an existing file to be updated by an export operation. If you are migrating to Developer release 3.1 from an earlier release, you must convert export files as part of your migration procedure. You can request the Import Wizard to perform this conversion for you, but if you choose to run the Import Utility from the command line, you must run SGML2XML to convert the SGML file before performing the import. The SGML2XML Utility is a command line tool. The following table describes the parameters. Parameter Description -i inputfile Input file name -o outputfile Output file name Example C:\UREPDIR\bin > SGML2XML.exe -i myfile.sgml -o myfile.xml

61 Administering Version Control Shutting Down UREP Administrator s Workbench Shut down the UREP Administrator s Workbench whenever it is not being used. If it is left running, users may be unable to login to a Version Control Bank from the client workstations. Summary After completing this section you can: Add users to the Version Control Bank, assigning userids and passwords. Dynamically alter the maximum users for a Version Control Bank. Monitor space usage for the OSMOS database. Use the Export and Import tools to back up, recover, and migrate a Version Control Bank. Use the SGML2XML Utility to convert files from SGML to XML format

62 Administering Version Control

63 Section 4 Security for Version Control This section describes how security can be implemented for Developer Version Control. This section includes: Version Control and Developer Security Restricting Access Rights to Administrators Auditing The Audit Query Facility Setting Integrity Management Security and Integrity Management Restrictions on Load Operations Version Control and Developer Security You can configure Developer Security matrixes to grant or deny access to versionable objects for Version Control users. To enforce Developer Security in Version Control: 1. Logon to Developer Security. 2. Select Set Security from the Development menu. Set Security is a toggle switch which is checkmarked when selected (set on). 3. Select User / Access Matrix from the Administration menu. This displays the User Security Access Matrix which shows the access rights of all users registered in Developer Security. 4. Select Add User from the Edit menu and key in the userid of the new user. 5. Double-click in the cell corresponding to the Business Segment which the user needs to access in Version Control. An 'X' is displayed in each selected cell. 6. Close the User / Access Matrix

64 Security for Version Control 7. Select the User / Business Segment Matrix from the Development menu and double-click on all the cells corresponding to the Business Segment which the user will need to access in Version Control. An 'X' is displayed in each selected cell. Note: There is no facility in Developer that allows you to select individual objects belonging to a Business Segment for versioning access. If a user has access to a Business Segment, then all objects in that Business Segment must be selected for versioning access. 8. Close the User / Business Segment Matrix. 9. Exit Developer Security. The next time the user starts a Developer session, the Set Security function prompts for the userid and password to be entered. When the user logs into Version Control, only those objects and functions that were selected for that user in the Developer Security matrixes are accessible. Note: For Windows security users (that is, the Use Developer Security command is not selected) the password defaults to the user's User Id. See the Unisys Enterprise Application Developer Administration Guide for details of the user access matrixes discussed above. Restricting Access Rights to Administrators An additional security feature which is implemented in the UREP configuration itself is the facility for the Version Control Bank to be interrogated to determine if a user has Administrator rights. During Version Control operations, only operations which can be performed by an Administrator such as deleting an object, deleting and renaming labels, are enabled. Other menu entries, entry fields and other items are disabled. Auditing When auditing for Version Control is set in Developer Security, every operation creates an audit entry in the Audit Store. An audit entry contains the Version Control operation and the object on which this operation was performed. For logging in and logging out of the Version Control Bank, the userid, Bank name, and Server name are part of the audit entry. Auditing in Developer is described in the Unisys Enterprise Application Developer Administration Guide. The Audit Query Facility You can interrogate the Audit Store from within Developer Security by building queries with an easy-to-use dialog. Your queries can be saved and added to a Query menu for reuse

65 Security for Version Control Only users who are Developer Administrators are permitted to use the audit query facility. See your Unisys Enterprise Application Developer Administration Guide for details on audit queries. Setting Integrity Management There are two options which determine the setting of Integrity Management for Version Control: the Enforce Integrity check box in the Version Control Options dialog box and the Set Integrity Management command in Developer Security. When the Set Integrity Management command is off, individual Version Control users can set Integrity Management on for their own workstations using the Enforce Integrity check box in the Version Control Options dialog box. When the Set Integrity Management command is on, however, Integrity Management is in force for all users of the Repository. This means that the Enforce Integrity check box in the Version Control Options dialog box is check and disabled, and Integrity Management can only be switched off again from Developer Security. See Security and Integrity Management Restrictions on Load Operations for a discussion of how setting Integrity Management impacts load operations. Security and Integrity Management Restrictions on Load Operations Load operations are restricted by Integrity Management settings in both the Developer Security module and Version Control. Load operations are not allowed when Integrity Management is on because they affect the contents of the Developer Repository and would cause synchronization issues between the Repository and the Version Control Bank. To perform a load operation, you must consider two settings: The Set Integrity Management option in Developer Security The Enforce Integrity check box in Version Control Options If the Enforce Integrity check box is checked and Set Integrity Mangement is not on, then you can unchecked the Enforce Integrity check box and run the load. It will then be your responsibility to synchronize the Developer Repository and the Version Control Bank after the load

66 Security for Version Control If Set Integrity Management is on, however, you will not be able to de-select the Enforce Integrity and run the load. You can turn off Set Integrity Management for the Repository and run the load, but if this option is not acceptable because of your security requirements, there are two other options for performing a load operation. 1. Create a separate Repository for the load 1. Turn off Integrity Management in Developer Security. 2. Configure a separate Repository for the load operation. 3. Load your data into this Repository. 4. Check in or add the elements to the Version Control Bank, making them available to users with Repositories which have Integrity Management set on. Users can then perform the familiar Get or Check Out operations to access these objects in the Version Control Bank. It is your responsibility to synchronize the Repository and the Version Control Bank after the load, but this method guarantees that integrity between the objects you use in the Repositories and the objects in the Version Control Bank is maintained. 2. Assign Administrator privileges to the person performing the load Using the User Security Access Matrix in Developer Security, assign $ADMIN access rights to the person who will perform the load operation. See your Unisys Enterprise Application Developer Administration Guide for details on assigning access rights to users. It is your responsibility to synchronize the Repository and the Version Control Bank after the load. Summary After completing this section you can: Use Developer Security to grant or deny access to the Version Control Bank. Set Integrity Management on for your Version Control system. Understand the impact of Integrity Management on Developer loading operations

67 Section 5 Project Management with Version Control The branching, merging, and labelling features of Version Control can be used to help you manage your development projects. This section describes how these features work, then discusses how these features can be used for project management and release management. This section includes: What Is Branching? Merging Branches What Is Labelling? Building a Product Release Project Management What Is Branching? Branching allows you to work on a set of revisions to a versionable object without affecting a different set of revisions to that object. You might want to do this if you have two developers working on different features which affect the same object. Another reason for branching would be to develop a fix for an object that is also undergoing changes for the next product release. When you first add an object to the Version Bank, Version Control creates a main branch and adds a first revision on that main branch. Version Control automatically identifies each revision with a branch and revision number unique to that object in the format <branch>.<revision>. The first revision on a main branch for an object is given the number 1.1. Subsequent revisions of the object on its main branch are numbered 1.2, 1.3, and so on. You can create a new branch for an object when you check an object in to the Version Bank. If you do not create a new branch, then the object is checked in to the branch from which it was checked out. Note: Loading objects into a Developer Repository may cause the branch information for checked out objects already in the Repository to be lost. To ensure an object is checked in to the branch from which it came, check it in from the Version Control Explorer instead of from the Model Directory

68 Project Management with Version Control A revision checked in to a newly created branch is assigned a number that shows the source branch and revision number as well as the new branch and revision number. For example, if you check out revision 1.3, work on it, then check it in and create a new branch for it, the new branch is numbered and the new revision is numbered , or <sourcebranch>.<sourcerevision>.<newbranch>.<newrevision>. If you check out revision , make changes, then check it in and create another new branch, the new branch number would be and the new revision number would be This method of assigning branch and revision numbers means that these numbers can become quite long. A branch can also be identified with a user-defined short name, as described in Branch Labels. Branching is displayed in the Version Control Explorer in a tree structure with the most recent revision at the top of a branch, as shown in the following diagram: If you are working on a feature that requires branching from the main branch in a given Model, you should either work on your own Developer Repository or on a Repository set up for that feature separate from the main Repository. This separate Repository should contain a copy of the Model in the main Repository, but should have versionable objects specific to the feature you are working on. The reason for this is that a Repository can hold only one copy of a versionable object at a time and therefore cannot support two developers working on different branches of the same object. Merging Branches If you are using branching to work on two sets of changes to an object, you may at some point decide to combine the two sets of changes into one revision. For example, if you are fixing a bug on BranchOne and coding a new feature on BranchTwo, you will want to include the fix changes in the new feature code. To do this, use the Version Control merge feature

69 Project Management with Version Control The rules for merging two revisions of an object in the Version Bank are: You can only merge the latest revisions from two branches. The two revisions to be merged cannot be in checked out or deleted status. You must specify the direction of the merge; that is, will revision A be merged into revision B, or will revision B be merged into revision A? The direction of the merge determines on which branch the new revision created by the merge will reside. For example, if revision A is merged to revision B, a new (merge) revision C is created on the branch where B resides. No further revisions can be created on the branch where A resides. After the merge operation, the merge revision (C) and merged revisions (A, B) can be checked out. A rollback of a revision that is the result of a merge operation will 'undo' the merge. In the Version Control Explorer a revision that is merged and a revision created by a merge are represented by the following icons: Merged revision: this revision was merged with another revision. Merge revision: this revision is a result of a merge operation. The figure below gives an example of how merged and merge revisions are shown in the Explorer. Merge information for a revision is also shown in the Version Control Properties dialog box

70 Project Management with Version Control The diagram below shows an example of branching and merging for an object. In this example: Revision is branched from Revision 1.2. Revision is branched from Revision 1.3. Revision is branched from Revision Revision 1.4 is the result of a merge of Revision into Revision 1.3. No further revisions can be added to Branch Feature1. What Is Labelling? While Version Control automatically assigns unique numbers to branches and revisions of an object in the Version Bank, you can also create your own short names for branches and for revisions. This is the Version Control labelling feature

71 Project Management with Version Control Version Labels Version labels are optional user-defined short names that can be assigned to a revision of one object or many objects. Version labels are associated with a Model, so once a label is defined, it can be assigned to other objects in the Model. The diagram below gives an example of how a version label can be assigned to identify revisions of different objects. Labels can be assigned to a revision when objects are added or checked in to the Version Control Bank, or through the Model Directory or the Version Control Explorer. Labels are alphanumeric and can be up to 36 characters long. A revision can have more than one version label, but you can assign a given version label to only one revision of an object. For information on creating, renaming, or removing version labels, see Working with Version Labels. The display for version labels in Version Control lists can be toggled on and off using the Show in Lists/Labels command from the View menu. Branch Labels A branch has an identifying number assigned by Version Control when it is created, but in addition you can create a branch label to give your own short, descriptive name to a branch. A branch label is associated with a Model, but any number of objects within the Model can have a branch with the same label. Labels can be used to specify a branch search order to find objects when a Get Latest Revision or Check Out operation is performed

72 Project Management with Version Control A branch label is alphanumeric and can be up to 36 characters long. A label can be assigned to a branch during an Add or Check In operation. A branch may have more than one label, but you can assign a given branch label to only one branch of an object. For information on creating, renaming, or removing branch labels, see Working with Branch Labels. You can customize how branch numbers and labels are displayed in the Version Control Explorer. A branch can be displayed with its number only, its label only, or both. See Customizing Branch Information Display for more information. Labelling Recommendations If your project uses branching, you should decide on a naming convention for branch labels that will avoid confusion when viewing objects in the Explorer or when performing merge operations. Label each branch. Information in branch labels might include a code or abbreviation for a project, release, platform, operating system, task, or feature. Version labels are generally used to identify a specific revision for a number of objects that you would want to handle as a group. The most common usage of version labels is to identify revisions to be included in a release. It is not necessary and not desireable for performance reasons to assign a label to every revision in a Version Bank. Building a Product Release In addition to giving you a more meaningful way to refer to revisions, version labels can be used to build a product release. Version Control allows you to do a Get operation on all revisions with a specified label. By assigning a release-specific label to the revisions of all objects required for a release of your product, you can retrieve all of these objects in one operation. Assigning Version Labels A version label can be assigned to one revision at a time, but to make labelling of a number of revisions easier, Version Control also allows you to assign a label to: The current revisions in the Repository for all objects or for selected objects in a Model. The latest revision on the main branch for all objects or for selected objects in a Model. See Working with Version Labels for details

73 Project Management with Version Control Assembling the Release To assemble the revisions required for a release, perform a Get a Revision by Label operation to load a copy of all revisions with the specified version label into the Repository. In the diagram below, revision 1.3 for Ispec C1, revision 1.4 for Report R1, and revision for GSD1 will be retrieved to build the release. Delivering the Release After the revisions required for the release have been copied to the Repository using a Get operation, use Builder to define a System and generate directly to the target host. Alternatively: 1. Extract the LCIF file for either the whole Model or a particular Business Segment. 2. CASELOAD this LCIF file to the target host, generate the system, and run it

74 Project Management with Version Control Example The diagram below gives an example of two Ispecs which are added to the Version Bank and modified for two projects. (1) Ispec1 and Ispec2 are added to the Version Bank, creating revision 1.1 on a main branch for each object. (2) A decision is taken to develop variants of Ispec1 for the A Series and Unix platforms. Revision 1.1 is checked out, rewritten for Unix, and checked in to a new branch called UNIXProj. The main branch is given a branch label ASeriesProj. Ispec2 will be the same for both A Series and Unix. Its main branch is given two labels: ASeriesProj and UNIXProj. (3) Ispec1 and Ispec2 are modified. Version label UNIXRel1 is assigned to Ispec1 revision and to Ispec2 revision 1.3. A Get by Label operation is performed to build Unix Release 1. Version label ASRel1 is assigned to Ispec1 revision 1.3 and to Ispec2 revision 1.3. A Get by Label operation is performed to build Release 1 for the A Series Project

75 Project Management with Version Control Project Management This subsection presents three examples for the use of Version Control for project management. The three approaches are not mutually exclusive, and most projects would be a combination of the types outlined here. Project Management with Merging In this example branching is used to support work on an object for different features, prototypes, or fixes, with the goal of eventually merging all work into the object's main branch. This approach is suitable for prototyping work or feature work in the same product release. This is also suitable for a single project that does not produce releases frequently

76 Project Management with Version Control Independent Parallel Project Management In this example each branch is treated as an independent project which will not be merged back to the main branch. This approach might be used if you are developing variations of software for different platforms or operating systems, or customizing software for different clients. Sequential Project Management In this example each branch is treated as a project release. This approach is suitable for multiple releases of a product that is also patched or maintained between releases. This is ideal for a progressive migration of code from the previous release to the next release where fixes must be applied to both releases at the same time. Because a

77 Project Management with Version Control branch can have more than one label, you can label the same branch as both Release1 and Release2 until such time as Release2 requires a change in the object which is not in Release1. 1. Development of Object A for Release1. Revision 1.3 is included in the Release1 delivery. 2. Following delivery of Release1, fixes are applied to Object A. Main branch has two branch labels: Release1 and Release2. 3. Creation of separate Release2 branch for development of new release features. Fixes must now be made to Object A on both branches. Copying a Project If you require a copy of an existing project, for example to develop a new application based on an existing one, follow these steps: 1. Create a new Model or Business Segment in the Version Bank. 2. Select the old Model or Business Segment in the Version Control Explorer and perform a Get Latest Version from Main Branch for all objects in that Model/ Business Segment. 3. Add all objects to the new Model or Business Segment

78 Project Management with Version Control Summary After completing this section you can: Describe the branching, merging, and labelling features of Version Control. Understand how version labels can be used for building a release. Understand the three scenarios for project management with Version Control

79 Section 6 Getting Started in Version Control This section describes some of the basics you need to know before you actually begin working in Version Control: how to log on, how to set Version Control options, and how to use the Version Control Explorer to see a hierarchical view of your Version Control Bank. This section includes: Logging on to Version Control Setting Version Control Options Setting Multiple Check Out Options The Version Control Explorer Version Control Status Window Version Control Logging Using the Object Count Auditor Logging on to Version Control You can log on to Version Control from Developer or from Developer Security. When you use the Login command from the Version Control menu, Developer uses your userid, password, and the default Version Control Bank name as specified in the Version Control Options dialog box, to automatically log you into the Version Control Bank. If these attributes are valid, the login is successful, and the Version Control Status window is displayed. If the default attributes are invalid, or if the Repository is committed to another Version Control Bank, then the login fails and the Version Control Login dialog box is displayed to allow for manual login. You may also choose to log on automatically to Version Control whenever you begin a session of Developer. This selection is made by activating the Auto logon at startup option in the Version Control Options dialog box. It is also possible to log on to Version Control from outside Developer using the Developer Console. This facility is particularly useful if you wish to automate routine Version Control operations using a batch file

80 Getting Started in Version Control Version Control Login Dialog Box This dialog box is displayed when your default Version Control Bank, userid, or password attributes fail during automatic login. You can specify that this dialog be displayed for every login attempt by checking the Prompt for Login check box in the Version Control Options dialog box. The fields in the Version Control Login dialog box include: Version Control Bank Name The default value for the Version Control Bank Name field is the value specified in the Version Control Options dialog box, and the name is case-sensitive. Key over this default to specify another Version Control Bank if required. User Id The value displayed in the User Id field is the userid you use to login to your computer. You cannot change this field. Password The value displayed for the Password field is the password you use to login to to Developer. You cannot change this field. Version Control Bank Name Use the Version Control Bank Name field to specify the name of the Version Control Bank that you want to access. This name should be identical to the UREP Repository name that you entered during the installation of the Version Control Client on your workstation. You may also remove an existing Bank Name or add a new one. The Version Control Bank name is case-sensitive. The displayed name is the Default Bank Name specified in the Version Control Options dialog box. This may not be valid for your installation. User Id Your default userid for the Version Control Bank is the login name you used to login to your computer. Because Developer uses your userid to lock objects in the Repository, you cannot change your userid to login into the Version Control Bank. If you want to use a userid other than the computer login, you must: 1. Specify a new userid and password in Developer Security. 2. Specify the new userid and password in the Version Control Repository. 3. Update the Developer Security matrixes to ensure you have access rights to the objects you want to modify in the Version Control Bank

81 Getting Started in Version Control 4. Select Set Security to ON. When you login to Developer using the new userid and password, Developer will automatically use them for Version Control login. Password Your default password for the Version Control Bank is the password you used to login to Developer. You can change your password in the Version Control Login dialog box. Setting Version Control Options Version Control allows you to set options that control certain aspects of how Version Control functions at your workstation. The Smart Check In and Smart Check Out options are defined in the LINC.ini file. All other options are defined in the Version Control Options dialog box. Smart Check In and Smart Check Out These options cause Version Control to monitor the status of an object in the Version Control Bank relative to the Repository and adjust the action of Check In and Check Out accordingly. When you perform a Check Out operation with the Smart Check Out option set on, and Developer determines that the objects in the Version Control Bank and the Developer Repository are identical, the objects are not loaded into the Repository but are locked in the same manner as when an actual check out occurs. Similarly, when you perform a Check In operation with the Smart Check In option set on, and Developer determines that the objects in the Version Control Bank and the Developer Repository are identical, the objects are not loaded into the Version Bank but are unlocked in the same manner as when an actual check in occurs. The default value for both Smart Check In and Smart Check Out is ON. To switch these options off, add the following lines to the LINC.ini file using a text editor: [Version Control] SmartCheckOut=N SmartCheckIn=N

82 Getting Started in Version Control Version Control Options Dialog Box The Version Control Options dialog box allows you to set preferences for how Version Control functions at your Client workstation, as well as select settings for specific load options during an individual session of Version Control. To access this dialog box, click the Settings command on the Version Control menu, then select the Options command. The information specified in the Version Control Options dialog box includes: Client Workstation - General Options Default Server name Specify the Server that you wish to access. You may select a name from the dropdown list or use the Browse button to select from all the available Server machines on the network. Default Bank name Specify the name of the Version Control Bank that you want to access. This name is case-sensitive. You may also remove an existing Bank Name or add a new one. Use dialog for Get/Check Out Check this check box to specify that a dialog box is to be displayed on each Get Revision or Check Out command. Enforce Integrity Check this check box to set Integrity Management for the Developer Repository. Search Options Click Search Options to open the Search Order Options dialog box. Explorer Colors - Options Click Explorer Colors to change the color in which containers or deleted objects are displayed in the Version Control Explorer, if required. Version Control Temporary Directory Specify the location of the temporary directory where the.mdl files from the Developer extract and load processes are to be located. Delete temporary file(s) after operation, if operation was successful Check this check box to have temporary files deleted after a successful operation. Client Workstation - Login Options Auto logon at startup Check this check box to specify automatic logon to the Version Control Bank at Developer start up time

83 Getting Started in Version Control Prompt for Login Check this check box to cause the Version Control Login dialog box to be displayed to the user on each logon request, so the user is prompted for a User Id and Password. Client Workstation - Load Options Load in Exclusive Mode Check the Load in Exclusive Mode check box to lock the Repository during a load operation. In a multiuser system this option is not enabled. Validate/Save Logic After Load Check the Validate/Save Logic After Load check box to validate and save the logic following a load operation. DMA Enabled Check the DMA Enabled check box to enable Data Dictionary Maintenance (DMA) during loading. Conflicts Allowed Check the Conflicts Allowed check box to allow items which conflict between the Local Data Dictionary and the Global Data Dictionary to be loaded. Drop Reserved Check the Drop Reserved check box to specify that reserved words should be dropped during loading. Default Server name Use the Default Server name field to specify the Server that you wish to access. You may select a name from the drop-down list or use the Browse button to select from all the available Server machines on the network. If you select a new Server name you must start a new session by logging out of Version Control and logging in again for the change to take effect. Default Bank name Use the Default Bank name field to specify the name of the Version Control Bank that you want to access. This name should be identical to the UREP Repository name that you entered during the installation of the Version Control Client on your workstation. You may also remove an existing Bank Name or add a new one. If you select a new Bank Name, you must start a new session by logging out of Version Control and logging in again for the change to take effect. The Version Control Bank name is case-sensitive. The displayed default name is repository_name. This may not be valid for your installation

84 Getting Started in Version Control Use dialog for Get/Check Out Check the Use dialog for Get/Check Out check box to display a dialog box whenever a Get Revision or Check Out command is given to allow you to customize the operation of the command. If this option is checked, each Get Revision command presents the Version Control Get File(s) dialog box, and each Check Out command presents the Version Control Check Out File(s) dialog box. Enforce Integrity Check the Enforce Integrity check box to set Integrity Management on for your workstation. The status of the Set Integrity Management command in Developer Security can override the value in Enforce Integrity. If Set Integrity Management is on, then Enforce Integrity is also set on, and you will not be able to update this check box. The default value of Enforce Integrity is OFF. See Security and Integrity Management Restrictions on Load Operations before setting this option. Search Options Click Search Options to open the Search Order Options dialog box and define a Branch Search Order list. The Branch Search Order list is a series of branch labels to be searched in sequence when a Get Latest Revision or Check Out is performed. Only the branch labels in the Branch Search Order list are examined by the Get Latest Revision or Check Out to find the requested object from the Version Bank. The search options are stored in the Developer Repository. Explorer Colors - Options Click Explorer Colors - Options to open the Colors dialog box and change the color in which containers or deleted objects are displayed in the Version Control Explorer. Version Control Temporary Directory Use the Version Control Temporary Directory field to specify the location of the temporary directory where the.mdl files from the Developer extract and load processes are to be located. Key in a path, or use the Browse Button to locate and set the path. The default setting is C:\TEMP

85 Getting Started in Version Control Delete temporary file(s) after operation, if operation was successful Check the Delete temporary file(s) after operation, if operation was successful check box to have temporary files deleted after a successful operation. The default for this option is ON. Auto logon at startup Check the Auto logon at startup check box to automatically logon to the Version Control Bank at Developer start up time. This feature is also supported by the Developer Console. Prompt for Login Check the Prompt for Login check box so that the Version Control Login dialog box will be presented each time a login is requested by the user, or automatically initiated if Auto logon at startup is checked. Note: This feature is disabled when accessing Version Control via the Developer Console. See Developer Console and the DEVLOGIN command for further details. Load in Exclusive Mode Check the Load in Exclusive Mode check box to lock the Repository while loading an object. This helps speed up the load. It is not possible to load in Exclusive Mode when in multiuser mode. The Load in Exclusive Mode check box is enabled only when in single user mode and Developer has exclusive access to the Repository. No Developer Test sessions should be opened on this Repository during an exclusive load. Caution If Developer is performing an exclusive load, starting Developer Test will cause the suspension of both applications. Before selecting Exclusive Mode, ensure you have a complete backup of the Repository. Loading takes much less time if you are running in Exclusive Mode. Errors during load can corrupt the Repository, however, and if you load in Exclusive Mode, these errors will require you to completely restore the Repository from the backup. Consider using non-exclusive load if you are loading only part of the Repository

86 Getting Started in Version Control The overhead in providing sharing and recovery capability for a non-exclusive load greatly slows loading performance. However, the Repository is fully recoverable if an error occurs during non-exclusive load. The default value of Load in Exclusive Mode is OFF. Validate/Save Logic After Load Use the Validate Logic After Load check box if you want all logic in the loaded file to be automatically validated after the file has been loaded. Caution If you load in Exclusive Mode, Developer will also validate in Exclusive Mode and the recovery option will not be active. If your system terminates abnormally during the load or validation, your Repository will be corrupted. You will need to rebuild it from your most recent backup and start the load again. If you load and validate your Model in non-exclusive mode (the default), an automatic recovery process will protect you from Repository loss. The default value of Validate/Save Logic After Load is OFF. DMA Enabled Check the DMA Enabled check box to activate Dictionary Maintenance for your Repository. With DMA Enabled on, a 'get' or 'check out' operation of a Data Dictionary item will cause the definition of the item in your Repository (if one exists) to be overwritten by the definition of the item in the Version Bank, even if the item is used by other objects. This option will be temporarily allowed for the current load only and will override the system default of NO. If this check box is not checked, a Data Item in the Version Bank which is different from the Dictionary version will not be loaded into your Repository during a 'get' or 'check out' operation. The DMA Enabled option, when it is on, has a different effect when you 'get' an Ispec that includes a Data Dictionary item. In this situation if the definition of the Dictionary item is not the same as the Version Bank Data Item, the Data Item is loaded into the Repository with its Dictionary definition. A warning message is written to the error file and also displayed on screen. It is your responsibility to synchronize the definition in the Version Bank with the Dictionary (ie. the Repository) definition. Conflicts Allowed Check the Conflicts Allowed check box to load Local Data Dictionary items that conflict with the Global Dictionary. Uncheck the check box to ensure that no Data Items can be loaded which conflict with the Global Dictionary

87 Getting Started in Version Control If this check box is checked, conflicts will be temporarily allowed for the current load only, and will override the selection made for Conflicts Allowed in the Data Item Options dialog box when a Data Item was added. Drop Reserved When performing a load, a check is done to see whether the object is named with a reserved word for the appropriate target host (as specified in the Model options). If it is, and the Drop Reserved check box is checked, then the error message Word is a reserved word, item dropped is displayed and the object is not loaded. If the Drop Reserved check box is not checked, then the warning message Warning word is a reserved word is displayed, and the item is loaded as normal. Setting Branch Search Options Setting branch search options involves defining a Branch Search Order list. This is a list of branch labels that the system will search in sequence to find an object when a Get Latest Revision or Check Out is performed. If you choose to use the list for your search, only the branch labels in the Branch Search Order list are examined to find the requested object from the Version Bank. When a Get Revision is being performed the list is ignored, because you have already selected specific revisions for the Get Revision operation. This list is stored in the Developer Repository, so that every user has the same Branch Search Order list. The reason for this is that a Repository can contain only one revision of every object, e.g. if one object would have more than one branch and two different people are working on each branch, they cannot work in the same Repository. To prevent this there is only one Search Order list for a Repository. A Branch Search Order list is defined using the Search Order Options dialog box. Search Order Options Dialog Box Use the Search Order Options dialog box to set up a Branch Search Order list, and to specify that this list is to be searched in sequence when a Get Latest Revision or a Check Out is performed. You can access this dialog box in one of two ways: Click Search Options on the Version Control Options dialog box. Select the Settings command from the Version Control menu, then selecting the Branch Search Options command

88 Getting Started in Version Control The fields on the Search Order Options dialog box are: Branch Search Order Displays the list of branch labels in search order. Branch Label Displays other available branch labels to add to the list. Use Branch Search Order Check this check box to specify that a Get Latest Revision or Check Out operation will search for objects using the Branch Search Order list. The default setting is Off, in which case a Get Latest Revision or Check Out operation will default to the main branch or the selected branch. The branch labels available for selection are all the labels in the Version Bank for the Model in the Developer Repository. If you are not logged on to the Version Bank, the selection list will be disabled. Use the << and >> keys to move branch labels into or out of the list. Use the Up and Down buttons to change the order of branch labels in the list. Setting Multiple Check Out Options The multiple check out facility of Developer Version Control allows the same revision, of the same Object, to be checked out of a Version Bank by more than one user id, at the same time. Notes: Different revisions of the same object can be checked out, even if multiple check out is set on either the client or the server machine. Each user must check out the revision to a different Developer Repository. The Version Control Administrator defines whether multiple check outs are enabled or disabled for all users of a Version Bank, or whether multiple check out privileges are to be determined on a user-by-user basis. This is done in Developer Security using the Multiple Check Out Settings dialog box. Privileges for the individual user are set by the Administrator in Developer Security in one of two ways: By checking the Allow Multiple Checkout check box on the Version Control User dialog box. By selecting the user from the Version Control Users List, then selecting the Allow Multiple Check Out command from the Edit menu. The status of an object that has multiple check outs is shown both in the Version Control Explorer and in the VC Properties dialog box for the selected object

89 Getting Started in Version Control Multiple Check Out Settings Dialog Box Use the Multiple Check Out Settings dialog box to define whether multiple check outs of the same revision of an Object are permitted for the Version Bank named in the title bar. You must be a Version Control Administrator to do this. To open the dialog box, select the Multiple Check Out Rule command from the Version Control - Settings menu. Select one of the radio buttons to define a multiple check out option for the Version Bank: Allow all users All Version Bank users are allowed to perform multiple check outs. Disallow all users No one can perform multiple check outs on Objects in this Version Bank. Use individual user settings Multiple check out privileges are defined at the user level. See Setting Multiple Check Out Options for details on how to do this. The Version Control Explorer The Version Control Explorer is made up of two panes. The left pane, or tree view, displays a hierarchical view of all the objects in the Version Bank. The right pane, or Explorer List View, displays details of the object selected in the left pane. To open the Explorer, log on to Version Control and click Open the Version Control Explorer toolbar or select the Open Developer Version Control Explorer command from the Version Control menu. Items in the left pane are displayed in the following structure: Containers are at the top of the hierarchy and hold versionable objects. Containers are followed by versionable objects in the hierarchy. These are followed by branches from the main branch, if any exist. Revisions of a versionable object are the lowest members of the hierarchy. A revision that has a branch (such as Revision 1.2) has a dual purpose. It contains the revision 1.2, which can be checked out, and it will also have children, that is, the branch revisions. Their branch number uniquely identifies branches. The history of an object in the Version Bank is displayed as a series of file revisions dating from the time that the file was initially added to the Version Bank. Each revision represents one set of changes

90 Getting Started in Version Control Icons Icons are used in the Version Control Explorer to indicate the status of a revision. Labels A container called Labels lists all the branch and version labels that have been used in the Model, each in a different subcontainer. The Branch Labels container holds all branch labels defined for the Model. You are given the option to display only the branch number, only the branch label, or the branch number and the branch label. The branch container is displayed in the color specified for containers in the Explorer Colors - Options in the Version Control Options dialog box. Normal Version Control operations can be performed on the label container or its children. Also, by accessing the VC Properties dialog of a label, the name and description can be edited as described in Version Control Properties Dialog Box (Labels). Deleted Objects Deleted objects can be displayed or hidden using the Deleted objects command in the View menu. When deleted objects are hidden, if you select a container with only deleted objects in it, the right pane displays the message There are no items to show here - all items marked as deleted. Explorer Icons The following table shows the icons that are used in the Version Control Explorer to indicate the status of a revision: Revision Icon Description Normal Revision Revision is not checked out. Checked Out Revision Revision is checked out by one user. Multiply Checked Out Revision Revision is checked out by more than one user

91 Getting Started in Version Control Revision Icon Description Merged Revision Merged and Checked Out Revision Revision was merged with another revision. There are two merged revisions involved in a merge. One will be the end of its branch (so that no new revisions are permitted). The other revision will have a next revision added (the result of the merge) which can have a check in on the same branch. Revision was merged with another revision and has been checked out by one user. Merged and Multiply Checked Out Revision Merge Revision Revision was merged with another revision and has been checked out by more than one user. Revision is a result of a merge operation. Merge Revision with Check Out Revision is a result of a merge operation and is checked out by one user. Merge Revision with Multiple Check Out Revision is a result of a merge operation and is checked out by more than one user. Explorer List View Details of the versionable object selected in the tree view (left pane) of the Version Control Explorer are displayed in the right pane, the Explorer List View. Icons are used as in the Explorer tree view to indicate the status of a revision. If a parent node is selected, the list view includes for each child object the name, author, check in/check out date and time, and locked status. If a revision is selected, the revision number, author, check in/check out date and time, and locked status are displayed. If a label is selected, the details displayed refer to the object to which the label is assigned. Details include the name and type of the object, revision number, author, check in/check out date and time, and locked status. For a version label, the parent of the object is also shown

92 Getting Started in Version Control The details displayed are: Revision The Revision is in the format nnn where nnn is a numeric starting from 1. Each time a versionable object is checked out of the Version Control Bank and then checked in, a new revision is created and the number is incremented by 1. The higher the number, the more recent the version. Author Author is the userid of the person who created the versionable object in the Developer Repository. Date-Time If the versionable object is checked out, then the Date-Time displayed is the date and time the object was checked out. If the object is not checked out, the Date-Time displayed is the date and time the object was added or checked into the Version Control Bank. Locked by If the versionable object is checked out, the Locked by column displays the userid(s) of the person(s) who checked out the object from the Version Control Bank. Version Labels Display The version labels on a versionable object or on a single revision can optionally be displayed in the Explorer List View. To display the labels, click the Show in Lists command on the View menu, then select Labels. A new column is included to display the version labels. The column contains the list of labels separated by a space. The order in which the labels are displayed is the order in which the labels were created, with the last label created being displayed first. Printing from the Explorer From the Version Control Explorer you can print the hierarchical view shown in the left panel or the list view shown in the right panel. To do this: 1. Position the cursor in the panel that you want to print. 2. Select the Print command from the File menu. The Listing Options dialog box is displayed. 3. Click Print Options if you want to specify a title, header, footer, or other print options for your listing. 4. Click Font, if you want to specify a font, point size, or attributes for your listing. 5. Click OK to initiate the print job

93 Getting Started in Version Control Printing a Specification of an Object From the Version Control Explorer you can print a detailed listing for a single object in the Version Bank. To do this: 1. Click an object in the Explorer to select it. 2. Select the Print Specification command from the File menu. The Specification Listing Selections dialog box is displayed. 3. Check the relevant check boxes to include the details you require. The options are: Revision details Includes object name, revision number, Version Control Bank name, description, last modified date, last modified by, status (checked in or checked out), whether the object is marked as deleted, whether the revision is merged, and version labels. Version labels Includes the revision number to which the label is assigned and label description. Branch labels Includes the branch number to which the label is assigned and label description. Version tree Includes details of every revision in the version tree. Parent list Includes parent name(s) and object type(s). Include deleted objects Include in the listing objects marked as deleted. 4. Check the Table of contents check box if you want the listing to include a table of contents. 5. Check the Expanded print check box, if you want a page break after each section of the listing. 6. Click Print Options, if you want to specify a title, header, footer, or other print options for your listing. 7. Click Font, if you want to specify a font, point size, or attributes for your listing. 8. Click OK to initiate the print job. Customizing Branch Information Display You can customize the display of branch information on the Version Control Explorer. To specify how branch information should be displayed for your workstation: 1. Select the Branch Container Display command from the Options menu in the Version Control Explorer. The Branch Display Option dialog box is displayed

94 Getting Started in Version Control 2. Select a radio button to specify that you want to see Branch Number, Branch Label(s), or Both Number and Label(s). 3. If you select Both, select a display order and key in a separator. A blank is a valid separator character. 4. Click OK. The order in which the labels are initially displayed is in the order in which they were created. Branch Display Option Dialog Box Use the Branch Display Option dialog box to specify the type and order of information about branches that you want to see displayed in the Version Control Explorer. This dialog box is opened when you select the Branch Container Display command on the Options menu. The fields are: Options Select a radio button to display Branch Numbers, Branch Label(s), or Both Number & Label(s). Display Order If Both Number & Label(s) are to be displayed, select a radio button to specify if they are to be shown in Number/Label order or Label/Number order. Separator If Both Number & Label(s) are to be displayed, key in a character to separate the information displayed. A blank is a valid separator character. Click OK to close the dialog box. Version Control Status Window The Version Control Status Window displays the current status of Version Control activities as well as other informational messages. Only the messages from the last operation performed are shown, and the Status Window is cleared when the next operation begins. The display of the Status window can be toggled on and off using the Developer Version Control Status Window command on the Version Control menu. If this command has a check mark next to it, the Status Window is displayed. Select the command to turn the display off

95 Getting Started in Version Control You can additionally select a font for the display of messages in the Status Window. To do this, click on the Status Window, then on the Fonts toolbar button. The standard Windows font dialog box is displayed. Select a font from the list of fonts available on your system. When the Status Window is active, the Copy, Select All, Find, and Repeat Find functions are available from the Edit menu. Note that while you can select and copy text to the clipboard, you cannot enter or change text in the Status Window. Use the Save command from the Edit menu to save the contents of the Status Window to a file. Use the Logging command to turn Version Control logging on or off. All Edit menu commands are also available from a pop-up menu opened with a rightclick in the active Status Window. Saving the Status Window Contents To save the current contents of the Version Control Status Window to a file: 1. Select the Save command from the Edit menu of the active Status Window. 2. Specify a location and name for the file to be created, and click OK. If you save more than once to the same file, you are asked if you want to overwrite the existing file. Version Control Logging Version Control logging writes all entries in the Version Control Status Window to a file called vc_statuspanelog.txt in the temporary directory specified in Version Control Options. There are three ways to activate logging for Version Control: Add 'StatusPaneLogging=Y' to the Version Control section of your LINC.ini file. Click on the Status Window and press Ctrl + L. Click on the Status Window and select the Status Logging command from the Edit menu. When logging is on, the Status Logging command has a check mark next to it and the Status Window title contains the message 'Status Logging On'. If you turn logging off and then on again, new entries are appended to the existing file. Shortcut Ctrl+L

96 Getting Started in Version Control Using the Object Count Auditor The Object Count Audit feature helps you to determine the size of your system. You can choose which Business Segments to include in this count. As with all Analysis output, the result is sent to the printer. To run the Object Count Auditor: 1. Select the Object Count Audit command from the Analysis menu of the Model Directory. The Object Count Auditor dialog box is displayed. 2. Click a radio button to select the Business Segments to be included in the count: All, Selected, or None (to include only a total number of Business Segments and Global Data items). If you choose Selected, click Browse to open the Select Objects dialog box and select the Business Segments. 3. Click OK to start the Auditor run. Object Count Auditor Dialog Box Use the Object Count Auditor dialog box to run an audit to determine the size of your system. This dialog box is presented when you select the Object Count Audit command from the Analysis menu of the Model Directory. You may choose to include in the count: All All Business Segments in your system will be included in the count of objects. Selected The count will include only those Business Segments which you select. Click the Select button to open the Select Objects dialog box and specify the Business Segments to be included. None The count will only include the total number of Business Segments in your Model, along with any Global Data Items. After you have made your selection, you may set up the print output by using the Print Options button and/or the Fonts button. Click OK to start the Auditor run. Select Objects Dialog Box Use the Select Objects dialog box to specify which Business Segments are to be included in an Object Count Audit. This dialog box is presented when you click Select on the Object Count Auditor dialog box

97 Getting Started in Version Control Business Segments available for inclusion are listed in the Objects list box on the left. Select Business Segments for inclusion using any of these methods: Clicking on the Business Segment name. Holding down the Control key and clicking on a number of non-sequential Business Segment names. Clicking the Select All button under the Objects list box. Use the << and >> keys to move Business Segments into or out of the Selected Objects list. Click OK to return to the Object Count Auditor dialog box. Summary After completing this section you can: Log on to Version Control. Set options for the operation of Version Control. Use the Version Control Explorer to see a hierarchical view of the Version Control Bank. Print the hierarchical view in the left panel or the list view in the right panel of the Explorer. Print a detailed specification of an object selected in the Explorer. Toggle the view of status messages on or off. Save status messages to a file. Set logging for Version Control on or off. Run an Object Count Audit to determine the number of objects in a Business Segment

98 Getting Started in Version Control

99 Section 7 Using Version Control This section describes how to perform Version Control operations. This section includes: What is a Versionable Object? Adding Elements to the Version Control Bank Adding an Individual Element to Version Control Checking In an Element Checking Out an Element Getting an Element Undoing a Check Out Using Container Operations Managing Version Bank Objects Working with Version Labels Working with Branch Labels Working with Integrity Management Viewing Version Control Properties Version Control Operations Dialog Boxes Developer Console Note: Version Control operations across multiple Business Segments are not recommended. All affected objects must be checked out of the Version Control Bank before renaming objects or performing dictionary maintenance. If relationship integrity is not maintained between Enterprise Application objects, there is a risk of corrupting object relationships in the Version Control Bank. What is a Versionable Object? All of the following objects are versionable Enterprise Application objects, meaning they can be stored in the Version Control Bank: Model Definitions

100 Using Version Control Global Data Dictionary Items Business Segment Definitions Local Data Dictionary Items Global Setup Data Items Global Setup Data Item Blocks Functional Areas Activities Ispecs Keywords Global Logics Profiles Reports Wildcards Model Definitions The following properties of the Model can be stored in the Version Control Bank: Options Business Rules Graph nodes to child Business Segments and Wildcards Global Data Dictionary Items Each Data Item in the Global Data Dictionary is versionable. The following properties can be stored in the Version Control Bank: Options Business Rules Value checking logic Business Segment Definitions The following properties of the Business Segment can be stored in the Version Control Bank: Options Host information Business Rules

101 Using Version Control Relations Graph nodes to child Functional Areas Environmental options Local Data Dictionary Items Each Data Item in the Local Data Dictionary is versionable. The following properties can be stored in the Version Control Bank: Options Business Rules Value checking logic Global Setup Data Items Each ungrouped GSD item is versionable. Grouped GSD items can be stored with the parent and are not individually versionable. The following properties can be stored in the Version Control Bank: Options Business Rules Global Setup Data Item Blocks The following properties of the GSD Block can be stored in the Version Control Bank: Options Business Rules GSD Blocks are new in release 3.1. To define Global Setup Data Items into blocks, check out the GSDs. The Check Out operation places the GSDs in a default GSD Block. Define your new GSD Blocks and assign the GSDs to them, then add the GSD Blocks to the Version Bank and check in the GSDs (the GSD definition will contain the GSD Block name). See your Unisys Enterprise Application User Guide for details on setting up GSD Blocks. Functional Areas The following properties of the Functional Area can be stored in the Version Control Bank: Options

102 Using Version Control Business Rules Relations Graph nodes to child Activities Activities The following properties of the Activity can be stored in the Version Control Bank: Options Business Rules Relations Graph nodes to parent Functional Areas Ispecs The following properties of the Ispec can be stored in the Version Control Bank: Options Business Rules Relations Graph nodes to parent Functional Areas Painted screen Logic Teach screens Keywords The following properties of the Keyword can be stored in the Version Control Bank: Options Business Rules Painted Screen Global Logics The following properties of the Global Logic can be stored in the Version Control Bank: Options Business Rules Relations

103 Using Version Control Graph nodes to parent Functional Areas Painted screen (if any) Logic Teach screens Profiles The following properties of the Profile can be stored in the Version Control Bank: Options Business Rules Relations Graph nodes to parent Functional Areas Teach screens Reports The following properties of the Report can be stored in the Version Control Bank: Options Business Rules Relations Graph nodes to parent Functional Areas Painted screen Logic Teach screens Wildcards The following properties of a Wildcard can be stored in the Version Control Bank: Options Business Rules Relations Graph nodes to parent Business Segments Although a Wildcard can be the child of a Model and a Business Segment, you should define a Wildcard as having one parent only. If a Wildcard is defined as being the child of both, it will be versioned under the Model (that is, any Version Control operation on

104 Using Version Control this Wildcard will use the one under the Model). To ensure that a Wildcard is versioned under a Business Segment, define the Wildcard under its parent Business Segment only. Adding Elements to the Version Control Bank You must add objects to Version Control before you can carry out any other Version Control activity on the objects. Adding an element to Version Control means that a copy of the object in the Developer Repository is added to the Version Control Bank. A main branch is created in Version Control, and a new revision of the object is created on that branch. You can add objects to the Version Control Bank individually, or you can use Container Operations to add an object and all its versionable children in one operation. Because the Version Control Bank is unaware of the dependencies that exist between objects, it is up to you to identify and add all the relevant objects to Version Control. The easiest way to ensure all objects are added is to use Container Operations. During the add operation, a temporary file is created. This file contains a record of the objects that have been added successfully. If the add operation fails (for example, the Version Control Bank runs out of space during a large add), you can check the temporary file to see which objects have been added. After you resolve the reason why the add failed, you can add the remaining objects. The temporary file is named VC_ADD.LOG and is located in the TEMP directory specified in the Version Control Options dialog box. VC_ADD.LOG is deleted when an add operation completes successfully. It is also possible to add an element using the Developer Console. This facility is particularly useful for routine operations. See the VCADD command for further details. Note: Every object in an add operation is processed sequentially within a single transaction. If you cancel the add operation, the cancellation takes effect after the current object in the sequence has been added. Adding an Individual Element to Version Control You can add any versionable object to the Version Control Bank. To add an individual object or objects: 1. Click on the object(s) in the Model Directory to select it. 2. Select the Add Element(s) to Bank command on the Version Control menu. If this command is not available, the object you have selected is either not versionable or has already been added to the Version Bank. The Version Control - Add File(s) dialog box is displayed, with the objects you selected in the Items list box

105 Using Version Control 3. Key in a comment or description of the object in the Comment field. This is required. 4. Check the Keep checked out check box if you want this object to be checked out and locked under your userid after adding it to the Version Bank. 5. Check the Create branch check box if you want to create a new branch into which the object will be checked. When you add an object to the Version Bank, the system automatically creates a main branch and adds a new revision to this branch. Check this check box only if you want to create a branch other than the main branch, and a revision will then be added to both branches. If you select Create branch, the Add Branch Label field and Add new branch name to branch search order check box are activated. Select a branch label from the Add Branch Label drop-down list to attach an existing label to the new branch, or key in a new label, if you wish to assign a label to the new branch. Check the Add new branch name to branch search order check box if you want to add the new label to the Branch Search Order list. 6. If you want to assign a version label to the revision that will be created when the object is added, select a version label from the Add Version Label drop-down list, or key in a new label. 7. Click OK to begin the add operation. Note: Invalid characters, or strings longer than the maximum length of this field cannot be entered and will not be displayed. If you paste an entry containing invalid characters or which exceeds the length, the text will be pasted up to the invalid character or maximum length. Refresh the Version Control Explorer by clicking on the Refresh command in the Window menu and check that all your additions worked correctly. If you add an individual object to the Version Control Bank, you must ensure that all its dependent objects are also added. Checking In an Element Checking in an object creates a new version of the selected object in the Version Control Bank from the Developer Repository. New versions are displayed as revisions in the Version Control Explorer. To check in an object: 1. Select the checked out object in the Version Control Explorer. 2. Select the Check In command from the Version Control menu. The Version Control - Check In File(s) dialog box is displayed with the objects selected for check in presented in the Items list

106 Using Version Control 3. Revise the Items list if required. 4. Key in a Comment to describe the change you have made. 5. Check the Keep checked out check box if you want to keep the object checked out. 6. Check the Create branch check box if you want to check the object(s) into a new branch. If you select Create branch, the Add Branch Label field and Add new branch name to branch search order check box are activated. Select a branch label from the Add Branch Label drop-down list to attach an existing label to the new branch, or key in a new label, if you wish to assign a label to the new branch. Check the Add new branch name to branch search order check box if you want to add the new label to the Branch Search Order list. 7. If you want to assign a version label to the revision that will be created when the object is added, select a version label from the Add Version Label drop-down list, or key in a new label. 8. Click OK. It is also possible to check in an element using the Developer Console. This facility is particularly useful for routine operations. See the VCCHECKIN command for details. Checking in revisions with multiple check outs If you check in a revision and the latest revision on the branch existed before your check out, you are prompted to create a new branch for your revision. If you check in a revision and another check in on that branch occurred after your check out, the Merge Confirmation dialog box is displayed. You are prompted to either merge your changes with the latest revision on the branch, create a new branch for your revision, or cancel the check in. If you choose to merge, the Merge dialog box is displayed for you to incorporate your changes as a new revision on this branch, without losing other users' changes. Note: Invalid characters, or strings longer than the maximum length of these fields cannot be entered and will not be displayed. If you paste an entry containing invalid characters or which exceeds the length, the text will be pasted up to the invalid character or maximum length. Checking Out an Element Checking out an element moves a copy of the selected object from the Version Control Bank into the Developer Repository, where it can be modified. When you check out a file, it is locked under your userid

107 Using Version Control To check out an element: 1. Select the object in the Version Control Explorer. 2. Select the Check Out command on the Version Control menu. If the Use Dialog option is active for your system, the Version Control - Checkout Files dialog box is displayed. If you are permitted to perform multiple check outs and the object you have selected is already checked out, you are asked to confirm that you wish to continue with the check out. 3. If the object in the Version Control Bank is different to the object in the Repository, you are asked to confirm that you wish to replace the object in the Repository with the object from the Version Control Bank. It is also possible to check out an element using the Developer Console. This facility is particularly useful for routine operations. See the VCCHECKOUT command for details. Version Control will only be able to check out and lock a file under your userid if the load into the Developer Repository is successful. A load into the Repository may fail if linked objects are missing from the load. Therefore, in order to ensure that the required file can be checked out and locked, you may have to check out other related files. If you have multiple check out privileges, you will not be able to check out an element that is already checked out to a user who doesn't have multiple check out privileges. Getting an Element 'Getting' a revision of an object from the Version Bank makes a copy of the selected revision in the Developer Repository without locking the object. There are four Get commands in Version Control: Getting the Latest Revision Loads the latest revision of an object from the Version Control Bank into the Repository without locking the object. Getting the Latest Revision from the Main Branch Gets the latest revision of an object from the main branch only. Getting a Revision Loads a specific revision of an object from the Version Control Bank into the Repository without locking the object. Getting a Revision By Label Retrieves all objects labeled with a given version label

108 Using Version Control It is also possible to get an element using the Developer Console. This facility is particularly useful for routine operations. See the VCGET command for details. Note: When you perform a 'get' operation on an Ispec that includes a Dictionary Data item, and the definition of the Dictionary item is not the same as the Version Bank Data Item, the action taken by Version Control depends on the setting of the DMA Enabled option in the Version Control Options dialog box or the Version Control Get File(s) dialog box. If DMA Enabled is not checked, the Data Item will not be loaded into the Repository if there is a conflict. If DMA Enabled is checked, the Data Item is loaded with its Dictionary definition. A warning message is written to the error file and also displayed on screen. It is your responsibility to synchronize the definition in the Version Bank with the Dictionary definition. Getting the Latest Revision Getting the latest revision of an object moves a copy of the most recent revision from the Version Control Bank into the Repository without locking the object. When you get a file, it is not locked under your userid and can be checked out and modified by another user. To get the latest revision of an object: 1. Select the object(s) from the Version Control Explorer or the Model Directory. 2. Select the Get Latest Revision command in the Version Control menu. You can use the Get Latest Revision command from: The Version Control Explorer The following Developer panes that are accessed from the Open Model Navigation dialog box: Model Directory Global Data Dictionary Business Segment List The following Developer panes that are accessed from the Open Business Segment Navigation dialog box: Local Data Dictionary Global Setup Data Item List Functional Area List Activity List Ispec List

109 Using Version Control Profile List Report List Global Logic List If the Get Latest Revision command is unavailable from one of the Developer panes, it means that the selected object is not in the Version Control Bank. See Adding an Individual Element to Version Control for information on adding objects to the Version Bank. Getting the Latest Revision from the Main Branch Getting the latest revision of an object from the main branch moves a copy of the most recent revision on the main branch from the Version Control Bank into the Repository without locking the object. Any later revisions of the object which may exist on other branches of the tree will be ignored. When you get a file, it is not locked under your userid and can be checked out and modified by another user. This operation is only available from the Model Directory. To get the latest revision from the main branch: 1. Select the object in the Model Directory. 2. Select the Get Latest Revision From Main Branch command on the Version Control menu. If the Use Dialog option is active for your system, the Version Control - Get Files dialog box is displayed. If the Use Dialog option is not active, the Check Out command executes immediately. Getting a Revision Getting a revision makes a copy of any revision you select from the Version Control Bank into the Developer Repository. When you get a file, it is not locked under your userid and can be checked out and modified by another user. To get a revision: 1. Select a revision of an object in the Version Control Explorer. 2. Select the Get Revision command on the Version Control menu. If the Use Dialog option is active for your system, the Version Control - Get File(s) dialog box is displayed. If the Use Dialog option is not active, the Check Out command executes immediately. 3. If the object in the Version Control Bank is different to the object in the Repository, you are asked to confirm that you wish to replace the object in the Repository with the object from the Version Control Bank

110 Using Version Control Note that the Get Revision command is only available from the Version Control Explorer or the Developer Console. If you want to get a copy of an object in the Version Control Bank from one of the Developer panes, only the Get Latest Revision or the Get Latest Revision From Main Branch commands are available. Getting a Revision By Label You can retrieve all revisions of objects labeled with a given version label, a Version Control feature which supports release management. There are two ways of getting revisions by label. Using the Select Version Label Dialog Box 1. Select the Labels command on the Version Control menu. 2. Select the Get By Label command on the Labels menu. The Select Version Label dialog box is displayed. 3. Select the Model in which the revisions are kept. 4. Select the version label of the objects you want to retrieve. 5. Click OK. If the Use Dialog option is active for your system, the Version Control - Get File(s) dialog box is displayed. If the Use Dialog option is not active, the Check Out command executes immediately. Selecting a Label 1. Click on a label in the Version Control Explorer to select it. 2. Select the Labels command on the Version Control menu. 3. Select the Get By Label command on the Labels menu. The Get By Label command can be accessed from any list window or from the Version Control Explorer, or the Developer Console. See What Is Labelling? for an example of how labels are displayed in the Version Control Explorer. Undoing a Check Out Use the Undo Check Out command to unlock objects that were previously checked out from the Version Control Bank -- that is, to reverse the check out operation. Only the Version Control Administrator or the user who checked out the object can unlock that object. You can identify the user responsible for checking out an object in the Locked By section of the Revision information in the Version Control Explorer, or in the Version Control Properties dialog box

111 Using Version Control To undo a check out: 1. Select the checked out object in the Version Control Explorer. 2. Select the Undo Check Out command on the Version Control menu. 3. If you are a Version Control Administrator, the Undo Check Out dialog box is displayed, permitting you to undo your own check out, other users' checkouts, or all check outs for the selected object. For an object that is currently checked out by more than one user, you can undo check outs using the Check Outs dialog box, as follows: 1. Select the checked out object in the Version Control Explorer. 2. Select the VC Properties command in the Files menu. The Version Control Properties dialog box is displayed. 3. Click Check Outs to display the Check Outs dialog box. 4. Select one or more check outs and click Undo Check Out. It is also possible to undo a check out using the Developer Console. This facility is particularly useful for routine operations. See the VCUNDOCHECKOUT command for details. Using Container Operations Container Operations allow an operation to be carried out on a selected object and all its versionable children in a single action. Container Operations are only available for Models, Business Segments, Functional Areas, and Activities. Container Operations can be performed from either the Model Directory or using the Developer Console. The Container Operations command is not available from the Version Control Explorer. The Container Operations command displays a submenu with the following options: Container Operations - Adding Element(s) to Bank Container Operations - Checking In Container Operations - Checking Out Container Operations - Get Latest Revision Container Operations - Get Latest Revision From Main Branch Container Operations - Undo Check Out When you select a command from the submenu, the operation is performed on the latest versions of the selected objects including all the versionable children

112 Using Version Control Container Operations - Adding Element(s) to Bank Use the Container Operations - Add Element(s) to Bank command to add Model, Business Segment, Functional Area, and Activity objects, together with their versionable children, to the Version Control Bank. Using Container Operations to do this ensures that all objects required to maintain the integrity of Enterprise Application object relationships are added to the Version Control Bank. To add an object using Container Operations: 1. Select the Model, Business Segment, Functional Area, or Activity in the Model Directory. 2. Select the Container operations command in the Version Control menu, then click Add Element(s) to Bank. The Version Control - Add File(s) dialog box is displayed. 3. Complete the fields in this dialog box as described in Adding an Individual Element to Version Control. Container Operations - Checking In Use the Container Operations - Check In command to check a new version of the selected object and all its versionable children into the Version Control Bank from the Developer Repository. New versions are displayed as revisions in the Version Control Explorer. This command is available only for Model, Business Segment, Functional Area, and Activity folders. To check in an object using Container Operations: 1. Select the checked out Model, Business Segment, Functional Area, or Activity in the Model Directory. 2. Select the Container operations command in the Version Control menu, then select Check In. The Version Control - Check In File(s) dialog box is displayed. 3. Complete the fields in this dialog box as described in Checking In an Element. Container Operations - Checking Out Use the Container Operations - Check Out command to load the selected object and all its versionable children from the Version Control Bank into the Developer Repository. When you check out these objects, they are locked under your userid. This command is available only for Model, Business Segment, Functional Area, and Activity folders

113 Using Version Control To check out an object using Container Operations: 1. Select the Model, Business Segment, Functional Area, or Activity in the Model Directory. 2. Select the Container operations command in the Version Control menu, then select Check Out. The Version Control - Checkout File(s) dialog box is displayed. 3. Complete the fields in this dialog box as described in Checking Out an Element. Container Operations - Get Latest Revision Use the Container Operations - Get Latest Revision command to get the latest revision of the selected object and all its versionable children. This command is available only for Model, Business Segment, Functional Area, and Activity folders. To get the latest revision using Container Operations: 1. Select the Model, Business Segment, Functional Area, or Activity in the Model Directory. 2. Select the Container operations command in the Version Control menu, then select Get Latest Revision. The Version Control - Get File(s) dialog box is displayed. 3. Complete the fields in this dialog box. Note: It is not possible to get a specified revision of a Container object via the Developer Console. You should get the individual objects separately instead. See Developer Console for further details. Container Operations - Get Latest Revision From Main Branch Use the Container Operations - Get Latest Revision From Main Branch command to get the latest revision of an existing object and all its versionable children from the main branch of the Version Control Bank into the Repository without locking the objects. The operation will ignore any later revisions of the object which may exist on other branches of the tree. This command is available only for Model, Business Segment, Functional Area, and Activity folders. To get the latest revision from main branch using Container Operations: 1. Select the Model, Business Segment, Functional Area, or Activity in the Model Directory

114 Using Version Control 2. Select the Container operations command in the Version Control menu, then select Get Latest Revision From Main Branch. The Version Control - Get File(s) dialog box is displayed. 3. Complete the fields in this dialog box. Container Operations - Undo Check Out Use the Container Operations - Undo Check Out command to unlock objects that were previously checked out from the Version Control Bank. This command is available only for Model, Business Segment, Functional Area, and Activity folders. To undo a check out operation using Container Operations: 1. Select the checked out Model, Business Segment, Functional Area, or Activity in the Model Directory. 2. Select the Container operations command in the Version Control menu, then select Undo Check Out. Managing Version Bank Objects Version Control offers a number of functions to control objects in the Version Bank. These functions include: These functions are described in the following subsections: Rolling Back to a Revision Deleting an Object Undoing a Delete for an Object Purging an Object Restoring an object to an earlier revision. Marking an object as 'deleted' to exclude it from VC operations. Removing an object from 'deleted' status. Physically removing an object from the Version Bank. Rolling Back to a Revision The rollback function allows you to discard a specified revision and all later revisions of an object, effectively rolling back changes in the Version Bank. Only a Version Control Administrator is permitted to perform a rollback. To rollback changes to a revision: 1. Select the earliest revision of the object that you want to discard in the Version Control Explorer. The selected revision and all later revisions will be removed. 2. Select the Rollback command on the Edit menu

115 Using Version Control 3. You are prompted to confirm the rollback request. Click Yes to confirm the rollback, or click Cancel to abort the operation. Deleting an Object The delete function marks an object in the Version Bank as 'deleted'. Objects marked as deleted: Can be displayed or hidden in the Version Control Explorer Are displayed in a different color when not hidden Are not included in Container Operations Cannot have Version Control operations other than Undo Delete or Purge performed on them Can be included in queries by specifying Select Status = 'Deleted' You cannot delete an object that is checked out. To mark an object as deleted: 1. Select the object that you want to delete in the Version Control Explorer. 2. Select the Delete command on the Edit menu. 3. You are prompted to confirm the delete request. Click Yes to confirm the delete, or click Cancel to abort the operation. It is also possible to delete an object using the Developer Console. This facility is particularly useful for routine operations. See the VCDELETE command for details. If you mark an object in a branch for deletion, not only is the branch object marked but also the original object itself is marked for deletion. To perform a deletion on a revision, you must be logged on as an administrator and "Rollback" the revision. For details of this procedure, refer to Rolling Back to a Revision. For additional information about deleted objects, see Displaying Deleted Objects, Changing Color for Deleted Objects, and Undoing a Delete for an Object. To remove an object permanently from the Version Bank, see Purging an Object. Displaying Deleted Objects To display objects marked as deleted in the Version Control Explorer, select the Deleted objects command from the View menu. When the option to display deleted objects is on, this command appears with a check mark to the left of it. Select the command again to turn off the display of deleted objects

116 Using Version Control Changing Color for Deleted Objects The default color for the display of deleted objects in the Version Control Explorer is red, but you can set another color if you wish. To set a color for deleted objects: 1. Select the Colors command from the Options menu. The Colors dialog box is displayed. 2. Click Delete. A color palette window is displayed. 3. Select the required color and click OK. 4. Click OK again to close the Colors dialog box. Undoing a Delete for an Object An object that is marked as deleted in the Version Bank can be restored by undoing the delete. A deleted object must be restored before you can perform any Version Control operations on it. To undo a delete: 1. Select the deleted object in the Version Control Explorer. (You must have the display of deleted objects option turned on.) 2. Select the Undo Delete command from the Edit menu. Purging an Object The purge function removes an object from the Version Bank permanently; the operation cannot be reversed. You can purge a deleted object, but you cannot purge an object that is checked out. Only a Version Control Administrator is permitted to purge an object from the Bank. To purge an object: 1. Select the object to be purged in the Version Control Explorer. 2. Select the Purge command from the Edit menu. 3. You are prompted to confirm the purge request. Click Yes to confirm the purge, or click Cancel to abort the operation. It is also possible to purge an object using the Developer Console. This facility is particularly useful for routine operations. See the VCDELETE command and use of the - P switch for details

117 Using Version Control Working with Version Labels Version labels are short, user-defined names that can be used to identify revisions of objects in the Version Control Bank. Version labels are associated with a Model, so once a label is defined, it can be assigned to other objects in the Model. You can create new version labels and assign existing labels to revisions in several ways. During an Add or Check In operation When an object is added or checked in to the Version Bank, the dialog box displayed includes an Add Version Label field. You can select an existing label using the dropdown list, or key in a new label. If the selected label is in use on another revision for the same object, you are asked if you want to move it. Using the Branch/Version Label Maintenance Dialog Box 1. Select a revision in the Version Control Explorer. 2. Select the VC Properties command in the File menu. The VC Properties dialog box is displayed. 3. Click Labels. The Branch/Version Label Maintenance dialog box is displayed. 4. Key in a new label and description, or select an existing label name. 5. Click Apply. You can also use this dialog box to rename or remove a label (if you are a Version Control Administrator). All users can modify the description associated with a label. Using the Labeling Items Dialog Box The Labelling Items dialog box is displayed when you select the Labels command from the Version Control menu, then select Label Selected Item(s) or Label Selected Model. Use this method when you want to assign a label to a number of revisions in one operation. 1. In the Items list, select the items to which you wish to assign a label. 2. Select an existing label from the Label drop-down list, or key in a new label. 3. Key in a description if you have specified a new label. 4. Click OK to assign the label. Using the Developer Console See the VCLABEL Developer Console command for details

118 Using Version Control Working with Branch Labels A branch has an identifying number assigned by the system when it is created, but in addition you can create a branch label to give your own short, descriptive name to a branch. A branch label is associated with a Model, but many objects within the Model can have a branch with the same label. Branch labels can be used to specify a branch search order to find objects when a Get Latest Revision or Check Out operation is performed. A branch label is alphanumeric and can be up to 36 characters long. You can create new branch labels or assign existing labels to branches in one of two ways: During an Add or Check In operation When an object is added or checked in to the Version Bank, the dialog box displayed includes the Create Branch check box to create a new branch. If you select this, you can key in a new name for the branch in the Add Branch Label field or select an existing label using the drop-down list. Note: The Developer Console does not support a parameter to assign branch labels. Using the Branch/Version Label Maintenance Dialog Box 1. Select a branch node in the Version Control Explorer. 2. Select the VC Properties command in the File menu. The VC Properties dialog box is displayed. 3. Click Labels. The Branch/Version Label Maintenance dialog box is displayed. 4. Key in a new label and description, or select an existing label name. 5. Click Apply. You can also use this dialog box to rename or remove a label (if you are a Version Control Administrator). All users can modify the description associated with a label. Working with Integrity Management Integrity Management is an optional checking procedure which ensures that the contents of the Developer Repository are synchronized with the contents of the Version Bank. Each time you perform an operation that might change a versionable object, Integrity Management checks to see what other objects might be affected by the change and takes remedial action. If Integrity Management is set on for your system, you will see some differences in the way Version Control works. Some options in dialog boxes and menus are disabled when an operation is not allowed by Integrity Management. For other operations, you are prompted to take additional actions to ensure that the integrity of the Version Bank is maintained

119 Using Version Control Some examples of how Integrity Management affects Version Control are included below. Updating If you select an object in the Model Directory that has not been checked out from the Version Bank, you cannot change or delete the object. If you update an object which would cause other objects to be modified, you are prompted to check out these objects first before the update can proceed. If you don't, the update will fail. Checking Out For a Check Out operation initiated by Integrity Management, you will not be prompted to confirm the overwrite of changed objects in the Repository. The Check Out will go ahead and overwrite what is in the Repository. Adding The Add command is disabled if you want to add a new object to the Repository, and the parents of the object: Are in the Version Bank Are not checked out by you Will be modified by the add operation If you add a new versionable object to the Repository, Integrity Management prompts you to add the object (and any other uncontrolled objects) to the Version Bank. (You can keep the object checked out if you choose to add it to the Bank.) When you end your Developer session, Integrity Management prompts you to add any uncontrolled versionable objects to the Version Bank. Deleting The Delete command is disabled if you want to delete an object from the Repository, and the parents of the object: Are in the Version Bank Are not checked out by you Will be modified by the delete operation Note: There is a performance overhead when using Integrity Management. The size of the impact depends on the number of dependencies on the object that is being changed. See Setting Integrity Management for information on how Integrity Management is enabled

120 Using Version Control Viewing Version Control Properties Version Control properties refers to information about an object in the Version Control Bank, such as the object's name, the name of the Version Bank, whether the object has been modified, who modified it and when. View Version Control properties for a selected object by clicking on the VC Properties command in the File menu. The Version Control Properties dialog box is displayed. There are four variations of the Version Control Properties dialog box: Version Control Properties Dialog Box (Model) for objects selected from the Model Directory. Version Control Properties Dialog Box (Container) for containers selected from the Version Control Explorer. Version Control Properties Dialog Box (Revisions) for revisions selected from the Version Control Explorer. Version Control Properties Dialog Box (Labels) for a label selected from the Version Control Explorer version label or branch label container. When a Version Control Properties dialog box is open, you can perform other Developer operations, such as opening an options dialog or selecting another object. If you select another object, the Properties dialog box is updated with the information for the newly selected object. If you select a non-versionable object or multiple objects, the open dialog displays the message No Properties available. Some Properties dialog boxes allow you to update information. If you close a Properties dialog box or select another object of a different type, any change you have made is committed immediately; you are not prompted to confirm the change. Properties dialog boxes include an Apply button to commit changes without closing the dialog. Version Control Properties Dialog Box (Model) Open the Version Control Properties dialog box for a Model by selecting the Model in the Explorer, then selecting the VC Properties command from the File menu. This dialog displays the following details: The name of the selected object. The name of the Version Control Repository and Server. If the object has not been added to the Version Bank, it displays "Not Controlled". The state of the object, that is, whether or not it has been modified. This information is updated as soon as a checked out object is modified in the Developer Repository. The date and time that the object was modified

121 Using Version Control The userid of the person who last modified the object. The status of the object, that is, whether it is checked in or out and, if it is checked out, the userid of the person who has it checked out. The branch and revision number of the latest version of the object. To see a list of Version Labels for the object, click Version Labels. The button is disabled if you are not logged into Version Control, or if the object is not controlled Version Control Properties Dialog Box (Container) Open the Version Control Properties dialog box for a container by selecting the container in the Explorer, then selecting the VC Properties command from the File menu. This dialog displays the following details: The name of the Container (Folder Name). The contents of the Container. Version Control Properties Dialog Box (Revisions) Open the Version Control Properties dialog box for a revision by selecting the revision in the Explorer, then selecting the VC Properties command from the File menu. This dialog displays the following details: The name of the selected object. The name of the Version Control Repository and Server. The state of the object, that is, whether or not it has been modified. This information is updated as soon as a checked out object is modified in the Developer Repository. The date and time that the object was modified. The userid of the person who last modified the object. The status of the object, that is, whether it is checked in or out and, if it is checked out, the userid of the person who has it checked out. Three dots following the userid indicate that more than one person has the object checked out. If this is the case, the Check Outs button on the right is activiated. Click Check Outs to display details of the check out status. Whether the object has been merged or is the result of merging two branches. The branch and revision number of the latest version of the object. A Label button to display the Branch/Version Label Maintenance dialog box, which will allow you to maintain labels for a selected object. The comments relating to the object or the modifications to the object as entered when the object was checked in or added to the Version Control Bank. These comments can be modified

122 Using Version Control Version Control Properties Dialog Box (Labels) Open the Version Control Properties dialog box for a label by selecting the Label or Branch Label container in the Explorer, then selecting the VC Properties command from the File menu. This dialog displays the following details: Label name Description assigned to the label Both the Label name and description can be modified in this dialog box if the dialog box was called from the Branch/Version Labels Maintenance dialog box. A label can be deleted using the Edit/Delete menu. You must have Version Control Administrator rights to rename or delete a label. Version Control Operations Dialog Boxes The dialog boxes which assist you with Version Control operations and navigation include: Branch/Version Label Maintenance Dialog Box Check Outs Dialog Box Colors Dialog Box Confirmation of Overwrite Dialog Box Go Dialog Box Labelling Items Dialog Box Merge Confirmation Dialog Box Select Version Label Dialog Box Undo Check Out Dialog Box Version Control Add/Check In File(s) Dialog Box Version Control Get/Checkout File(s) Dialog Box Branch/Version Label Maintenance Dialog Box Use the Branch/Version Labels Maintenance dialog box to maintain branch and version labels for a Model. When you select a label in the Version Control Explorer, this dialog shows an overview of all the labels assigned to the selected object(s) for which you can add, rename or remove labels or edit the description. Any user is permitted to add a label or edit a description, but only users with Version Control Administrator rights are allowed to rename or remove a label

123 Using Version Control The Branch/Version Labels Maintenance dialog box is displayed when you select a revision from the Version Control Explorer, select the VC Properties command in the File menu, then click Labels in the Version Control Properties dialog box. When an item in the list is selected, the name is displayed in the Labels For Object field and the description in the description field. The following actions can be taken: Click Add to add a label. Click Edit to rename the selected label or change its description. If you click either the Add or Edit button, the Version Control Properties dialog box (Labels) will be displayed for you to make your changes. Click Remove to remove the selected label from the list. Click OK to commit your changes. Click Cancel to close the dialog without making any changes. Changes are not commited to the Version Bank until the OK button is clicked. Check Outs Dialog Box The Check Outs dialog box displays status details of a revision which has been checked out by more than one user. You can also use this dialog box to undo check outs, although to undo another user's check out you must be a Version Control Administrator. This dialog box is opened by clicking Check Outs on the Version Control Properties dialog box for a revision. For each check out, the details displayed include: User Id The user id of the person who has this revision checked out. Date-Time Date and time of the check out operation. Role (displayed for Administrators only) Role of the Version Control user ('SysAdmin' for an Administrator or 'User' for a user without administrator privileges). To undo a check out You must be an Administrator to undo another user's check out. 1. Select one or more user ids from the list. 2. Click Undo Check Out

124 Using Version Control Colors Dialog Box Use the Colors dialog box to specify colors for the display of containers and deleted objects in the Version Control Explorer. This dialog box can be accessed in one of two ways: Select the Settings command from the Version Control menu, then select Options to display the Version Control Options dialog box. Click Explorer Colors - Options. Select the Colors command from the Options menu. The buttons on this dialog box include: Containers Click this button to open a standard color palette window and select a color for the display of containers. Deleted Click this button to open a standard color palette window and select a color for the display of deleted objects. Confirmation of Overwrite Dialog Box When you select objects for the Check Out or Get Revision operations, Version Control checks the relative status of the objects in the Version Control Bank and the Developer Repository. If Version Control detects that an object in the Version Control Bank is different to the object in the Repository, you are asked to confirm that you wish to replace the object in the Repository with the object from the Version Control Bank. Click Yes to confirm that you wish to replace the current object in the Repository with the object in the Version Control Bank. Click No to leave the object in the Repository unchanged. If you have selected multiple objects on which to perform a Check Out or Get Revision: Click Yes All to replace all the selected objects. Check the Skip Checked Out Objects check box to replace all the selected objects, except for objects you have checked out. Click No All to leave all the objects in the Repository unchanged. Click Cancel to cancel the operation and return to the previous screen. Go Dialog Box Use the Version Control Go dialog box to specify a window within a Model and Business Segment that you wish to become the active window

125 Using Version Control You can access this dialog box by: Clicking on the Go toolbar button. Selecting the Go command from the File menu. Pressing F9. The fields on this dialog box include: Model Select a Model from the drop-down list. Business Segment Select a Business Segment from the drop-down list. Go field Key in the identifier of the window to which you want to 'go'. Click OK to action your request. Labelling Items Dialog Box Use the Labelling Items dialog box to assign version labels to selected objects or to all objects in a selected Model. This dialog box is presented when you select the Labels command on the Version Control menu, then the Label Selected Items or the Label Selected Model commands. The fields on this dialog box include: Items Use the Items list to select the object or objects to which you want to add a version label. Initially all the items in the list are selected. Label Select an existing version label from the list, or add a new one. If you select a label that is already assigned to another object, you are asked to confirm that you wish to move the label to the new revision. Description Key in a description for a newly added label. If you have selected an existing label from the Items List, this description field is disabled. Note: Invalid characters, or strings longer than the maximum length of this field cannot be entered and will not be displayed. If you paste an entry containing invalid characters or which exceeds the length, the text will be pasted up to the invalid character or maximum length

126 Using Version Control Use the Select All button to select all items in the Items List, and the Unselect All button to deselect all items in the list. Use the OK button to assign the version labels. Merge Confirmation Dialog Box The Merge Confirmation dialog box is displayed when you check in a revision, and another check in of the object has occurred since your check out. This situation occurs when multiple check outs are permitted for a Version Bank. Click Merge if you want to merge your changes with those of the latest revision on the branch from which the check out occurred. The Merge dialog box is opened for you to review and select changes for the resulting merge revision. Click Branch, if you want to create a new branch and check your revision into it. Click Cancel to cancel the check in operation. Select Version Label Dialog Box Use the Select Version Label dialog box to specify a label in order to get all revisions of objects with that label. This dialog box is presented when you select the Get By Label command from Labels in the Version Control menu. The fields are: Model A list of Models available in the Version Bank is displayed. Select the Model which contains the revisions of the objects you wish to retrieve. Labels A list of version labels for the selected Model are displayed. Select the version label which corresponds to the revision of all objects in the system which you wish to retrieve. Load in Developer Repository Select this radio button if you want the retrieved objects to be loaded into the Developer Repository. Extract from Version Control Bank only Select this radio button if you want the retrieved objects to be written to an extract file instead of being loaded into the Repository. If you select this, the Target Directory and Browse button will be enabled for you to specify a file name and path for the extract file. When you click OK, if you have checked the Use dialog for Get/Check Out option in the Version Control Options dialog box, you are presented with the Version Control - Get File(s) dialog box

127 Using Version Control Undo Check Out Dialog Box The Undo Check Out dialog box is displayed for Version Control Administrators only when the Undo Check Out command is selected from the Version Control menu. The dialog box enables Administrators to reverse their own check out on the selected object, reverse a check out by another user, or reverse all check outs. Select of the radio buttons to specify which check outs are to be 'undone': My Check Out Select this option to undo your own check out. This option is disabled if you do not have the selected object checked out. Check Out by Selecting this option activates the drop-down list at the right. Select the userid whose check out you wish to undo. All Check Outs Select this option to undo all check outs on the selected object. Check the Apply To All check box if you have selected more than one object from the Explorer and you want the specified undo operations to apply to all of them. Version Control Add/Check In File(s) Dialog Box The Version Control Add File(s) dialog box and the Version Control Check In File(s) dialog box serve similar functions: to specify which objects are to be added or checked in to the Version Control Bank, and to specify additional information about those objects. The Version Control Add File(s) dialog box is displayed when you perform an Add operation. The Version Control Check In File(s) dialog box is displayed when you perform a Check In operation. The fields on these dialog boxes include: Items This lists the items which can be selected for processing by the Add or Check In command. Comment Key in a description of the object that you are adding or changing. Keep checked out Check the Keep checked out check box if you wish to keep the object checked out

128 Using Version Control Create Branch Check the Create Branch check box if you wish to add or check the objects in to a new branch. Add Branch Label Select a branch label from the Add Branch Label list or key in a new one. Add new branch name to branch search order Check on the Add new branch name to branch search order check box to add a new branch label to the Branch Search Order list. Add Version Label If you wish to assign a version label to this revision, select one from the list in the Add Version Label box, or key in a new label. Use the Select All button to select all items in the Items list, and the Unselect All button to deselect all items in the list. Use the OK button to complete the Add or Check In procedure. On the Version Control Check In File(s) dialog box only, click Differences to view the differences between the object to be checked in and the object that was checked out from the Version Bank. Items Use the Version Control Items list to highlight the object or objects you want to check in or add to the Version Control Bank. Initially all the items in the list will be highlighted (selected). You may deselect individual items so that they will not be checked in or added when you proceed with the action. Comment Use the Comment field to key in a description of the object if you are adding an object to the Version Control Bank or, if you are checking in an object which has been changed, key in a description of the changes made. Keep checked out Check the Version Control Keep checked out check box if you wish to update the Version Control Bank with the current object in the Repository but wish to keep the object checked out. A new version will be created in the Version Control Bank and locked. Create Branch Check the Create Branch check box if you wish to check the objects in to a new branch. If this option is not checked, the objects will be checked into the branch from where they were originally checked out

129 Using Version Control Add Branch Label If you select Create Branch, you are given the option of assigning a branch label to the new branch. Select a branch label from the Add Branch Label list or key in a new one. The label can be alphanumeric. If the object is a new object and Create Branch is selected, then two revisions are created, one on the main branch and one on the new branch. If a branch is created and a branch label is given, and this label is in use by another branch on the same object, then the branch is created but the label is not set. Add new branch name to branch search order When a new branch label is keyed in to the Add Branch Label field, you can check the Add new branch name to branch search order check box to add the label to the Branch Search Order list. The label will be added to the top of the list. For details on the Branch Search Order list, see Setting Branch Search Options. Add Version Label If you wish to assign a version label to this revision, select one from the Add Version Label list box or key in a new label. When a version label is assigned and the label is used on another revision on the same object, then you are asked if you want to move the label to the new revision. Version Control Get/Checkout File(s) Dialog Box The Version Control Get File(s) dialog box and the Version Control Checkout File(s) dialog box serve similar functions: to specify which objects are to be copied or checked out from the Version Control Bank, whether to find the objects using the Branch Search Order or version labels, and load options for the retrieved objects. The load options selected in this dialog override the default settings specified in the Version Control Options dialog box. The new load options are limited to the individual Get or Check Out operation only. One of these dialog boxes is displayed when you perform a Get Revision or a Check Out operation and the Use Dialog option is active for your system. The fields on these dialog boxes include: Items This lists all items which can be selected for processing by the Get Revision or Check Out command

130 Using Version Control Load Options Fields The default status of each field is set in the Version Control Options dialog box. Load in Exclusive Mode Check the Load in Exclusive Mode check box to load the objects in exclusive mode. In a multiuser system this option is not enabled. Validate/Save Logic After Load Check the Validate/Save Logic After Load check box to validate and save the logic during loading. DMA Enabled Check the DMA Enabled check box to enable Data Dictionary Maintenance (DMA) during loading. Conflicts Allowed Check the Conflicts Allowed check box to allow items which conflict between the Local Data Dictionary and the Global Data Dictionary to be loaded. Drop Reserved Check the Drop Reserved check box to specify that reserved words should be dropped during loading. Search Settings Fields Use Branch Search Order Check this check box to use the Branch Search Order list to find the objects which you are getting or checking out. Use Version Label To get or check out a revision with a specific version label, select the label from the Use Version Label drop-down list. Use the Select All button to select all items in the Items list, and the Unselect All button to deselect all items in the list. Use the OK button to complete the Get Revision or Check Out procedure. Items This lists the items which can be selected for processing by the Get Revision or Check Out command. Initially all the items are selected. Load in Exclusive Mode Check the Load in Exclusive Mode check box if you wish to run the Get Revision or Check Out command in exclusive mode, overriding the setting in the Version Control Options. This option is only enabled in a single user Repository. Check or uncheck this option to override the setting in the Version Control Options

131 Using Version Control Validate/Save Logic After Load Check the Validate/Save Logic After Load check box if you wish to validate and save the logic of loaded objects such as Ispecs and Reports. Only objects which are actually loaded will have the logic validated. If an object is not loaded due to Smart Check Out determining that the object is unchanged, or for any other reason, it will not have its logic validated. Check or uncheck this option to override the setting in the Version Control Options. DMA Enabled Check the DMA Enabled check box to activate Dictionary Maintenance for this operation. With DMA Enabled on, a 'get' or 'check out' of a Data Dictionary item will cause the definition of the item in your Repository (if one exists) to be overwritten by the definition of the item in the Version Bank, even if the item is used by other objects. Check or uncheck this option to override the setting in the Version Control Options. If this check box is not checked, a Data Item in the Version Bank which is different from the Dictionary version will not be loaded into your Repository during a 'get' or 'check out' operation. The DMA Enabled option, when it is on, has a different effect when you 'get' an Ispec that includes a Data Dictionary item. In this situation if the definition of the Dictionary item is not the same as the Version Bank Data Item, the Data Item is loaded into the Repository with its Dictionary definition. A warning message is written to the error file and also displayed on screen. It is your responsibility to synchronize the definition in the Version Bank with the Dictionary (ie. the Repository) definition. Conflicts Allowed Check the Conflicts Allowed check box to load Local Data Dictionary items that may conflict with the Global Dictionary. Uncheck the check box to ensure that no Data Items can be loaded which may conflict with the Global Dictionary. If this check box is checked, conflicts will be temporarily allowed for the current load only, and will override the selection made for Conflicts Allowed in the Data Item Options dialog box when a Data Item was added. Check or uncheck this option to override the setting in the Version Control Options. Drop Reserved When performing a load, a check is done to see whether the object is named with a reserved word for the appropriate target host (as specified in the Model options). If it is, and the Drop Reserved check box is checked, then the error message "Word is a reserved word, item dropped" is displayed and the object is not loaded. If the Drop Reserved check box is not checked, then the warning message "Warning word is a reserved word" is displayed, and the item is loaded as normal. Check or uncheck this option to override the setting in the Version Control Options

132 Using Version Control Use Branch Search Order Check the Use Branch Search Order check box to use the Branch Search Order list to find the objects for this Get Revision or Check Out operation. This will temporarily override the setting for this option in the Search Order Options dialog box. When Use Branch Search Order is not selected, then the Get Revision or Check Out command uses a branch determined by the selection of the object as follows: For objects selected in the Version Control Explorer, it defaults to the branch from which the items were selected. For objects in the Developer Repository, it uses the branch information stored in the Repository. The default is the main branch. Note: If the Version Control Get File(s) dialog box or the Version Control Checkout File(s) dialog box has been accessed from the Get By Label command, the Use Branch Search Order option is disabled. Use Version Label To get or check out a revision with a specific version label, select the label from the Use Version Label drop-down list. When Use Version Label is not selected, then the Get Revision or Check Out operation uses a branch determined by the selection of the object, as follows: For objects selected in the Version Control Explorer, it defaults to the branch from which the items were selected. For objects in the Developer Repository, it uses the branch information stored in the Repository. The default is the main branch. Note: If the Version Control Get File(s) dialog box or the Version Control Checkout File(s) dialog box has been accessed from the Get By Label command, the Use Version Label option is disabled. Version Control - Message Dialog Box Click Yes to accept the proposed action for the object named. Click Yes All to accept the proposed action for all objects selected. Click No to refuse the proposed action for the object named. Click No All to refuse the proposed action for all objects selected. Click Cancel to close the dialog without taking any action

133 Using Version Control Scope of EAE-MS SCCAPI based Version Control System The EAE-MS SCCAPI based Version Control System (VCS) implementation has replaced the existing EAE Version Control by using alternative Version Control Systems to perform source control operations on the versionable EAE objects, such as Ispecs, Profiles, Reports, Global Logics, and so on. This subsection gives you the information about the functionalities taken into account for the implementation. It also provides a brief idea on how to perform the VCS operations by setting up the EAE-MS SCC API based VCS environment with the use of alternative Version Control Systems that are compatible with the SCC API. Following are the functionalities considered during the EAE-MS SCCAPI based VCS implementation. Logging in to the VC environment Adding elements to the Version Control Bank Checking in an element Checking out an element Undoing a check out function Getting the latest revision Logging out of the VC environment EAE-MS SCCAPI Based Version Control System The following subsection provides the implementation details of using the EAE-MS SCCAPI based Version Control System as an alternative to the existing EAE Version Control System. You should have the basic knowledge of EAE and a clear picture of the existing EAE Version Control System that is based on the UREP Version Control System. You must install EAE along with the proposed Version Control System. The following tasks related to the Developer Version Control are: Installation of the VCS Administration of the VCS Use of the VCS

134 Using Version Control Overview of Version Control Version Control is an optional Developer feature that provides source control of versionable Enterprise Application objects, such as Model definitions, Data dictionary items, Ispecs, Profiles, and Reports. Version Control stores each version of an object so that you can access and use the earlier versions, if required. The hub of Version Control is the Version Control Bank. The Version Control Bank is a file storage facility that holds controlled copies of objects, but it does not replace the Developer Repository. The Version Control Bank supports source control services, such as locking and maintaining the history of an object, while the Repository functions as a work area where copies of the controlled objects are modified and tested before being moved back into the Version Control Bank. Versionable objects in the Developer Repository are not automatically protected by Version Control. You must add the objects to the Version Control Bank. You can add an individual object, or you can add a group of related objects by using container operations. Once the object is added to the Version Control Bank, you can modify that object and keep track of its revisions. You can achieve this by using the Check Out operation. The object is then locked under your userid in Version Control. Once the modifications or updates to the Checked Out object have been finished, you can perform the Check In operation on that respective object. When you check in a modified object, a new revision or version of that object is created in Version Control, the respective objects are unlocked, and the object created is available for the further operations. You can also perform the Get Latest Revision operation to get the latest version of an object from the Version Control into the Developer Repository. The copy of the object present in the Developer Repository is replaced by the latest copy of the same object from the Version Control. Existing Version Control System The existing EAE Version Control System was specifically designed for EAE by using universal repository (UREP) as the repository to store the versions. Additionally, all the source control operations were controlled by EAE Developer. To use the existing EAE Version Control System (UREP), you are expected to have the EAE Version Control Server installed on the VC Server machine, and have EAE Developer installed along with the VC Client on any client machine, providing the necessary details to connect to the VC Server. The version control menu option to perform VC operations is then enabled

135 Using Version Control EAE-MS SCCAPI Based Version Control System An EAE-MS SCCAPI based VCS is designed to provide you with an option to choose the VCSs that are compatible with MS SCCAPI. The design of EAE-MS SCCAPI has no dependency on the existing Version Control System. It does not expect the existing Version Control Server to be present to work successfully. The following is the design of EAE-MS SCCAPI based VCS: Although there is no restriction or rules for modifying the Version Control Bank directly outside the Developer, it is not possible to secure the Version Control Bank from unauthenticated changes or data corruption from the source control provider side. EAE-MS SCCAPI based VCS uses a concept of temporary working directory, which is a local folder mapped with the source control systems. This working directory contains model (.mdl) files corresponding to each versionable element. Note: It is recommended to not make any changes directly to the.mdl files in the temporary work directory and to maintain the synchronization between the EAE Developer Repository and temporary working directory

136 Using Version Control Setting Up EAE-MS SCCAPI Based VCS Software Requirements The following are the software required to set up the EAE-MS SCCAPI based VCS: Enterprise Application Environment Version Control Systems Source Control Provider that is compatible with SCC API Setting Up EAE-MS SCCAPI Based VCS for SVN This section explains how to configure the EAE-MS SCCAPI based VCS by using SVN. 1. Install EAE. 2. Install the SVN server (Subversion ). 3. Install the PushOk SVN source control provider (PushOk SVN SCC ). 4. Install the Tortoise SVN client (TortoiseSVN ). PushOk SVN provides an SCCAPI interface, but does not provide any graphical user interface. You must install the Tortoise SVN client to navigate through the contents of the source control repository and to perform user-related operations, such as viewing the mdl files of various versionable objects. 5. Create an SVN Repository and sync it with the work directory to be used as VCLocalTempPath. (Refer to Creating Local SVN Repository and Synchronizing it with the Local Work Directory of SVN for more information on the above operation). 6. Set the following LINC.ini options under the [Version Control] section: EAEMSSCCAPIVC VCProjectName VCProviderDLLName VCAuxillaryPath VCLocalTempPath (Refer to LINC.ini Options under VERSION CONTROL Section for SVN for more information on the above settings). 7. To configure SVN to view the contents of the mdl files from the source control client before the Check In operation, refer to the Viewing the Content of the File Using TortoiseSVN. 8. To configure SVN to view the differences in the revisions of mdl files from TortoiseSVN, refer to the Comparing Different Revisions of an mdl File Using TortoiseSVN

137 Using Version Control Setting Up EAE-MS SCCAPI Based VCS for ClearCase This section explains the procedure to configure the EAE-MS SCCAPI based VCS by using ClearCase VCS. 1. Install EAE (Single User Mode/Multi-user Mode with or without VC Client). 2. Install ClearCase Client. 3. Create ClearCase VOB and the Base ClearCase view to access it. 4. Set the following LINC.ini options under the [Version Control] section: EAEMSSCCAPIVC VCProjectName VCProviderDLLName VCAuxillaryPath VCLocalTempPath (Refer to LINC.ini Options under VERSION CONTROL Section for ClearCase for more information about the above-mentioned settings). 5. To configure ClearCase Explorer and view the contents of the mdl files from the source control client before the Check In operation, refer to Viewing the Content of the File Using Source Control Client (ClearCase). Setting Up EAE-MS SCCAPI Based VCS for Team Foundation Server (TFS) Perform the following steps to set up EAE-MS SCCAPI for TFS: 1. Install EAE (Single User Mode/Multi-user Mode with or without VC Client). 2. Install the Visual Studio Team Explorer at the client machine. Note: If the machine already has Visual Studio 2010 or higher installed, you can skip step Install Microsoft Team Foundation Server MSSCCI Provider. Notes: As EAE is a 32-bit application, it is recommended to use a 32-bit version of the TFS MSSCCAPI provider even on a 64-bit machine. Locate the installed path of tf.exe and include it in the path variable. Add the MS SCCAPI provider path in the path environment variable. For example: C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE for MSSCCI provider

138 Using Version Control 4. Create the TFS repository and sync it with the Work directory to be used as VCLocalTempPath. (Refer to Synchronizing the Local Work Directory with the Server in TFS for more information about the above-mentioned operation). 5. Set the following LINC.ini options under the [Version Control] section: EAEMSSCCAPIVC VCProjectName VCProviderDLLName VCAuxillaryPath VCLocalTempPath VCSameWorkspace (Refer to LINC.ini Options under VERSION CONTROL Section for TFS for more information about the above-mentioned settings.) 6. Copy the eaetfsync.bat and killeaetfs.bat files to the folder where LINC.ini file resides, if the LINC.ini file is in a location different from the default location; that is, the work folder. Basic Operations in EAE-MS SCCAPI Based VCS The EAE Developer must first connect to Version Control, to enable the Version Control operations; otherwise, none of the following operations will be available. Adding Element(s) to Version Control Bank You can add any versionable object to the Version Control Bank. To add an individual object or objects: 1. Select the object(s) in the Model directory. 2. Click the Add Element(s) to Bank command on the Version Control menu. Note: If this command is not available or disabled, the object you have selected either is not versionable or has already been added to the Version Bank. For TFS: 1. While adding elements to the TFS bank, a pop-up dialog box from TFS appears. Click Check In to complete the add operation

139 Using Version Control Refer to the following screenshots. Note: If a large model is being added to TFS, then this Check In dialog box appears for each group of 5000 objects. Checking Out an Element Checking out an element locks the object to be modified or updated and does not allow any changes from others on the same object. To check out an element 1. Select the object in the Model directory. 2. Click the Check Out command on the Version Control menu. The Check Out command gets the latest version of an object into the Developer Repository from the bank and the object gets locked. Note: If this command is not available or disabled, the object you have selected either is not versionable or has not yet been Added or Checked In to the Version Bank

140 Using Version Control To get the latest revision from the server during checkout: Verify the following settings to ensure that you always get the latest revision from the server during checkout: For SVN (PushOk Client): 1. Select Start > All Programs > PushOk Software > SVNCC > Configure Plugin. The PushOk SVN Proxy properties dialog box appears. 2. Select the SVN options tab. 3. In the Compatibility section, select Update files before checkout (incompatible with offline mode) as shown in the following screenshot

141 Using Version Control For TFS 1. Select Start > All Programs > Microsoft Visual Studio <version> > Microsoft Visual Studio <version>. 2. Select the Tools tab, and click Options. The Options dialog box appears. 3. Click Visual Studio Team Foundation Server under Source Control, and select the Get latest version of item on check out check box, as shown in the following screenshot. Undoing a Check Out You can use the Undo Check Out command to unlock objects that were previously checked out from the Version Control Bank to reverse the Check Out operation. To undo a check out operations: 1. Select the checked out object in the Model directory. 2. Select the Undo Check Out command on the Version Control menu. The object reverts to the previous state as it was before the Check Out operation and the object is unlocked. Note: If the Undo Check Out command is not available or is disabled, the object you have selected either is not versionable or has not yet been Checked Out from the Version Bank

142 Using Version Control Viewing the Difference in the Developer Repository with the Source Control Before Performing Check In from the Developer After the modification, you can see the difference between the object that has been modified and the latest version of the same object that was already checked into the source control by using the LDADiff.js script provided. The LDADiff.js script compares the two different revisions of the versionable object by considering the two revisions as parameters and presents the result to the end user. Before performing the Check In command, if the object in the Developer Repository is different from that of the bank, perform the following steps to view the difference: 1. On the Tools menu, click Show differences. 2. Browse to the path mentioned in VCLocalTempPath. 3. To view the difference, select the respective object from the repository and the LCIF file of the same object in the VCLocalTempPath. Viewing the Contents of the mdl File Using Command Prompt You can view the contents of the versionable object by running the LDAView.js script file from the command prompt, as shown in the following screenshot. Note: Open the LDAView.js file and ensure that LINC.ini is mapped appropriately

143 Using Version Control Comparing the mdl Files Using Command Prompt You can view the differences in the versionable object by running the LDADiff.js script file from the command prompt, as shown in the following screenshot. Note: Open the LDADiff.js file and ensure that LINC.ini is mapped appropriately

144 Using Version Control Merging Two Files Using Command Prompt You can merge the two model files of a versionable object by running the LDAMerge.js script file from the command prompt, as shown in the following screenshot. Note: Open the LDAMerge.js file and ensure that LINC.ini is mapped appropriately

145 Using Version Control Viewing the Content of the File Using TortoiseSVN You can view the contents of the versionable object by performing the following steps by using the Tortoise SVN client: 1. Locate the versionable object mdl from the TortoiseSVN/Repo-browser. 2. Right-click the.mdl file and select open with option. 3. Browse to the path where LDAView.bat is available, select the LDAView.bat file, and then click Open. You can now view the.mdl file contents. Note: Open the LDAView.bat file and ensure that the absolute path of this file is updated properly. Viewing the Content of the File Using Visual Studio Team Explorer (TFS) You can view the contents of the versionable object by performing the following steps through the Visual Studio Team Explorer: 1. Locate the project in Team Foundation Server using Visual Studio Team Explorer. 2. Select the.mdl file prsent in the folder under the TFS project, and right-click the.mdl file. 3. Click View to see the contents of the.mdl file

146 Using Version Control The following screenshots depict how to view the contents of the.mdl file from Visual Studio Team Explorer

147 Using Version Control Viewing the Content of the File Using Source Control Client (ClearCase) You can view the contents of the versionable object by performing the following steps through the ClearCase client: 1. Open the Rational ClearCase Explorer. 2. Browse and select the file to be opened. 3. Double-click (or right-click) the file, and then select Open with. 4. In the Open with dialog box, browse and select LDAView, and then click OK. Comparing Different Revisions of an mdl File Using TortoiseSVN Perform the following steps to configure TortoiseSVN for comparing the different revisions of the mdl file: 1. In the TortoiseSVN settings dialog box, click Diff Viewer. 2. Select the External option under the Configure the program used for comparing different revisions of files section. 3. Click Advanced to open the advance diff settings window. 4. Click Add to open the Add extension specific diff program window, type the Extension or mime-type value as.mdl. and External Program as wscript.exe <Absolute path of the LDADiff.js script file> %base %mine. Note: In case of 64-bit OS, provide the absolute path of 32-bit versioned wscript.exe file. For example, C:\Windows\SysWOW64\wscript.exe 5. Right-click an object and click Show log from TortoiseSVN/Repo-browser to view the differences in the revisions of the versionable objects. 6. Select the different revisions of the same object

148 Using Version Control 7. Right-click and use Compare Revisions to view the differences

149 Using Version Control Note: Open the LDADiff.js file and ensure that the LINC.ini is mapped appropriately. Comparing Different Revisions of mdl Files Using Source Control Explorer You can view the differences in the revisions of the versionable objects by performing the following steps: 1. Open Visual Studio, and go to Tools > Options. The Options dialog box appears. 2. Point to Source Control > Visual Studio Team Foundation Server option. Click Configure User Tools on the right pane. The Configure User Tools dialog box appears. 3. In the Configure User Tools dialog box, click Add. The Configure Tool dialog box appears. Specify the following details in the Configure Tool dialog box, and click OK. Extension :.mdl operation : Compare Command : Enter the full path pointing to the LDADiff.js file. Arguments : %1 %2 4. Select the.mdl file available in the folders pane under the TFS project on the Source Control Explorer tab

150 Using Version Control 5. Right-click the.mdl file. 6. Click Compare. You can compare the revisions of the versionable object by either Changeset or label. The following screenshots depict how to view the differences in the revisions of the versionable object

151 Using Version Control Select Changeset (revision) from the drop-down, and then click Find Changesets and click on Find to view the different Changesets (revisions) of the versionable object

152 Using Version Control Select the respective Changeset (revision), and click OK. Note: You can also compare the different revisions of the versionable objects by using the view history command from Visual Studio Source Control Explorer. Checking In an Object Checking in an object creates a new version of the selected object in the Version Control Bank from the Developer Repository. To check in an object 1. Select the checked out object in the Model directory. 2. Click the Check In command on the Version Control menu. Note: If this command is not available or disabled, the object you have selected either is not versionable or has not yet been checked out from the Version Control Bank. Getting the Latest Revision from Version Control Bank Getting the latest revision of an object moves a copy of the most recent revision from the Version Control Bank into the Developer Repository. To get the latest revision of an object 1. Select an object from the Model directory. 2. Click the Get Latest Revision command on the Version Control menu

153 Using Version Control Get Latest Revision Container Operation Before performing the Get Latest Revision action by using the Container operation feature, ensure that the temporary working directory is in sync with the Version Control Bank. To perform the Get Latest Recursive Operation of a folder object 1. Select the folder object in the Model directory. 2. Select the Get Latest Container option. Other Features The features that are provided in EAE-MS SCCAPI include the following: Enforce Integrity History Explorer Enforce Integrity The Enforce Integrity option ensures that the user is maintaining synchronization between the versionable objects that are present in the Developer Repository with the objects in the Version Control Bank. The Enforce Integrity option is available to users in the form of a check box in the SCC API Version Control Options dialog box. Individual Version Control users can set Integrity Management for their own workstations by selecting the Enforce Integrity check box in the Version Control Options dialog box

154 Using Version Control When you select Enforce Integrity, 1. You cannot modify the versionable objects that were checked into the bank. 2. You are allowed to modify the versionable objects only when the versionable objects are checked out from the Version Control Bank. 3. You are restricted in performing the load operation. Load operations are not allowed when Enforce Integrity is selected because they affect the contents of the Developer Repository, which in turn does not keep the Developer Repository in sync with the server repository. To perform a load operation, you must consider the following settings: 1. Create a Repository for the load. 2. Clear Enforce Integrity in the SCC API Version Control dialog box. 3. Configure the Repository for the load operation. 4. Load your data into this Repository. 5. Check in or add the elements to the Version Control Bank to make them available to users with Repositories in which the Enforce Integrity check box is selected. You can now perform the familiar Get or Check Out operations to access these objects in the Version Control Bank. History Explorer History Explorer is an independent executable tool, available in the IC, which helps you to perform the following operations: Comparing differences in the revisions of versionable objects from the exported data of UREP. Importing the exported data from UREP to the Developer Repository. Viewing the contents of the respective revision of the versionable object from the exported data of UREP. Comparing Two Revisions of a Versionable Object from the Exported Data of UREP You can view the differences in the two revisions of the same versionable object by performing the following steps by using History Explorer: 1. Run the Register.bat file (preferably run as administrator). 2. Launch the History Explorer by double-clicking Explore3x.exe (preferably run as administrator). 3. Provide the contents.xml file that is available in the UREP exported data as an input

155 Using Version Control 4. Select different revisions of the same versionable object and use the compare icon to compare. The following screenshots represent the above-mentioned steps

156 Using Version Control Importing a Revision from the Exported Data of UREP to the Developer Repository You can import revision from the exported data to the Developer Repository by performing the following steps by using History Explorer: 1. Run the Register.bat file (preferably run as administrator). 2. Launch the History Explorer by double-clicking Explore3x.exe (preferably run as administrator). 3. Provide the contents.xml file that is available in the UREP exported data as an input. 4. Select the business segment. 5. Click the Import icon. 6. Browse to the EAE installed folder of the respective Lincdev.exe file to where the bank needs to be migrated and click OK

157 Using Version Control The following screenshots represent the above-mentioned steps

158 Using Version Control Viewing the Content of the Object Revision from the Exported Data of UREP You can view the content of the object revision from exported data by performing the following steps by using History Explorer: 1. Copy the LINC.ini file from the work folder to the place where the Lincdev.exe file resides. 2. Run the Register.bat file (preferably run as administrator). 3. Launch the History Explorer by double-clicking Explore3x.exe (preferably run as administrator). 4. Provide the contents.xml file that is available in the UREP exported data as an input. 5. Select the revision and click View. The following screenshots represent the above-mentioned steps

159 Using Version Control Configuration for SVN on Windows Server 2003 in 32-Bit and 64-Bit Platforms To set up the configuration for SVN in Windows Server 2003 Operating System, you need to copy msvcr100.dll and msvcp100.dll, which are available as part of the IC, to the EAE installed folder. This completes the connection to the Version Control Bank. Note: Windows Server 2003 OS support from Microsoft is going to cease by July 14, 2015 and hence it is no longer supported. Getting the Latest Revision from EAE VC Bank to EAE-MS SCCAPI Based VCS You can migrate the repository from an existing Version Control System into the EAE- MS SCCAPI based VCS by performing the following operations: 1. Log in to the Version Control System with valid login credentials

160 Using Version Control 2. Open Version Control Explorer and select one or more objects (or business segments) that you want to retrieve into the repository. Refer to the following screenshot. 3. Click the Get Latest Revision command on the Version Control menu to retrieve the objects from the VC Bank into the Developer Repository

161 Using Version Control 4. Perform a complete extract of the business segment on which the Get Latest Revision operation was done and load the extracted model file into the Developer Repository, where EAE-MS SCCAPI based VCS is setup. Migrating EAE Developer Repository with EAE-MS SCCAPI Based VCS to another EAE Developer Repository The following steps enable you to migrate the data from EAE Developer with EAE-MS SCCAPI based VCS to another EAE Developer (for example, Developer to Testing environments or Testing to Production environments): 1. Perform the Get Latest operation of the business segment by using container operations in the Source EAE Developer. 2. Either do a full extract or perform an extract since the last load by using the Changed Items option. 3. Load the extracted model file on to the destination Developer Repository. More on EAE-MS SCCAPI Based VCS Setup Details LINC.ini Options under VERSION CONTROL Section for SVN Option Value Description EAEMSSCCAPIVC N/Y Indicates whether to use existing VCS or EAE-MS SCCAPI VCS. For example, EAEMSSCCAPIVC = Y VCProjectName String < 256 chars VC project Name. For example, VCProjectName=projName Name of the Project that you will create in the source control tool. VCProviderDLLName String < 256 chars Name of the source control client DLL with an absolute path that provide interfaces to carry out the VC operations. For example, VCProviderDLLName= C:\Program Files\Pushok Software\SVNSCC\PushokSVNSCC.dll

162 Using Version Control Option Value Description VCAuxillaryPath String < 256 chars Version Control Bank path. For example, VCAuxillaryPath = file:///d:/eaemssccapivc/ SVNRepos/BANK (This is the path where the repository is locally created. You can also use the path when remotely created(svn://<ip address>/bank)). VCLocalTempPath String < 256 chars Path points to local work directory. VCLocalTempPath = C:\TEMP\VC The following screenshot displays the newly added LINC.ini settings. LINC.ini Options under VERSION CONTROL Section for ClearCase Option Value Description EAEMSSCCAPIVC N/Y Indicates whether to use existing VCS or EAE-MS SCCAPI VCS. For example, EAEMSSCCAPIVC = Y VCProjectName String < 256 chars VC project Name. For example, VCProjectName=projName Name of the project that you will create in the source control tool. VCProviderDLLName String < 256 chars Name of the source control client DLL with an absolute path that provide interfaces to carry out the VC operations. For example, VCProviderDLLName= C:\Program Files\IBM\RationalSDLC1\ClearCase\bin\ccscc.dll. VCAuxillaryPath String < 256 chars For ClearCase, this variable has no effect. This variable can point to any string VCAuxillaryPath=demo

163 Using Version Control Option Value Description VCLocalTempPath String < 256 chars Path points to local work directory. VCLocalTempPath = C:\TEMP\VC The following screenshot displays the newly added LINC.ini settings. LINC.ini Options under VERSION CONTROL Section for TFS To set the LINC.ini file, add the following options to the LINC.ini Version Control section: Option Value Description EAEMSSCCAPIVC N/Y Indicates whether to use existing VCS or EAE-MS SCCAPI VCS. For example, EAEMSSCCAPIVC = Y VCProjectName String < 256 chars VC project Name. For example, VCProjectName=projName Name of the project that you will create in the source control tool. Note: In case of the TFS 2012 environment, the project name should be set to $/team project name. VCProviderDLLName String < 256 chars Name of the source control client DLL with an absolute path that provide interfaces to carry out the VC operations. For example, VCProviderDLLName= C:\Program Files\Microsoft Team Foundation Server MSSCCI Provider\TfsMsscciProvider.dll

164 Using Version Control Option Value Description VCAuxillaryPath String < 256 chars Version Control Bank path. For example, VCAuxillaryPath = VCAuxillaryPath = VCLocalTempPath String < 256 chars Path points to local work directory. VCLocalTempPath = c:\tmp\tfs8 VCSameWorkspace N/Y Specifies the VC work space. Note: You must provide a valid VCProjectName and the option is set to Y. From the next EAE Developer launch, when you try to connect to TFS, EAE Developer synchronizes the local workspace with the server automatically. Hence, you do not need to select the project path manually. For more information on setting the option, refer to Precaution while Using VCSameWorkspace LINC.ini Option with TFS

165 Using Version Control Using the GUI to Set LINC.ini Options To set the LINC.ini options that are previously described, you can use the GUI interface. The following screenshot shows the GUI to set the four LINC.ini options. The options set using this GUI is also reflected in the LINC.ini file. To get to this GUI interface, perform the following steps: 1. Launch EAE Developer. 2. Go to Version Control Menu > Settings > Options. Creating Local SVN Repository and Synchronizing it with the Local Work Directory of SVN Before doing any further operations, the repository needs to be created at the location mentioned in the settings dialog box of the Version Control menu. To create a local repository by using TortoiseSVN, perform the following steps: 1. Create a folder in any drive; for example, C:\SVNSERVER. 2. Open the folder, right-click TortoiseSVN, and click Create repository here to create the SVN Repository. 3. Launch EAE Developer and perform the following steps: a. Go to Version Control > Settings > Options. b. Set the Server Path (where the SVN Repository is created) with a format, for example, file:///c:/svnserver

166 Using Version Control c. In the GUI interface, set the Work Directory for this developer; for example, C:\TEMP\SVNTEMP. 4. Perform Connect from the Version Control menu. A pop-up dialog box appears

167 Using Version Control In the dialog box, the VCProjectName (VC in this example) is shown as part of the SVNURL. One approach is to first remove VC from the SVNURL. Click Check, a message stating The SVNURL is OK appears, if the SVNURL is proper. 5. Enter the VCProjectName VC under the SVN MODULE, and then click Create. This creates a folder in the SVN Repository, and then click OK. Connecting and syncing the SVN Repository with the working directory from EAE Developer is successful. Note: Creating the SVN module eliminates reappearance of the following dialog box on subsequent connection attempts to the SVN Repository. 6. Initiate the Version Control operations. Connecting to local SVN Repository by developers signed onto the same machine: For other developers signed on to the same machine to be able to connect to the local SVN Repository, ensure that all the LINC.ini settings under the Version Control section and bank path should match with the existing developers that are already connecting to the SVN Repository, except the VCLocalTempPath or the working directory. The working directories for each developer should be unique. For example, to sync the working directory with the local SVN Repository from another developer, create a folder named SVNTEMP1 in the folder C:\TEMP. Double-click the SVNTEMP1 folder, right-click TortoiseSVN, and click Repo-browser

168 Using Version Control Select the URL, as shown in the following screenshot: Click OK. The following screen appears

169 Using Version Control To check out the files to the folder C:\TEMP\SVNTEMP1, right-click and select Checkout, as follows:

170 Using Version Control At this point, the working directory is populated and is in sync with the SVN Repository. Then launch the other EAE Developer, and ensure that the Server Path and the Work Directory are properly set. Perform Version Control/Connect: If the Select SVNURL, module and local path dialog box appears, enter the details as you had done initially for Developer. At this point, the developer should be connected and can perform all version control operations. Synchronizing the Local Work Directory with the Server in TFS While connecting to the TFS Server, eaetfsync.bat takes care of syncing the local working directory with the TFS project. Note: With respect to the TFS 2012 and TFS 2013 environment and its corresponding MSSCCI provider, an additional setting of manual mapping is required to synchronize the local work directory with the TFS project. Perform the following: 1. Launch the Visual Studio IDE

171 Using Version Control 2. Select TEAM > Connect to Team Foundation Server with TFS. 3. On the Team Explorer tab, click Select Team Projects. The Connect to Team Foundation Server dialog box appears where you can add one or more servers. 4. Select the team projects of your preference, and then launch the Source Control Explorer. 5. Under the team project selected, choose the folder to be mapped manually

172 Using Version Control 6. Right-click the folder, and select Advanced > Map to Local Folder... The Map dialog box appears. 7. Choose a local folder to be mapped, and click Map. 8. Select Yes when a confirmation box appears prompting if you want to get the files to the local folder

173 Using Version Control The following screenshot depicts how the local folder is mapped to the server folder. 9. Ensure that the LINC.ini setting of VCLocalTempPath is set to this mapped local path

174 Using Version Control 10. In case a new folder needs to be created under the team project, you can add the folder directly by mapping the team project to a local path and by clicking the fourth icon on the Source Control Explorer top panel as depicted in the following screenshot. Note: As the mapping needs to be done manually, in the case of both TFS 2012 and TFS 2013 environments, the Object reference not set to an instance of an object pop-up dialog box might appear. The same can be addressed by refreshing the mapping in the Visual Studio environment. VC Operations with EAE-MS SCCAPI Based VCS Add Element(s) to Bank After the operation of Add Element(s) to Bank from container operations, the objects of both the element and its group are retrieved from the Developer Repository and added to the Source Control Repository, as shown in the following screenshots:

175 Using Version Control

176 Using Version Control

177 Using Version Control Note: If the operation of of Add Element(s) to Bank is performed directly from the Version Control tab and not from the container operations, then only that particular element is added to the SVN Repository (that is, the objects of the complete group of an element are not added to the SVN Repository). Check Out The objects that are in Check out status are locked and a symbol appears on the toolbar depicting the same against that particular object. Additionally, the container operations are not enabled for an object that does not have child objects on which the Check Out operation can be performed

178 Using Version Control Undo Check Out The Undo Check Out operation of a versionable object is possible only for a locked object. This means, this operation is possible on an object only if that was checked out earlier. The following screenshots show a scenario where an object (SERCH) that is already checked out is reverted by using the Undo Check Out operation

179 Using Version Control

180 Using Version Control Check In The Check In operation of a versionable object sends the selected object into the bank. The following screenshots show a scenario where a report LCKLMT is checked in. Get Latest Revision This Get Latest Revision operation on a versionable object retrieves the latest revision of a particular object from the Version Control Bank as follows:

181 Using Version Control Getting the Latest Revision from the Version Control Bank by using Container Operation Before performing the Get Latest Revision operation by using the Container operation feature, ensure that the temporary working directory is in sync with the Version Control Bank. The following screenshot clearly depicts how to sync the temporary working directory with the Version Control Bank for Subversion. 1. Right-click the temporary working directory

182 Using Version Control 2. Use the SVN Update option

183 Using Version Control Setting Up an Environment with SVN Rep on Remote Machine and Performing VC Operations You can set up the VCS environment so that the working folder is placed in one machine (Client Machine) and its VC Bank is located in a remote machine (Server Machine) by appropriately setting the LINC.ini parameters. The following example demonstrates setting up such an environment. Creating the Remote SVN Repository Open a folder, right-click, select TortoiseSVN, and click the Create repository here option to create the SVN Repository. Providing Authentication in the SVN Server After creating the SVN Repository on the remote machine or host system where the VC bank is present, you need to perform the following few changes within the conf folder in the SVN repository. Change the authz file to provide read-write permissions as follows at the end of the file: [/] * = rw Append the user credentials in the passwd file: <username> = <password> Uncomment the following in the General section in the svnserv.conf file, as follows: anon-access = read auth-access = write password-db = passwd authz-db = authz realm = My First Repository Other Required Settings Ensure that SVN Server is running as a service in the server. Execute the following in the command prompt: sc create svn binpath= "\"<Absolute path of Subversion>\svnserve.exe" --service -r <Absolute path of SVN rep>" displayname= "Subversion Server" depend= Tcpip start= auto For more information, refer to the svnserver as Windows Service under Invoking the server in the Subversion documentation

184 Using Version Control Configuring to Access the Remote SVN Repository from Multiple Developers Perform the following steps to access a remote SVN Repository by using the TortoiseSVN/Repo-browser: 1. Right-click the client desktop, select TortoiseSVN, and click Repo-browser. The URL window appears. 2. Enter the following URL in the URL box (refer to the following screenshot): svn://<ipaddress of svn servermachine> The Repository Browser of the SVN appears. Perform the following steps to add files to a remote SVN Repository: 1. Create a temporary working folder as C:\TEMP\SVN1. 2. Set the Server Path (Version Control > Setting > Options) to svn://<ip address of the SVN server>. For example: svn:// Click Version Control, and then select Connect. The following window appears. 4. Under SVNURL, click Check. If the validation is successful, click OK

185 Using Version Control Version Control operations can now be performed. 5. Load the Sample model and add all the files to the SVN Repository. Note: You get this authentication dialog box for the first time you tried to access the remote SVN Repository, and that the username entered must be in the passwd file (as previously discussed in Check Out). 6. Type the username and password, and then click OK. Perform the following steps for the other developer clients to connect to the existing SVN Repository: 1. Create a new temporary working directory for the next developer; for example, C:\TEMP\SVN2. 2. Open the SVN2 folder, right-click TortoiseSVN, and select Repo-browser

186 Using Version Control 3. Check out all the files to the SVN2 folder. Note: You get this authentication dialog box for the first time you try to access the remote SVN Repository, and that the username entered must be defined in the passwd file (as previously discussed in Check Out). 4. The developer then brings up EAE Developer and ensures that the Version Control settings have the correct Server path (in this example, svn:// ) and the temporary path points to C:\TEMP\SVN2. 5. Perform Connect. Note: Ensure that the SVN Module value is maintained the same as in step 3 of the Configuration to Access the Remote SVN Repository from Multiple Developers section, which includes the procedure to connect to an existing SVN Repository. Ensure that connecting to the SVN Repository by other developers is successful. 6. Perform container get latest on UNTITLED. Container Get Latest brings in all the objects from the other developers. Note: If all the developers are accessing the same EAE repository, this step is not required

187 Using Version Control Setting Up an Environment with VC Bank Remote Machine for TFS While connecting the TFS machine from the developer, you can have either a common shared folder to add the source control files or a unique folder under TFS for each user, under a common TFS project. Note: In a multi-user environment, it is mandatory that all the developer clients should maintain unique working directories, workspaces, and LINC.ini files. Steps to configure multiple developers signed on the to same machine with different user IDs Developer1 creates the workspace and performs the ADD. The other developers open Source Control Explorer and create their own workspace, pointing to the same TFS folder or project, but pointing to their own individual working directory. Each developer must have a LINC.ini file pointing to the correct Project Name. For example, $/GTC_EAEDeveloper_3_1/MultiRep The following screenshot provides the details of the TFS Connection dialog box:

188 Using Version Control Create a folder in the server and map this folder to a local path. For example, you can create a folder under the project, mapped to the local folder; for example, c:\tmp:tfs8. After you map the path, you are eligible to use the repository. After completion, the following message in the Version Control Status Window appears: Logged into Version Control Bank as DasMK Once the connection to TFS is successful, you can perform various VC operations, such as Add, Checkout, Checkin, Undo Checkout and Get Latest operations from EAE Developer. You can view the folder and its contents located under the TFS project that was created from the Choose Folder in Team Foundation Server dialog box using Visual Studio Source Control Explorer

189 Using Version Control The following screenshot provides the details of the Version Control Bank: Advantages of EAE-MS SCCAPI Based VCS Following are the advantages of using the EAE-MS SCCAPI based VCS. Enables you to overcome the limitation of the existing VCS by being available on current windows operating systems. Allows you to connect to freely available source control systems, such as SVN, TFS, and so on. Allows you to continue to have both existing VCS and EAE-MS SCCAPI based VCS by setting the LINC.ini option appropriately. Limitations of EAE-MS SCCAPI based VCS Following are the restrictions of using the EAE-MS SCCAPI based VCS. Migration of the EAE Developer Repository with EAE-MS SCCAPI based VCS to another EAE Developer Repository needs to be done manually. Cannot perform a Check Out operation of a particular revision of an object. Getting a particular revision into the Developer Repository needs be done manually using the source control client. The explorer of the source control client can be used to identify a particular revision of any versionable object and load that file in the.mdl format into any Developer Repository. Objects revision information displays only controlled or Not controlled

190 Using Version Control Version Control Explorer is not available within Developer, but the explorer of the source control tool can be used to perform operations instead. The Get by Label operation is not available. Unable to Suppress the Message from Source Control Provider from TFS Ignore the following message, which is displayed when EAE Developer is closed. Click OK to proceed. Unable to Cancel the Add Operation from the Source Control Provider The return value from the Source Control Provider is not the right value when you Cancel an Add operation from the Source Control Provider. Therefore, do not cancel an Add operation from the Source Control Provider. Precaution while Using VCSameWorkspace LINC.ini Option with TFS The VCSameWorkspace LINC.ini option helps when you wish to work on the same project residing in the server. By setting the option, you can avoid the step of mapping the workspace and the intended project from the server at the time of connection. Notes: The LINC.ini setting is available from the next launch of the EAE Developer. Always remember to provide a valid VCProjectName in the VersionControl option when the VCSameWorkspace option is set to Y. If you miss to provide a valid value for VCProjectName, EAE Developer fails to connect to the TFS and returns an error as shown below