Setting up License Manager on Windows

This topic includes the following sections:

 

License Manager is a set of utilities that controls the use of Synergy/DE products. On Windows, License Manager is a server, synd, which runs as the service synlm. Starting with Synergy/DE version 10, License Manager uses sockets (TCP/IP) to communicate. Previously, it used pipes. A version 10 license server can accept connections from version 10 license clients using sockets as well as from older clients that still use pipes. By default, License Manager runs on port 2380. See Network requirements (TCP/IP) for client/server products for more information about TCP/IP.

Note

License Manager can also be used to secure the applications that you create with Synergy/DE. When a product is secured with License Manager, it will not run unless License Manager is installed and has been configured to recognize that product. To build License Manager protection into your own applications, you’ll need Synergy/DE Licensing Toolkit. For more information about this product, see the Licensing Toolkit User’s Guide or contact your Synergy/DE account manager.

To use License Manager—and your Synergy/DE products—you’ll need to complete these steps:

1. Decide whether you want to configure License Manager for local licensing or network licensing. See Deciding how you want to configure License Manager.
2. Install the Synergy/DE products; License Manager is included in the core components. See Installing License Manager.
3. Obtain license configuration keys from Synergex. See Obtaining configuration keys.
4. Install configuration keys to allow your Synergy/DE products to continue running after the 14‑day evaluation period. See Installing configuration keys.
Important

When you first install Synergy/DE on a machine that has never before had it installed, you will have unlimited evaluation use of all products for 14 days. After 14 days, you can run only the products that you have configured. Once you configure a particular product, your use of that product is limited to the number of licenses you purchased. After the 14‑day evaluation period expires, if you want to evaluate a product, you must obtain a special configuration key from Synergex.

Each time you access the runtime during the evaluation period, the Synergex copyright message will display, along with the licensee name and the number of days remaining in the evaluation period. After you configure the runtime, this message no longer displays.

Deciding how you want to configure License Manager

License Manager can be configured for local licensing or network licensing.

Local licensing

Local licensing uses License Manager server (synd) to manage licenses on a single machine. You can configure local licensing on any Windows system. Each system with local licensing requires its own set of configuration keys, and you must configure a single‑user license for each Synergy/DE product that will be run on that system. (You can easily configure multiple products in one step with a Synergy key file.) A single‑user license grants authorization to any number of concurrent Synergy/DE application windows.

Network licensing

Network licensing uses License Manager server to manage licenses for one or more license clients. You can configure network server licensing on any Windows machine to manage license clients in a local area network (LAN).

Note

There are two scenarios in which you must use network licensing:

  • When 32‑bit Synergy/DE is installed on a 64‑bit machine. The license server can be the local machine if 64‑bit Synergy/DE is also installed, or it can be any other (32‑bit or 64‑bit) machine.
  • When Synergy/DE is installed to run from a shared drive. The machine on which Synergy/DE Client is installed must be configured as a license client. The license server can be any machine; it doesn’t have to be the shared machine. See Installation considerations.

When using network licensing, configuration keys are installed only on the license server machine, not on each license client. On the license clients all you need to do is specify the name of the license server during installation. Synergy/DE applications running on the license client take their licenses from the license server; therefore, the license server must have the necessary licensing in place before you can run applications on the client.    

Note

Users accessing an application via remote desktop software or a terminal server session are licensed using the license settings on the terminal server machine. There is no licensing setup required on the remote client device.

You can configure a backup license server, which will take over the task of serving licenses should the primary server fail. See Configuring a backup license server (Windows).  

Note

For Synergy .NET applications (including those using ClickOnce deployment) that are deployed to systems where Synergy licensing is not configured, you must specify a license server name in the App.Config file. For details, see Runtime Settings page, Project Designer (Synergy .NET).

Understanding concurrent users and license usage

A configuration key specifies the maximum number of concurrent users for each Synergy/DE product that will be run by the license server and its license clients. Synergy/DE products are licensed by seat, with the exception of SQL Connection, which is licensed by connection. (A seat may be defined as a desktop [that is, a person logged in to the system], a service, or a scheduled task.) This means that each license client can run multiple occurrences of a Synergy/DE product, but is counted as only one license by the license server. If the total number of concurrent users is exceeded, new Synergy/DE applications will not be allowed to run until the number of users has dropped below the maximum.

Installing License Manager

1. Follow the instructions included with your distribution to install the Synergy/DE products. License Manager is installed with core components.
2. When prompted for the license configuration, choose either “License Server or Stand‑alone” (if the machine will be a license server or have local licensing) or “License Client” (if the machine will take its licenses from a license server).
3. If you choose “License Server or Stand‑alone”, in the Unique Licensee Name field enter the name that you provided to Synergex when you ordered Synergy/DE products for this machine. (This name will display in the copyright notice when you run licensed Synergy/DE products.) By default, the license server runs on port 2380. If you need to change it, you must do so from the command line. (See Changing a license server’s port.)
Tip

We recommend that your company establish a licensee naming standard. If your company installs Synergy/DE on multiple systems at one site, we recommend that you use the name of the company followed by the user or domain name (e.g., “ABC Computers, Mary Smith” or “ABC Computers, Tiger”). If your company installs Synergy/DE at multiple sites, we recommend that you specify the company and city or location (e.g., “ABC Computers, Gold River” or “ABC Computers, store 215”).

4. If you choose “License Client”, in the Server Name field specify the license server machine that this client will use. If your configuration includes a backup license server, you must specify the license server by DNS name; otherwise, you can specify the license server using either an IP address or the DNS name. Depending on how your DNS is configured, you may be able to specify a shortened form of the name (e.g., Tiger) or you may have to specify the full DNS name (e.g., Tiger.ABCComputers.loc).

If the license server is not running on the default port (2380), specify the license server port by appending a colon followed by the port number to the end of the server name or IP address (e.g., Tiger:5555).

Note

If you are installing 32‑bit Synergy/DE on a 64‑bit machine, and 64‑bit Synergy/DE is already installed with server licensing, the server name for the client will default to that of the 64‑bit machine. You can change the 32‑bit installation to be a license client to another machine if desired.

Obtaining configuration keys

You can use the following methods to obtain configuration keys:

Obtaining keys online

To complete this procedure, you will need your Resource Center username and password.

1. Gather the registration information for the machines in one of the following ways:
2. Access the Licenses area of the Resource Center in either of the following ways:
3. On the Synergy Licenses page, select the Manage Licenses button to display a list of your company’s licenses.
4. Use search or sort to locate the license on the list. You can change the Show dropdown to New Licenses to limit the list to only those licenses for which keys have not yet been generated.
5. When you find the license, click on its license number, and then follow the instructions to generate keys.
Tip

If you need to change the licensee name, do it now, before generating keys. The licensee name entered on the machine during installation must match the one you see on the licenses website (which is the licensee name given to Synergex when products were ordered). You can easily change either of them at this point. On the website, you can change the licensee name on the Edit page; to change the name on the machine, see Licensee name entered during installation is wrong.

6. When prompted, download the Synergy key file (.skf file) or select to have it sent to you as an email attachment. Save the key file to your hard drive; you’ll use it to install the keys (see Installing configuration keys).

Obtaining keys by mail or fax

This procedure prints a license agreement, with your registration information filled in, which you can mail or fax to Synergex.

1. Start the Synergy Configuration Program (from the Windows Control Panel, select Synergy Control Panel > Synergy Configuration Program).
2. On the Licensing tab, click the Print Registration Information button.
3. Complete the fields in the Registration Information dialog box:

Company name

Enter the fname of your company.

Contact name

Enter the name of the person at your company to contact about licensing issues.

Phone number

Enter the phone number of the contact person.

Send keys to me by

Choose the method by which you want Synergex to send your configuration keys to you.

E‑mail address

If you chose to receive keys by email, enter the email address that you want them sent to. You will receive a Synergy key file (.skf file) as an email attachment.

Fax number

If you chose to receive keys by fax, enter the fax number that you want them sent to.

Installation type

Select New if this is the first time Synergy/DE will be installed for this license. Select Upgrade if you are upgrading the license from a previous version of Synergy/DE. Select Re‑install if you are re‑installing the same version of Synergy/DE for this license.

Synergy/DE version

Select the version of Synergy/DE for which you are requesting keys. If you select Other, explain in the Comments field.

Comments

Enter any comments you have regarding this request. If you selected Other for either “Send keys to me by” or “Synergy/DE version”, explain here.

4. Click the Print button to print the license agreement. Optionally, you can click the Save to File button to save it as a text file.
5. If you printed the license agreement, sign and date it, and then mail or fax it to Synergex. When you receive your configuration keys, install them; see Installing configuration keys.

Installing configuration keys

Before installing configuration keys, ensure that the system date and time are correct, and that no Synergy applications are running.

If you have a Synergy key file

1. Start the Synergy Configuration Program.
2. On the Licensing tab, click the Execute Key File button.
3. Type the path and filename of the .skf file in the Key file field, or click the Browse button and select the file.
4. Click the Execute button. The lmu utility executes the key file and installs all keys in the file for the current machine. See the lmu Error Messages table for a list of possible errors returned by lmu.  
Note

You can also run the Synergy key file by double‑clicking it from Explorer, or you can run lmu from the command line and specify the key file with the ‑f option. See lmu utility for more information about lmu command line options.

If you do not have a Synergy key file

1. Start the Synergy Configuration Program.
2. On the Licensing tab, click the Install Keys Manually button.
3. Complete the fields in the Install Keys Manually dialog box:

Product code

Select the product code from the drop‑down list or, if the code you need is not listed, type it in.

Producer code

Enter the code for the company that produces the product you’re configuring. Synergex’s producer code is 999.

Configuration key

Enter the configuration key that Synergex sent you for this product. This key must be entered correctly! Pay special attention to occurrences of the number one (1) and the lowercase letter “L”, as well as occurrences of the number zero (0) and the uppercase letter “O”.

4. If this product requires an extended data string, click the Extended Data String button and enter it in the dialog box that displays. (This string is required only in special circumstances and will be given to you by Synergex.)
5. Click the Install Key button.
6. Repeat steps 3 through 5 to install the remainder of the keys. When you are through, click the Close button, and then click Apply on the Licensing tab.    

Changing license configurations

Do not remove or edit registry entries or uninstall licensing to change a license configuration.   

Note

When you install Synergy/DE Client, if the machine is not already a license client, the license configuration will be changed to network license client and will use the network license server specified in the setup.ini file. See the installation instructions that accompanied your distribution for more information.

Note

To change the licensee name on the server, see Licensee name entered during installation is wrong.

Changing a license client to use a different license server or port

1. Start the Synergy Configuration Program.
2. Click the Advanced button on the Licensing tab.
3. If the license server has changed, in the Advanced License Manager dialog, change the value in the Server name field. The server must have the necessary licensing in place before you can run applications on the client.
4. If the port for the license server has changed, or if the new license server is not running on the default port (2380), specify the port by adding a colon followed by the port number after the server name (e.g., Tiger:5555).
5. Click OK.

Changing a license client to a license server

You must have administrator privileges to change the license configuration from client to server.

1. Contact Synergy/DE Developer Support to get the current ‑k password.
2. From the command line run lmu ‑k, supplying the password as an argument.
3. Start the Synergy Configuration Program.
4. When you are prompted to configure licensing, select “License Server or Stand‑alone”. In the Unique Licensee Name field, enter the name that you provided to Synergex when you ordered Synergy/DE products for this machine.

Changing a license server to a license client

Important

If you change a configuration from license server to license client, you cannot use the Synergy Configuration Program to change it back. See Changing a license client to a license server.

1. Start the Synergy Configuration Program.
2. Click the Advanced button on the Licensing tab.
3. In the Advanced License Manager dialog box, select Client and type the IP address or DNS name of the network license server in the Server name field. If your configuration includes a backup license server, you must use the DNS name. The server must have the necessary licensing in place before you can run applications on the client.
4. If the license server is not running on the default port (2380), specify the port by adding a colon followed by the port number after the server name (e.g., Tiger:5555).
5. Click OK.

Changing a license server’s port

By default, License Manager server (synd) runs on port 2380. We recommend that you use this port if at all possible, because a non‑default port must be specified not only on the license server, but—for network licensing—on all the license clients as well.

To change the License Manager server port, you will first need to change it from the command line on the license server (it cannot be changed from the Synergy Configuration Program on the server). Then you will need to specify the new port on each client, which can be done from either the Synergy Configuration Program or from the command line.

1. Change the port on the server using lmu:

Reinitialize License Manager using the ‑ns, ‑r, and ‑po options, specifying the new port. Valid ports are in the range 1024 through 32767. For example,

lmu -ns -r -po5555 

You’ll be prompted to confirm the change. If you have stand‑alone licensing, you are done.

2. Change the port on each license client from either the Synergy Configuration Program or the command line.
lmu -nc -rTiger:5555 
Note

You can specify the port number with the ‑po#### option instead of appending it to the end of the server name. If both methods are used, the port specified with ‑po takes precedence.

Changing back to the default port

To change the license server back to the default port, do the following:

lmu -ns -r

You’ll be prompted to confirm the change.

To change the license clients back to the default, do one of the following:

lmu -nc -rTiger

Starting and stopping License Manager server (synd)

The License Manager server, synd, is a background process that runs on license servers and on machines that have local licensing. Synd runs as the service synlm. See synd program for synd syntax and command‑line options.

To start or stop License Manager server, you must have administrator privileges.

Starting License Manager server

License Manager server is started automatically when you install Synergy/DE core components.

Starting License Manager server manually

Do either of the following to start the service synlm, which starts synd:

net start synlm

If you receive the error “Could not start the Synergy/DE License Manager service. The system could not find the file specified”, you should unregister and reregister the synlm service. See synd program for the synd syntax. After reregistering, try starting synlm again.

Note

The License Manager service synlm always logs its version and start/stop line to the Windows application event log. You can view the event log with the Windows Event Viewer. For more information on extended event logging for the synlm service, see Error logging.

Stopping License Manager server

Do any of the following to stop (but not unregister) the synlm service:

synd -q
net stop synlm 

To stop and unregister the synlm service, type the command synd ‑x at a command prompt.

Error logging

By default, the License Manager service synlm always logs its version, start‑up and shut‑down messages, and any errors it reports to the Windows application event log. You can view the event log with the Windows Event Viewer.

You can request more verbose logging in a separate log file. Verbose logging includes additional information such as licensing activity (logins and logouts) and the session and seat IDs. You can run lmu with the ‑s option to see these IDs, so that you can match them up with the logging output.

Note

Synd buffers the logging information and then periodically writes it to the log, so unless there is a lot of licensing activity, you may not see anything in the log right away. You can force synd to write to the log by stopping the service.

To request verbose logging,

1. In the Synergy Configuration Program, click the Advanced button on the Licensing tab.
2. In the Advanced License Manager dialog box, select Enable verbose logging.
3. Change the default log file name and location, if desired. Include the complete path. If the log file specified does not exist, it will be created, but the directory path must exist. By default, the log is named synd.log and is located in the synergyde\dbl\bin directory.
4. Click OK.

Remember to review and clear the log from time to time. Do not leave verbose logging enabled indefinitely because the file will get quite large.

Uninstalling License Manager

License Manager is uninstalled when you uninstall Synergy/DE. Uninstalling removes only the License Manager files; it does not remove the license configurations. If you need to remove your license configurations, use the lmu ‑k option before uninstalling Synergy/DE. The ‑k option requires a password. Contact Synergy/DE Developer Support for the current ‑k password.