Aquaveo License Service

From XMS Wiki
(Redirected from ALS)

This is the approved revision of this page, as well as being the most recent.
Jump to navigationJump to search


The Aquaveo License Service protection (ALService protection) replaces the old Sentinel and password protection (SAP protection) with a design which:

  • Eliminates hardware locks and drivers.
  • Allows virtual machine and servers to be used without restriction.
  • Enforces the expiration date of evaluation or checked licenses.
  • Detects the overuse of evaluation or checked licenses.
  • Still allows customers to share a license within a user session.
  • Still allows customers to move a license between computers.
  • Still allows customers to share a network license.
  • Still allows Aquaveo to create non-network licenses.
  • Detect the overuse of non-checked licenses or warn user when not verified.

Single and Network User Configurations

The following figure displays configuration option for the Aquaveo License Service.

Aquaveo License Service Configuration Options
  • ALManager – An Aquaveo service that distributes licenses to customers.
  • ALService – The Windows service that authorizes the execution of the software.
  • ALRegistration – The graphical user interface to the ALService.

Accessing the Aquaveo License Service

The ALService can be accessed locally or over the network from the Register window.

  • A Flex license is a license to SMS that can be accessed or shared over a local network. This type of license can also be moved by checking-in and checking-out the license to other locations. A Flex license code begins with the letter "F".
  • A Local license enables SMS on a single computer and cannot be moved to another computer. A Local license codes begin with the letter "L".
  • An Evaluation license enables SMS on a single computer and cannot be moved to another computer. This license will expire after two weeks. An Evalutation license code begins with the letter "E".

Registration Dialog

The Aquaveo License Registration dialog when first seen.

This dialog opens when the Help | Register command is used.

If the software has already been licensed, the license code, expiration date, and maintenance date will be shown.

If the software has not been licensed, a field will appear when the license code can be entered.

The dialog also has the following options:

  • Request License – Opens a browser on the Aquaveo website where options for purchasing a license are available.
  • Advanced Options – Opens a dialog with advanced options for registering the product.

Advanced Registration Dialog

Example of the ALS Registration dialog

The Aquaveo License Registration – Advanced dialog for advanced options gives a display of the current active license. It has the following options:

Available licenses: Specifies the licensing location the application will use.

  • Change Location – Opens a dialog to change the location of the license.

License List: Displays all available licenses.

  • Sel – Selection box. Turning on this box attaches the license to the active product.
  • App – Shows which XMS application the license can activate.
  • Licenses – Shows number of licenses available with the license code.
  • License Expires – Shows expiration date for the license.
  • Maintenance Expires – Shows expiration date for Aquaveo maintenance agreement.
  • Code – Displays network or password code. Flex codes start with the letter F. Local codes start with the letter L.
  • Details – Brings up the Aquaveo Add License dialog where details about the license are show.

Update License:

  • Add License – Brings up the Aquaveo Add License dialog. Process where the service obtains seats (s) of a license form the database.
  • Refresh License – Refreshes the license list.
  • Remove License – Process where the seats (s) of a license are removed from the service and returned to the database.
  • Request License – Opens a browser on the Aquaveo website where options for purchasing a license are available.

Version:

  • Version – Brings up a dialog that displays the version number for RegWiz and the ALService.

Change License Location

The Aquaveo License Registration – Change License Location dialog

The Aquaveo License Serviece – Change License Location dialog is an advanced option that allows specifying the location of the license. The dialog has the following options:

The license location can be specified as one of the following:

  • Hostname – Allows entering the host name or IP address of the license location.
  • IP Address – Allows entering the IP address of the license location.

The port number to communicate with the license location can also be specified.

  • Port – Identifies the network port for the network license. The default is "56789".

Add License Dialog

This dialog allows adding a license code and indicating the number of licenses included with the code.

Aquaveo Add License dialog

Single User

When running XMS without a network license, do the following:

  1. Start XMS. The Welcome dialog should appear if the product has not already been registered.
  2. Select Register or Use Community Edition.
  3. In the Register dialog, enter the license code or click Advanced to being up the advanced Register dialog.
  4. In the advanced Register dialog, select Default Local address.
  5. Check on Manage Licenses and click on Add License.
  6. In the Aquaveo Add License dialog, enter license code.
  7. Close the Aquaveo Add License dialog.
  8. Click Apply.
  9. Close the Register dialog.

Network User

When ALService is set up by an adminstator, XMS automatically gets a license from the default AquaLicenseDNS. Therefore, a new user only needs to do the following:

  1. Install XMS.
  2. Run XMS.

If the administrator has set up the ALService using a different DNS name, the Registration dialog will need to be used to point the XMS software to the correct DNS. Therefore the new user will need to do the following:

  1. Start XMS. The Welcome dialog should appear if the product has not already been registered.
  2. Select Register or Use Community Edition.
  3. In the Register dialog, click Advanced to being up the advanced Register dialog.
  4. In the advanced Register dialog, select Other.
  5. Enter the DNS name in the IP or DNS Address field.
  6. Click Apply.
  7. Close the Register dialog.

Network User Server Set Up

Do this once on the network server:

  1. Install the Aquaveo License Service on a single network server.
  2. Open the Aquaveo License Service folder in Windows Start menu and run XMS License Setup, i.e. RegWiz.
  3. Add one or more XMS license codes to the Aquaveo License Service.
  4. Point DNS name AquaLicenseDNS to the Aquaveo License Service server.
    • Optionally skip this step but then manually point each client to the Aquaveo License Service.

Evaluation User or Other Special User

Same as Single or Network User except that:

  • The Aquaveo License Service must initially connect to ALManager if it is restarted (due to a reboot for instance). This requirement is enforced when the Custom1 module is disabled in the license.
    • If the ALService is unable to connect to the ALManager, open the Register dialog to the ALService and re-Add the license code. Registration Wizard will then prompt for a manual browser connection after which the newly started ALService will allow the license to be used.
    • Alternatively, allow the ALService to access the ALManager through their firewall and onto the internet.*
  • Evaluation codes start with the letter E.

Moving a License

At time a license will need to be moved. This is for the following reasons:

  1. Reduce the number of licenses on one Aquaveo License Service.
  2. Add those licenses to another Aquaveo License Service. I.e. check them back out from the ALManager after having checked them in.

Contact Aquaveo's licensing team for help in moving a license.

Manually Exporting a License

Sometimes a license needs to be moved manually. In this case, the "Netenble.001.reg" file needs to be updated to the following:

Windows Registry Editor Version 5.00M
("[HKEY_CURRENT_USER\Software\EMRL\WMS]")
"ALS"="1"
"ALSHost"="127.0.0.1"
"ALSPort"="56789"
"ALSCode"="COMMUNITY"
  • Adding in the path of the registry key is needed for changing the license. Also note that the certain software needs to be specified at the end of that path.
  • Adding this path will also help with locating the registry key for exporting it.
  • ALSCode doesn't necessarily need to be added except to prevent the register dialog from showing on startup.
  • Something else that may help to add is that the "ALSHost" is going to be whatever the server IP address is unless it is a local code.

The .bat file should be updated to the following:

reg import Netenble.001.reg
START wms.exe
  • The START command will skip the command prompt from opening and streamlining the process a little bit.
  • Also, the version is necessary for the .exe. For the full filename, look in the program files folder for the XMS software.

If the registry key needs to be exported, complete the following:

  1. Select Start , type regedit.exe in the search box, and then press Enter. If you are prompted for an administrator password or for confirmation, type the password or provide confirmation.
  2. In Registry Editor, locate and click the registry key or subkey that you want to back up.
  3. Select File | Export.
  4. In the Export Registry File dialog box, select the location to which you want to save the backup copy, and then type a name for the backup file in the File name field.
  5. Select Save.

And with the command prompt:

  1. Open the command prompt as an administrator and input the following:
reg export HKCU/EMRL/GMS <filename.reg> %UserProfile%\Desktop\output.reg

This will export the registry key to the desktop of the user as "output.reg"

Miscellaneous Features

  • Each user can select the ALService and code that they want to use on each computer for each XMS product.
  • An ALService can store the licenses for all XMS products.
  • Each computer runs only a single instance of the ALService.
  • An installed ALService automatically starts when a computer starts the Windows OS.
  • RegWiz is only allowed to change licenses on a local 127.0.0.1 ALService.
  • Multiple instances of XMS which are started within a user’s account on one computer can share the same XMS license.
  • If the ALSCode is not found in the registry, RegWiz will auto-select the first code available to it. To prevent this behavior, set "ALSCode" to "COMMUNITY".
  • Switching to community version to change licenses will NOT work with a local license and will only work with a flex license that is being used as a server license. This means that the local host code of "127.0.0.1" can only be used if the code is already registered on the machine as each local license has its own unique identifier or "password" whenever it is installed on a machine and cannot be transferred.

Registration Wizard License Details

This dialog is used to troubleshoot potential registration problems. It displays the current licenses details including registered modules, models, and expiration dates.

Aquaveo Add License details dialog

Error Conditions

  • XMS cannot get a license because all licenses are in use.
    • See RegWiz details of who is using the licenses.
  • RegWiz cannot do add or remove for license code in use.
    • See RegWiz details of who is using the licenses.
  • ALService cannot connect to the ALManager.
    • RegWiz cannot add or remove licenses. RegWiz will instruct the user to use their browser for the add or remove. Or first fix the connection and firewall to the ALManager.
    • RegWiz cannot show some license details and shows those details as a ?. Fix the firewall to allow ALService to communicate with ALManager.*
  • RegWiz cannot connect to the ALService.
    • Ensure that the firewall allows the connection.
    • Or restart the ALService in Windows Services as administrator.
    • Or try an IP port different than default 56789 on both the ALService and the clients.
  • XMS cannot get a license. Check license selection in RegWiz.
  • XMS cannot connect to the ALService, i.e. can no longer get a license from the ALService.
    • Check the ALService address in RegWiz.
  • XMS cannot use a password code license across the network.
    • This is only allowed for an network code license.
  • XMS cannot Add all password code licenses to an ALService.
    • Two or more licenses can only be added for an network code license.

Related Topics