Install Syndeia plugin.

Owned by Debesh Roy Chowdhury
Last updated: Nov 14, 2024 by Manas Bajaj
2 min read

Pre-Requisites

The following pre-requisites are required before installing the Syndeia Rhapsody plugin.

Steps

Follow the instructions below to install the Syndeia plugin for Rhapsody.

  1. If you have Rhapsody running, close Rhapsody - so that you can modify its configuration files
     

  2. Locate the Profiles folder in your Rhapsody installation.

    1. For Rhapsody 8.4 - On Windows 10/11, the Profiles folder is located under your user directory as follows:<Your_User_Directory>\IBM\Rational\Rhapsody\8.4x64\Share\Profiles
      e.g. C:\Users\InterCAX\IBM\Rational\8.4x64\Share\Profiles. 

      1. Alternatively, if you have a merged installation of Rhapsody, then the Profiles folder will be under ProgramData\IBM\Rational\Rhapsody folder, such as:
        C:\ProgramData\IBM\Rational\Rhapsody\8.4x64\Share\Profiles

    2. For Rhapsody 9.x - On Windows 10/11, the Profiles folder is located under in <Rhapsody_Installation>\9.0\Share\Profiles, e.g. C:\Program Files\IBM\Rhapsody\9.0\Share\Profiles.

      1. Do not install in <Your_User_Directory>\IBM\Rhapsody\9.0x64\UserShare\Profiles, e.g. C:\Users\Rose\IBM\Rhapsody\9.0x64\UserShare\Profiles

  3. If you have an existing installation of Syndeia (e.g. Syndeia 3.5 SP2), first make sure you have a backup of the lib folders assembled when configuring integrations, and then delete the Syndeia folder under the Profiles folder (as identified above).
     

  4. Extract the Syndeia Rhapsody plugin zip file (e.g. Syndeia_3.6-SP1_Plugin_for_Rhapsody.zip) file to the Profiles folder (chosen in Step 2). After extracting, there should be a Syndeia folder directly under the Profiles folder, as shown below.

 

  1. Copy the library folders assembled when configure integrations, such as libTC, libWC, libMySQL, libNX, and libCreo, to the Syndeia folder, as shown in the figure above.

    1. Note that you will need library folders for only those repositories / tools that you will be connecting to using Syndeia and for which you have a Syndeia license.

    2. The libSimulink folder is automatically installed with Syndeia.

 

  1. Copy the Syndeia license file that your organization obtained from Intercax Support to the .syndeia folder in your user directory.

    1. If you do not have a .syndeia folder, create one in your user directory.

      1. Windows Users: the user directory is often C:\Users\<your login id>, e.g. C:\Users\<Your user account>\.syndeia

      2. Linux and Mac Users: the user directory is often ~<your login id>

 

  1. Copy mapping file – If you are upgrading from Syndeia 3.5 SP2 to 3.6 SP1, follow the sub-steps below. If you are upgrading from Syndeia 3.6 to 3.6 SP1 or installing the Syndeia Rhapsody plugin for the first time, skip this step and move to the next one.

    • Locate the syndeia.mappings file for Syndeia 3.5 SP2. It should be located in .syndeia/3.5 folder in your user directory, e.g. C:\Users\<Your Account>\.syndeia\3.5\syndeia.mappings for Windows.

    • Copy the syndeia.mappings file to the .syndeia/3.6 folder in your user directory, e.g. C:\Users\<Your Account>\.syndeia\3.6\syndeia.mappings for Windows.

  2.  Congratulations! You have successfully installed the Syndeia plugin for Rhapsody.

 

  1. The Syndeia log file for Rhapsody is stored in the .syndeia folder, e.g. C:\Users\.syndeia\3.6\syndeia.rh.log. When asking questions or reporting observations on our helpdesk, you will receive faster service by providing a copy of this file with your tickets. Practice good operational security and make sure your IT team redacts or approves the sharing of the log files.

 

Package Properties for Model Transforms

If your organization will be performing Syndeia Model Transformations from integrated repositories into Rhapsody models, then very likely you will want to alter the Rhapsody Project Properties to allow spaces in Package Names which Syndeia will create for you. See https://www.ibm.com/support/pages/how-name-package-spaces-rational-rhapsody and the General::Model::NamesRegExp property.

 

Read available product documentation to learn about the Syndeia Dashboard and its features. Then, assure that either you or your organization's analysts perform the step-by-step instructions in the tutorials available at Intercax.com (Tutorials - Syndeia for Rhapsody).