Configure Cloud Mode

Owned by Debesh Roy Chowdhury
Last updated: Feb 22, 2024

Prerequisite: To use Syndeia plugin in cloud mode, your Syndeia administrator should have set up Syndeia Cloud and provided you the hostname (or IP address), port number, username, and password to access Syndeia Cloud from your machine. As a simple test, verify if you can access Syndeia Cloud by going to the URL <protocol>://<hostname>:<port> (e.g. http://mydomain.myhost.com:9000) on your web browser. You should be able to see the Syndeia Cloud login page, as shown below. Try to log in with your Syndeia Cloud username and password. If Syndeia Cloud is configured to authenticate using an LDAP server in your organization, then select LDAP for the Select account option and use your LDAP username and password to log in. If you don't see the Syndeia Cloud login page or are unable to log in, check with your Syndeia Cloud administrator.

 

By default, Syndeia is configured to operate in the local mode after installation. Follow the steps below to configure Syndeia in the cloud mode.

  1. Create a new SysML project in MagicDraw, if you don’t already have a SysML project open, using File > New Project and then selecting SysML Project in the window shown below.


     
  2. Select File > Use Module (MagicDraw 18.0) or File >  Use Project > Use Local Project (MagicDraw 18.5), select <install.root>\profiles, and then select the Syndeia Profile, as shown below. Press the Finish button. If you are prompted to see all Auxiliary Resources in MagicDraw, select No.


  3. Right-click on any element in the MagicDraw model tree (containment tree) and select Syndeia > Settings. This will launch the Syndeia Settings window, as shown below. Set the properties under Syndeia store settings, as shown below
    1. Select primary store = CLOUD
    2. Protocol = http or https, depending on whether Syndeia Cloud has been set up with http or https protocol 
    3. Authentication protocol = BASIC if Syndeia Cloud is configured to authenticate users directly, or LDAP if Syndeia Cloud is configured to authenticate users using an LDAP server in your organization
    4. Hostname = hostname for your Syndeia Cloud installation, e.g. myHost.myDomain.com. Do not include the protocol (http/https) or the port number in the hostname.
    5. Port = Port number for your Syndeia Cloud installation. Default port numbers are different for http vs https. Check with your Syndeia Cloud admin.
    6. Username = Your username on Syndeia Cloud. If the Authentication protocol is set to LDAP, this will be your LDAP username.
    7. Password = Your password on Syndeia Cloud. If the Authentication protocol is set to LDAP, this will be your LDAP password.


Refer to the demonstration video Creating a Syndeia Cloud Project available in Part 1 - Introduction.

Notes: 

  • This setting is used when Syndeia is initialized for a project which happens when the Dashboard is launched for the first time after opening a project. Once Syndeia is initialized for a project, then changing this setting will require you to close and reopen the project. However, if the Setting Panel is launched as described above, before Syndeia is initialized (Dashboard is launched), then you will not need to close and reopen the project. 

  • This setting is a global setting, i.e. it will apply to all projects once it has been set. If you want to change the setting on a per-project basis, then you must follow the steps above for each project – launch Syndeia settings before launching the Dashboard and change it for that project.