Soon, we will launch a new and updated customer portal, which is an important step toward providing our customers with one place to learn, interact, and get help.
Learn more.

Transferring and Updating a Softkey License

This article outlines how to update the support information on a softkey license and how to move a softkey license from one machine to another. 

If you are working on a machine without internet access, please see our article "Activate, Transfer, or Update a Softkey License On A Machine Without Internet Access."

CONTENTS
Alissa Wilczynski
10/06/2016
Related articles

For information on installing a new softkey license, please visit How to Install a Single User Softkey or for network licenses, "How to Install the Network License Version of OpticStudio."

 
Hardware Key
Installation and Troubleshooting
OpticStudio

 

Introduction

NOTE:  Before continuing this article, you should be certain that you have a softkey license.  If you received a USB dongle from Zemax Sales, you do not own a softkey license.

                

If you need to update support information for a Red or Green USB license, refer to the following article: Update a Red or Green USB Dongle With Internet Access. For Black USB keys, refer to Is My Key Under Current Support.

Introduction

To follow the instructions in this article, you will need the Zemax License Manager installed.  The Zemax License Manager is automatically installed with OpticStudio. If you need to install Zemax License Manager separately, you can find it in the Resource Files section of the Downloads page

For the purposes of this article, the "source" computer is the one the license is currently installed on. The destination is the one you want to move it to. 

Network License transfer questions

Can I transfer a network license? Yes, network licenses may be transfered to a new keyserver machine. Before initiating the transfer, you should ensure that there are no active sessions on the license.  To view active sessions, see "How Do I Monitor and Control Usage of the Network Key?"

Can I transfer a checked-out seat from a network license? No, checked out seats are locked to the machine that checked out the license. (the "transfer away" button is unavailable out to indicate this). You will need to check the license seat back in, and check it out on a different computer.

Can I transfer a network license if there are currently seats checked-out? Yes, you may transfer a license even if there are checked-out seats.  Once the checked-out seat's loan period ends, their seats will be returned to the general pool, regardless of the host location of the network license. To return a checked-out seat early, the client machine simply needs visibility to the new network license location.


Preparing To Transfer

The license transfer process has changed in OpticStudio 16.5 and in the Zemax License Manager released after August 2016. The transfer process is not compatible with older versions. Before beginning transfer, you need to verify you are using compatible License Manager versions on the source and destination computer.

1.Open the Zemax License Manager on the source computer. Make note of the date at the top.
2.Open the Zemax License Manager on the destination computer. Make note of the date at the top.

3a.If both are dated before Aug 2016, move to the section Transfer a softkey license using OpticStudio versions released before August 2016. 
3b.If both are dated after August 2016, proceed to the section Transfer a softkey license using OpticStudio versions released after August 2016

3c.If one computer uses a license manager before Aug 2016, you will need to update the Zemax License Manager. You can get the ZLM from the Resource Files section of the Downloads page. Once installed, there will be a new "Zemax License Manager" folder in your Windows start menu, separate from the OpticStudio folder. Once both versions are dated after August 2016, proceed to Transfer a softkey license using OpticStudio versions released after August 2016

 

Transfer a softkey license using OpticStudio versions released after August 2016

The transfer process for versions after August 2016 has 2 primary steps:

  1. Push the license away from the previously licensed machine.  The license will "live" on the Zemax License Server indefinitely until you complete step 2.
  2. Retrieve the license from the Zemax License Server to any machine of your choosing.

We will walk through the complete details for both of these primary steps.

Push the License Away from the Previously Licensed Machine (source)

1. Close OpticStudio if it is currently open.
2. Launch the Zemax License Manager (ZLM) on the machine where your license is currently located. For OpticStudio users with a single-user license, open the ZLM from Start / Programs / Zemax OpticStudio, open Start / Programs / Zemax License Manager. 

IMPORTANT: Check the date posted at the top of the License Manager. If it is dated July 2016 or earlier, move to the section Transfer a softkey license using OpticStudio versions released before August 2016
Navigate to the License Information tab and locate the license you would like to transfer in the list.  On the right hand side of the license details, you will see a "Transfer Away" button.



4. Press "Transfer Away". You may leave this box blank, and click OK, or you can input an email address. We highly recommend inputting an email address as an extra security measure for the protection of your license. Note that Zemax LLC does not save the email addresses entered during this process for marketing purposes.  

Please note if you are working with sales to do a key exchange make sure to email the transfer code to sales@zemax.com




5. A dialog box will pop-up with a transfer code.  This is the code that you will use to retrieve your license, so copy it and keep it in a safe place!  If you did opt to input your email address, an email was sent to you from license@zemax.com which includes the transfer code and your license details. Your softkey license will be removed from your current machine and will be hosted indefinitely on the Zemax License Server.  


 

Retrieve the License from the Zemax License Server and Apply It To Any Machine

1. On the machine where you would like your license to be located (destination), close OpticStudio if it is running.

2. Launch the Zemax License Manager (ZLM). For OpticStudio users, it is located in Start / Programs / Zemax OpticStudio / Zemax License Manager. For network license keys, Open Start / Programs / Zemax License Manager / Zemax License Manager. 

3. Click on the "New key" tab and paste in the code you received when you transferred the license away from its previous host machine.  Be sure to include the brackets ().

4. Click  "Apply License."  You should get a message telling you that the license was successfully applied to your machine. 

Tip: If you cannot click "apply" either you did not include the brackets () from the transfer code, or you are attempting to apply the transfer to a license manager version dated before August 2016 which uses a different transfer method. Update the license manager or OpticStudio version on the destination machine and try again. 

5. If you get an error message, first check the "Q&A" section below to see if the suggestions apply to your situation. If you still need help, contact support@zemax.com. Please provide a screenshot or text of the error message, a description of the steps you have completed, your license key number (L1XXXXX) and the transfer code you attempted to use.
 




 

Q&A for license transfers (using a license manager after August 2016)

I get a certificate error when trying to apply the transfer code to the destination machine. What do I do?

Most commonly this means there is an issue with the underlying licensing software required to apply the transfer. You can check if the licensing software is working, and repair them by following the repair instructions here:
How to Troubleshoot Softkey License Issues. Once your licensing software is working, then attempt to apply the transfer code again. If it still fails, contact Zemax Support. Please include a screen shot of the Sentinel Admin Control Center's "Sentinel Keys" page located at http://localhost:1947/_int_/devices.html .It will look similar to below, though will not likely have any keys listed.


I'm getting an error when I try to Transfer Away.  What should I do? 

First, be sure OpticStudio is not running on the machine hosting the softkey.You cannot transfer a license while OpticStudio is open and using it. 

Next, check that your firewall is not blocking communication with the Zemax Server: open Internet Explorer (no other browsers!) and navigate to the following address:

https://zws.zemax.com/OpticStudioService.svc

If you are able to communicate with the server, you will see a page that says "Metadata publishing for this service is currently disabled..."  If you do NOT see this text, your firewall settings are preventing your machine from talking to our license server.  Work with your IT person to resolve this problem.  Feel free to contact Zemax support if you need any additional information on unblocking the service. If you are still unable to resolve this issue, you can also use the offline transfer method

What happens if I transferred the license away, but I want it back on the same machine?

You can use the transfer code to retrieve the license from the Zemax License Server on any machine, including the original host machine.

What should I do if I lost my transfer code?

Contact support@zemax.com. Please include license key serial number (this should begin with "L10...") if possible. If you do not have that, the company name, registered user of the key if known, and time and date it was transferred,   We will help find the missing code for you.

I cannot hit "apply" when I try to use the transfer code to apply the license on the destination machine. I'm sure I'm connected to the internet.  What's happening?

First, be sure you included the brackets () in the transfer code. Next, make sure that you have the same OpticStudio release installed on both machines -- a transfer code generated in a version released after August 2016 will NOT WORK if you attempt to complete the transfer on a machine using an older release, dated before August 2016. Update the OpticStudio version on the destination machine. 

Transfer a softkey license using OpticStudio versions released before August 2016

To move a softkey license from one machine to another, both machines must have internet access and be able to communicate with the Zemax server.  If one or both machines do not have internet access, please see our article "Activate, Transfer, or Update a Softkey License On A Machine Without Internet Access."

The transfer process for versions before August 2016 has 3 primary steps. We will walk through the complete details for each of these 3 primary steps.
  1. Start on the destination machine, and generate a license transfer code.
  2. Move to the source machine, and push the license away onto the Zemax transfer server. 
  3. Complete the license transfer on the destination machine.

To begin:

1. Close OpticStudio on both machines, if it is currently open.

2. Move to the
machine you would like to move the softkey to, referred to as the "destination" machine. 

3. Launch the Zemax License Manager (ZLM) from Start / Programs / Zemax OpticStudio or (for network licenses) Start / Programs / Zemax License Manager. 

IMPORTANT: Check the date posted at the top of the License Manager. If it is dated September 2016 or later, move to the section Transfer a softkey license using OpticStudio versions released after August 2016

4. Navigate to the Transfer key tab and click Generate Transfer Code. Copy the code generated in this dialog box and either email it to yourself or copy it into a file accessible to the source machine.

Important - Be sure to include the brackets {} when saving the code. 



5. Move to the currently licensed (source) machine.  Open the Zemax License Manager. On the "License Information" tab, find the license that you would like to move to the destination machine.  

6. Click the "Transfer Away" button and, in the pop-up dialog, paste the code generated from the destination machine. Be sure to include the brackets {} when pasting to typing the code. 



Confirm that you do want to remove the license from this machine, and you should receive a message "License successfully transferred away."  The license has now been transferred temporarily to the Zemax server.  If you receive any other message, there was an error during your transfer.  Please read the error text and attempt to follow the instructions.  If the error persists, first check the "Q&A" section below to see if the suggestions apply to your situation. If you still need help, contact support@zemax.com. Please provide a screenshot or text of the error message, a description of the steps you have completed, your license key number (L1XXXXX) and the transfer code you attempted to use. 

7. Return to the destination machine.  Open the Zemax License Manager again.

8. Click the "Transfer key" tab on the left, and click Complete Transfer.  Paste or enter the transfer code into the pop-up box. Again, be sure to including the brackets. The license will then be retrieved from the Zemax server and saved on the local machine. The License Information tab should now be populated with the license you transferred in. If you have any problems, refer to the Q&A section below. 


 

Q&A for license transfers (using a license manager before August 2016)

I'm getting an error when I try to Transfer Away.  What should I do? 

First, make sure you are not running OtpicStudio on the machine that hosts the softkey. Close OpticStudio and launch the License Manager separately.

Next, check that your firewall is not blocking communication with the Zemax Server: open Internet Explorer (no other browsers!) and navigate to the following address:

https://zws.zemax.com/OpticStudioService.svc

If you are able to communicate with the server, you will see a page that says "Metadata publishing for this service is currently disabled..."  If you do NOT see this text, your firewall settings are preventing your machine from talking to our license server.  Work with your IT person to resolve this problem. Feel free to contact Zemax support if you need any additional information on unblocking the service. If you are still unable to resolve this issue, you can also use the offline transfer method


What happens if I generate a transfer code, then decide not to move my license?

When you generate a transfer code, you create a fingerprint to identify a particular transfer process.  If you do not wish to continue the transfer, you can simply abandon the process at this stage.


If I decide I no longer want to move the license but have already hit Transfer Away, what should I do?

Your license is now stored on the Zemax server.  The best and easiest way to retrieve your license is to complete the transfer to the destination machine, then simply re-transfer the machine back to the original host.  If this is not possible, send a message to support@zemax.com explaining the situation.  Ensure that your message contains your transfer code and as much key information as you have, such as your key serial number or key ID.
 

If I generate a transfer code from destination machine A but then decide I'd rather move the license to destination machine B, what should I do?

So long as you have not already pressed the Transfer Away button on the currently licensed (source) machine, you can simply go to destination machine B and generate a new transfer code.  Use the transfer code from destination machine B to complete the remainder of the transfer steps. 

It says that I successfully transferred by license away, but when I try to use the transfer code again to get the license on the new machine, I cannot hit OK. I'm sure I'm connected to the internet.  What's happening?

Please make sure that you have the a compatible OpticStudio (or Zemax License manager) release installed on both machines -- a transfer code generated in a version released before August 2016 will NOT WORK if you attempt to complete the transfer on a machine using a newer release, dated after August 2016, and vice-versa.

 

Update Support Expiration on a Softkey License

Automatic Updates
For all versions of OpticStudio released after August 2016, available updates for softkey licenses will be automatically applied to the license when OpticStudio, Lensmechanix, or the Zemax License Manager is launched, provided that the host machine is connected to the internet and can communicate with the Zemax License Server. The automatic update occurs once each day, the first time that you launch the Zemax License Manager or Zemax application.  

Manual updates

For versions of OpticStudio, Lensmechanix, or the Zemax License manager released prior to August 2016, updates must be manually applied according to the following instructions:

1. On the machine hosting the softkey license, open the Zemax License Manager (ZLM).  You can open the Zemax License Manager from inside OpticStudio under Help > License Manager. If this is a network server, open Start Menu / Programs / Zemax license Manager. For Lensmechanix, Open Start / Programs / Lensmechanix /  Zemax license Manager.

2. On the License Information tab, locate the license that you would like to update and press the Update button.

3. Enter the update code provided to you by the Zemax sales team, including the brackets []. You should then receive a message of a successful update. 




4. Look at the License Information tab and verify the "Support expiration" field now reflects the renewed expiration date.  If the date displayed here is not correct, please contact Zemax Support. Include your license number and update code. If you receive any errors or cannot apply the code, see the Q&A below.

 

Q&A (license updates)


If I update a network license while seats are in use or checked-out from the network, what will happen?

Any client machines and the keyserver using the network license will see the updated license information immediately. If you have any checked-out (offline) seats, they will not display the updated information until they are checked back in to the license pool.  Updating the license while they are in use will not interrupt client's use of the license.

How often does the automatic update occur? 

The automatic update occurs once each day, the first time that you launch the Zemax License Manager or OpticStudio programs.
 

I get an error when applying an update code!  What should I do? 

First, verify that you have included the brackets [] in the update code.

Next, verify the update has not already been applied. If this was a support renewal, check the support expiration date for your license in the Zemax License Manager.  If this was an upgrade to a different version of OpticStudio (from standard to professional or premium for example) it will be listed there as well.

If you have verified you don't already have the update, check that your firewall is not blocking communication with the Zemax Server: open Internet Explorer (no other browsers!) and navigate to the following address:
https://zws.zemax.com/OpticStudioService.svc
If you are able to communicate with the server, you will see a page that says "Metadata publishing for this service is currently disabled..."  If you do NOT see this text, your firewall settings are preventing your machine from talking to our license server.  Work with your IT person to resolve this problem, or use the link at the end of this answer to perform an offline update.

Once you've confirmed that you can "see" the license server, you can force your software to check for an available update to your softkey license (only Applicatable if you are using the Sept 2016 or newer Zemax License Manager). To do this, go to C:\Users\<your user name>\AppData\Local\ZemaxLicenseManager and find a file called "Settings.XML."  Delete this file, then re-launch the Zemax License Manager.  

If you continue to experience issues, you can try the offline method below.
 
Can I update my license information without connecting to the internet?

Connecting to the internet is the easiest way to perform the update. If the machine where the key is hosted cannot be connected to the internet, or the process fails, please see this article for offline instructions.

 

Getting Help


If you receive any error messages while transferring or updating, contact the Zemax Support team for further help. Please include any error messages as well as your license key number (such as L000001). It would also help to send a screen shot of the Sentinel Keys page located at http://localhost:1947/_int_/devices.html.