Scribd
Upload
0 views

SetupGuide

The Tom Sawyer SysML v2 Viewer setup guide provides instructions for running the application in Docker, including prerequisites like Docker and Docker Compose. It details steps for extracting files, configuring licenses, setting the SysML v2 endpoint, running the application, and accessing it via a web browser. Additionally, it includes information on running the SysML v2 Pilot Implementation and troubleshooting tips for common issues.

Uploaded by

fahadoosss
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0 views

SetupGuide

The Tom Sawyer SysML v2 Viewer setup guide provides instructions for running the application in Docker, including prerequisites like Docker and Docker Compose. It details steps for extracting files, configuring licenses, setting the SysML v2 endpoint, running the application, and accessing it via a web browser. Additionally, it includes information on running the SysML v2 Pilot Implementation and troubleshooting tips for common issues.

Uploaded by

fahadoosss
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

Tom Sawyer SysML v2 Viewer 1.

0
Setup Guide

Welcome to the Tom Sawyer SysML v2 Viewer setup guide. This document will help you get started
with running Tom Sawyer SysML v2 Viewer in Docker. Follow the steps below to configure and launch
the application.

Prerequisites
Before you begin, ensure you have the following:

 Docker
 Docker Compose
 Compliant SysML v2 API & Services Instance

Note: If you do not have an API & Services instance, we offer a Docker deployment that launches the
SysML v2 Pilot Implementation developed by the Object Management Group’s Systems Modeling
Community (SMC). For more details on this see step 3 of this guide and section ‘Run SysML v2 Pilot
Implementation’.

Step 1: Extract the Zip File


If you haven't already done so, extract the zip file that you downloaded. After extraction, you should
have the following files:

 application.properties
 docker-compose.yaml
 Dockerfile.tsviewer
 SetupGuide.pdf (this guide)
 smc (directory)
 SysML2.jar

Page 1 of 4 Document version 1.0.0


Step 2: Configure License
Depending on your License Location, follow the corresponding steps:

For Tom Sawyer Hosted License

 Replace application.properties with the file you downloaded during license activation
on the Tom Sawyer Software website.

For Local Hosted License


 Replace application.properties with the file you downloaded during license activation
on the Tom Sawyer Software website.
 Open the application.properties file in a text editor.
 Locate the following properties and set them according to your Licensing Server settings:

com.tomsawyer.licensing.centralServerHostName=
com.tomsawyer.licensing.path=tslicenseserver
com.tomsawyer.licensing.protocol=https
com.tomsawyer.licensing.port=443

Note: If both Docker and Tom Sawyer Licensing Server are running in the same machine, you
can use host.docker.internal for the centralServerHostName property. For more
information see https://docs.docker.com/desktop/networking.

Step 3: Configure your SysML v2 Endpoint


 Open application.properties in a text editor.
 Set your SysML v2 API & Services endpoint URL in the following property:

sysml2.server.url=

Note: For your convenience we provide a separate Docker deployment of the SysML v2 Pilot
Implementation developed and maintained by the Object Management Group’s Systems
Modeling Community (SMC). If you use it, set the endpoint url to the following value:
http://host.docker.internal:9000/.

For more information on running this, please see the ‘Run SysML v2 Pilot Implementation’
section at the end of this document.

Step 4: Run the Application


 Open a terminal with administrative rights and navigate to the directory where you extracted
the zip file.
 Ensure that Docker is running
 Run the following command to start the application:

docker compose up --build -d

Page 2 of 4 Document version 1.0.0


Step 5: Access the Application
Once the containers are up and running, you can access the application on your Web browser:
http://localhost:4788

Tom Sawyer SysML v2 Viewer allows you to visualize the SysML v2 projects from your Compliant
SysML v2 API & Services Instance.

Run SysML v2 Pilot Implementation

Disclaimer: The SysML v2 Pilot Implementation is not developed, maintained, or supported by Tom
Sawyer Software. It has been developed by the OMG Systems Modeling Community and is provided
solely for your convenience. Tom Sawyer Software makes no representations or warranties, express
or implied, as to the functionality, compatibility, reliability, or accuracy of this software. Use of the
SysML v2 Pilot Implementation is at your own risk, and Tom Sawyer Software disclaims any and all
liability for any damages or issues that may arise from its use.

Follow these steps to run the SysML v2 Pilot Implementation:

 Open a terminal with administrative rights and navigate to the directory where you extracted
the zip file.

 Go to the smc directory.

 Ensure that Docker is running.

 Run the following command:


docker compose up --build -d
Note: Depending on your computer performance this setup process might take up to 30
minutes. This setup process is done only once.

 To ensure that the API & Services is up, open the following URL on a Web Browser:
http://localhost:9000/docs/

Note: The first time this page is opened it may take a long time. This is the database startup
time and will happen anytime the API & Services container is restarted.

 Go to the following URL on a Web Browser:


http://localhost:8888/lab

 On the JupyterLab page, open the FirstSteps.ipynb file. This notebook contains detailed
instructions on how to compile and publish SysML v2 models.

Page 3 of 4 Document version 1.0.0


Troubleshooting Tips
 Ensure Docker and Docker Compose are installed and running.
 Verify that the application.properties file contains the correct values for licenseName
and centralServerHostName. Ensure that protocol and port are set accordingly as
well.
 If the application fails to start, you can see the logs by running the following command:
docker-compose logs

We hope this guide helps you set up Tom Sawyer SysML v2 Viewer. If you encounter any issues,
please contact our support team at https://support.tomsawyer.com.

Page 4 of 4 Document version 1.0.0

You might also like