Table of Contents

1. SSI Software Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2. Installing or Updating SSI Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. SSI License Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. SSI License Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5. Using SSI Software Licensing with ShipConstructor 2014 and Earlier . 19
6. Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1. SSI SOFTWARE LICENSING
ShipConstructor is a suite of software products that may be purchased separately. When clients purchase a product, they receive a license to use
that product. There are two types of licenses:

Standalone - Standalone licenses must be installed on the same computer that is running ShipConstructor; only the user at that machine
can access the licenses. Standalone licenses may also be called nodelocked licenses.

Network - Network licenses are installed on a machine running an SSI License Server; all users on your network may access these
licenses. SSI License Servers may contain multiple instances of the same network license, allowing different users to use the same
product simultaneously.

Clients will receive one or more license files containing the licenses for the products that are purchased. These license files must be allocated to
an appropriate computer (ShipConstructor client machines for Standalone licenses and SSI License Server machines for Network licenses). Both
network and standalone licenses may only be hosted (installed) on the single machine they were allocated to. If it becomes necessary to relocate
the licenses to a different computer, SSI must be contacted to do so.

Products, Suites, Editions, Options & Special Licenses

ShipConstructor products (e.g. Structure, Pipe, HVAC, Electrical, etc.) each have three Editions: Standard, Premium or Ultimate. These editions
allow clients to purchase the most economical product given the size of the project that they will be working on (size is determined by the number
of parts in the project). Products may be purchased individually or in Suites which act as collections of individual products. A single suite license
enables a user to run commands from any of the products that make up the suite. In addition, the suites, regardless of edition, allow a limitless
number of parts (with the exception of Training or Academic suites).

WorkShare Licenses
Projects that have made use of SSI's WorkShare functionality (e.g. splitting, merging, WorkShare Design Export, etc.) are marked as WorkShare
enabled projects. Only product licenses with the WorkShare option may be used in a WorkShare enabled project.

EnterprisePlatform
In order to run EnterprisePlatform PublisherLT on a project, the project must bet set to be EnterprisePlatform Enabled (via Manager's
EnterprisePlatform menu). Once a project is EnterprisePlatform enabled all users must obtain an EnterprisePlatform Client license in order to run
any commands in this ShipConstructor project (in addition to the product license required by the command).

Compatibility with Previous Versions of ShipConstructor

3
Any version of ShipConstructor prior to ShipConstructor 2015 uses legacy hardware locks (USB keys) by default. However, it is possible to
update a client machine so that these older versions of ShipConstructor will interface with the new software licensing system. This is done via the
SSI Licensing Client Update module. Once installed on a machine any ShipConstructor version prior to ShipConstructor 2015 will access new
software licensing architecture, (either through a network SSI License Server, or through a software license file containing standalone licenses),
rather than the legacy USB keys.

Important: Once the SSI Licensing Client Update module is installed on a machine it is impossible to access the legacy hardware locks. All
versions of ShipConstrctor on this machine will now require access to the new software licensing system.

Any organizations that manage multiple projects with different ShipConstructor versions both prior and subsequent to ShipConstructor 2015 will
need extra planning and scheduling to ensure that sufficient licenses are available to both types of projects. This may involve keeping some
legacy hardware locks and only upgrading a portion to the new licensing system; or clients may decide to use the SSI Licensing Client Update
module on any machines operating ShipConstructor 2014 R2 or earlier so that these clients may obtain licenses from the new software licensing
system. Talk to your SSI representative to discuss which model would be best for you.

2. INSTALLING OR UPDATING SSI LICENSES

When you purchase ShipConstructor you will be asked to determine what computer(s) you want to host your SSI licenses. Run the SSI License
HostID application that is installed with ShipConstructor to generate a token file for that computer. The token file must be sent to your SSI
representative and you will receive a license file back that contains your licenses. The licenses CANNOT be moved from the computer they were
purchased for. To move licenses to another computer, contact SSI. Uninstalling ShipConstructor will not remove any installed licenses.

IMPORTANT: It is recommended that the ShipConstructor client application be run on a different machine than the one hosting the network
server. As such, SSI does not support a configuration having both Standalone and Network licenses hosted on the same machine (though it can
be arranged by special request). While the behavior of the licenses (i.e. acquisition, etc.) should work as expected there may be issues with the
reporting of available licenses in ShipConstructor when it is run on a machine with both Standalone and Network licenses.

Generating a Computer Host Token

The SSI License HostID utility is included in both the ShipConstructor and SSI License Server install. It can also be downloaded directly (http://w
ww.ssi-corporate.com/downloads/SSILicenseHostID.zip). It is used to generate the machine-specific token file that will be used to encode the
licenses for that computer.

On the computer that will host the license(s):

1. Run SSI License HostID utility.

2. Choose the location to save the token file. Click Save.

3. Repeat this on each computer that will host licenses including computers that will have standalone licenses.
4. Email the token file(s) to your SSI representative.

Tip: The SSI License HostID utility is a standalone utility with no other ShipConstructor requirements. As such it can be run prior to installation of
ShipConstructor (e.g. in order to expedite the acquisition of license files). Simply get the utility from another installation of ShipConstructor or from
your SSI representative.

4
Installing / Updating Licenses
The SSI License Update utility is included in both the ShipConstructor and SSI License Server install. It is used to install the license file received
from SSI and process it to ensure ShipConstructor (for standalone licenses) or the SSI License Server (for network licenses) will be able to detect
it.

On the computer to install the licenses:

1. Close any instances of ShipConstructor.

2. If the computer is going to be a network license server, the SSI License Server must be installed (see Step 3 of the Install
ShipConstructor Client, Standalone, or Server section of the Installation Guide). Standalone licenses do not require a license server
(but will require a ShipConstructor client installation in order to use the licenses).
3. Run the SSI License Update utility (Start > All Programs > SSI > ShipConstructor > Utilities > SSI License Update).
4. If a User Account Control prompt is displayed, click Yes.

5. Select the license file received from SSI.

6. Click Open.

3. SSI LICENSE ADMINISTRATION

Much of the information contained here comes from the RLM_License_Management_FAQ (http://www.reprisesoftware.com/publisher/license-ma
nagement-faq.php) and RLM_License_Administration (http://www.reprisesoftware.com/RLM_License_Administration.html) manuals provided by
Reprise Software. See these documents for further information.

Terminology
When using any third party API it is important to understand any terminology introduced in external documentation:

RLM - Reprise License Manager. The licensing solution used for SSI applications.

Entitlement - A purchasable unit of software the user can buy, e.g. 10 networked ultimate structure licenses.

License - An instance of an entitlement granted to a single user. One entitlement may provide many licenses to many different users.

5
Nodelocked License - Equivalent to standalone in previous licensing. The preferred term is standalone. The license cannot be used on another
computer.

Floating License – Equivalent to network lock in previous licensing. The preferred term is network.

ISV - Independent Software Vendor; the application provider. For all SSI based software this is SSI.

License Server Web Administration

The RLM server contains an embedded Web Server which can be used to perform most administration of the SSI License Server.

This web server is not created or managed by SSI, but is part of the Reprise Software licensing solution. To use the web server, simply point your
browser to: http://ServerHostName:5054 (where ServerHostName is the name of the server machine on the local network).

Tip: If you are on the server machine you can use http://localhost:5054.

With the web administration page of the license server it is possible to:

View the details of all current licenses.

See who has acquired licenses.
Forcibly remove a license from a user (freeing it for use by others).
Shut down or refresh the license server.
Temporarily transfer licenses from one server to another (for example if the primary server is going down for maintenance).
Manage logs and perform diagnostics on the server.
View the RLM License Administration manual.
View the details/version of the RLM license software.

6
Access Control to the RLM Web Interface
The web interface can be secured so that it requires a login. This is described fully in the "The RLM Web Server" section of the RLM License
Administration manual.

1. Create a text file called rlm.pw with contents like this:

tom::all
harry::reread,status

Note: each line is of form <username>:<encryptedpassword>:<permissions> - the password is left empty so that it can be changed after
initial login.
2. Place the rlm.pw file in the C:\Program Files\SSI\LicenseServer directory (alongside rlm.exe).
3. Open up the web administration page and login as a user in the rlm.pw file (with no password).
Note: it may be necessary to refresh the web page to see the login prompt.
4. Use the Change Password button to assign a password to the current user.

License Server Status

Clicking the Status button at the top of the left panel in the RLM Web Interface will display the status of the license server.

Heading - e.g. VJR-76-CLEAN (port 5053) - The server name and port that are used in ShipConstructor on client machines to
communicate with the license server. 5053 is the default tcpip port used for RLM communication.
License files - Displays the valid license files detected by the server. This should match the name of the license file provided by SSI.
EDIT rlm Options - This button allows you to modify the RLM Options, which control access to status, reread, shutdown administration
commands as well as control over the editing of options files. See the "The RLM Options File" section of the RLM License Administration
manual for details.
SHOW rlm Debug Log - This button displays the last 20 lines of the RLM Debug Log (activity of the RLM system, for example starting of
services, detection of license files, etc).
ISV Servers Table - Displays information for each of the Independent Software Vendors (e.g. SSI) hosted by this RLM instance.
Port - Secondary port used for the ISV server communications. Randomly selected each time the license server restarts (unless
specified at the end of the ISV line of the network license file - e.g. if there are internal firewall restrictions in the local network).
Server Status - The SSI button navigates to a detailed status including all licenses available on the server.
License Usage - The SSI button navigates to a page where license usage may be queried by user, host or product.
Debug Log - The SSI button displays the debug log for the SSI ISV (activity of the SSI license system, for example available

7
 licenses, license acquisitions, etc).
REREAD - The SSI button causes the RLM system to reread the SSI license and options files.
OPTIONS - The SSI button allows editing of the SSI ISV Options. These allow reserving or excluding license use for users or
groups, as well as logging of activity. See the "The ISV Options File" section of the RLM License Administration manual for
details.
TRANFSER - May be used to temporarily transfer licenses from another server to this one.
SHUTDOWN - Shuts down the SSI ISV, preventing access to any SSI licenses.

ISV (SSI) Status

Clicking the SSI button in the Server Status column of the ISV Servers table (see above) displays detailed status of the SSI license system
including locations of log files, server statistics and license details:

The licenses table displays the product, version, expiry date, total count of the licenses, as well as the number currently in use. In addition,
clicking the usage... button will display the usage details of the particular license:

ISV (SSI) Options

Clicking the SSI button in the OPTIONS column of the ISV Servers table on the RLM status page (see above) allows modification of the SSI
options. These options are saved as ssi.opt in the SSI License Server program directory. They can be used to include or exclude people or
groups from specific licenses or all licenses. See the “ISV Options File” section of the RLM_License_Administration for full details.

8
SSI has included a sample of how to add a report log file in the options (see above image). The lines are commented out by default. Simply
remove the # from the front of the line to enable the option.

Licensing & Firewalls

While many networks only employ a firewall for traffic external to the network, if network infrastructure includes firewalls for internal traffic then
communication ports will need to be opened in the firewall exceptions.

There are TWO ports that are necessary to be open for licensing to work in ShipConstructor, plus one additional port (5054) for the RLM Web
Administration web page.

1. ISV Communication Port - Can be seen in the Port column of the ISV Servers table on the Status page of the RLM Web
Administration site (see the image under License Server Status above). It must be opened for TCP/IP traffic. As this port changes
randomly every time the license server resets (every 24 hours), it should be specified on the ISV line of the license file so that the firewall
exception will continue to operate successfully (see below).
2. RLM Communication Port - Defaults to 5053. You can see this port in the title of the Status page in the RLM Web Administration site
(see the image under License Server Status above). It must be opened for both TCP/IP and UDP traffic.
3. Web Administration Server Port - 5054 - Must be open for TCP/IP traffic in order to be able to access the web administration page from
a machine other than the license server.

Note: It should not be necessary to modify the RLM Communication Port and Web Administration Port from 5053/5054 as both have been
assigned to Reprise Software by the Internet Assigned Numbers Authority (iana.org). However, it is possible to modify the RLM Communication
Port by adding the port number to the HOST line in the license file. See the "The License File" section of the RLM License Administration manual
for details.

Specifying ISV Communication Port

The ISV communication port changes every time the license server is restarted or reset (which happens every 24 hours). In order to keep this port
from changing (so firewall exceptions continue to operate) it should be specified in the ISV line of an SSI license on your license server.

1. Click the Edit License Files button on the left panel of the RLM Web Administration page.
2. In the License File To Edit drop-down select the license file received from SSI and click the Edit License File button.
3. Add the desired port to the end of the ISV line near the top of the file. For example, to set the port to 12345 the license file might look like:

9
 #---------------------------------------------------------------------
# SSI LICENSES
# Issuer: jasonr
# Issued: 19-Mar-2015
# Company: SSI
#---------------------------------------------------------------------
HOST VJR-76-CLEAN disksn=1SNASNDA2B6710
ISV ssi port=12345
...

A good way to determine a safe port is to use the one initially selected by RLM (seen in the Port column of the ISV Servers table on the
Status page of the RLM Web Administration site).
4. Click the Update License File button.
5. To verify that the change worked as desired restart the SSI License Server service:
a. Run services.msc from the Windows Start menu.
b. Locate the SSI License Server service and use the right-click > Restart menu option.
6. Back on the RLM Web Administration page refresh the browser and click the Status button. The ISV Servers table should now display
the desired port:

Diagnosing Licensing Problems

If no licenses are detected when ShipConstructor connects to a project then there are number of investigations that should be performed.

License Server Diagnostics

If the unavailable licenses are network licenses the first step is to ensure they are being detected by the SSI License Server.

Check License Server Status via RLM Web Administration Page

On the license server machine (to avoid firewall issues) open up the RLM Web Administration page: http://localhost:5054/ and click the Status but
ton at the top of the left panel:

10
 The license file you received from SSI should be displayed in the license files row of the top table.
The SSI server should be displaying Yes in the Running column of the ISV Servers table.

1. If the RLM Web Administration page is not available then ensure that the Windows Services (services.msc) contains a service named SSI
License Server. Start it if it is not running. If the service doesn't exist then it may be necessary to do a repair installation of the SSI
Licensing component (see Install ShipConstructor Client, Server, or Standalone in the Installation Guide for details).
2. If no license file is displayed then it may be necessary to install the license file received from SSI (see the Installing or Updating SSI
Licenses section of this manual).
a. If the license file does not display after doing so it may be necessary to perform a Reread/Restart of the server (using the Rerea
d/Restart button on the left panel of the RLM Web Administration page).
b. Restarting the SSI License Server Windows service will also ensure that everything is restarted.
3. If the Running column in the ISV Servers page is displaying No then it may be that either:
a. The server is a Virtual Machine but the license file received from SSI is not VM enabled. Contact SSI to ensure that the file you
received is VM enabled.
b. The host id of the license file does not match that of the machine. Have any changes to the machine happened since the SSI
License HostID utility was used to generate a token file (which was used in turn to encode your license file)?
Note: In both cases, the Diagnostics button in the left pane should be used and the resulting file sent to SSI (see below for details).

Check Server Licenses Are Displayed

If the Status of the license server appears correct and the correct license file is listed, the next thing to determine is if the licenses are detected.

On the Status page of the RLM Web Administration page, click the SSI button in the Server Status column if the ISV Servers table:

11
 1. Ensure that the expected licenses are visible.
a. If licenses are missing it may be that the license file does not match the server machine. Use the Diagnostics button on the left
panel of the RLM Web Administration page and send the resulting file to SSI (see below).

Running License Server Diagnostics

If the above steps have been performed and licenses are not being detected then it is probably necessary to contact SSI support for help. Before
doing so, you should generate a complete diagnostic file which SSI can use to determine the problem.

1. (Optional) Enable the SSI Report Log, which will give more detailed information about your SSI License Server (see the ISV (SSI)
Options section above for details).
a. Click the SSI button in the Options column of the ISV Server table on the main Status page of the RLM Web Administration
page.
b. Uncomment the following two lines by removing the '#' from the front of them:

REPORTLOG "+C:\Program Files\SSI\LicenseServer\Logs\ssireportlog.log" detailed

ROTATE weekly

c. Click Update Options and restart the SSI License Server service in Windows Services (services.msc in the start menu).
2. Click the Diagnostics button in the left panel of the RLM Web Administration page.
3. Specify an output location (or accept the default of C:\Program Files\SSI\LicenseServer\rlmdiag.txt).

4. Click the Run Diagnostics button. Remember the result will be generated on the server machine.

Check Communication Settings

If all licenses are displayed correctly on the RLM Web Administration page when it is run from the server machine, the next step is to ensure the
communications are operating correctly.

1. Run the RLM Web Administration web page from the client machine (i.e. the same machine you wish to run ShipConstructor on) and
check that the Status and licenses are displayed correctly (as above).

a.

12
 1.

a. If the RLM Web Administration page is unavailable it is a good indication that your network's firewall settings are interfering with
the communication.
2. If you have internal firewalls in your network see the Licensing & Firewalls section of this manual.
3. Ensure that the server address and RLM communication port on the License Server (Status page of the RLM Web Administration page)
match those in ShipConstructor (Server Configuration window, via the Server button on the main Licensing window):

Client Side Licensing Diagnostics

If the SSI License Server appears to be correctly configured and the communication settings between the client and server are correct and
unimpeded by any firewalls, or if all the licenses are standalone (i.e. don't involve a server at all), then it is time to move analysis to the client
machine.

ShipConstructor Client License Logs

ShipConstructor creates a log for all license related activity inside ShipConstructor. The location of these logs is in the
C:\Users\<username>\AppData\Roaming\SSI\Licensing directory. (Tip: use %appdata% which Windows automatically resolves as
C:\Users\<username>\AppData\Roaming).

To increase the verboseness of the information in the log files, modify the log.config file (in the same directory) by setting Verbosity=3 (the default
value is 2). Possible values are:

0 - Report all errors

1 - Report all errors and warnings
2 - Report all errors, warnings and notifications (e.g. acquiring/releasing of licenses).
3 - Report everything, including debugging messages.

Enable RLM Client Logging

ShipConstructor contains a command that enables RLM to create a diagnostic log file when the licensing system is initialized in the
ShipConstructor client.

1. Open ShipConstructor and run SCLICENSEDIAGNOSTIC (does not require connection to a project).
2. Specify a location for the log to be generated (e.g. %appdata%\SSI\Licensing\sclicensediag.txt)
3. Restart ShipConstructor.

This file contains:

The version of the RLM licensing system

The ISV name (SSI), host, user and working directory of the application.
A listing of any license files detected on the system. For example:

License files:
C:\ProgramData\SSI\Licenses\FloatingClient.lic
C:\ProgramData\SSI\Licenses\VJR-76-A345_2014-12-10.lic

13
 A reference to which servers (if any) are being interrogated for licenses. For example:

In license file C:\ProgramData\SSI\Licenses\FloatingClient.lic

(server at: 0@VJR-76-CLEAN)

Note: FloatingClient.lic and any similar files (e.g. FloatingClient2.lic) inform the licensing system which license servers to query for
licenses.
A listing of any licenses contained in the local standalone license files. For example:

In license file C:\ProgramData\SSI\Licenses\VJR-76-A345_2014-12-10.lic

(server at: 0@VJR-76-A345)

rlm_roam v1.0 OK
entplatclient_2 v2015.213 OK
suite-ult_2_ws v2015.213 OK

4. SSI LICENSE CLIENTS

In order to perform any commands inside ShipConstructor an appropriate license for that command must be acquired. For example a structure
command like SCCREATEPLATE requires a structure license or a suite license. Other commands which are shared between products might
require one of a number of licenses, like the 3D Viewpoint ShipConstructor utility which requires a Structure, Pipe, HVAC, Electrical or Hull
license. Additionally, in order to create or modify drawings of a particular type (for example Structure or Pipe drawings) a license for that product
must be acquired.

Licensing Window
Licensing inside ShipConstructor is largely controlled by the Licensing window.

This window is displayed after connection to a project, or may be displayed at any time via the SCLICENSE ShipConstructor command which can
be found on the Manage tab of the ShipConstructor ribbon.

To acquire a license simply check the Acquired box for the desired product. Any licenses that are acquired in the licensing window will remain
checked out until ShipConstructor is shut down or the licenses are released again by unchecking the box. In addition, any selections that are

14
made in the license window will be automatically restored next time ShipConstructor is started or connected to a new project.

Standard Columns
Acquired - Checking the box will acquire the license. Unchecking it releases it for use by other users.
License - Displays the full product description of the license (including the product name, year, whether it is a WorkShare license and if it
is network or standalone).
Available Licenses - How many instances of the license are currently available.
Server - Displays the server a license was acquired from. The server can only be displayed for licenses that are currently acquired.
Additional Information - If a license may not be acquired the reason will be displayed here. For example:
Insufficient Edition - The part count of the current project exceeds that supported by the products edition.
WorkShare Required - The project is WorkShare enabled, so only licenses with the WorkShare option are acquirable.
Expired Subscription - If the license version exceeds the ShipConstructor version (e.g. a ShipConstructor 2016 license in use in
ShipConstructor 2015) then licenses may only be used as long as they have a valid subscription.
Insufficient Permissions - The current ShipConstructor user has been denied permissions to acquire the product (in Manager >
General > User Permissions > Product Licensing).
Hovering over the Additional Information column will also provide a tooltip with detailed information on the license:

Note: Standalone licenses are acquired automatically (they cannot be used by any other machines, so there is no need to release them).

Show on startup
With this option checked, every time ShipConstructor connects to a new project the Licensing window is displayed. If a user's needs are fairly
consistent then there may be no need to change the selected licenses every time ShipConstructor starts. In this case unchecking the Show on
startup will cause ShipConstructor to automatically acquire the licenses that were selected the last time the Licensing window was displayed. For
example, if a user works predominantly with the Pipe product, then the Licensing window can be used to acquire a Pipe license. After unchecking
the Show on startup option, each time ShipConstructor connects to a new project the Pipe license is acquired without displaying the Licensing
window. Subsequently, if the user needed to use a Structure license, the Licensing window would be opened and a Structure license checked
out. If the Pipe license was not unchecked then ShipConstructor would automatically acquire both the Structure and the Pipe license next time it
was started.

Project Type
The bottom left of the Licensing window displays the project type. This includes whether the project is WorkShare enabled or EnterprisePlatform
enabled. Possible values are:

ShipConstructor (i.e. just a standard project with neither WorkShare or EnterprisePlatform)

WorkShare
EnterprisePlatform
WorkShare & Enterprise Platform

Server Configuration
If no network licenses appear in the Licensing window it is likely the server needs to be specified. To do this use the Server button to open the Se
rver Configuration window.

Server - Specify the network name of the license server machine.

Port - 5053 is the default port and should be left unchanged in almost all cases.

15
 Enable broadcast to locate server - If checked then ShipConstructor will perform a broadcast search and use the first license server it
finds.
Note: There is no guarantee that the detected license server will have any licenses if users have installed license servers that do not host
any licenses; this option should only be used if SSI License Servers are only installed on machines that actually host licenses.
Roam (Days) - Defines the number of days until a roamed license will expire after it is roamed. See the Roaming Licenses section below.

Customizing the Licensing Window

The Licensing window is very customizable and may be modified to your liking. Right-click on the header column of the Licensing window to
display the options context menu for the licensing window.

Additional Columns
Product / Year / Edition / Network / WorkShare - Components of the full product name.
Part Count - Part count of the license's product in the current project.
Max Parts - Maximum number of parts supported by the product's edition.
Total Licenses - Total number of licenses (including any that are currently in use).
Subscription Expiry - Expiry date of the subscription accompanying the product.
Roaming - This column allows "roaming" a license, which can temporarily make it available even if the license server is not available. (Se
e the Roaming Licenses section below).

16
Behavior
Columns may be hidden or displayed by selecting them in the options context menu.
Columns order may also be changed by dragging and dropping them in the header row.
Columns may be sorted by clicking on the column header (use the SHIFT+Click to sort by multiple columns).

Rows may be filtered by clicking on the icon in the column header.

It is possible to group the licenses by dragging a column header into the Group Panel (Show Group Panel in the options context menu).
For example you might group by Network to separate the Standalone and Network licenses into separate groups:

In this example the Network column has been hidden again after grouping. It is also possible to hide the group panel once grouping has
been established and the groups are maintained.

Licensing Log Panel

The Licensing window has an expandable panel where log messages are displayed. If any licensing errors occur while working with the licenses
they will be displayed in the log panel. Show or hide the panel using the up/down circle button near the bottom of the licensing window.

It is possible to customize the detail level of the logs in the log.config file. Use the Open Location button to open the location of this file. See Ship
Constructor Client License Log in the SSI License Administration section of this manual for details.

Roaming Licenses
ShipConstructor has the ability to allow network licenses to roam to a system that will be subsequently disconnected from the network. For
example, if the license was on a laptop that was going off-site, or if the local network was going down for maintenance the licenses would still be
usable by the machine that had roamed them. A roamed license can be used for the number of days specified in the Server Configuration window
, after which it will be automatically checked back in to the server. Alternately, the license may be returned to the license server early if so desired.
While a license is roamed to a machine, no other machines on the network will be able to use it.

To roam a license:
1. In the Server Configuration window specify the desired number of days to roam.

17
 A value of 0 will allow the license to roam for the rest of the current day, and a value of 1 will roam for today and tomorrow. A maximum of
30 days is possible, but it is recommended to use the minimum number of days possible.
2. Ensure the Roaming column is visible (by right-clicking on the header row of the Licensing window).
3. Check the Roaming box for the desired license.
4. All licenses will be refreshed and depending on the duration you've selected you may get prompted with a warning.

5. If roaming succeeded you will see a new license row in the list of licenses. It should be already marked as Acquired.

6. This roamed license will be available for use on the current machine even if it is disconnected from the license server the license
originated on.

To return the roamed license simply uncheck the Roaming box on the roamed license while connected to the server it originated from. Any
attempts to un-roam a license will fail if the server it came from is not available.

Licensing Permissions
It is possible to control access to individual product licenses via the Licensing permissions in Manager (see the User Permissions sections of the
Project Management manual for complete details on permissions in ShipConstructor). In addition there are a couple of other licensing permissions
that control licensing behavior. These permissions are set on an individual project basis.

18
Automatically acquire licenses - When this permission is enabled an appropriate license will be automatically acquired when a
command is run that requires a license the user does not currently have. Care should be taken when using this option, as once a license
is acquired it is not released until ShipConstructor is shut down or the license is manually released in the Licensing window.
If multiple products with the same properties (i.e. workshare, network, edition) satisfy the commands requirements it is arbitrary which
will be selected. Consider the following scenario:
1. A pipe modeler opens ShipConstructor and first runs the 3D Viewpoint command, SCVPOINT (which requires either a
Structure, Pipe, HVAC, Electrical or Hull license). A Hull license is arbitrarily acquired to fulfill the command requirements.
2. The pipe modeler continues by inserting a pipe, so a Pipe license is acquired. The modeler now has a Pipe and a Hull license
(though only a Pipe license is required any more).
3. The company's lofter starts ShipConstructor and tries to perform some Hull commands. He is unable to acquire the single Hull
license as it is already in use.
4. The RLM Web Administration page can be used to determine who is using the Hull license and it can either be forcibly removed
via this administration page, or the Pipe modeler can do so manually after being asked.
In cases like this it might be simpler to just disable the Automatically acquire licenses permissions and acquire licenses manually.
License Roaming - This permission controls whether or not the current ShipConstructor user is able to roam a license.

19
5. USING SSI SOFTWARE LICENSING WITH
SHIPCONSTRUCTOR 2014 AND EARLIER
Prior to ShipConstructor 2015, SSI used hardware based (USB dongle) licensing technology. This hardware licensing can be used side-by-side
with the new software licensing system SSI is current using. However, users may wish to upgrade their ShipConstructor 2014 (hardware) licenses
to the latest ShipConstructor version's software licensing system. In order to allow ShipConstructor users to continue using older versions of
ShipConstructor with their new software licenses, SSI has made a special licensing module (SSI Licensing Client Update) that can be used to
update ShipConstructor client installations that are from ShipConstructor 2014 R2 and earlier.

Important: There is one major caveat to using the SSI Licensing Client Update module. Once it is installed on a computer ShipConstructor will
no longer connect to any hardware based licenses (either standalone or network), regardless of ShipConstructor versions. For example, if you
install the SSI Licensing Client Update module to enable ShipConstructor 2014 to be able to access your software license server, then on this
machine ShipConstructor 2014 will only access software licensing; the same limitation will also apply to an installation of ShipConstructor 2012 or
any other ShipConstructor installation on the same machine.

It is, of course, possible to uninstall the SSI Licensing Client Update module and then re-install the original licensing system if necessary, (see R
estoring Hardware Licensing below).

Installing SSI Licensing Client Update

The installer for the SSI Licensing Client Update has been packaged in all ShipConstructor installers since ShipConstructor 2015 R2.1.
Alternately, contact an SSI representative to receive the installer for this module.

On any machine that wishes to use ShipConstructor 2014 R2 or earlier with software licenses:

1. Run the SSI_Licensing_Client_Update_x64.msi file located in the redist folder of the ShipConstructor installer.
2. Agree to any warnings or prompts that appear during the install:

Using ShipConstructor with the SSI Licensing Client Update

In order to use ShipConstructor after the SSI Licensing Client Update is installed it will be necessary to have access to software licenses (either
standalone or network).

Using Standalone Licenses

Provided the standalone licenses are installed correctly (see the Installing or Updating SSI Licenses section of this manual) ShipConstructor
should detect any standalone licenses without any modifications to the settings in ShipConstructor.

The Licensing Window will display the standalone licenses when connecting to a project or when the ShipConstructor Licensing command
(SCLICENSE) is run.

20
Using Network Licenses
In order to use network licenses it is required to direct ShipConstructor to a license server (or servers) serving valid licenses.

1. Connect to a project or open the Licensing window via the ShipConstructor Licensing command.
2. Click the Network button to open up the Network License Settings window.
3. Specify the network name of the server(s) to connect to, ensure the port is 5053.

4. The network licenses should now be displayed in the Licensing window.

21
Restoring Hardware Licensing
If it is necessary to use hardware (USB) based licensing on a machine that has the SSI Licensing Client Update installed then it is possible to
restore the original behavior.

1. Use the Add or remove programs feature of Windows to uninstall SSI Licensing Client Update.

2. Restart the computer.

3. In the msi folder of the original full ShipConstructor installer locate and run the SSI_Licensing_..._x64.msi (e.g.
SSI_Licensing_2014_R2_x64.msi).
4. Open ShipConstructor and connect to a project.
5. When licensing runs for the first time an error might appear (if you use a network license server).

Click OK to ignore this error.

6. Click the Network button and specify the location of your hardware-based license server AND reset the Port to 3960.

22
6. FREQUENTLY ASKED QUESTIONS

How do I install the license server during ShipConstructor install?

How do I add the license server to an existing ShipConstructor installation?
How do I process license file received from SSI Dealer?
How do I update from using only Standalone (nodelocked) licenses to using network licenses?
How do I update from using network licenses to Standalone (nodelocked) licenses?
How do I generate a host token for license generation?
Is it possible to have both standalone and networked licenses?
How do I specify multiple license servers inside ShipConstructor?
What is the process for purchasing new licenses or upgrade existing licenses?
What happens if my machine dies or I upgraded to a new machine?
If I have a standalone license, do I still require an SSI License Server?
Do I need a WorkShare license when copying/restoring from a previous WorkShare project?
How do I monitor license usage?

How do I install the license server during ShipConstructor install?

The license server is part of the ShipConstructor install via the server tools component.

The license server can also be installed by the SSI License Server msi that is in the msi sub-folder of the installer (e.g.
SSI_License_Server_2016_R1_x64.msi).

How do I add the license server to an existing ShipConstructor installation?

Run the ShipConstructor install and select the server tools option, or run the SSI License Server msi in the msi sub-folder of the installer (e.g.
SSI_License_Server_2016_R1_x64.msi).

How do I process license file received from SSI Dealer?

Run the SSI License Update utility that is installed in both ShipConstructor client and ShipConstructor Server installations. This tool processes
the file and verifies that it is correctly encoded for use on the current machine.

How do I update from using only Standalone (nodelocked) licenses to using network licenses?
If a user currently has only standalone licenses (i.e. no license server), and subsequently purchases new networked licenses here is the process:

1. Determine a machine on which to run an SSI License Server (it is recommended to be on a machine that does not run a ShipConstructor
Client, though this is not required).
2. Use the ShipConstructor installer to install the License Server, via the Server Tools options (or the SSI License Server msi in the msi
sub-folder of the installer)
3. Run the SSI License HostID tool which is included in the License Server installation (or at http://www.ssi-corporate.com/downloads/SSILi
censeHostID.zip). This will prompt for a location to save host token file, which should be emailed to an SSI Dealer.
4. After receiving a license file from the SSI dealer, use the SSI License Update utility on the server machine to process the new licenses.
5. On the server machine, open http://localhost:5054 and click the Status button. Ensure the new license file is visible in the license files ro
w of the top table.
a. If no license file is displayed, try using the Reread/Restart Servers button in the left panel to refresh the license server.
6. Click on the ssi button in the Server Status column of the ISV servers table, and ensure that the expected network licenses appear in
the License pool status table.
a. If either this step, or the previous step fails, see Diagnosing Licensing Problems in the SSI License Administration section of this
manual.
7. Run the ShipConstructor client on another machine. After connecting to a project the Licensing window should appear.
8. Click the Server button and specify the name of the license server machine in the License Server box.
9. Click OK in the Server Configuration window and ensure that the network licenses appear in the Licensing window when it refreshes.

How do I update from using network licenses to Standalone (nodelocked) licenses?

If a user currently only has network licenses and wishes to switch to standalone licenses this is the process:

1. Run the SSI License HostID tool (included in the ShipConstructor client or server install, or at http://www.ssi-corporate.com/downloads/S
SILicenseHostID.zip) on the machine the ShipConstructor client is running on.
2. Send the host token file to SSI (via a dealer or representative), who returns a license file with the purchased standalone licenses.
3. Run the SSI License Update included in the ShipConstructor client install which will process the new license file to make the licenses

23
 3.

available to ShipConstructor.
4. The next time ShipConstructor is run the new license will be detected.
5. Any network licenses that are still on the server that was previously may still be available. To disable this:
a. In the ShipConstructor Licensing window, click the Server button, and delete the server listed.
b. In the same window ensure that the Enable broadcast to locate server check box (so that the client does not look for existing
license servers).

How do I generate a host token for license generation?

The SSI License HostID tool will be installed by both a ShipConstructor Client and a ShipConstructor License Server install. It can also be
downloaded directly from http://www.ssi-corporate.com/downloads/SSILicenseHostID.zip. It generates the token that is required by SSI in order to
generate licenses.

1. Run the SSI License HostID tool.

2. In the window that appears, specify an output file/folder location (default file name is ssihostid_LOCALMACHINENAME.tok).
3. Send the generated file to an SSI representative.

Is it possible to have both standalone and networked licenses?

A user may have both standalone and network licenses, however SSI does not support hosting standalone and network licenses on the same
host machine.

Standalone licenses are noted in the Server column in the licensing window, these can only be used on the machine the licenses reside on.
Server licenses will display a blank Server column until the license is acquired, after which the server name is displayed.

If a user wishes to only obtain standalone licenses on a particular client:

Open the Server dialog from the ShipConstructor Licensing window, clear the server name and uncheck the Enable broadcast to locate
server checkbox.

If a user wishes to obtain licenses from both the standalone client and the network server

Set up the SSI License Server with network licenses.

Ensure standalone licenses are correctly installed on the client machine.
On the client computer, specify the server in the Server Configuration window accessible by clicking the Server button in the main
Licensing window.

How do I specify multiple license servers inside ShipConstructor?

Similarly to having both standalone and network licenses, it is possible to have multiple SSI License Servers that are accessible either
simultaneously or individually.

ShipConstructor’s licensing uses a “.lic” file to specify a license server. By default there is only one. For a user to access multiple license servers
additional .lic files need to be created for each license server you want to connect to.

To use licenses from multiple servers simultaneously:

1. Navigate to C:\ProgramData\SSI\Licenses and copy the FloatingClient.lic to another file name or names (e.g. FloatingClient2.lic,
FloatingClient3.lic). FloatingClient.lic is where ShipConstructor records the server it is connecting to (i.e. it will be updated by
ShipConstructor when the server is modified in the Server Configuration window.
2. For each additional server to connect to modify one of the new FloatingClient files to contain a line like this: HOST MY_SERVER_NAME
5053. They should also contain a line ISV ssi at the top. For example:

ISV ssi
HOST MYSERVER 5053

3. Restart ShipConstructor and connect to a project. Licenses from all the servers should now be displayed in the licensing window.

What is the process for purchasing new licenses or upgrade existing licenses?
1. Contact your Dealer and purchase either upgraded or new licenses.
2. If you not are maintaining the same machine as the License Server host (or client for standalone licenses), you will also need to send a
new Licensing Host token (generated by the SSI License HostID utility).
3. Your Dealer will send a new file containing the upgraded licenses (and also any of the older licenses that were perpetual but not
upgraded).
4. Run the SSI License Update utility from your License Server or ShipConstructor installation and choose the new license file.
5. The new license file will supersede any pre-existing license files, and allow the new SSI products to run. In addition, prior SSI versions
will continue to work as long as the subscription on the new licenses is current (along with other subscription based functionality, i.e.
Advantage Pack).

24
What happens if my machine dies or I upgraded to a new machine?
Since the licenses are tied to your machine, your previous licenses will not work on your new machine. You will be required to contact your SSI
representative to obtain new licenses.

If I have a standalone license, do I still require an SSI License Server?

No you do not need a license server. The SSI License Server is only required for network licenses.

Do I need a WorkShare license when copying/restoring from a previous WorkShare project?

If the source project is a WorkShare project, any projects that are copied/restored from it will also be WorkShare enabled and will require using a
WorkShare enabled license.

How do I monitor license usage?

The license server provide a web portal to view all the licenses and who holds them.

1. Start your web browser.

2. Enter the address: http://licenseservername:5054 where licenseservername is the name of the computer that contains the licenses.
Tip: If on the server machine http://localhost:5054 may be used.

It is also possible to generate report logs for license usage as well. See the RLM License Administration manual for details.

25