Pre-Requisites

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

• You have successfully gone through the previous steps under the parent section Installation - Syndeia for MagicDraw | Cameo.

• You have downloaded the Syndeia Cameo plugin from the download site that was shared with you when you requested licenses/downloads via our helpdesk.

• Use the following plugin variants for different variants of Cameo:

  • For Cameo 2021x R2 and above, use Syndeia_3.6-SP1_Plugin_for_Cameo_2021xR2_and_above.zip

  • For Cameo 19.x, use Syndeia_3.6-SP1_Plugin_for_Cameo_19.0.zip

Steps

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

1. Launch Cameo as an administrator. On Windows 10/11, you can right-click the 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.

Open

3. Click on the Import button (as shown above) and select the plugin installation zip file that you downloaded, e.g. Syndeia_3.6-SP1_Plugin_for_Cameo_2021xR2_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:

Open

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

5. Close Cameo.

6. Go to the Syndeia for Cameo plugin installation folder: <Your Cameo Installation>\plugins\com.intercax.syndeia.md, e.g. C:\Program Files\Cameo Enterprise Architecture\2024x\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  libSimulink folder is 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/11, 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. 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 Cameo 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, or /Users/<Your Account>/.syndeia/3.5 on Mac OS X.

• 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, or /Users/<Your Account>/.syndeia/3.6 on Mac OS X.

9. Additional step for Cameo 2024x

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

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

2. 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 4 lines at the end of the vm.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 --add-opens java.desktop/sun.awt.shell=ALL-UNNAMED

4. After adding these 4 lines, the file should appear as shown, with the new lines shown here as 36 through 39.

5. Save the vm.options file. 

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

10. Restart Cameo as an administrator, similar to Step 1. 

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

12. 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 3.6 SP1 is loaded and enabled (true for both columns), as shown below.

13.  Congratulations!!! You have successfully installed the Syndeia plugin for MagicDraw / Cameo.

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

15. The Syndeia log file for MagicDraw/Cameo is stored in the .syndeia folder, e.g. C:\Users\.syndeia\3.6\syndeia.mdx.log.

• The log file is named syndeia.mdx.log for Syndeia Cameo plugins for Cameo 2021x R2 and above.

• The log file is named syndeia.md.log for Syndeia Cameo plugins for Cameo 19.0.

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.