Install Syndeia plugin

Owned by Debesh Roy Chowdhury
Last updated: Mar 08, 2024 by Rose Yntema

Follow the instructions in this section to install the Syndeia plugin for MagicDraw/Cameo.


1. Launch MagicDraw/Cameo as an administrator. On Windows 10, you can right-click the MagicDraw/Cameo icon and select Run as Administrator. On other operating systems, ensure that you have administrative privileges to install the software.


2. Go to Help > Resource/Plugin Manager.

 

3. Click on the Import button (as shown above) and select the plugin installation zip file that you downloaded, e.g. Syndeia_3.5_SP2_Plugin_for_Cameo_2021x-R2_and_above.zip.

  1. The plugin's installation zip file is stored in your workstation's local directories from wherever you downloaded that. Frequently, Windows users download files to C:\Users\<self>\Downloads.
  2. You will need to locate the import file with your file explorer:

4. If you are installing Syndeia for the first time, you will see a message indicating that the installation will finish upon restarting MagicDraw/Cameo. If you are installing Syndeia on top of your existing Syndeia 3.5 installation, you will see a message indicating that Syndeia 3.5 will be removed and Syndeia 3.5 SP2 will be installed upon starting MagicDraw/Cameo. 

5. Close MagicDraw/Cameo.

6. Go to the Syndeia for MagicDraw/Cameo plugin installation folder: <Your MagicDraw/Cameo Installation>\plugins\com.intercax.syndeia.md, e.g. C:\Program Files\MagicDraw\18.0\plugins\com.intercax.syndeia.md. 

  • Library Installation for specific Repositories - Copy the library folders assembled when configuring integrations , such as libTC, libWC, libMySQL, libNX, and libCreo, to this folder as shown below. 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. The libDOORS, libSimulink, and libIJIDE folders are automatically installed with Syndeia.

7. Setting up Syndeia license – Copy the Syndeia license file that you obtained from us to the .syndeia folder in your user directory. If you do not have a .syndeia folder, create one in your user directory. If you have problems creating the .syndeia folder using Windows explorer or Finder (Mac), create it using the command window or terminal. 

  1. On Windows 10, this would be C:\Users\<Your Account>\.syndeia 
  2. On Mac OS X, this would be /Users/<Your Account>/.syndeia 
  3. On Linux (Ubuntu), this would be /home/<Your Account>/.syndeia 

8. Additional step for MagicDraw/Cameo 2024x

This step is only relevant if you are installing the Syndeia plugin on MagicDraw/Cameo 2024x. If you are installing on MagicDraw/Cameo 19.0, 2021x, or 2022x, skip this step and go directly to step 9. 

  1. Open the vm.options file located in your MagicDraw/Cameo installation (<Your MagicDraw/Cameo 2024 Installation>\bin\vm.options), as also shown below, in a text editor. 

     

  2. If MagicDraw/Cameo is installed in C:\Program Files, you may need to open your text editor as an Administrator in order to save changes to the file.

  3. Add the following 3 lines at the end of the vim.options file.

    --add-opens java.base/java.net=ALL-UNNAMED
--add-opens java.base/java.lang.reflect=ALL-UNNAMED 
--add-opens java.base/java.util=ALL-UNNAMED


  4. After adding these 3 lines, the file should appear as shown, with the new lines outlined in red below.



  5. Save the vm.options file. 

Note: This additional step is required because MagicDraw/Cameo 2024x uses Java 17. 

9. Restart MagicDraw/Cameo as an administrator, similar to step 1. 

10. Go to Help > Resource/Plugin Manager and check if Syndeia 3.5 SP1 is installed, as shown below.


11. Go to Options > Environment. Select Plugins (as shown below) and click on the Provider column header to sort the plugin list by the Provider. Check that the Syndeia plugin is loaded and enabled (true for both columns), as shown below.


12. (thumbs up) Congratulations!!! You have successfully installed the Syndeia plugin for MagicDraw/Cameo.

13. Read through this document to learn about the Syndeia Dashboard and its features. Then, walk through the step-by-step instructions in Tutorials - Syndeia for MagicDraw | Cameo.

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