Show all text and icon decorations Preferences->Team->IBM Rational ClearTeam Explorer->ClearCase decorations: Enable Text and Icon Decorations

Transcription

1 CTE Startup Guide This guide provides a glimpse into the IBM Rational ClearTeam Explorer (CTE). We will present a number of IBM recommended preferences and practices as well as demonstrate a variety of common user scenarios that one might encounter when working with the CTE / RSA RTE integration. Please note that this guide does not provide a complete list of CTE functionality. Instead it provides only a small subset of user scenarios that an RSA RTE designer might frequently encounter. This document is meant as an aid in the transition from SCM Adapter to CTE. Warning: Logical Model Merge is not yet recommended for production. There is currently a risk of model corruption. These issues are actively being worked and will be available soon This document does directly address this topic. ** Search for (updated) to see new changes ::RECOMMENDATIONS:: The recommendations below are presented with all logical model scenarios in mind, including logical model merge. Users should continue to use file by file merge during the first phase of the CTE rollout. It is understood that some of the preferences recommended below may not be consistent with the current file by file process e.g. checkin/undo checkout all or none. If you find it necessary to modify some of these preferences for this first phase of the CTE rollout, you may do so. However, once logical model merge is introduced as part of the process. It is a imperative that these preferences be strictly followed. If not there is a great risk of model corruption. Recommended Preferences Show all text and icon decorations Preferences->Team->IBM Rational ClearTeam Explorer->ClearCase decorations: Enable Text and Icon Decorations Decorate projects with view tags Preferences->Team->IBM Rational ClearTeam Explorer->Workspace->Decorate workspace project names with viewtags Display logical model names Preferences->Team->IBM Rational ClearTeam Explorer->Workspace->For Logical Model integrations, display the logical model name for each physical file in the checkout, checkin and undo checkout dialogs Preserve modification time (avoid Out of Sync messages) Preferences->Team->IBM Rational ClearTeam Explorer->Preserve modification time when checking in files and adding new files to source control (updated) 19/6/12 Logical model Aware Checkouts Preferences->Team->IBM Rational ClearTeam Explorer->Dialogs->Checkout: For Logical Model integrations, select only the requested resources for checkout Set to ON (It is off by default) Checkin all or none (for a logical model s elements) This is imperative and avoids logical model corruption

2 Preferences->Team->IBM Rational ClearTeam Explorer->Dialogs->Checkin: For Logical Model Integrations, allow selective checkin of resources Set to OFF (It is off by default) Logical model Aware Checkin Preferences->Team->IBM Rational ClearTeam Explorer->Dialogs->Checkin: Logicla Model Integrations for this dialog Select Allow selective radio button and check initialize using user s selection checkbox Checkin identical This is imperative and avoids logical model corruption Logical Model Aware Undo Checkout Preferences->Team->IBM Rational ClearTeam Explorer->Dialogs->Undo Checkout: Logical Model Integrations Select Allow selective radio button and check initialize using user s selection checkbox Undo Checkout all or none (for logical model elements) This is imperative and avoids logical model corruption Preferences->Team->IBM Rational ClearTeam Explorer->Dialogs->Undo Checkout: For Logical Model integrations, allow selective undo checkout of resources Set to OFF (it is OFF by default) Disable automatic logical model merge This is imperative and avoids logical model corruption Preferences->Team->IBM Rational ClearTeam Explorer->Integration->Compare/Merge: For Logical Model integrations, perform merges automatically if possible Set to OFF (is is ON by default) Recommended Practices When executing a Merge Search. They target-version of the model must be loaded in the workspace.

3 Warning: Logical Model merge is not yet recommended for production. There is currently a risk of model corruption.these issues are actively being worked and will be available soon. or If you experience extremely long hangs during transformation operations, start CTE with the following arguments: -vmargs -Dcom.ibm.rational.clearcase.DisableCTEChangeEventHandler=ON We recommend this flag be turned OFF once the builds are complete.

4 ::COMMON SCENARIOS:: This section describes a subset of common scenarios that might be encountered by an RSA RTE designer. Most of the described scenarios are focused on the ClearTeam Explorer s IDE workspace integration, specifically the RSA RTE contributed UML Development perspective. Set to an existing dynamic view and start CTE 1. From the command line run cleartool setview <view> 2. Launch CTE /opt/ibm/sdp/eclipse List and navigate the views on your system 1. Change to the ClearTeam Explorer perspective Window->Open Perspective->Other->ClearTeam Explorer 2. List views on your system 3. Browse a view using the ClearTeam Navigator and ClearTeam Details views

5 Create a view: 1. Open the main ClearCase menu 2. Select Create View to open the wizard 3. Select the ClearCase Local node 4. Follow the wizard and specify view options 5. Press Finish 6. Once the view is created, a dialog will appear. 7. Add or Copy config spec rules and press OK, otherwise Cancel Tip: You can copy a config spec from an existing view. Tip: You can modify or copy a config spec at a later time: o Navigate to the ClearTeam Explorer perspective o Right click a view you would like to modify o Choose Show ClearCase View Configuration o Press the Edit Configuration button or o Modify your config spec and press OK

6 Create a working set Working sets provide a means to de-clutter your working environment by filtering on content important to you. 1. Select the desired artifacts (with ctrl-click) using the ClearTeam Navigator 2. Right click one of the selected artifacts to bring up the context menu 3. Select Create Working Set

7 4. Enter a name for the working set and press OK 5. A working set based on your selection is created and displayed. Tip: You may create as many working sets as you like 6. Switch back to the default working set

8 Import Project Set 1. Navigate an IDE perspective e.g. 'UML Development' perspective 2. Choose File-> Import 3. Select Team->Team Project Set 4. Follow the wizard and press Finish Tip: If automatic add to source prompting is not required, you can set the following preference to improve import performance: Window->Preferences->Team->IBM Rational ClearTeam Explorer->Workspace

9 LTE Import 1. Navigate an IDE perspective e.g. 'UML Development' perspective 2. Choose File-> Import 3. Select LTE Importer 4. Follow the wizard and press Finish Transformation 1. Set to the 'UML Development' perspective 2. Navigate to a particular project 3. Open 'Models' 4. Selects a Package containing a 'Transformation Configuration' 5. Right click's the transformation configuration and set it to 'Active Transformation Configuration'. This decorates the transformation with a green icon and updates the active transformation toolbar button 6. Run the transformation NOTE: See recommended practices above for tips on performance Make a change 1. Set to the 'UML Development' perspective 2. Navigate to a model project 3. Open 'Models' 4. Select an element to change and open it in an editor 5. Start typing to make the change 6. CTE prompts for checkout (NOTE: some editors are implemented to prompt on Save) Tip: You can set your preference to automatically checkout Open Preferences Navigate to Team->IBM Rational ClearTeam Explorer -> ClearTeam Explorer -> Workspace Set the following: 7. Press OK 8. Finish making the change 9. Check in the change

10 Commit all changes 1. Change to the ClearTeam Explorer perspective Window->Open Perspective->Other->ClearTeam Explorer 2. Select the view and choose 'Aggregated->Checkin' 3. Selectively choose artifacts for checkin. Note: Checking/Un-checking an element belonging to a logical resource will cause all elements in that logical resource to also be checked/un-checked. Review Changes prior to checkin 1. Execute a checkin via the Checkin or Aggregated->Checkin operation (This is accomplished by pressing the Checkin button on the toolbar or selecting the Checkin/Aggregated->Checkin operation from Team menu)

11 2. The checkin dialog opens 3. Right click a file in the dialog s resource table to launch Compare with Predecessor, Show Version Tree, or Show History 4. Once the review is complete, Press OK to commit the checkin, or Cancel Coming Soon (ETA weeks) The Checkouts view: Find and monitor checkouts in real time

12 (updated) 25/6/12 Version Tree Open the Version Tree 1. Select a file or version in the UML Development or ClearTeam Explorer perspective 2. Right click and select Show Version Tree Sort the Version Tree The version tree enables two methods for sorting labels: 1. alphanumeric, 2. most recently applied first. To show most recently applied first, ensure the following button is checked. This button toggles a persistent preference. The button only needs to be pressed once and remembers your choice. Most recently applied first Alphanumeric Display full names in the Version Tree The version tree allows the user to display the tree showing full names or truncated names. To show full names ensure the following button is checked.

13 This button toggles a persistent preference. The button only needs to be pressed once and remembers your choice. Full names Truncated names Display multiple version trees To ensure a version tree view is not replaced with a new version tree, Pin the version tree by pressing the Pin button. This will force the next version tree request to open in a new view. You may Pin as many version tree views as you like. Find checkouts

14 Launch the Aggregated->Checkin or Aggregated->Undo Checkout dialog to view a list of checkouts. You can review each each change by selecting a checkout in the table and bringing up its context menu. The follow operations are available, Compare with Predecessor, Show Version Tree and Show History are all available operations. (see the Review Changes Prior to Checkin section) Coming soon (ETA weeks) Open the ClearCase Checkouts view to display the list checkouts. The view also enables a user to perform a variety of ClearCase operations (including Compare with Predecessor, Show Version Tree and Show History, etc). The ClearCase Checkouts view will also provide real time tracking of checkouts for the selected view. Lastly, it will support the ability to navigate from a file listed in the ClearCase Checkouts view to that same file in the Project Explorer. (see the Review Changes Prior to Checkin section) File by File Merge by branch or label The following information is provided only for users who want to play with file by file merge in CTE. All other users may skip this section and instead continue to merge using the command line and internal scripts. Important Note: File by File Merge in CTE currently supports merge from a specified branch or merge from a specified label. It does not support merge from a specified view. If this is too restrictive, please continue to merge using your current process, whether that be cleartool findmerge or some existing internal script. Two options to use File by File Merge w/ CTE 1. (updated) 19/6/12 Use an empty workspace : Logical Models only exist if their file elements are imported into the workspace. If the files are not imported in the workspace, only a file by file merge can be done. One way to easy execute a file by file merge in CTE is to launch CTE with an empty workspace. Once launched, do the following: 1. Navigate to the ClearTeam Explorer perspective 2. Right click on the view you would like to merge to. 3. Select ClearCase Merge Search Follow the wizard to run the File by File Merge 2. (updated) 15/6/12 Disable Model Merge : The disabling or re-enabling of Logical Model Merge as described below in step 1. requires a restart of Eclipse to take effect. Disabling Logical Model Merge will also disable Logical Model handling within Eclipse completely! This means that all CTE Logical Model handling will also be disabled. Due to this fact, we recommended that Logical Model Merge only be disabled when performing a file by file merge within CTE. Once the merge is complete, you should immediately re-enable Logical Model Merge, so that logical model handling in re-activated in Eclipse. Unfortunately, this requires two restarts; one to disable and merge, a second to re-enable and re-activate logical model handling. Please note, that once Logical Model Merge is fully supported, the recommendation is that Logical Model Merge is never to be disabled.

15 Warning: Logical Model Merge is not yet recommended for production. There is currently a risk of model corruption. These issues are actively being worked and will be available soon 1. Disable Logical Model Merge Preferences->General->Compare/Patch->Modeling Compare (set the following) 2. From the UML Development perspective select the files or directories to merge. From the main 3. From ClearCase menu, select ClearCase Merge Search

16 4. The selection in step 2 will seed the ClearCase Merge Search dialog. Skipping step 2 requires manual selection

17 5. Specify a branch or label, and press Finish

18 6. Merge begins. Continue merging until all merging is complete.

19 7. Automatic merge example 8. If a manual merge is requested, answer Yes to start merging now. 9. Resolve the conflict and Save

20