Configuration Management Guide

Transcription

1 Rhapsody Configuration Management Guide

2

3 Rhapsody Configuration Management Guide Release 2.3

4 I-Logix Inc. Three Riverside Drive Andover, Massachusetts The software described in this document is furnished under a license and may be used or copied only in accordance with the terms of such license. Rhapsody software contains proprietary information, as well as trade secrets of I-Logix Inc., and is protected under copyright law. Duplication of this manual, in whole or in part, is strictly prohibited, except with the prior written consent of I-Logix Inc. The information in this manual is subject to change without notice, and I-Logix assumes no responsibility for any errors which may appear herein. No warranties, either expressed or implied, are made regarding Rhapsody software and its fitness for any particular purpose. Rhapsody is a registered trademark of I-Logix Inc. I-Logix, and the I-Logix logo are trademarks of I-Logix Inc. Other products mentioned may be trademarks or registered trademarks of their respective companies. Romeo Music International provides the sounds clips used in the Radio demo: Bali.wav, Bg_Clas1.wav, Bg_Jazz.wav, Bohm.wav, Drunken.wav, Heavymtl.wav, Ireland.wav, Latingrv.wav, Russia.wav, Stabs.wav, Tarrega.wav and (P) Copyright Romeo Music International ALL RIGHTS RESERVED Copyright 2000 by I-Logix Inc. All rights reserved. Part No. 2157

5 Preface Welcome to this Configuration Management Guide for Rhapsody by I-Logix Inc. The goal of this Guide is to provide you with enough information to get you started archiving your Rhapsody models into one of the supported 3rd party configuration management (CM) software applications supported by Rhapsody. Rhapsody interfaces 3rd party software configuration mangement tools to allow users to safely document and archive changes made to their software projects. Through a process of check-in and check-out, the CM process insures that only one user can change any part of the project at a time. This allows a team of Rhapsody developers to collaborate to jointly develop a model. To facilitate this team concept, Rhapsody also makes it possible to divide a project into different parts that teams can work on in parallel. This Configuration Mangagement Guide for Rhapsody is organized into the following two chapters: Chapter 1 Collaboration This chapter describes the principles of collaboration that allow a team of developers to work on projects in parallel. It consists primarily of the semantics of archival check-in and check-out, along with aspects of unifying the parts of a Rhapsody model divided for collaborative purposes. Chapter 2 Implementing CM Operations Beneath the common semantics of Rhapsody s CM interface there are properties and settings that address the uniqueness of each CM tool. In this chapter, you edit specific implementations of CM tools that are not permanently set in rhapsody to enable Rhapsody s interface to it. Rhapsody Configuration Management Guide v

6 Where to Find More Information The following are some additional titles in the Rhapsody documentation set: The Rhapsody Installation Guide describes the proper procedure for installing Rhapsody and configuring your software licenses. The Rhapsody Release Notes describe new features and known problems or issues associated with a specific software release. The Getting Started documents (Guided Demo, Quick Start, and Tutorial) help you quickly get started building and running software models with Rhapsody. See Getting Started with Rhapsody on page -viii. The Rhapsody Reference Guide provides in-depth reference information on the Rhapsody VPE. The RTOS Interface Guide provides information on how to adapt Rhapsody to a new real-time operating system (RTOS) environment. This document is currently a work in progress. Rhapsody s extensive online help provides detailed information on most of Rhapsody s features, including project properties and the read-write COM API. The following are some additional sources of information on object-oriented software development for real-time embedded systems: Real-Time UML by Dr. Bruce Powel Douglass is part of the Addison- Wesley Object Technology Series. It demonstrates how to use the UML to effectively analyze and model real-time embedded systems using object-oriented methods. You can find it on I-Logix web site at under What s New. Doing Hard Time; Designing and Implementing Embedded Systems with UML by Dr. Bruce Powel Douglass is another book in the Addison-Wesley Object Technology Series. Executable Object Modeling with Statecharts by Dr. David Harel and Eran Gery is a cover feature article from the July 1997 issue of the IEEE Computer Magazine describing the use of Statecharts for behavioral modeling within Rhapsody. You can find the article on the Web at vi Rhapsody Configuration Management Guide

7 Using the Online Documents Using the Online Documents The online books in the Rhapsody documentation set, including this Guide, are accessible as Adobe Acrobat PDF files from Rhapsody s Help menu. To view these documents, you must have the Acrobat Reader installed. An option to install the Acrobat Reader is included as an option during Rhapsody installation. The latest version of the Reader is also available from Adobe s web site. To access any of the online books from within Rhapsody: 1. From the Help menu, select List of Books. If your Acrobat Reader is properly installed, the List of Books opens in the Reader. 2. Select the book you are interested in viewing from the displayed document set. The PDF document opens in the Reader. Contacting I-Logix I-Logix technical support hotline provides assistance with installation, application issues, and documentation. Technical support engineers also collect information about product defects and take suggestions for product enhancements. Technical support, sales, and application engineers assist prospective customers with product evaluations and provide timely responses to user issues. Contacting I-Logix via the Hotline Contact the hotline as follows: Telephone: In the US: :30 am to 5:30 pm EST In Europe: +44 (1249) Rhapsody Configuration Management Guide vii

8 Fax In the US: In Europe: +44 (1249) Contacting I-Logix via the Web An alternative way to contact I-Logix is via the World Wide Web. If your host machine is connected to the Internet, you can access I-Logix Tech Support site through Rhapsody s Help menu: 1. From the main menu, click Help > I-Logix on the Web. 2. From the cascading menu, click Technical Support. A Web browser opens with I-Logix Technical Support Form displayed. Note: You can also access I-Logix Technical Support site outside of Rhapsody by starting a Web browser and directly entering the URL 3. In the Technical Support Form, enter your name, company, contact information, and a description of the problem, enhancement request, or question. To submit the form, 4. Click Send. To clear the form and start over, 5. Click Reset. Getting Started with Rhapsody The online Getting Started guide helps you quickly get up and running with Rhapsody. Getting Started is accessible from the Windows Start menu. It has the following three parts: viii Rhapsody Configuration Management Guide

9 Getting Started with Rhapsody Guided Demo Walkthrough of a model of a radio that lets you play tunes, switch stations, and set memory buttons. The radio is a prebuilt Rhapsody model. Quick Start Instructions on how to quickly get started building a model, generating code, and animating an application. The Quick Sstart is a WinHelp file. Tutorial Step-by-step instructions describing all the fine points of creating a simple Hello World program and then building a slightly more complicated model of a dishwasher. The Tutorial is a PDF file. You can invoke Getting Started either outside or inside of Rhapsody: Outside of Rhapsody In the Windows Task bar, click Start > Programs > Rhapsody by I-Logix > Rhapsody Getting Started. Inside of Rhapsody From Rhapsody s Help menu, select Getting Started. Once Getting Started opens, you can run through the Guided Demo, the Quick Start, and/or the Tutorial in any order to learn about Rhapsody. We recommend doing the Guided Demo first, the Quick Start second, and the Tutorial third. To invoke the Guided Demo, do the following: 1. Invoke Getting Started (see above). 2. On the first page of Getting Started, click Guided Demo. To invoke the Quick Start, do the following: 1. Invoke Getting Started (see above). 2. On the first page of Getting Started, click Quick Start. To invoke the Tutorial, do the following: 1. Invoke Getting Started (see above). 2. On the first page of Getting Started, click Tutorial. Rhapsody Configuration Management Guide ix

10 x Rhapsody Configuration Management Guide

11 Contents Preface Where to Find More Information vi Using the Online Documents vii Contacting I-Logix vii Contacting I-Logix via the Hotline vii Contacting I-Logix via the Web viii Getting Started with Rhapsody viii 1 Collaboration Basic Concepts of Collaboration 1 Creating Units 2 Project 3 Configuration Item 4 Workspace 4 Configuration Management Repository 4 Add to Model 5 Unresolved References 5 Resolving Unresolved References 6 Resolution by ID vs. Resolution by Name 7 Handling Unresolved Elements 7 Rhapsody Configuration Management Guide Contents-xi

12 Checker 7 Browser and Diagrams 8 Code Generator 8 Read-Only Configuration Items 8 ASCII-Based Repository 9 Configuration Management Interface 9 Configuration Management Operations 9 Connect to Archive 9 Check Out 10 Check In 10 List Archive 10 Add Member 10 Lock 10 Unlock 10 Synchronize 10 Using the Configuration Items Dialog 11 Connecting to the Archive 12 Adding Members 15 Listing the Archive 15 Checking Out Configuration Items 16 Checking In Configuration Items 18 Locking Configuration Items 19 Unlocking Configuration Items 19 Synchronizing Configuration Items 20 Useful Scenarios in Configuration Management 23 Renaming a Child Package within a Parent Package 23 Propagating Child Package Name Change to the Development Team 24 Adding a New Parent Package to the Rhapsody Model 24 Propagating New Parent Package to the Development Team 25 Making a Child Package into a Parent Package in Rhapsody Model 26 Propagating New Parent Package to the Development Team 26 Using the Browser for Configuration Management 28 Contents-xii Rhapsody Configuration Management Guide

13 2 Implementing CM Operations General Procedures 1 Naming the Project Directory 1 When to Check Out Packages 1 Rhapsody CM Pre- and Post-Actions 2 Source Integrity 7.3e 2 Setting Up Source Integrity 2 Source Integrity Semantics 4 PVCS Setting Up PVCS 5 Configuring the Master Project 6 Configuring the Current Project 7 PVCS Semantics 8 ClearCase Setting Up ClearCase 8 Case Sensitivity in ClearCase 9 Team Environment Issues in ClearCase 10 Setting up Team Member Rhapsody Projects 10 Adding New Members to the Archive 10 ClearCase Semantics 11 Configuring Rhapsody to a CM Tool 12 Arguments to Properties 12 Properties for Configuring a CM Tool 13 Index Rhapsody Configuration Management Guide Contents-xiii

14 Contents-xiv Rhapsody Configuration Management Guide

15 Collaboration Rhapsody allows a team of developers to collaborate jointly to develop a model. To facilitate this, Rhapsody allows you to divide a project into different parts that several teams can work on in parallel. These parts are called units. Units are composite model elements that are stored in separate files. After making units of important model packages and classes you can then manage their development via a Collaboration Management (CM) tool. Basic Concepts of Collaboration Collaboration comprises the following features: An ASCII-based repository for storage and differentiation by a CM system The interface with CM tools, 1 allowing exchange of versioncontrolled configuration items Some read-only configuration items Decoupling of configuration items using unresolved references This section describes the fundamental concepts of collaboration. Some of the concepts have meanings outside of the area of collaboration and are explicitly redefined here. 1. Some common CM tools that Rhapsody interfaces with are Source Integrity by MKS, PVCS by Intersolv, and (to a limited extent) ClearCase by Rational Software. Rhapsody Configuration Management Guide 1-1

16 Collaboration Creating Units You can partition your model into units down to the class level for collaboration with other developers. You can then check unit files in and out of a configuration management system giving you explicit control over filenames and modification rights (R/O vs. R/W). You can make units of the following kinds of elements: Components Packages Classes Diagrams (except Statecharts and Activity diagrams) An element that is a unit has a gray file bitmap overlaid over its regular icon. For example, the active component shown in the left hand margin is also a unit. To make an element a unit, do the following in the Browser: 1. Right-click the element. 2. From the element s popup menu, select Create Unit (elements that are already units have the popup menu selection Edit Unit). The Unit dialog for the element opens. 1-2 Rhapsody Configuration Management Guide

17 Project 3. You can select the Store in separate file checkbox only if you are editing an existing unit. If you are creating a unit, this setting is defaulted to true. 4. Edit the default filename, which is the name of the element, if desired. Do not enter an extension. Rhapsody assigns the following extensions to unit files: Model Unit Extension Components.cmp Packages.sbs Classes.cls Use Case diagrams.ucd Sequence diagrams.msc Object Model diagrams.omd 5. You can select the Read Only, Read/Write, or Reference radio button to specify the unit s modification rights only if you are editing an existing unit. When you create a unit, it is automatically created with Read/Write privileges. Note: To copy an attribute or operation from a Read Only package to a Read/Write package, you can drag and drop it from the RO package to the RW package. Caution: It is highly recommended that you save your model before changing any modification rights to Read Only! 6. Click OK. When you save the model, Rhapsody creates files for all units in the project (_rpy) directory. Project A project is the overall set of elements components, packages, diagrams, etc. that describe the system that a group of developers is modeling. Elements are typically stored in a CM repository. Rhapsody Configuration Management Guide 1-3

18 Collaboration Configuration Item A configuration item is a unit of collaboration that is exchanged among developers. CM tools manage versions of configuration items. Units chosen for archival by a CM tool are configuration items in Rhapsody. They are elements exchanged between collaborating developers of a Rhapsody model. Workspace Workspace refers to an area allocated to a CM tool for checking out specific revisions of configuration elements chosen for archival. In the case of Rhapsody, units are checked out to and checked in from an open Rhapsody project s own workspace. Thus the workspace for the CM tool and Rhapsody s workspace (where the model s files reside) are the same. Configuration Management Repository The CM repository stores versions of configuration items in archives. An archive is a CM repository grouping for common versions of a project s configuration items. The archive may track related versions of configuration items for a specific project version. For example, it may group all configuration items of the same version as a separate configuration item. CM tools refer to this configuration item as the project. Each project version is referred as a release, indicated as such through labeling. Note: Rhapsody does not explicitly support the notion of releases. A release is facilitated through labels that you can attach to configuration items on check in. Each configuration item has the following properties: Version Mode: Read/Write (locked) vs. Read-Only (unlocked) Locked By: As defined by the CM tool (usually, the last user who had write permission) 1-4 Rhapsody Configuration Management Guide

19 Add to Model Note: Configuration items keep track only of their own permissions (R/O vs. R/W) on the file system, but not of their status (locked vs. unlocked) in the CM tool. Add to Model The Add to Model command imports configuration items into a workspace. When you use the Add to Model command without the CM interface, there is no version control and locking. This may be useful in the initial stages of a project when you want to keep your overhead down and import design patterns from previous projects. The CM interface also uses the Add to Model. CM tools provide version control and locking, which are very useful once you start working with other developers. Unresolved References Every Rhapsody configuration item may include references to other configuration items (CI cross-references). Once a configuration item is moved to another workspace, some of its references may no longer exist in the new context. These dangling references are called unresolved references. For example, as often happens when people collaborate on a project, if you replace an existing package with a newer version and the new package does not contain an item that appears in some view, that item will be unresolved. Unresolved references belong to either of the following groups: Diagram view elements not defined in a particular package, such as: Packages Classes Role names Attributes Operations Events Types Rhapsody Configuration Management Guide 1-5

20 Collaboration Actors Use Cases Associations between actors and use cases References between packages in the Browser Superclasses Super-events Events (in Class -> Operations) Other classes of a role Types Note: You may need to refresh your file in order to obtain updated, unresolved information. Sometimes, you may need to close and reopen the model. All unresolved view elements are indicated with the prefix U in the diagram or the Browser. Once the element is resolved, the unresolved indicator disappears. Since unresolved references are references to objects that are not really present, the only thing you can do with them is observe them, attempt to resolve them, or delete them (remove from view). Other operations such as modifying them or double-clicking produce error messages from Rhapsody. Note: Inconsistent roles added to the same model are removed after a message from Rhapsody. Note: If the other class of an association is unresolved, the other-class area of the Association dialog is dimmed. Resolving Unresolved References There are three ways to resolve an unresolved reference: If there is an unresolved element that initially you didn t think you would need, but now you realize you need it, introduce a new configuration item containing the missing element. 1-6 Rhapsody Configuration Management Guide

21 Resolution by ID vs. Resolution by Name If the unresolved element is something you knowingly did not want to import but now want to define yourself, explicitly define the missing element using the Browser or other diagram. If the unresolved element arose from working with an older or newer version of a package and the object referred to was renamed, rename an existing element to match the unresolved element. Renaming a composite meta-object such as a package or a class may resolve a whole set of unresolved references. Note: Rhapsody cannot resolve a relation by explicit definition. Although it is possible to define a relation using the Object Model diagram, the Browser refuses to resolve the relation as if it already exists. Resolution by ID vs. Resolution by Name In certain cases, Rhapsody can track an item that was renamed. For example, consider the following scenario: 1. User A defines a class C in package P. 2. User B loads package P into the workspace and draws a diagram including a reference to class C. 3. At this point, user A renames class C to C1. 4. Then user B reloads package P with the new updated package. The reference to C in the diagram is now resolved to C1 and the name is replaced with C1. Handling Unresolved Elements Checker The Checker has two ways of checking for unresolved superclasses, superevents and other classes of relation names. Currently the Checker does not check for unresolved references in diagram elements which you can inspect by observing the diagrams. Rhapsody Configuration Management Guide 1-7

22 Collaboration Browser and Diagrams Code Generator In the Browser and diagrams, unresolved items are marked with a (U). The Code Generator checks for unresolved references within the configuration scope. If it detects unresolved elements, it aborts code generation. Note: The only logical way to fix unresolved elements is to remove them or resolve them. Read-Only Configuration Items A significant part of collaboration involves change-control policy. To support this, Rhapsody uses the concept of read-only configuration items. Configuration items are loaded into a workspace in either Read/Write (R/W) or Read-Only (R/O) mode, depending on the permission granted from the CM tool check out or some other team policy. You cannot modify configuration items that are designated as R/O. Rhapsody designates a configuration item as R/O if the file associated with it is write protected. For example, when you check out a configuration item from a CM repository, it can be either write-protected or not. Rhapsody assigns the change protection to the configuration item based on this attribute. The following read-only configuration items are marked RO : Packages: marked as read-only within the Browser Diagrams: once opened, the window banner has a read-only title beside the diagram name Components 1-8 Rhapsody Configuration Management Guide

23 ASCII-Based Repository ASCII-Based Repository Rhapsody s ASCII-based repository facilitates an open, linear representation of Rhapsody models. All meta-objects within each configuration item are represented as hierarchical object structures, where each object is contained within some container object and the top-level container is the configuration item itself (package, diagram or configuration). Configuration Management Interface The CM interface automates common CM operations in most CM tools. The purpose of the CM interface is to facilitate the configuration of a Rhapsody workspace with respect to the project repository. By applying a CM operation, a developer can check configuration items into or out of an archive to facilitate collaborative work with other developers. Rhapsody does not create such a repository, but must work with an independent CM tool, such as Source Integrity. Note: I-Logix emphatically discourages two or more developers from modifying the same unit at the same time. This may cause anomalies when you merge the units.to prevent problems, use proper locking within the CM tool. Configuration Management Operations Connect to Archive The following list describes the abstract, predefined operations implemented for all CM tools supported by Rhapsody. The Connect to Archive operation defines a property representing the archive to be used when communicating with the CM tool (whatever this means for the tool). You should connect to the archive before taking any other CM operation. Note: Once the connection between a CM archive and a project has been made, there is no need to repeat the operation again in future work on the same project. Rhapsody Configuration Management Guide 1-9

24 Collaboration Check Out The Check Out operation checks out a configuration item to the Rhapsody repository workspace, performing Add to Model and Update Configuration Items operations using the appropriate CM information (such as version, CM header). Check In The Check In operation checks in a configuration item from the Rhapsody repository to the archive after saving the workspace to the Rhapsody repository (including concatenating CM headers and footers). The workspace is implicitly saved to the repository during the Check In, Add Member, and Connect to Archive operations. List Archive The List Archive operation lists the configuration items in the CM repository. Add Member Before you can check in a configuration item you must first introduce it as a new member to the CM repository. Lock The Lock operation locks a file so that only you can edit it. Unlock The Unlock operation unlocks a previously locked file so that multiple users can have access to it. Synchronize The Synchronize operation makes the versions of selected items the same in both the configuration management repository and your workspace Rhapsody Configuration Management Guide

25 Using the Configuration Items Dialog Using the Configuration Items Dialog You invoke all CM operations from the Configuration Items dialog. To access this dialog, choose File > Configuration Items from the Rhapsody main menu. The Configuration Items dialog lists the configuration items and properties for items currently loaded in your workspace (see Basic Concepts of Collaboration on page 1-1). The buttons in the Configuration Items dialog carry out the CM commands. You can perform those commands on multiple items at a time. Check Out the selected items Check In the selected items Show items in Archive Add the selected items to the Archive Connect to Archive Rhapsody Configuration Management Guide 1-11

26 Collaboration Lock the selected items Unlock the selected items Synchronize selected items in Archive Connecting to the Archive The operations apply commands directly to the CM tool. The response of the specific tool appears in Rhapsody s output window. Caution: It is extremely important to pay attention to the messages in the Output window, because CM commands can sometimes fail. For example, an attempt to check out a configuration item that is already locked with the Lock box checked will fail. Because Rhapsody cannot anticipate all responses from various CM tools, it simply displays the tool s response in the Output window so that you can respond accordingly. Before you can connect to an archive, you must configure the CM tool as one of your project s properties. See the Project Properties document for details. To configure a CM tool: 1. Choose File > Project Properties Rhapsody Configuration Management Guide

27 Connecting to the Archive This opens the Features dialog for the project. 2. Select ConfigurationManagement for the Subject, and General for the MetaClass. 3. From the property list below, select CMTool and click the Modify button. This opens the following Property dialog for CMTool. Rhapsody Configuration Management Guide 1-13

28 Collaboration 4. Select a CM tool from the drop-down list and click OK. You are now ready to connect to an archive. 5. From the File menu select Configuration Items From the Configuration Items dialog, select the Connect to Archive button. This opens the Connect to Archive dialog shown below, in which you can either confirm the default archive (called a master project in Source Integrity) or select another one by either browsing or entering the full path and name of an archive. Note: When using the Browse button, if the archive is represented as a directory rather than a file (as in PVCS and Source Integrity), then you must select a file within this directory and edit the path in the dialog. Of course, you can directly enter the entire path without using the Browse button. 7. Once you have set the archive, click OK to confirm Rhapsody Configuration Management Guide

29 Adding Members Listing the Archive Note: Setting the archive property may involve additional activities, depending on how your CM tool has been customized. Rhapsody connects your project to the CM tool archive. Adding Members Note: Once a Rhapsody project is connected to a CM tool archive, it remains permanently connected once the project is saved. You do not have to reconnect it again the next time you reopen the project. Before you can list the archive or begin checking in revisions of a configuration item to the CM repository, you must first add it as a new member to the CM archive. To add a new existing configuration item to the archive from the Configuration Items dialog, do the following: 1. In the Configuration Items dialog, select the new item. 2. Click the Add Selected Items button. Rhapsody then adds the selected items to the CM tool archive. If the adding is successful, the Output window displays a confirmation message. When you add an item to an archive, Rhapsody triggers an automatic save of the entire model in the repository. The List Archive operation lists all of the configuration items in the CM archive. This operation is required if you need to check out a configuration item that does not exist in your workspace. To view the items in the archive, do the following: 1. In the Configuration Items dialog, click List Archive. Rhapsody Configuration Management Guide 1-15

30 Collaboration The Archive dialog opens, listing all of the configuration items in the archive. Once the list of archive configuration items is displayed, you can select items from the list and check them out using the Check Out button. If you select more than one configuration item to check in or out, the items are handled in sequence, rather than all at once. Checking Out Configuration Items To check out configuration items from the archive: 1. In either the Configuration Items or the Archive dialog, select the items to check out. In the Configuration Items dialog, be sure that a version number is displayed for the selected item. This indicates that the selected item has been added as a configuration item to the archive and that versions of the selected item have been checked in previously. 2. Click the Check Out button Rhapsody Configuration Management Guide

31 The Check Out dialog opens as shown below: Checking Out Configuration Items 3. Choose from the Check Out dialog options as follows: Check Locked if you are acquiring a read/write copy of the items into your workspace and you want other networked users to be prevented from modifying them while you have a lock on them. Leave the Locked box unchecked if you want to check out the items as read-only. Note: It is customary for one user at a time to hold a lock on a given configuration item. However, some CM tools allow more than one lock on a single configuration item. This is not recommended. Select the With Descendant checkbox if you wish to check out the configuration items a parent item contains. For example, if you are checking out a package, selecting this checkbox will check out all archived classes, diagrams, and other elements that belong to the package. In the Label field, enter an optional revision setting, such as 1.1. Or you can enter a label name instead of a number. Note:If you do not enter a revision label and you are checking out the items as locked, the CM tool automatically checks out the version with the highest revision number. 4. Click OK to confirm your settings and check out the items. Rhapsody Configuration Management Guide 1-17

32 Collaboration Checking In Configuration Items To check items from your workspace back into the archive, use the Configuration Items dialog as follows: 1. Select the items you want to check in. 2. Click the Check In button. This opens the Check In dialog. 3. Select the following options: Select the Locked option if you want your workspace to continue to own the current copy of the items you are checking in (the default is Unlocked). Select the With Descendant checkbox if you wish to check in the configuration items that the check in items contain. For example, if you are checking in a package, selecting this checkbox will check in all the classes, diagrams, and other elements that it contains into the archive. In the Label field, enter an optional label for the revision. In the Revision Description box, enter some text describing the new revision: for example, how it was modified Rhapsody Configuration Management Guide

33 Locking Configuration Items Note: Most CM tools ignore this text the first time you check in a configuration item. 4. Click OK to confirm and check in the items. When you check an item in to an archive, Rhapsody triggers an automatic save of the entire model in the respository. Locking Configuration Items You lock units so that no one else can lock them out and change them. You often do this when you are preparing to check in a new revision and need to check in some units that are not locked. Locking them first, then checking them in ensures you can check them in from your workspace: 1. Select the items in the list that you want to lock. 2. Click the Lock button. 3. When the Lock/Unlock dialog appears, you can specify whether or not to lock the descendents of the item and set the revision label. The descendents of a package would include classes, diagrams, and other elements that are in that package. When you click OK, the message in the Output window confirms that the units have been locked. Unlocking Configuration Items You unlock a previously locked configuration item when you want to give others access to it and allow them to change it. 1. Select the items in the list that you want to unlock. 2. Click the Unlock button. Rhapsody Configuration Management Guide 1-19

34 Collaboration 3. When the Lock/Unlock dialog appears, you can specify whether or not to unlock the descendents of the item and set the revision number or label. The descendents of a package would include classes, diagrams, and other elements that are in that package. When you click OK, the message in the Output window confirms that the units have been unlocked. Synchronizing Configuration Items You can synchronize items that have been changed to correct the following situations where there is a difference between the project item version and the archive item version: The local copy and the project archive respository have different content. The version numbers of the project item in the repository and the local copy are different because someone else has changed the repository copy. OR The item exists in the local area, but not in the project repository, because it is new. Synchronize the items as follows: 1. Select the items to be synchronized. 2. Click the Sync button Rhapsody Configuration Management Guide

35 Synchronizing Configuration Items 3. A new dialog appears, displaying a list of items you might want to synchronize: Set By Label here Enter label here Checkout Final Refresh Each of the items is labeled with a mode and a status: RW for read-write with Status of Modified (version numbers are the same, but the content is different) RO for read-only with Status of Difference (local and archive version numbers are different because someone else has changed the archive copy) A Status of New for new items. Click the items to synchronize. You can choose to give them all the newest revision number (shown in the list) by leaving Head Revision displaying in the combo box. Press the Refresh button to the right in the upper left corner to update the list of units. Or you can assign those you select a distinct label by selecting By Label in the combo box and entering the label to the right. Then click the Rhapsody Configuration Management Guide 1-21

36 Collaboration Refresh button to the right of the Checkout button (to the upper left) to update the display. Final Synchronizing gets a list of all configuration items in the repository and checks out any new/updated items to the local model. If a new configuration item exists in the repository, it adds the item to the local model automatically. The end result is that the workspace reflects what the repository contains. To synchronize the items you have selected, click the Checkout button (to the far upper left). For each unit that is in read-write mode, Rhapsody asks if you want to update that item, letting you confirm each unit you are synchronizing/overwriting. CarDiagram.omd is writeable, overwrite? 1-22 Rhapsody Configuration Management Guide

37 Useful Scenarios in Configuration Management Now, the local archive and the configuration management repository should contain items that are the same. Useful Scenarios in Configuration Management What follows are details of how to implement some useful scenarios in configuration management. Renaming a Child Package within a Parent Package To rename a package within the parent package, you can take the following steps: 1. From the Rhapsody browser window, right click on the parent package containing the child package whose name will be changed and select Configuration Management > Check out from the popup menu. 2. Check the check boxes stating Locked. Click OK. 3. Repeat the above steps for the child you are interested in renaming. 4. In the Rhapsody Output window, verify that the parent package and its child have been successfully checked out. 5. From the Rhapsody browser window navigation area (left window pane), highlight (by left clicking on) the child package whose name needs to be changed. 6. In the information area of the Rhapsody browser window (right window frame), type in the new name of the child package and press Enter or click the apply (*) button. 7. In the source code control system, select the child package and change its name. In some source code control systems, you may need to remove the member and add it again with the new name as if it were an entirely new member. 8. If you could simply change the name of the member in your source code control system, skip this step. If you had to add the member again as if it were a new member, you must select File > Configuration Items and when the dialog appears, select the unit and then select the Add button to add the member to the repository anew. Rhapsody Configuration Management Guide 1-23

38 Collaboration 9. In the Rhapsody browser window navigation area (left window pane), select (left click to highlight) the parent package to be checked back in, right click and select Configuration Management > Check In. 10. From the Rhapsody browser output window, verify that the parent package and its children (if applicable) have been successfully checked backed in. Propagating Child Package Name Change to the Development Team Once you have renamed the package, you must update the Rhapsody browser window so that others working on the project can see the change. 1. For another team member to see the change to the child package name, in the Rhapsody browser window, from the menu bar at the top, select File > Configuration Items. 2. Select the Show List button (with the magnifying glass on it), which opens a window that displays the current items in the configuration management repository. (Otherwise you are seeing only the configuration items in the local workspace and not what is really in the archive.) 3. Select (highlight by left clicking) the parent package containing the child package whose name was changed from the list of configuration management items. 4. Click the button at the top of the Configuration Management window to Check Out the selected parent package. 5. Check both check boxes, Locked and With Descendents. Click OK. 6. From the Rhapsody browser output window, verify that the parent package has been successfully checked out. 7. Other developers should now see the modified child package name in the Rhapsody browser window navigation pane. Adding a New Parent Package to the Rhapsody Model 1. From the Rhapsody browser window navigation area (left window pane), right click on the Package folder and select Add New Package Rhapsody Configuration Management Guide

39 Propagating New Parent Package to the Development Team 2. From the Rhapsody browser window information area (right window pane), type in the name of the new parent package in the Name field and hit Enter or click the Apply (*) button on the tool bar. 3. From the Rhapsody browser window navigation area (left window pane), right click on the new package and select Configuration Management > Add to Archive. 4. Check the box stating With Descendents, type in a comment, and click OK. 5. In the Rhapsody Output window, verify that the parent package and its children (if applicable) have been successfully added to the archive. (You may also be able to verify that the object was successfully checked in by checking to see if the source code control system has incremented the version.) Propagating New Parent Package to the Development Team 1. For another team member to see the new parent package in the source code control repository, in the Rhapsody browser window, from the menu bar at the top, select File > Configuration Items. 2. Select the Show List button (with the magnifying glass on it), which which opens up a window that displays the current items in the configuration management repository. (Otherwise you are seeing only the configuration items in the local workspace and not what is really in the archive.) 3. Select (highlight by left clicking) the new parent package from the list of configuration management items. 4. Click the button at the top of the Configuration Management window to Check Out the selected parent package. 5. Check both check boxes stating Locked and With Descendents. Click OK. In the Rhapsody Output window, verify that the parent package and its children (if applicable) have been successfully checked out. 6. Other developers should now see the new parent package in the Rhapsody browser window navigation pane. Rhapsody Configuration Management Guide 1-25

40 Collaboration Making a Child Package into a Parent Package in Rhapsody Model 1. From the Rhapsody browser window, right click on the parent package containing the child package to be moved and select Configuration management > Check out from the popup menu. 2. Check both check boxes stating Locked and With Descendents. Click OK. 3. In the Rhapsody Output window, verify that the parent package and its children (if applicable) have been successfully checked out. 4. From the Rhapsody browser window navigation area (left window pane), select the child package to be moved and while holding down the left mouse button, drag the child package into the Package folder so that it is at the same level as the other parent packages. 5. Save the change to the Rhapsody model by selecting File > Save from the menu at the top of the Rhapsody main window. 6. In the Rhapsody browser window navigation area (left window pane), select (left click to highlight) the new parent package which was moved, right click, and select Configuration Management > Check In to check the package back into source code control. 7. Check the box stating With Descendents, type in a comment and click OK. 8. In the Rhapsody Output window, verify that the parent package and its children (if applicable) have been successfully checked backed in. You may also be able verify that the unit was successfully checked in by being sure the version number in the source code control system has been incremented. Propagating New Parent Package to the Development Team 1. For another team member to see the new parent package in the source code control repository, in the Rhapsody browser window, from the menu bar at the top, select File > Configuration Items. 2. Select the button with the magnifying glass on it (Show List) to open a window that displays the current items in the configuration management repository. (Otherwise, you are seeing only the configuration items in your local workspace and not what is really in the repository.) 1-26 Rhapsody Configuration Management Guide

41 Propagating New Parent Package to the Development Team 3. Select (highlight by left clicking) the new parent package from the list of configuration management items. 4. Click the button at the top of the Configuration Management window to check out the selected parent package. 5. Check both check boxes stating Locked and With Descendents. Click OK. 6. In the Rhapsody Output window, verify that the parent package and its children (if applicable) have been successfully checked out. 7. You should now see the new parent package in the Rhapsody browser window navigation pane. Rhapsody Configuration Management Guide 1-27

42 Collaboration Using the Browser for Configuration Management Rhapsody provides you with a convenient subset of the commands from the Configuration Items dialog and makes them directly available for units displayed in the Browser. To perform CM activities in the Browser, do the following: 1. Expand the Browser to reveal a unit you want check in, check out, or add to archive. 2. Right-click the unit. 3. From the resulting popup menu, select Configuration Management From the next resulting popup menu, select one of the following CM actions: Add to archive Check in Check out Selecting Check In or Check Out produces dialogs the same as those encountered using the Configuration Items dialog. The Add to archive option takes no dialog. After each operation, the appropriate CM transcript appears in the Output Window, just as before Rhapsody Configuration Management Guide

43 Implementing CM Operations Rhapsody s CM tool support defines certain abstract operations supported in most CM tools. However, because each CM tool implements the operations differently, Rhapsody adopts the semantics of the particular tool to avoid enforcing any one approach. The following sections describe the common semantics of the five CM operations implemented in Rhapsody for all CM tools, and any differences that may apply to the way they are implemented by specific tools. You can edit specific implementations and are not permanently set in Rhapsody. You may well need to modify some settings to meet your specific requirements. General Procedures The items below are important CM considerations you need to make regardless of your CM software Naming the Project Directory As a general guideline, be sure to name the project and the directory that it s in with the same name. When to Check Out Packages Depending on what changes are made to an element of a package, the package information may also change accordingly. In the following situations, it is Rhapsody Configuration Management Guide 2-1

44 Implementing CM Operations necessary for users to check out the containing package as well as the element itself. Changing the package that the element belongs to Moving the element from one configuration item to another within the package Changing the name of the element Rhapsody CM Pre- and Post-Actions Rhapsody assumes a miminal configuration for all CM operations, and takes certain actions either before (pre-actions) or after (post-actions) beginning CM support. Operation Pre-Action Post-Action Connect to Archive Saves the project None List Archive None None Add Member Saves the project Rereads the CM information stored in the configuation item s file. This causes load metering to begin and to process rapidly. Check Out None Loads the configuration item from its file Note: Rhapsody performs all post-actions whether or not the CM operation succeeded. Source Integrity 7.3e Setting Up Source Integrity To set up Source Integrity to use as your CM tool, follow these steps: 1. Create a directory to serve as your archive directory. 2. Create an archive facade as follows: Open Source Integrity. 2-2 Rhapsody Configuration Management Guide

45 Setting Up Source Integrity Choose File > Create Project. For the Project Name field browse to the new archive directory or directly enter the full path and project name. Note: The project name must have the extension.pj. The default project name is project.pj. 3. Click the Finish button. This creates the project file project.pj in the archive directory and opens an empty project window with title [...<path>\project.pj] title shown below:. Note: Clicking the Next button instead of Finish allows you to create new file archives (page 2 of 3) and a sandbox (page 3 of 3). These are, however, not necessary since file archives can be created later and I-Logix does not recommend that you start a sandbox for your projects. 4. Set the configuration for this project with the following steps: Select Configuration > Personal... from the Source Integrity main menu. In the Configuration dialog, select the Checkout tab. In the Check Out Defaults group, as the Working File Format select DOS Format (CR/LF). Select Expand Keywords (in Working File). Select the Archive tab. Under Archive Defaults, select Strict Locking. Rhapsody Configuration Management Guide 2-3

46 Implementing CM Operations Select OK to for the Personal Configuration Source Integrity Semantics The following table shows the semantics of the five CM operations as specifically implemented for Source Integrity. Operation Check In Check Out Show Items in Archive Add Member Connect to Archive Semantics Items are checked in, even if their current contents are identical to those already in the archive. Configuration item files overwrite writable (locked or newly created) configuration items of the same name. The items listed are the head revisions, usually the most recently checked-in revision of each configuration item. Copies the file to the archive directory and adds is as a Source Integrity project member, without creating an archive. The first check-in creates the archive. The project file project.pj created in Steps 1-5 represents the archive. No Source Integrity operation is performed during its creation. Particularly, no sandbox is created. I-Logix recommends that you do not create a sandbox file, and especially not in the _rpy directory. 2-4 Rhapsody Configuration Management Guide

47 PVCS PVCS Setting Up PVCS To set up PVCS to use as your CM tool, follow these steps: 1. Create a directory to serve as your archive directory. 2. Configure the project to specify: A flag to save read-only work files (NODELETEWORK) The archive path (VCSDIR) Keyword expansion in files with the extensions.cmp,.cls,.msc,.omd,.ucd, and.sbs (EXPANDKEYWORDS). In PVCS, there are two ways to do this. You can either include these settings in the Master Project configuration file (continue with Step 3 on page 6) or, if you cannot modify the Master Project, you can include them in the current project configuration file (continue with the alternative Step 3 on page 7). The PVCS program directory contains two configuration files: master.cfg and template.cfg. The first lists the configuration setting for the Master Project, the second the default values for those settings. Use the template as the basis for a new project configuration file. Each project also has its own configuration file, which should contain only those settings that differ from the Master Project. The project configuration file is stored in the project directory and bears the name of the project. For example, the configuration file for a project named myproject would be stored as...\myproject\myproject.cfg When Rhapsody opens a project, it reads only this project configuration file. Rhapsody Configuration Management Guide 2-5