Documentation

No results
    gitHub

    Software registration

    *If you're using a an older version of Hackolade Studio (up to v6.11.9), consult *this page for the older screenshots and process.

     

    After downloading Hackolade Studio, you need to obtain and validate an activation key before you can use the application, except for the Community Edition.

     

    You can initiate the process of getting an activation key either from the website, or from inside the application.  Once you have an activation key, it needs to be validated from the application.

     

    IMPORTANT NOTE: Your license key is a valuable asset and should be treated with care.  Just like you would reclaim a laptop when seomone leaves, you should do the same for our license keys.  If you change computers or a user leaves the organization, take a moment to release the license key on the old PC before retiring it, so your license key can be validated again on a new machine.  Many customers add to the exit checklist of team members the action of releasing the license key.  All details can be found here.  

     

    Important: the following domains must be whitelisted: https://hackolade.comhttps://quicklicensemanager.com, https://qlmdr.com, and https://github.com/hackolade

     

    Warning: if you have an HTTP proxy server on your network, you may have to manually set in the application the proxy parameters.  You will find more information on the Network Proxy page.  In particular, in environments with proxies using SSL inspection (Zscaler, BlueCoat, etc.) it is critical that Hackolade Studio be whitelisted to connect properly with SSL/TLS protocols.

     

    Useful info when managing licenses for multiple users: read this article if you're a license administrator and want to track who's using Hackolade licenses.

     

     

    Get a software license key

    Starting with v7.0.0, the Community Edition no longer requires a license key.  For the Community Edition, the experience is 100% frictionless: no license key, no sign up, no login.  Just download the software and start to use use it.  If you want to avoid seeing the License Status screen each time you start the application.  Just click on the Continue for Free button in the Community Edition card.

     

    For obvious reasons, it is not possible to accumulate multiple 14-day free trial keys.  Once your key has expired, you may take a subscription for the Edition of your choice, or choose to use the Community Edition for free.  If you need more time, you may send an email to support@hackolade.com, explainng the evaluation plans and timeline for your organization.

    from the website

    Go to the pricing page and choose the version you prefer (see here for more info).  You will be directed to the Hackolade Store where you'll be guided through the checkout process.  A license key will be generated and provided on screen and via email.   You will need this key to access the application.  Go to the validation step below for instructions.

    from the application

    When you start Hackolade Studio, if there is no valid license key present, you are presented with this License Status screen, also available by clicking the key icon at the bottom of the context bar in the lower left-hand corner, or by going to Help > License Status:

     

    License Status - request license key

     

    Choose your Edition and subscription plan.  You will be directed to the Hackolade Store in your browser where you'll be guided through the checkout process.  A license key will be generated and sent to you via email.   You will need this license key to access the application.  

     

    Validate your license key

    If you have not downloaded Hackolade yet, please do so from the download page.

     

    License Status - validate license key

     

    Paste the license key received by email, or provided by your administrator.  The license key has a format of multiple 5-character segment like XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.  Note that the dashes ("-") are cosmetic and optional.  A proper license key with no dashes validates equally well.

     

    The Identifier field is pre-populated with information fetched from your Operating System.  This Identifier is important in the management of license keys.

     

    Click the Validate button.

     

    You must be connected to the Internet for the validation of your license key with Hackolade's license server.  In some rare cases when your machine must be isolated from the Internet, you may use the offline validation process described below.

     

    If the license key is successfully validated, the following message willbe breifly appear at the top of your screen.

    License Status - license key validated

     

     

    The License Status screen can be accessed at any time by clicking the key icon at the bottom of the context bar in the lower left-hand corner, or by going to Help > License Status:

     

    License Status - status screen

     

     

     

    Release the license key from one computer to move to another

    If you need to move your license key to another computer, you first need to release it on the machine where it is currently validated.

     

    To release it, go to the option Help > License Status then click the Release key button.

     

    As of this moment, you can no longer use Hackolade Studio on the original computer, unless you you re-register it, or witch back to the Community Edition.

     

    Go to the other computer where you want to use Hackolade Studio and validate your license key using the instructions above 'Validate your license key'

     

    Offline validation

    Important note: offline validation will NOT work for subscriptions or perpetual concurrent licenses.  This section is only for 14-day trial, and perpetual individual workstation licenses.

     

    If the application cannot reach the Internet, the following dialog is displayed:

     

    Offline license activation - connection failu

     

    If the machine does have access to the Internet, it is possible that a proxy setting is preventing the application from properly connecting, and you should follow the steps described here.

     

    There are legitimate reasons for the machine to be disconnected from the Internet, in which case you should follow the steps below.

     

    By clicking on the link or the Send button, you will be directed in your browser to this page (or you should copy the URL so it could be used on a different computer with Internet access), with the fields pre-filled:

    Offline license activation - web screen

     

    To manually access the above, you may also use this link

     

    When you click the activate button, an XML file will be downloaded to your PC.  With the application, choose the path and filename of the downloaded file:

     

    Offline license activation - choose file

     

    And the application should get activated.  Do not modify anything in the downloaded file, or the activation will fail.

     

    Concurrent licenses

    Concurrent licenses (a.k.a. floating licenses) work differently than workstation licenses.  With concurrent licenses, Hackolade's cloud-based licensing server tracks the number of simultaneous users for a given concurrent license key.  If the number of simultaneous users reaches the maximum number of seats for the license key, anyone who subsequently tries to start the software is denied access.  

     

    The application may be installed on a large number of computers, each with the same validated license key, but a maximum number of users are allowed at the same time, according to the number of seats purchased for that concurrent license key.  For example, an organization has acquired a single concurrent license key for 20 seats.  The application and validated license key are installed on 250 PCs.  At any given time, only a maximum of 20 users will be allowed to use the application.  If a 21st user attempts to open the application, access will be denied until a previous user exits the application and frees up a seat.

     

    With individual workstation licenses, the license key is entered and validated by our Hackolade cloud-based licensing server when the application is first accessed.  After that validation, the application no longer needs to access the licensing server.  To be complete, each time the maintenance or the subscription expires, the application will again communicate with the licensing server to check if the contract has been renewed. 

     

    For concurrent licenses, the licensing server is contacted multiple times: each time the application is started, plus each time the application is exited.  Assuming that the license key has been validated once for an application instance, each time the application is started, the licensing server is contacted to verify the availability of a seat.  If a seat is available, it gets reserved on the licensing server with the unique UUID of the PC, and access is granted.  If no seat is available, access is denied.  Any seat granted when opening the application gets released upon exiting the application.  

     

    Offline use of the application is possible but requires to start the application so a seat can be granted before going offline, provided that a seat is indeed available. The seat will remain assigned until the application is exited while online.

     

    Note: In particular with concurrent licenses, it is strongly suggested to read and apply this article so a license administrator can track who's using Hackolade licenses and seats.  

     

    Licenses on Virtual Machines (or physical computer accessed via RDP or equivalent)

    As long as you validate and use Hackolade Studio with the same combination of host machine, remote machine, and login, there should be no issue.  If any of these 3 parameters is different, access is blocked.  In a VM environment, it is critical that the VM instance is persistent to ensure the stability of the 3-parameter combination.

     

    Important note: installing Hackolade on a central computer (whether on a PC or a server, whether the machine is virtual or physical, and whether on premises or in the Cloud) does not change the terms of our License Agreement.  Specifically, that license metric is per "per seat", and that a license must be obtained for each device on or from which the Product is used or accessed. When the Product is accessed remotely across using Terminal Server, Remote Desktop, Citrix XenDesktop or an equivalent method, a separate Product license is required to be assigned to each device from which the application is accessed, i.e. not the virtual machine on which the Product is installed.

     

    Important: before you delete a user login on a VM, or delete an entire VM, make sure to release the Hackolade key(s) via Help > Software Key Validation > Release.  This is the only way for you to free up the seats of that user, and make it available for another one.

     

    Reminder: when installing Hackolade on a VM to share among multiple users, it is important to realize that licensing is not attached to just the machine, but to the combination of the machine where Hackolade is installed, a client workstation identification for the PC accessing the application, and the user login.  As per the EULA: "A license must be obtained for each device on or from which the Product is used or accessed."  

     

    Example: having 4 Hackolade users on a single VM is the equivalent of having 4 individual PCs running Hackolade from a licensing point of view: you need 4 license seats to be validated.

     

    VM configuration

    Note: it is critical that the VM setup is such that you access a persistent VM instance of the application.  Non-persistent instances will cause license issues.  See this article for a good discussion of persistent vs non-persistent (or stateless) VDI.

     

    Persistent vs non-persistent VDI

     

    Hackolade licensing is enforced through registration on our license server of a combination of unique identifiers, including the UUID of the computer where Hackolade is installed, a client workstation identification for the PC accessing the application, and the user login.  Each unknown combination reserves one seat on our license server, until you reach the total number of seats purchased for the submitted license key.

     

    While typically Windows installation does not require admin rights, if the directory where the software is to be installed requires admin rights, you may need the intervention of an administrator with elevated rights to execute the installation.  The Hackolade installation should be made for "all users" of the central computer, if given the choice.  Please refer to the section above for instructions on the installation process.

     

    Once the software is installed centrally, each user login should be able to access its own instance of the application.  Each user login on the central computer will be required to go through software key validation, following the steps outlined here.

     

    Given the way license seats are counted, it is important that identifiers remain stable.  If your IT department configured VM infrastructure differently, it may be required for your IT department to adjust parameters in order to achieve stability.

     

    Citrix

    ENABLE_DYNAMIC_CLIENT_NAME should be left to YES
    Allows client name to be the same as the computer name. When you change the computer name, the client name changes too. 

    • Yes (default) – Allows the client name to be the same as the computer name. Example, CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=Yes. 

    • No - Does not allow the client name to be the same as the computer name. You must specify a value for the CLIENT_NAME property. Example, CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=No

     

    Additional resources:

    https://docs.citrix.com/en-us/receiver/windows/4-9/install/cfg-command-line.html#identify-a-user-device

    https://docs.citrix.com/en-us/receiver/windows/4-9/install/cfg-command-line.html#dynamic-client-name

     

     

    VMWare

    As per this VMWare article, setup should generally be OK:  "Each virtual machine has a universal unique identifier (UUID). The UUID is generated when you initially power on the virtual machine...  Suspending and resuming a virtual machine does not trigger the process that generates a UUID...  If you do not move or copy the virtual machine to another location, the UUID remains constant."  

     

    If it is not the case, maybe instructions in this article will help your IT department configure appropriately