Enterprise Architect
User Guide Series

License Management
Managing licenses in Sparx Systems Enterprise Architect? Register each installation ofEnterprise Architect or an Add-In on the Licence Management dialog. A named user has a
Private License, or groups share Floating Licenses from a central key store.

Author: Sparx Systems
Date: 5/09/2018
Version: 1.0

CREATED WITH

Table of Contents
License Management
Finding Your License Information
Adding License Keys
Keystore Troubleshooting
Upgrade an Existing License
Register Add-In
Add an Add-In Key

3
5
6
8
9
11
12

User Guide - License Management

5 September, 2018

License Management

Each purchased version of Enterprise Architect requires a license, and tools to manage the licenses are available for the
product. There are two types of license available - Private Licenses, which are allocated to a named user, and Shared
Licenses, which essentially provide a pool of floating licenses. After a purchased copy of Enterprise Architect has been
installed, you will be required to enter either the license key provided at the time of purchase or a temporary shared key
obtained from a central Keystore.
Enterprise Architect provides a licence management dialog through which you enter, view and maintain licence
information, including upgrading the version of Enterprise Architect and registering Add-Ins.

AccessRibbonStart > Help > Help > Register and Manage Your License Key(s)Start > Help > Register

License Management options
OptionActionKeyThis column lists the registration keys that you are currently using.
If the entry is an alphanumeric code, that is your private key that has been issued toyou permanently. You register this key the first time you use the Sparx Systems
product, using the Add Key button.
If the entry is 'Shared Key', it indicates that you have temporarily been allocated ashared or 'floating' key from the key store. When you log on to Enterprise Architect,a key is automatically issued to you (if one is available) from the key store. Whenyou have finished your work session, the key will be returned to the key store forissue to another user. (Note that the Key Store might not have been configured to
manage keys automatically, in which case you manually obtain a key when you
open Enterprise Architect and, if you prefer, manually release the key before the'lease' expiry - see Add Key and Release Key.)

Lease Expires

This column indicates when the 'lease' on the registration key you are using expires.
For a private key the value is 'Never', because the key has been permanently
assigned to you and there is no 'leasing' involved.
For a shared key, the value is generally the day after the key was automaticallyissued to you at the start of a work session, but the Key Store Manager can set a
different expiry period. In practice, the key is usually returned earlier to the
keystore when you log out of the current work session.

Product(c) Sparx Systems 2018

This column identifies the Sparx Systems product that the registered key gives you

Page 3 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018
access to.

Add Key

Remove Key
Release Key

Display the 'Add Registration Key' dialog, which you can use to:·Register your new Enterprise Architect license key·

Manually obtain a shared key from the Sparx Systems Key Store (available forversion 4.51 and above); however, the Keystore Manager is normallyconfigured to assign keys - if available - automatically when you log off·

Add a new key to update to a higher version of Enterprise Architect or toregister an Add-In(For a Private Key) Make the Add-In or current version of Enterprise Architect
inoperable, such as when you are upgrading to a more complex edition ofEnterprise Architect.
(For a Shared Key) Release the key to the keystore; however, the Keystore
Manager is normally configured to release keys automatically when you log off.

Copy button

Place the highlighted key into the clipboard.

Close button

Close the dialog.

Help button

Display this Help topic.

(c) Sparx Systems 2018

Page 4 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Finding Your License Information
You can find information on your Enterprise Architect license in the 'About Enterprise Architect' dialog, which shows:·

The program version and build·

Your Registration Key·

The edition of Enterprise Architect you are registered to use·Your licensed user ID on the system

AccessRibbon(c) Sparx Systems 2018

Start > Help > Help > About EA

Page 5 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Adding License Keys
Two types of license key can be used in conjunction with Enterprise Architect: Private and Shared.

Private Keys
Private keys allow you to register, indefinitely, on the machine and user account that you are currently using:·

An Enterprise Architect license for the edition of Enterprise Architect you have purchased, or·

An Add-In product license

Shared Keys
Shared keys are obtained from a central shared key store, to give you temporary access to the installed 'suite' edition ofEnterprise Architect. They are available with the purchase of a floating license, and require Enterprise Architect version
4.51 or higher.
Shared Keys require a shared license key store to be configured by your license administrator; the key store can be either
file-based or network based (preferred). Only the Key Administrator is required to install the Sparx Enterprise Key Storeapplication; end users simply connect to the configured key file - advised by the administrator - as described here. No
additional software is required to be installed.

AccessRibbonStart > Help > Help > Register and Manage Your License Key(s) > LicenseManagement : Add Key > Add Registration Key
Start > Help > Register > License Management : Add Key > Add Registration Key

Add a Private Key
Step

Action1

Click on the 'Enter Private Key' tab.

2

In the 'Name' and 'Company' fields, type your user name and company name.

3

In the 'Copy registration key into space below...' field, copy the registration key (including any
parentheses around the key).

4

Click on the OK button to confirm the key selection.

Add a Shared Key(c) Sparx Systems 2018

Page 6 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Step

Action1

Click on the 'Get Shared Key' tab.

2

In the 'Name' and 'Company' fields, type your user name and company name.

3

In the 'Shared Keystore' field, click on the

button.

The 'Shared Keystore Selection' dialog displays.
4

If your keystore is file-based:·

Select the 'File Based Keystore' radio button·

Click on the Browse button, and·Locate and select the keystore file

Go to step 6.
5

If the keystore is network-based:

6

1.

Click on the 'Sparx Keystore Server' radio button.

2.

Select either 'ssks' or 'HTTPS' as the Protocol.

3.

In the 'Server' field, type the server address of the keystore.

4.

In the 'Port' field, type the server port of the keystore.

5.

If necessary type in the Username and Password (advised by your administrator), and/or click on the
Test button to check that you have a connection to the keystore.

Click on the OK button to return to the 'Get Shared Key' tab.
This now shows the name of the keystore in the 'Shared Keystore' field.

7

In the 'Select a Product' field, click on the appropriate product name.

8

Click on the OK button.
The 'License Management' dialog redisplays, indicating that the shared key is registered for the selected
product until the key expiry date.

9

Click on the Close button.

Notes
·

Some license keys can override and remove others:- The key for a more advanced edition of Enterprise Architect replaces the key for a simpler edition- The key for MDG Integration for Visual Studio replaces the key for MDG Link for Visual Studio- Shared keys and Private keys have different formats and cannot be used interchangeably(c) Sparx Systems 2018

Page 7 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Keystore Troubleshooting
The management of shared keys can be an onerous task, so Enterprise Architect provides the Keystore and its
management interface to make the administration as easy as possible. Occasionally issues arise that prevent users fromobtaining a license; these are typically due to the setup of the keystore and can be easily rectified.

Error Messages and Handling
Message Displayed:

Explanation

Error reading Key Store
file:

All users who are to use the shared key facility require Read, Write and Modify
access to the sskeys.dat file containing the shared keys.

(Access is denied)Please verify that all required users have sufficient permissions to the file and try
again.
Review the effective permissions calculated at the location of the key file for theuser account reporting the problem - you should closely examine the permissions
for both the Network Share and the File System; it is possible that these
permissions have been overwritten at some point.
If the problem continues, contact Sparx Support.

Error reading Key Store
file:(Key File has been moved)

In the key store, as a security measure the hard drive serial number is recorded
when the file is created; the file then cannot be moved from the original location inwhich it was created.
If the key store has to be re-located for any reason, the administrator should
re-create the key store in the new location using the original license keys.
This issue is commonly seen after a file server has undergone a hardware upgradein which the physical hard drives have been replaced; problems could also occur if
the drive used is part of a RAID configuration.
The message can also appear where the key store exists on a Novell-based filesystem - when creating the key store, the administrator is prompted to confirm thatthe key store is to be located on a Novell Netware file server; if they click on theYes button, the key store instead records the logical path used to create it, and allusers must connect to the key store using this same path.
The recorded path is case-sensitive and must be an exact match.

(c) Sparx Systems 2018

Page 8 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Upgrade an Existing License
As you work with Enterprise Architect you might become aware of additional features contained in other editions, which
you could use on your projects. Fortunately, it is easy to upgrade the edition you are using to a more powerful or specificedition. For example, you might have been working alone creating a private model using the Professional edition, andthen at some point the project expands and a team of people need to contribute to and update the models, and the ProjectManager decides to use security to encourage collaboration between the users. This would require an upgrade to the
Corporate version, which contains the role-based security features.
It is a cost effective and easy procedure to upgrade to another edition, but a new license key must be added to the productto make the upgrade effective. This should not be confused with license renewal, which is an extension of the license forthe same edition of Enterprise Architect and does not require a new key to be entered.
There are four editions of Enterprise Architect; from simplest to most powerful, these are:·Professional·

Corporate·

Unified·Ultimate

The Enterprise Architect installer provides the facilities of every edition; your registration key gives you access to thefacilities of the edition you have purchased.
If you have purchased a less powerful edition, such as Professional, you can subsequently upgrade your license to a more
powerful edition by purchasing a special upgrade key from Sparx Systems. Once you have received this key, use theprocedure described here to gain access to the additional features.
This procedure is mainly applicable to users with private keys; if you are an end-user with a shared key, you would
simply be allocated the relevant key next time you requested one. If, however, you want to upgrade while using a shared
key on a long lease, you would simply click on the Release Key button and then the Add Key button on the 'LicenseManagement' dialog.

AccessRibbonStart > Help > Help > Register and Manage Your License Key(s) > LicenseManagement : Add Key
Start > Help > Register > License Management : Add Key

Upgrade from one license edition to another
Step

Action1

Make sure you have a valid upgrade key purchased from Sparx Systems; you typically receive this in an
email or PDF format.

2

On the 'Add Registration Key' dialog, in the 'Name' and 'Company' fields, type your name and company
name.

3

Copy the key you received for the upgraded edition of Enterprise Architect - including the { and } bracket
characters - from the email.

(c) Sparx Systems 2018

Page 9 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 20184

Paste the key into the 'Copy registration key' field.

5

Click on the OK button.
Enterprise Architect displays the message:
Registration succeeded – Thank you for purchasing Enterprise Architect xxxx Edition

6

Click on the OK button, and then on the Close button to continue working in Enterprise Architect.

7

Select the 'Start > Help > Help > About EA' menu option.
Copy the registration key shown and store it somewhere safe; this is a key to the full license of the edition
you have upgraded to.
If you ever have to reinstall Enterprise Architect, you can register it with this key, so you will not have togo through the upgrade process again.

Notes
·

The Lite edition and the Trial version cannot be registered or upgraded; if you have used either of these versions andthen purchased Enterprise Architect, you must download the registered version from:sparxsystems.com/securedownloads/easetupfull.msi
Then you can enter your registration key(c) Sparx Systems 2018

Page 10 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Register Add-In
Apart from registering Enterprise Architect, you must also register any Add-Ins you purchase to use with the application.
You can register either a private key as explained here, or a shared Add-In key as explained in the Add An Add-In Key
topic.

AccessRibbonStart > Help > Help > Register and Manage Your License Key(s)Start > Help > Register

Register Add-Ins for Enterprise Architect
Step

Action1

Purchase one or more licenses for the Add-In from your Add-In provider.
Once you have paid for a licensed version of the Add-In, you receive (via email or other suitable means) alicense key for the product.

2

Save the license key and the latest full version of the Add-In.

3

Run the Add-In's setup program to install the Add-In.

4

In Enterprise Architect, select 'Start > Help > Register'.
The 'License Management' dialog displays.

5

Click on the Add Key button.
The 'Add Registration Key' dialog displays, showing the 'Enter Private Key' tab.

6

Type or copy-and-paste in the key you received with the Add-In, including the { and } characters.

7

Click on the OK button.

8

When the Add-In has been added successfully, close down Enterprise Architect and restart it to apply the
integration changes imposed by the Add-In.

(c) Sparx Systems 2018

Page 11 of 13

Created with Enterprise Architect

User Guide - License Management

5 September, 2018

Add an Add-In Key
When your organization is using a keystore to distribute keys you can retrieve a key for a third party Add-In in the same
way as you would for a key for any Sparx Systems product.

AccessRibbonStart > Help > Help > Register and Manage Your License Key(s) > Licence
Management : Add Key > Get Shared Key
Start > Help > Register > Licence Management : Add Key > Get Shared Key

Add a shared Add-In key
Step

Action1

In the 'Name' and 'Company' fields, type your user name and company name.

2

In the 'Shared Keystore' field, click on the

button.

The 'Shared Keystore Selection' dialog displays.
3

Click on the 'Sparx Keystore Server' radio button, and in the 'Server Address' field type the server addressof the keystore.

4

If necessary, in the 'Password' field type the password (advised by your administrator) and/or click on the
Test button to check the connection to the keystore.

5

Click on the OK button to return to the 'Get Shared Keystore' tab, which now shows the name of the
keystore in the 'Shared Keystore' field.

6

In the 'Select a Product' field, look for the appropriate product name and click on it.

7

Click on the OK button.
The 'License Management' dialog redisplays with the shared Add-In key in the 'Currently Registered
Keys' list.

8

Click on the Close button.

Notes
·

Shared Add-In keys require Enterprise Architect version 11 or higher(c) Sparx Systems 2018

Page 12 of 13

Created with Enterprise Architect

User Guide - License Management(c) Sparx Systems 2018

5 September, 2018

Page 13 of 13

Created with Enterprise Architect