LicenseServerGuide-VC2.1.2
LicenseServerGuide-VC2.1.2
Version 2.1.2
Contents
Introduction ...................................................................................................................................... 4
Installation & Setup........................................................................................................................... 4
Requirements ................................................................................................................................ 4
Installation Notes .......................................................................................................................... 5
Security.......................................................................................................................................... 5
Portal Accounts ............................................................................................................................. 6
Installation Instructions ................................................................................................................. 6
User Interface ................................................................................................................................... 7
Product Keys .................................................................................................................................. 8
Commands ................................................................................................................................................ 8
Columns .................................................................................................................................................... 9
Products ...................................................................................................................................... 10
Commands .............................................................................................................................................. 10
Columns .................................................................................................................................................. 11
Clients.......................................................................................................................................... 12
Commands .............................................................................................................................................. 12
Columns .................................................................................................................................................. 13
Groups ......................................................................................................................................... 14
Commands .............................................................................................................................................. 14
Columns .................................................................................................................................................. 15
Product Keys ................................................................................................................................... 16
Sharing ........................................................................................................................................ 16
Borrowing .................................................................................................................................... 17
Add a Product Key ........................................................................................................................... 17
Remove a Product Key .................................................................................................................... 18
Activate a Product Key .................................................................................................................... 19
Online Automatic Activation ....................................................................................................... 19
Offline Manual Activation............................................................................................................ 19
Deactivate a Product Key ................................................................................................................ 20
Online Automatic Deactivation ................................................................................................... 20
Offline Manual Deactivation........................................................................................................ 21
Renew a Product Key ...................................................................................................................... 22
Online Automatic Renewal .......................................................................................................... 22
Support
[email protected]
Forum | PAGE 2 OF 34 |
Forum.visualcomponents.com
Support
[email protected]
Forum | PAGE 3 OF 34 |
Forum.visualcomponents.com
Introduction
The Visual Components License Server can be used to manage licenses on a network for users of
all Visual Components products and compatible OEM products.
Requirements
Before you install the license server, verify that you have local administrator rights to install the
license server on a computer. Your computer must be using one of the following operating
systems:
Support
[email protected]
Forum | PAGE 4 OF 34 |
Forum.visualcomponents.com
Installation Notes
• To run the license server on your computer, during installation some dependency files and
runtime libraries may be installed. If your computer has no Internet connection, the
"Dependencies" folder included in the application download package must be included in
the same folder as the license server installer.
• If your computer is using an older version of the license server, the installer can uninstall
that version and transfer its product keys to the new server.
• If an activated product key is transferred from license server v1 to v2, the key is first
deactivated and then reactivated on your computer.
• During installation, if the license server is unable to connect to the global Visual
Components license server note the following steps:
1. The installer will prompt you to manually upgrade product keys by generating an
upgrade request file.
2. You then need to use your product user account to upload the request file and
manually generate a license file. Refer to the Offline Manual Activation section.
3. Finally, after completing installation you can run the license server and then use the
Open license file command to upload the license file for upgrading transferred
product keys.
• After a product key has been activated on a computer using a newer version of the license
server, that computer can no longer use an older version of the license server.
Security
Online product key activation and deactivation synchronization uses HTTPS encrypted
communication to contact a global Visual Components license server.
For Visual Components 2014 or older product keys:
• https://portal.visualcomponents.net
For Visual Components 4.0 or higher product keys:
• https://license.visualcomponents.net
In some cases, your license server might communicate with both global servers directly, or they
communicate with one another to accommodate the request from your local server.
IMPORTANT! If online functionality is to be used, corporate firewalls and web proxies should not
block nor prevent the connection your license server has to the global Visual Components license
server(s).
Support
[email protected]
Forum | PAGE 5 OF 34 |
Forum.visualcomponents.com
Portal Accounts
In some cases, you might need to sign into your portal account to handle licensing issues. For
example, you might need to manually deactivate or activate product keys and upgrade licenses to
work on a new license server.
For Visual Components 2014 or older product versions, go to:
• https://portal.visualcomponents.net
For Visual Components 4.0 or higher product versions, go to:
• https://license.visualcomponents.net
Installation Instructions
1. Download the installer for the license server from visualcomponents.com/downloads/.
2. Run the installer, and then follow the steps offered by the Wizard to complete installation.
3. After completing installation, run the Visual Components License Server Manager.
Support
[email protected]
Forum | PAGE 6 OF 34 |
Forum.visualcomponents.com
User Interface
The workspace of the license server contains different views for managing licenses.
Ribbon. Commonly used commands.
Status Bar. Indicates the status of a license server.
Tabs. Different contexts and views of a license server.
List View. View of a license server database.
Support
[email protected]
Forum | PAGE 7 OF 34 |
Forum.visualcomponents.com
Product Keys
The Product keys tab displays a view for handling keys.
Commands
• Start/Stop Local server Turns on/off the license server.
• Settings Displays the license server settings.
• Add Allows you to add a product key to server.
• Activate Activates a selected key.
• Deactivate Deactivates a selected key.
• Remove Removes a selected key from the server. You should not remove a key that has a
status of Activated. First, deactivate the key, and then remove it.
• Open license file Allows you to open a .dat file containing license information.
• View deactivation files Shows the Deactivations folder in File Explorer.
• Online/Offline Indicates if the license server is connected to the global Visual Components
license server.
• Synchronize Syncs the license server with the global Visual Components license server and
refreshes its database.
Support
[email protected]
Forum | PAGE 8 OF 34 |
Forum.visualcomponents.com
Columns
• Product key The product key.
• Product The name of product that can be used with a key.
• Type The type of key. Full is a complete license. Evaluation is a trial license.
• Status The status of a key. Not activated and Activation expired cannot be used by client.
Activated can be used by a client.
• Licenses The number of licenses (seats) associated with a key.
Note: The reference to Licenses and seats here relates to the number of allowed
simultaneous users of the product.
• Renewal The date of the next activation renewal date of a key.
• Expiration The expiration date of a key.
• Remarks Information on state of a key.
Support
[email protected]
Forum | PAGE 9 OF 34 |
Forum.visualcomponents.com
Products
The Products tab displays a view of product information including the amount of available licenses
and usage by clients.
Commands
• Start/Stop Local server Turns on/off the license server.
• Settings Displays the license server settings.
• Usage info Shows the usage of a selected product by clients including borrowed licenses
and their return dates.
• Open license file Allows you to open a .dat file containing license information.
• View deactivation files Shows the Deactivations folder in File Explorer.
• Online/Offline Indicates if a license server is connected to the global Visual Components
license server.
• Synchronize Syncs the license server with the global Visual Components license server and
refreshes its database.
Support
[email protected]
Forum | PAGE 10 OF 34 |
Forum.visualcomponents.com
Columns
• Product The name of a product that has one or more keys on the server.
• Total Licenses The total number of licenses for a product on the server.
• Network Used The number of licenses for a product being used by clients.
• Network Available The number of licenses for a product that can be used by clients.
• Commuter Used The number of licenses for a product that being borrowed by clients.
• Commuter Available The number of licenses for a product that can be borrowed by clients.
• Remarks Information on the state of a product and its usage.
Support
[email protected]
Forum | PAGE 11 OF 34 |
Forum.visualcomponents.com
Clients
The Clients tab displays a view about client computers of the license server.
Commands
• Start/Stop Local server Turns on/off the license server.
• Settings Displays the license server settings.
• Add Allows you to add a new client computer to a server. Generally, this is done before a
client connects to the server for the first time.
• Permissions Allows you to define the rights of a selected client to use licenses for products
supported by the server.
• Remove Removes a selected client from the server. You cannot remove a client that is
using a license, nor should you remove a client that is borrowing a license.
• Open license file Allows you to open a .dat file containing license information.
• View deactivation files Shows the Deactivations folder in File Explorer.
• Online/Offline Indicates if a license server is connected to the global Visual Components
license server.
• Synchronize Syncs the license server with the global Visual Components license server and
refreshes its database.
Support
[email protected]
Forum | PAGE 12 OF 34 |
Forum.visualcomponents.com
Columns
• Computer The name of a client computer.
• Computer ID The id of a client computer.
• Groups The groups that the client belongs to.
• Usage If client is using a license, indicates the product of that license.
• Commuted If a client borrows a license, it indicates the product of that license.
Support
[email protected]
Forum | PAGE 13 OF 34 |
Forum.visualcomponents.com
Groups
The Groups tab displays a view about client groups of the license server.
Commands
• Start/Stop Local server Turns on/off the license server.
• Settings Displays the license server settings.
• Add Allows you to add a new client group to server, set the clients into this group and
define the products that can be accessed by the clients in this group.
• Edit Allows you to edit the selected client group.
• Remove Removes a selected client group from the server.
• Open license file Allows you to open a .dat file containing license information.
• View deactivation files Shows the Deactivations folder in File Explorer.
• Online/Offline Indicates if a license server is connected to the global Visual Components
license server.
• Synchronize Syncs the license server with the global Visual Components license server and
refreshes its database.
Support
[email protected]
Forum | PAGE 14 OF 34 |
Forum.visualcomponents.com
Columns
• Group The name of a client group.
• Clients The number of clients in the group.
• Reserved The number of reserved seats (licenses) for the clients in the group.
• Used The number of seats (licenses) taken by clients.
• Remarks Information on state of a client group.
Support
[email protected]
Forum | PAGE 15 OF 34 |
Forum.visualcomponents.com
Product Keys
The license server supports both product and add-on keys.
• An add-on key allows you to use a plugin or additional services in a Visual Components
product.
In some cases, Visual Components or an OEM may license an add-on. In other cases, the concept
of licensing add-ons is resolved by upgrading a product key, thereby removing the need for having
an add-on key. In all cases, it depends on what product keys are managed by your server and the
products used by its clients.
A product key contains one or more floating licenses that can be shared online or borrowed by
users for offline use. A floating license is known as a seat, so a product key with 10 seats means
that up to 10 users can use that product key at a given time.
Note: The total amount of licenses (seats) is defined as part of the licence purchasing process.
LICENSE SERVER
Sharing
Sharing a license occurs when a user connects to a license server, and then uses an available
license with a Visual Components product. Once a user stops using a Visual Components product,
the license is reclaimed and becomes available for other users connected to the same license
server.
Support
[email protected]
Forum | PAGE 16 OF 34 |
Forum.visualcomponents.com
Borrowing
Borrowing a license (seat) occurs when a user connects to a license server and checks out an
available license from the server for a certain number of days to use offline with a Visual
Components product, and then disconnects from the server. The borrowed license remains
unavailable on the server until the user reconnects to the server, and then returns or checks in the
license. Borrowing a license is also known as commuting. If a client needs to know how to borrow
a license from the server, refer to the Network License section of the Visual Components User
Guide.
Note: A network license product key can have multiple licenses (seats) and borrowing only uses
one of those licenses.
2. In the Add product key dialog, Enter product key box, type or paste the 16-digit product
key you want to add to the server, and then click Add.
3. Verify the product key you added is listed in the license server.
Support
[email protected]
Forum | PAGE 17 OF 34 |
Forum.visualcomponents.com
2. On the Product keys tab, in the Product key group, click Remove.
Support
[email protected]
Forum | PAGE 18 OF 34 |
Forum.visualcomponents.com
2. In the Connection group, verify the license server is online and click Activate.
Note: If a selected product key is not activated, verify the product key has not expired and the
website for your portal account is not down or undergoing maintenance.
2. On the Product keys tab, click Activate, and then save the activation request file, but DO
NOT rename it.
3. Then open a web browser, and then go to the website associated with your product key
and portal account. Refer to the Portal Accounts section for the relevant links.
4. Log in to your portal account, and on the Welcome page or Ribbon of the website, click
Manual Licensing.
8. Then on your license server, in the Product keys tab, click Open license file, and open the
downloaded license file for your product key.
Support
[email protected]
Forum | PAGE 19 OF 34 |
Forum.visualcomponents.com
2. On the Product keys tab, in the Connection group, verify the license server is online and
click Deactivate.
Note: If a selected product key is not deactivated, verify the product key has not expired and the
website for your portal account is not currently down or undergoing maintenance.
Support
[email protected]
Forum | PAGE 20 OF 34 |
Forum.visualcomponents.com
2. On the Product keys tab, in the Product key group, click Deactivate, and then save the
deactivation request file but DO NOT rename it.
3. Then open a web browser and go to the website associated with your product key and
portal account. Refer to the Portal Accounts section for the relevant links.
4. Log in to your portal account, and then on the Welcome page or Ribbon of the website,
click Manual Licensing.
8. Then on your license server, click the Product keys tab, and then in the License files group,
click Open license file, and then open the downloaded deactivation permission file for your
product key.
9. On the Product keys tab, in the Product key group, click Deactivate, and then click Yes to
deactivate the product key locally and generate a deactivated license file and then save the
file.
10. Then open a web browser and go to the website associated with your product key and
portal account. Refer to the Portal Accounts section for the relevant links.
Support
[email protected]
Forum | PAGE 21 OF 34 |
Forum.visualcomponents.com
11. Log in to your portal account, and then on the Welcome page or Ribbon of the website,
click Manual Licensing.
12. On the Manual Licensing page, upload the deactivated license file.
13. Then click Confirm to unlock the license from the computer hosting the local license server.
2. In the License server settings dialog, Basic settings tab, Renewal field, select the
Automatically renew licenses online check box, and then click OK.
Support
[email protected]
Forum | PAGE 22 OF 34 |
Forum.visualcomponents.com
2. On the Product keys tab, click Renew, and then save the file but DO NOT rename it.
3. Then open a web browser and go to the website associated with your product key and
portal account. Refer to the Portal Accounts section for the relevant links.
4. Log in to your portal account, and then on the Welcome page or Ribbon of the website,
click Manual Licensing.
5. On the Manual Licensing page, upload the file generated from the local license server.
6. Click Confirm to generate a new license file from the portal account.
8. On your license server, click the Product keys tab, click Open license file, and then open
the downloaded license file for your product key.
3. In your text editor, find <visualcomponents.licensor.localserver.2.0> and then for its child
element <licenseServerSetting> add an autoRenewLicensePeriod attribute that is assigned
the number of days before a license expires in which the server should try to renew that
license.
<visualcomponents.licensor.localserver.2.0>
<licenseServerSettings
fileUpdateInterval="15"
defaultFeatureClientGrantLicense="true"
maximumCommuterLicensePercentage="-1"
licenseFilePath="C:\ProgramData\Visual Components\Visual Components
License Server 2.0\lservrc.dat"
Support
[email protected]
Forum | PAGE 23 OF 34 |
Forum.visualcomponents.com
autoRenewLicensePeriod="5" />
</visualcomponents.licensor.localserver.2.0>
4. Save any changes made to the file and restart your license server.
Support
[email protected]
Forum | PAGE 24 OF 34 |
Forum.visualcomponents.com
2. In the Add client computer dialog, set the Computer name and Permissions fields, and
then click OK.
3. If Grant licenses to client is not checked, all the client’s permissions are overridden to
block the access for the client.
Support
[email protected]
Forum | PAGE 25 OF 34 |
Forum.visualcomponents.com
4. Set the Permissions and Groups fields. If Grant licenses to client is not checked, all the
client’s permissions are overridden to block the access for the client.
5. Click OK.
6. Verify the permissions of the selected client are updated in the server.
Support
[email protected]
Forum | PAGE 26 OF 34 |
Forum.visualcomponents.com
Client Groups
Groups based access control
The license server allows you to manage access to available licenses on the server by client
grouping. To enable the group-based access management, the License server settings must have
the Access policy as Group based access control.
If Access policy is defined as Unrestricted access, all clients in the network could have access to
the licenses on the network license server, regardless of the settings defined by the grouping.
Support
[email protected]
Forum | PAGE 27 OF 34 |
Forum.visualcomponents.com
2. In the Add group dialog, set the Name for the client group.
4. Define the number of Reserved seats and Max limit of seats for each product.
5. Set the Clients by selecting computers from the Available list, and then move them to
Included list by clicking left arrow (<). You can move all clients with double left arrow (<<).
Support
[email protected]
Forum | PAGE 28 OF 34 |
Forum.visualcomponents.com
Edit a group
1. Do one of the following:
or
b. On the Groups tab, select a group. Then in the Group group, click Edit.
2. In the <GroupName> - Settings dialog, edit the Name of the client group.
4. Define number of Reserved seats and Max limit of seats for each product.
5. Add the Clients by selecting computers from the Available list, and then moving them to
Included list by clicking left arrow (<).
6. Remove clients by selecting computers from the Included list, and then move them to
Available list by clicking right arrow (>).
Remove a group
On the Groups tab, select a group and click Remove.
Support
[email protected]
Forum | PAGE 29 OF 34 |
Forum.visualcomponents.com
2. In the License server settings dialog, Basic settings tab, Commuter limit field, select the
Enabled check box, and then set the Percent of total to be the percentage of total amount
of licenses on the server that you want to make available for borrowing, and then click OK.
Support
[email protected]
Forum | PAGE 30 OF 34 |
Forum.visualcomponents.com
2. In the License server settings dialog, click the Email notification tab.
3. For Notifications, select the Send email for: check box, and then choose the type of event
that will trigger an email.
4. Complete the remaining fields, and then send and verify a test message, and then click OK.
Support
[email protected]
Forum | PAGE 31 OF 34 |
Forum.visualcomponents.com
Troubleshooting
The license server has some tools and workflows for troubleshooting issues.
Tracing
You can enable tracing to log the activity of the license server. The log file can then be used to
debug and diagnose errors.
1. On the ribbon, click Settings.
3. For Error tracing, select the Enable detailed trace logging check box, and then make any
needed changes to the file path of the log file, and then click OK.
Reloading
You can reload the server to use the most recent set of license codes obtained from the global
Visual Components license server as well as those added by you. Reloading does not contact the
global server, but it might help to reload license data.
1. On the Ribbon, in the Local server group, click Settings.
Support
[email protected]
Forum | PAGE 32 OF 34 |
Forum.visualcomponents.com
Common Cases
The following are recommended methods to handle potential issues with the license server.
Client cannot connect to the license server
1. Verify the client has the correct address of the license server.
2. Ensure there is no firewall or web proxy blocking the connection between the client and
the license server.
2. In the Products tab, verify the Network Available column shows an available license for
the client and product.
3. In the Product keys tab, verify that the status of the key is “Active”. If the status is “Not
activated”, select the key and click on the Activate button on the ribbon. If the status is
“Activation expired”, select the key and click on Renew.
2. Check if an error has occurred in the connection between the client and your server. If
found, consider restarting the license server and advise the client to restart their software
product.
3. Synchronize your license server with the global Visual Components license server(s).
Support
[email protected]
Forum | PAGE 33 OF 34 |
Forum.visualcomponents.com
4. If the issue persists, go to the website for the portal account (see Portal Accounts)
associated with the license to verify the state of its product key.
2. Verify the license has not expired or has past its due date.
Support
[email protected]
Forum | PAGE 34 OF 34 |
Forum.visualcomponents.com