TUFLOW Licensing
Introduction
A TUFLOW FV licence is required to run TUFLOW FV, except when running TUFLOW FV demo, tutorial or example models in licence free mode.
For further licensing information, please contact sales@tuflow.com.
Licence Options
TUFLOW products use WIBU CodeMeter locks for licensing, available in three forms:
- WIBU Hardware Lock (USB Dongle): WIBU hardware locks are physical dongles (USB-2) that contain TUFLOW licences. Licences are coded onto the dongle and can be moved between computers. WIBU hardware locks are recognised by the 2006-06-BD release onwards.
- WIBU Software Lock: WIBU software locks are coded onto the computer's or server's motherboard, it cannot be transferred to a different host. WIBU software locks are recognised by the 2016-03-AF release onwards.
- WIBU Cloud Licence: WIBU cloud licences are hosting on the WIBU cloud server. An internet connection is required to access a cloud licence. WIBU Cloud licences are recognised by the 2016-03-AF release onwards.
Note Legacy Licence Type (Softlok Dongle): As of August 2010, Softlok USB dongles are no longer issued or supported due to the dongle provider not supporting 64-bit. For TUFLOW release versions 2009-07, 2008-08, 2007-07 and 2006-06, the “DB” build or later will need to be used to function with a WIBU Codemeter dongle hardware lock. Also, upgrade to release version 2016-03-AF or newer is required if WIBU Software or Cloud locks are being used for the licencing.
Installing CodeMeter RunTime Kit
The first step when using a Wibu licence for TUFLOW FV modelling is to install CodeMeter User Runtime on every computer that will be running TUFLOW FV or acting as a network licence server.
Licence Hosting Options
After installing the CodeMeter RunTime Kit, select a hosting option based on your requirements. For more information, please refer to Frequently Asked Questions or contact sales@tuflow.com.
Licence Free Mode
A licence free mode has been built into TUFLOW. For information outlining the limits associated with the licence free mode, see TUFLOW FV Free DEMO Version Guide.
Local Licence
In this form, the licence is tied to a specific computer. TUFLOW FV simulations can only be run on the computer hosting the licence lock. For installation guidance see:
- Local Licence Hardware Lock (USB) Installation Guide
- Local Licence Software Lock (Digital) Installation Guide
Network Licence
In this form, the licence can be hosted on any server or computer. Other devices can utilise the available licences from the host computer via a company’s network. For installation guidance see:
- Network Licence Hardware Lock (USB) Installation Guide
- Network Licence Software Lock (Digital) Installation Guide
Cloud Licence
In this form, the licence is hosted on a Wibu cloud server. For installation guidance see:
- Cloud Direct Licence Installation Guide: All modelling computers link directly to the WIBU server over an internet connection.
- Cloud Server Licence Installation Guide: A company server acts as the licence host, linked to the WIBU server over an internet connection. Modelling computers are connected to the company server via the company’s network.
Updating a Licence
This section will cover the process of updating a licence, including requesting and importing a licence update. There are a number of reasons that the Wibu licence may need to be updated, for example:
- To add additional licences.
- To update to new support year.
- To add rental licences.
For each change to the dongle, it will be necessary to provide a licence update request file to the TUFLOW staff (sales@tuflow.com). The procedure is the same for local and network licences, the request will need to be generated from the computer which has the licence container (eg. USB-2 hardware lock, software lock).
Request a Licence Update
The instructions for creating a licence request differ slightly depending on the licence container type and operating system.
Hardware Licence (USB)
- Wibu licence update request for Windows (normal) - Unless specified otherwise by the TUFLOW staff, this option is the correct one for a USB-2 hardware lock.
- Wibu licence update request for Windows (uncoded or blank dongle) - If you have been provided with a blank dongle or are using a non BMT dongle the TUFLOW producer code needs to be added when requesting the licence update.
- Wibu licence update request for Linux
Software Licence (Digital)
After creating the licence update request, please email the created file (.WibuCmRaC) to sales@tuflow.com.
Cloud Licence
- Contact sales@tuflow.com.
Import a Licence Update
Once a licence update has been created, an update file will be provided to you via email. This update file will have the extension .WibuCmRaU. When an update is applied, this modifies the contents of the licence container (eg. USB-2 hardware lock, software lock), it does not need to be applied on each computer that will be used for TUFLOW FV modelling.
Hardware Licence (USB)
Software Licence (Digital)
Cloud Licence
Configuring Licence
Configuring Network Server
If the TUFLOW licence is a network licence, the computer hosting the dongle will need to be configured as a TUFLOW server. This is required even if the simulations are to be performed on the server. Instructions for configuring the network licence are detailed in the following page:
Configuring Access to Network Licence
To access TUFLOW licences on a remote network server, the CodeMeter runtime kit needs to be installed on the client machine. Once installed, CodeMeter needs to be configured to use the network licence.
Instructions for configuring the network licence are detailed in the following page:
Diagnostics
cmDust
When the CodeMeter Runtime Kit is installed a diagnostics utility call cmDust is also installed. The following link provides instructions how to create a diagnostics file. This file may be request by support@tuflow.com when solutions to licensing issues are being investigated:
Enabling Logging
Codemeter allows you to write extended log files to your local drive. The following link provides instructions how to enable this feature:
Enabling Network Server License Monitoring
Codemeter allows you to conduct real-time licence network monitoring. The following link provides instructions how to enable this feature:
Troubleshooting
- Hardware (USB) Dongle Not Working Correctly Note this page is hosted on the TUFLOW Wiki.
- Network Connectivity Issue
- Network Server Issue
- Unable to Remove Licence Container Note this page is hosted on the TUFLOW Wiki.
- Unable to Connect to Cloud Licence
Frequently Asked Questions (FAQ)
How many simulations can be run at the same time?
The number of licences reflect how many TUFLOW FV simulations can be run in parallel at any given time. For example, a Local 4 can run 4 simulations at the same time on the one computer. A Network 5 allows up to 5 simulations at any one time across an organisation’s network. If all licences are in use when a TUFLOW FV simulation starts, the simulation enters a holding pattern until a free licence is available.
What is the best licence for me?
Hardware (USB) vs. Software (Digital)
The advantage of a hardware (USB) lock is that it is portable and not tied to a specific computer. You can unplug it and plug it into another computer.
A software lock is tied to a specific computer and cannot be moved once bound to that computer. The advantage of a software lock however is that it can be installed on a computer that you don't have physical access to, and it doesn't require a free USB port.
Local vs. Network
The advantage of a local lock is that you only need CodeMeter installed on the computer that will be running your TUFLOW FV software, and the required configuration will be minimal. No network access beyond this computer is required. The lock is either installed directly on this local CodeMeter, as a software lock, or CodeMeter will pick up an inserted hardware lock automatically.
The advantage of a network lock is that you can host multiple licences in a single place (called the CodeMeter Network Server). Licences are shared to client (modelling) computers from the server over your network. To function, these computers need to be able to access the Network Server over port 22350, which may require some co-operation of your IT staff to configure.
Cloud vs. Non-Cloud
The advantage of a Cloud licence is that you can set it up on as many machines as you like, and reuse it on future machines, for as long as the licence is valid. This gives you a similar advantage to using a Network Licence, without the complexity of network connectivity. Another benefit of this is that you can put the licence on computers that are not connected to your local network. A potential disadvantage of a Cloud licence can be the requirement that the computer it is installed on has https (web) internet access to `wibu.cloud`. It is worth noting that currently the monitoring of Cloud licence usage is not as mature as the monitoring of network licences.
Conclusion
If you have any queries, feedback or requests, please contact sales@tuflow.com or support@tuflow.com.
If you wish to keep up-to-date with all things TUFLOW and TUFLOW FV, then please join our LinkedIn group.