IBM
Contents Index Previous Next



Using CM SYNERGY Together with an SDL System


This section describes one way of using the SDL Suite and CM SYNERGY in an integrated way.

For more information about the SDL Suite/CM SYNERGY Integration see the Readme file in the installation
<SDL Suite inst dir>\examples\cm\win32\cmsynergy\ or
<SDL Suite inst dir>/examples/cm/unix/cmsynergy/.

For a more general description of using a configuration or version control system, please see How to Manage the Diagrams in a Project.

Introducing CM SYNERGY with the SDL Suite - Migration

When handling of files by CM SYNERGY is to be applied on a system being developed by the SDL Suite, the following approach can be used.

  1. Make sure that all files (related to the system) are configured in one directory hierarchy outside CM SYNERGY.
  2. Install the CM SYNERGY menu into the Organizer. Add cmsynergy.ini to your org-menus.ini file.
    The SDL Suite will search for the org-menus.ini first in the directory where the SDL Suite was started, then in a directory pointed to by the HOME environment variable and finally in the directory in which the SDL Suite was installed.
    If you do not already have a org-menus.ini file, the cmsynergy.ini can serve as one. Just copy cmsynergy.ini to either your HOME directory or to where you have the SDL Suite installed and rename it to org-menus.ini. For more information on dynamic menus, see Defining Menus in the SDL Suite. (The CM SYNERGY menu that comes with the distribution of the SDL Suite is an example and could be tailored by the user.)
  3. Set your path environment variable to include
    • <CM SYNERGY inst dir>\bin or <CM SYNERGY inst dir>/bin, and
    • <SDL Suite inst dir>\bin\wini386 or <SDL Suite inst dir>/bin.
      This is necessary to be able to start the tools from each other directly.
  4. Start the CM SYNERGY Client.
  5. Change role to ccm_admin.
  6. Display the Admin>Type Definition dialog to define an SDL file type. Enter the following values:
    Type Name: SDL
    Description: Binary file
    Super Type: binary
    Initial Status: working
    Require Task at:<none>
    Verify Comment Existence on Promote / Check In: Off
    Allow Update during Model Install: Off
    Associate with a File in the File System: On
    Can be a Product File: Off
    Icon Color / Fil: binary.bmp
    File Name Extension: .ssy
  7. Display the Type>Modify File Operations dialog, and enter the following values:
    (If necessary, replace sdt below with the command you use to start SDL Suite. If the sdt script is not in your PATH, you should specify a full path.)
    Type Name: SDL
    Description: Binary file
    Command Templates:
    Graphical User Interface:
    Edit: sdt %file1
    View: sdt %file1
    Compare: sdt -fg -grdiff %file1 %file2
    Merge: sdt -fg -grdiff %file1 %file2 -mergeto %outfile
    Command line interface:
    Edit: sdt %file1
    View: sdt %file1
    Compare: sdt -fg -grdiff %file1 %file2
    Merge: sdt -fg -grdiff %file1 %file2 -mergeto %outfile
    Print:
    Compare Attribute: source
  8. Click OK.
  9. Click Update Type.
  10. Define a project file type (*.sdt) by entering the following values:
    Type Name: SDT
    Description: SDT project file
    Super Type: ascii
    Initial Status: working
    Require Task at:<none>
    Verify Comment Existence on Promote / Check In: Off
    Allow Update during Model Install: Off
    Associate with a File in the File System: On
    Can be a Product File: Off
    Icon Color / Fil: ascii.bmp
    File Name Extension: .sdt
  11. Display the Type>Modify File Operations dialog, and enter the following values:
    (If necessary, replace sdt below with the command you use to start SDL Suite. If the sdt script is not in your PATH, you should specify a full path.)
    Type Name: SDT
    Description: SDT project file
    Command Templates:
    Graphical User Interface:
    Edit: sdt %file1
    View: sdt %file1
    Compare: %FAIL
    Merge: %FAIL
    Command line interface:
    Edit: sdt %file1
    View: sdt %file1
    Compare: %FAIL
    Merge: %FAIL
    Print:
    Compare Attribute: source
  12. Click OK.
  13. Click Update Type.
  14. Close the dialog. (File>Close).
    Now you have set up CM SYNERGY for SDL system diagram and SDT project files.
  15. To manage the other SDL diagram types select Tools>Migrate>Options>Set>Edit to open up the migrate rules file (migrate.rul) in a text editor.
  16. After the entry for your new type which should look something like (might differ depending on platform):
    MAP_FILE_TO_TYPE .*\xfa [Ss][Ss][Yy]$ SDL # Created automatically ...
    MAP_FILE_TO_TYPE .*\xfa [Ss][Dd][Tt]$ SDT # Created automatically ...
    add the following lines:
    MAP_FILE_TO_TYPE .*\xfa [Ss][Bb][Kk]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Pp][Rr]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Pp][Dd]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Uu][Nn]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Oo][Pp]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Ss][Tt]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Bb][Tt]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Ss][Uu]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Pp][Tt]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Vv][Tt]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Ss][Ss][Vv]$ SDL
    MAP_FILE_TO_TYPE .*\xfa [Mm][Ss][Cc]$ SDL
    and save the file. Be very careful with the syntax in this file as it is sensitive to syntax errors. Close the open dialogs.
  17. Use the Migrate facility to load the files into CM SYNERGY, via Tools>Migrate.
    • Put in the path to your Project directory in the From Directory field, or use the browse button to locate them.
    • In the Project field use the syntax ProjectName-Version, make sure to set the version to a meaningful value.
    • Next click on the menu item Options>Set>Set Object State To>released and click OK.
    • Windows only: To be able to change files you must set the option Make Copies Modifiable in Work Area Properties and then click OK.
    • To ensure that the correct files are being migrated it is suggested that you click Preview. If the results are what you expected go ahead and click Load.
      Now you have a project that is baselined in a released state which you can start to work from.
  18. Each developer will now need to set up their own working environment before using CM SYNERGY with SDL Suite and TTCN Suite.

Introducing CM SYNERGY with the SDL Suite - Set up your working environment

After the build manager has migrated your SDL system into CM SYNERGY, each developer will need to set up their own CM SYNERGY work-area. This should be done using the CM SYNERGY client to ensure that all the correct options are selected.

  1. Select the correct project baseline for your SDL system as directed by your build manger.
  2. Check out your own personal working version of the project hierarchy using the correct options as directed by your build manager, check out the system file (this will be your own personal version).

Note:

You will normally only have to set up a working environment in this way once for each major release of your software.

  1. Load the CM SYNERGY menu into the Organizer <org-menus.ini>

Introducing CM SYNERGY with the SDL Suite - Day-to-Day Working with CM SYNERGY

These steps assume that you will be using the (recommended) CM SYNERGY Task Based-CM methodology. They may be executed from the Organizer.

  1. Select your SDL system and start CM SYNERGY from the Organizer.
  2. Set your default task (also known as the current task), create one if required.
  3. Check out the file(s) you wish to work on.
  4. Edit and test as required.
  5. Check in your (default) task.

Note:

If you are working as part of a team you may pick up your colleagues' latest work by selecting the top level directory and using the Update command (from time to time you may need to do a full update from the CM SYNERGY client - ask your build manager).


http://www.ibm.com/rational
Contents Index Previous Next