Install Modeler

Syside Modeler installs from the VS Code Marketplace or the Open-VSX Marketplace into Visual Studio Code or a compatible editor, and needs one thing Syside Editor does not: a Modeler license key, available on Sensmetry.com. See Minimum requirements for everything it needs. For the command line tool, see Install Modeler CLI instead.

Install extension

Uninstall or disable Syside Editor first: it shares features with Modeler, and the two conflict.

  1. Open your editor

  2. Click Extensions in the left sidebar (Ctrl/Cmd+Shift+X)

  3. In the search bar, type Syside Modeler

  4. Click Install on Syside Modeler by Sensmetry (identifier sensmetry.syside-modeler)

Where your editor cannot reach the marketplaces, or you need a specific version, install the extension from a downloaded .vsix file.

  1. Enter your license key and download the Syside Modeler extension for the machine that will run it (the download may take a few seconds to start)

    Once installed, this .vsix needs no further downloads. The .vsix the marketplaces offer for download is not this file: it downloads the rest of the extension after the first license check.

  1. Open your editor

  2. Click Extensions in the left sidebar (Ctrl/Cmd+Shift+X)

  3. Drag and drop the syside-modeler-*.vsix file onto the Extensions view

    Alternatively, open the Command Palette (Ctrl/Cmd+Shift+P), run Extensions: Install from VSIX…, and select the file

Activate license

Modeler checks the license with our licensing servers as you work. Licensing covers what that needs, and What data we collect lists what is sent and what you can turn off.

  1. Open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside Modeler: Check Syside license

    A prompt for your Syside license key should open:

    Syside Modeler license dialog

    Modeler opens the same prompt on its own the first time you open a SysML file.

  2. Enter your license key and press Enter

    A confirmation message should appear:

    Syside Modeler license success

    When it fails, an error message appears instead. Check the key and try again, and if it keeps failing, see Troubleshooting.

  3. If you get a popup asking to install Syside Tools, click Install Syside Tools

    If you dismissed the prompt, open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside Modeler: Install Syside Tools.

  4. Open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside Modeler: Add Syside license key to keyring

    This stores the key in your operating system’s secret storage, where Modeler CLI and Automator find it too, so the key is entered once per machine.

On a machine that cannot reach our licensing servers, import a license file instead: Offline license covers getting, carrying over and importing it.

Verify installation

Check that Modeler flags an error and draws a diagram:

  1. In your editor, save this as example.sysml:

    package Example {
   part def Electrical;

   part Automobile {
      part Motor : Electricall;
   }
}

    You should see an error highlighted and listed in the Problems panel (Ctrl/Cmd+Shift+M):

    Error on the misspelled part definition

  2. Correct the spelling to Electrical and save

    The error should disappear.

  1. Click the Syside logo (top right) and select Visualize current file (Ctrl/Cmd+Shift+V)

    A diagram of the model should open:

    Diagram of the example model

Continue to Write your model, or start at Troubleshooting if something did not work.

Update Modeler

Updating keeps your license activation and your settings.

By default, your editor updates extensions automatically. Reload the extension when it prompts you after an update.

If you are not receiving automatic updates:

  1. Click Extensions in the left sidebar (Ctrl/Cmd+Shift+X)

  2. Find Syside Modeler in the list

  3. Verify the Auto Update checkbox is enabled

A VSIX install does not update itself. Repeat the installation steps with the latest version.

Minimum requirements