Setting up Telelogic SYNERGY/CM

Installation > Setting up Applications to Work with Modeler > Setting up Telelogic SYNERGY/CM

CM tool integration support for Telelogic SYNERGY/CM is being deprecated.

A standard installation of SYNERGY/CM will not work with Modeler, because it will not have the Telelogic SCCI integration software installed. The SCCI integration software is installed through an integration patch that is available on the Telelogic website. If the Telelogic integration patch installation does not set up the required PATH environment variable, ensure that you set it up manually. If the PATH environmental variable is not set up correctly, the CM Tool integration will not work.

Ensure that SYNERGY/CM is licensed for use. When using the CM tool integration with an unlicensed copy of SYNERGY/CM, the error messages are unpredictable and misleading.

The CM tool integration works only if you set up the SYNERGY/CM database, project and directory object to work with Modeler:

• Database- You must create two types (rts_model_file and rts_package_file) before creating the project. We provide a batch file to help you set up these types.

• Project- You must use SYNERGY/CM to create and define a project in which to store the model:

◦ You must use SYNERGY/CM to create the project, because the CM tool integration cannot create a project for you.

◦ The name of the project must not contain any spaces.

◦ The Project's Purpose must be set to Shared. Note that when you create a Project in SYNERGY/CM, its Purpose is set to Personal by default and it cannot be changed after creation.

◦ The Project's Work Area path must be defined using a UNC path. On the Work Area Properties dialog, you must type the UNC path in the Directory box. For example:

If you want SYNERGY/CM to create a work area in a subfolder of the c:\cms folder on a computer whose machine name is computer12, create a share for the cms folder (named cmsshare in this example) and type the following text in the Directory box: \\computer12\cmsshare\

• Directory Object- You must set the status of the directory object to Integrate or Public. By default, the status of the directory object is set to working, which prevents non-owners of the directory object from checking in new Packages.

When using SYNERGY/CM, you typically check out files and then check in the tasks associated with those files. When using SYNERGY/CM with Modeler, you must perform all check out and check in operations from Modeler. Modeler associates check in and check out operations with the default SYNERGY/CM task. Warning: Do not check in package files or tasks from SYNERGY/CM, as this may check in out-of-date package files.

If SYNERGY/CM is not running and you open a Modeler model that is stored in a SYNERGY/CM project, Modeler will start SYNERGY/CM so that it can interrogate the status of the stored Model and Package files.

When you perform a check in or check out operation on a model, the operation applies also to files that reside in the ModelerATFiles subfolder for the Model. Unlike other CM tool integrations, the operation will not apply to files that reside in subfolders of the ModelerATFiles subfolder for the Model.

If you want to baseline a SYNERGY/CM project that stores a Modeler Model, check in the Model and all its Packages before creating the baseline. After creating the baseline, perform the following steps:

• Disconnect and Reconnect using the Configuration Management > Advanced > Disconnect From Configuration Management command followed by the Configuration Management > Advanced > Reconnect to Configuration Management > Store CM Tool Paths Globally in Model command.

• Check out the Model and all its Packages.

• Check in the Model and all its Packages.

To Set up a SYNERGY/CM Database to Work with Modeler:

You must run the supplied import batch file to set up a SYNERGY/CM database for use with Modeler. The import batch file creates two types (mdf and pkf) and must be run on the SYNERGY/CM server. The instructions assume the server is running on a Windows XP computer.

Important The batch file must be run on the SYNERGY/CM Server, not the SYNERGY/CM Client.

1. Install the SCCI integration software from the Telelogic integration patch, which is available on the Telelogic website.

If the Telelogic integration patch installation does not set up the required PATH environment variable, ensure that you set it up manually. If the PATH environmental variable is not set up correctly, the CM Tool integration will not work.

2. Open a Command Prompt window.

3. From the Modeler installation files, change directory to Synergy_Setup.

4. Run the import.bat file.

5. When prompted, log on to the database that you will be using to store Modeler Models, as a user with type_developer privileges.

The batch file will set the role and import the two types.

6. Check that the import was successful:

a. From the SYNERGY/CM Project View, on the File menu, click Show Messages.

b. At the bottom of the log, confirm that the rts_model_file and rts_package_file types have been imported without any errors.

c. Close the SYNERGY/CM Message View window.

Having completed the import, check that the Super Type and the Migrate Rules for each type have been set correctly:

1. Having completed the import, check that the Super Type and the Migrate Rules for each type have been set correctly:

2. For each of the imported file types (rts_model_file and rts_package_file):

a. Click the Browse Types button.

b. From the list of types, select the file type, and then click OK.

c. From the Type Definition dialog, check that Super Type is set to binary.

d. On the Type menu, click Modify Migrate Rule.

The Type Definition - Migrate Rules dialog is displayed.

e. Check that the File Match Patterns are set:

.*\.[Mm][Dd][Ff]$ for the rts_model_file file type.

.*\.[Pp][Kk][Ff]$ for the rts_package_file file type.

f. Close the Type Definition - Migrate Rules dialog.

3. Close the Type Definition dialog.

4. If your SYNERGY/CM server is not running NT, run the ccm commands listed in import.bat manually.

After setting up the SYNERGY/CM database, you can set up a SYNERGY/CM project to store the Model.

To Set up a SYNERGY/CM Project to Work with Modeler:

1. If you have not done so already, set up the SYNERGY/CM database to work with Modeler.

2. If you are using SYNERGY/CM version 7.0:

a. Ensure that you use the ccm_admin role when creating the project.

b. Ensure that the name of the project does not contain any spaces.

c. Set the project's Purpose to Shared. Note that when you create a Project in SYNERGY/CM, its Purpose is set to Personal by default and it cannot be changed after creation.

Note that a CM project can store only one Model.

3. Define the Project's Work Area Directory using a UNC path. On the Work Area Properties dialog, you must type the UNC path in the Directory box. For example:

If you want SYNERGY/CM to create a work area in a subfolder of the c:\ccm folder on a computer whose machine name is computer12, create a share for the ccm folder (named ccmshare in this example) and type the following text in the Directory box: \\computer12\ccmshare\

4. Close the Create Project dialog.

5. If you are using SYNERGY/CM version 7.0, from SYNERGY/CM, set the Status of the project's Directory object to Integrate or Public. Note that by default the status of the directory object is set to working, which prevents non-owners of the directory object from checking in new Packages.

For procedural information about working with SYNERGY/CM and checking in a Model for the first time, open the Modeler Help, expand the 'Database, model, component and package management (includes access permissions)' section, expand the 'Configuration management tool integration' section, and then see the topics in the 'Telelogic SYNERGY/CM integration' section.

For generic information about the configuration management tool integration, see the topics in the 'Database, model, component and package management (includes access permissions) > Configuration management tool integration' section of the Modeler Help.