Skip to content
STAGING SERVER
DEVELOPMENT SERVER

vTool Licensing#

The Workbench includes a number of free vTools. However, most vTools require a license.

This topic explains which license types are available and how to obtain a license.

License Types#

Demo License#

Demo licenses are pure software licenses that don't require a dongle. They allow you to use all licensable vTools in your current pylon installation for a period of 80 days after activation. Once a demo license has expired, it can't be renewed. Also, the following restrictions apply:

  • Each vTool can only be run for five (5) consecutive minutes. You can restart it once execution has stopped.
  • vTools can only be used in the pylon Viewer, not in the API.
  • Recipes you create can't be imported into your application code.
  • The license is tied to the pylon major version for which it was activated. Therefore, if you install a new pylon version, you have to request a new demo license.

Requesting a Demo License#

  1. In the vTools pane of the pylon Viewer, click the free demo license link.
  2. You will be asked to enter your e-mail address.
    You will receive an e-mail with a link for activating the license.
  3. Click the link. On the page that opens, click the activation button.
    The license will now be active for 80 days.

Evaluation License#

Evaluation licenses are pure software licenses that don't require a dongle. They allow you to use all licensable vTools for a period of 180 days after activation. Once an evaluation license has expired, it can't be renewed. The difference to the demo license is that you can import recipes created with an evaluation license into your application code and that you can work with them via the API. An evaluation license supersedes a demo license, i.e., after its activation you will immediately benefit from the increased scope even if your demo license is still valid. The following restriction applies:

  • Each vTool can only be run for five (5) consecutive minutes. You can restart it once execution has stopped.

Requesting an Evaluation License#

  1. Send a sales inquiry to Basler Sales asking for a vTool Evaluation License.
    Basler Sales will get in touch with you for all further information.

Runtime License#

Runtime licenses give you unlimited use of the vTools you've purchased. You can buy runtime licenses for individual vTools or for vTool bundles.

If required, you can also buy a USB dongle to load your licenses onto. This allows you to take your licenses with you to use them on different computers. You can load several licenses onto one dongle. Alternatively, you can opt for a software license. In this case, the licenses are bound to your computer.

The following table lists the respective advantages of each option.

USB Dongle Licenses Software Licenses
Dongles with activated licenses can easily be transferred to other computers No USB port needed
Licenses remain valid even if hardware configurations change No extra dongle cost
Fast activation because no hardware needs to be shipped

Purchasing a Runtime License#

  1. Visit the Basler vTools product page.
    There, you will find an overview of all the available vTools and vTool bundles.
  2. Decide which vTools or bundles you want to buy and note their order numbers.
  3. Send a sales inquiry to Basler Sales including the names and order numbers of the desired vTools or bundles and whether you need a USB dongle.

License Activation#

The following sections explain how to activate your licenses. The instructions apply to all license types.

Activating Licenses#

When your licenses order has been completed, you will receive an email with an activation link. The activation procedure is the same regardless of whether you're activating the licenses on a USB dongle or using the software licensing option.

To activate your licenses:

If you're using a USB dongle, make sure it is connected to your computer before starting.

  1. Open the activation link in a web browser on your computer, ensuring you have internet access.
    The WebDepot opens on the License Activation - Select CmContainer page.
    License Activation - Select CmContainer Page
  2. On the License Activation - Select CmContainer page, select the desired activation method:
    • CmDongle if you're using a USB dongle
    • CmActLicense if you want to bind the licenses to your computer
      The License Activation page opens.
      License Activation Page
  3. Select the licenses you want to activate.
  4. Select the license container from the Select CmContainer drop-down list.
  5. Click Activate Selected Licenses Now.
    The license transfer to your selected container starts immediately. This may take up to a few minutes.
    License Transfer In Progress
  6. When the transfer has been completed, a message appears. Click OK to close this message.
    License Transfer Completed
  7. In the WebDepot, go to My Licenses to see details of the licenses activated.
    My Licenses Page

Activating Licenses on Multiple USB Dongles#

If you received an activation link that includes multiple licenses, follow these steps to distribute them across multiple USB dongles:

  1. Connect a USB dongle to your computer.
  2. Open the activation link in a web browser on your computer, ensuring you have internet access.
    The WebDepot opens on the License Activation - Select CmContainer page.
    License Activation - Select CmContainer Page
  3. On the License Activation - Select CmContainer page, select the CmDongle activation method.
    The License Activation page opens.
    License Activation Page
  4. Select the license(s) you want to activate.
  5. Select the license container from the Select CmContainer drop-down list.
  6. Click Activate Selected Licenses Now.
    The license transfer to your selected container starts immediately. This may take up to a few minutes.
    License Transfer In Progress
  7. When the transfer has been completed, a message appears. Click OK to close this message.
    License Transfer Completed
  8. Connect the next dongle to your computer and repeat steps 4 to 7 to distribute the remaining licenses.

Activating Licenses Offline#

It is also possible to activate licenses on computers without internet access using a file-based license transfer. File-based license transfer can be used for both USB dongle and software licenses. This is a 3-step procedure:

  • Request
  • Update
  • Receive

A wizard in the CodeMeter WebDepot will guide you through the process.

Step 1: Request

  1. On a computer with internet access, open the activation link in a browser.
    The WebDepot opens on the License Activation - Select CmContainer page.License Activation - Select Container Page
  2. On the License Activation - Select CmContainer page, select the desired activation method:
    • CmDongle if you're using a USB dongle
    • CmActLicense if you want to bind the licenses to your computer
      The License Activation page opens.
      License Activation Page
  3. Click File-based license transfer.
  4. On the computer without internet access, open the CodeMeter Control Center.
    CodeMeter Control Center
  5. On the License tab, select the license container to which you want to transfer licenses.
  6. Click License Update.
    The CmFAS Assistant opens.
    CmFAS Assistant - Welcome Page
  7. Click Next.
    The Select Action page of the assistant opens.
    CmFAS Assistant - Select Action Page
  8. Select Create license request.
  9. Click Next.
    The Select File Name page of the assistant opens.
    CmFAS Assistant - Select File Name Page
  10. Specify the name of the request file and where to save it.
    The default file name is the serial number of the container used. You can change this if required.
  11. Click Commit.
    A message is displayed that the file has been created.
    CmFAS Assistant - Request File Creation Success
  12. Click Finish to exit the assistant.
  13. Transfer the request file to the computer with internet access, e.g., using a USB stick.
  14. In the WebDepot on the computer with internet access, select the request file.
    CodeMeter - Pick License Request File
  15. Click Start Activation Now.
    The Download Update page opens.
    CodeMeter - Download Update
  16. On the Download Update page, click Download License Update File Now to download the update file containing the new state of the license.
  17. Transfer the file to the computer without internet access, e.g., using a USB stick.

Step 2: Update

  1. On the computer without internet access, open the CodeMeter Control Center.
    CodeMeter Control Center
  2. On the License tab, select the license container to which you want to transfer the licenses.
  3. Click License Update.
    The CmFAS Assistant opens.
    CmFAS Assistant - Welcome Page
  4. Click Next.
    The Select Action page of the assistant opens.
    CmFAS Assistant - Select Action Page
  5. Select Import license update.
  6. Click Next.
    The Select File Name page of the assistant opens.
    CmFAS Assistant - Select File Name Page
  7. Select the update file you transferred to this computer before.
  8. Click Commit.
    A message is displayed that the update has been applied to the container.
    CmFAS Assistant - License Update File Import Success
  9. Click OK to close the message.
  10. Click Finish to exit the assistant.
    CmFAS Assistant - Finish License Update File Import
  11. In the CodeMeter Control Center, click License Update.
    The CmFAS Assistant opens.
    CmFAS Assistant - Welcome Page
  12. Click Next.
    The Select Action page of the assistant opens.
    Select Action Page of the CmFAS Assistant
  13. Select Create receipt.
  14. Click Next.
    The Select File Name page of the assistant opens.
    Select File Name Page of the CmFAS Assistant
  15. Specify the name of the receipt file and where to save it.
    The default file name is the serial number of the container used. You can change this if required.
  16. Click Commit.
    A message is displayed that the file has been created.
    CmFAS Assistant - Receipt File Creation Success
  17. Click Finish to exit the assistant.
  18. Transfer the receipt file to the computer with internet access, e.g., using a USB stick.

Step 3: Receipt

  1. In the WebDepot on the computer with internet access, click Next to go to the Upload Receipt page.
  2. On the Upload Receipt page, click Choose File to select the receipt file.
    WebDepot Upload Receipt Page
  3. Click Upload Receipt Now.
    A message is displayed that the license transfer has been completed.
    CodeMeter License Transfer Success
  4. Click OK to get back to the My Licenses page.
    Your activated licenses will be displayed.

CodeMeter Runtime#

The CodeMeter Runtime must be installed in order to use vTools.

Under Windows, the CodeMeter Runtime is installed automatically when using the pylon installer and selecting the Developer profile.

Under Linux, you have to manually install the CodeMeter Runtime. You can find Debian and RPM packages under \share\pylon.

In the CodeMeter Control Center, you can check your available vTool licenses and their validity. You can open it via the Windows Start menu.

License Validity#

If you install a new major version release of the pylon Software Suite, current demo licenses become invalid even if their usage period hasn't elapsed yet. In that case, you can request another demo license for the new pylon version. Evaluation licenses aren't tied to a specific pylon version and remain valid until their 180-day license period has elapsed. Runtime licenses remain valid indefinitely.

To check the time left until expiry of a demo or evaluation license:

  1. In the Workbench or Help menu, click vTool Licensing.
    The vTool Licensing tab of the Welcome to pylon dialog opens.
  2. On the My Licenses card, you will find an overview of all active licenses and the corresponding expiry dates.

General Restrictions#

  • vTools can't be used on virtual machines.
  • Demo licenses are tied to the pylon major version for which they were activated.