Revision as of 14:41, 4 December 2024

Introduction

TUFLOW Products are licenced via Wibu Codemeter locks, available in three forms; WIBU USB-2 Dongles (Hardware lock), WIBU Software Licences (Software lock) and WIBU Cloud locks.

WIBU Hardware Lock: 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.

The following pages provide details how to install, update and manage TUFLOW licences using all of the above forms.

Installation

Installing CodeMeter RunTime Kit

The first step when using a Wibu licence for TUFLOW modelling is to install CodeMeter User Runtime. It needs to be installed for all computers that will be running TUFLOW or configured as a network licence server.
The latest version of CodeMeter User Runtime can be downloaded from:

https://www.wibu.com/support/user/downloads-user-software.html

Installing CodeMeter RunTime Kit for Windows

Download the latest CodeMeter Runtime Kit for Windows installer

Install the software

If a computer is used as network licence server, please select the "Network Server" option during the installation. Selecting this option will configure the appropriate TCP and UDP protocols in the Windows Firewall.

Silent Install

It is possible to do a silent install of the CodeMeter Runtime kit. CodeMeter support staff have advised that this can be done with the following parameters:
CodeMeterRuntime.exe /ComponentArgs "*":"/qn"

Installing CodeMeter RunTime Kit for Linux

If you are installing on a Linux computer from the command line, refer to:

Installing Wibu CodeMeter Linux.

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:

WIBU Configure Network Server

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:

WIBU Configure Network Client

Updating

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. 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 (File)

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 modelling!

Hardware Licence (USB)

Software Licence (File)

Importing a Wibu licence update for Windows

Cloud Licence

Importing a WIBU Cloud Licence

Troubleshooting

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:

Create CM Dust Diagnostics File

Enabling Logging

Codemeter allows you to write extended log files to your local drive. The following link provides instructions how to enable this feature:

Enable Codemeter Logging

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:

Network License Monitoring

Up
Back to Wiki Main Page

@@ Line 1: / Line 1: @@
 =Introduction=
-TUFLOW Products are licenced via Codemeter locks, available in three forms; WIBU USB-2 Dongles (Hardware lock), WIBU Software Licences (Software lock) and WIBU Cloud locks.<br>
+TUFLOW Products are licenced via Wibu Codemeter locks, available in three forms; WIBU USB-2 Dongles (Hardware lock), WIBU Software Licences (Software lock) and WIBU Cloud locks.<br>
 * '''WIBU Hardware Lock''': 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.
@@ Line 8: / Line 8: @@
 =Installation=
 ==Installing CodeMeter RunTime Kit==
-The first step in using the Wibu licence is to install CodeMeter User Runtime.  This needs to be installed for any computers that will be running TUFLOW as well as for the network licence server.<br>
+The first step when using a Wibu licence for TUFLOW modelling is to install CodeMeter User Runtime. It needs to be installed for all computers that will be running TUFLOW or configured as a network licence server.<br>
-The latest version of CodeMeter can be downloaded from CodeMeter site:<br>
+The latest version of CodeMeter User Runtime can be downloaded from:<br>
 * <u>[https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]</u>
+=== Installing CodeMeter RunTime Kit for Windows ===
 <br>
-The correct file to download is the '''CodeMeter Runtime Kit for Windows'''<br>
+Download the latest CodeMeter Runtime Kit for Windows installer<br>
 [[File:CodeMeter_RuntimeKit_Download_02.png|550px]]
-<br>
+<br>Install the software
-If a computer is used as network license server, please select the "Network Server" option during the installation, so that CodeMeter can configure TCP and UDP protocols in the Windows Firewall.<br>
+If a computer is used as network licence server, please select the "Network Server" option during the installation. Selecting this option will configure the appropriate TCP and UDP protocols in the Windows Firewall.<br>
 [[File:CodeMeter_Network_Server_install_02.png|550px]]
 <br>
-<br>
-Once installed the configuration depends on if the TUFLOW licence is a local, network or software licence.
-* If this is the first time the licence has been used, or your existing licence has expired. You will need to update your licence file. Please progress to the <u>[[#Request_a_licence_update| Request a licence update]]</u> section
-* If there is already an active licence associated with the dongle:
-:* For a local licence, the dongle can now be inserted into the machine and TUFLOW simulations can be started.
-:* For a network and software licence, continue to the <u>[[#Configuring_Network_Server | configure network server]]</u> and <u>[[#Configuring_Access_to_Network Licence | configure network access]]</u> sections below.
 ===Silent Install===
 It is possible to do a silent install of the CodeMeter Runtime kit.  CodeMeter support staff have advised that this can be done with the following parameters:<br>
@@ Line 45: / Line 41: @@
 =Updating=
 There are a number of reasons that the Wibu licence may need to be updated, for example:
-* To add additional modules
+* 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.<br>
+For each change to the dongle, it will be necessary to provide a licence update request file to the TUFLOW staff. 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).
-The procedure is the same for local and network licences, the request will need to be generated from the computer which has the dongle plugged in.
 ==Request a licence update==
-The instructions for creating a licence request differ slightly depending whether the dongle has not previously been coded for TUFLOW simulations or if the dongle has not been provided by BMT.  <br>
+The instructions for creating a licence request differ slightly depending on the  licence container type and operating system.  <br>
 '''Hardware Licence (USB)''' <br>
-* <u>[[WIBU_Licence_Update_Request | Wibu licence update request for Windows (normal)]]</u> - Unless specified otherwise by the TUFLOW staff, this option is the correct one to chose.
+* <u>[[WIBU_Licence_Update_Request | Wibu licence update request for Windows (normal)]]</u> - Unless specified otherwise by the TUFLOW staff, this option is the correct one for a  USB-2 hardware lock.
 * <u>[[WIBU_Licence_Update_Request_Uncoded | Wibu licence update request for Windows (uncoded or blank dongle)]]</u> - 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.<br>
 * <u>[[WIBU_Licence_for_Linux | Wibu licence update request for Linux]]</u>
@@ Line 64: / Line 59: @@
 ==Import a licence update==
-Once a licence update has been created, an update file will be provide to you via email.  This update file will have the extension '''.WibuCmRaU'''. The same method is used for network, local and software licences.<br><br>
+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 modelling!<br><br>
 '''Hardware Licence (USB)'''
 * <u>[[WIBU_Licence_Update_Import | Importing a Wibu licence update for Windows]]</u>
 * <u>[[WIBU_Licence_for_Linux | Importing a Wibu licence update request for Linux]]</u>
-When an update is applied, this modifies the content of the dongle, it does not need to be applied on each computer that will be used for TUFLOW modelling!<br>
+<br>
 '''Software Licence (File)'''
 * <u>[[WIBU_Licence_Update_Softlock_Import |Importing a Wibu licence update for Windows]]</u><br>
 '''Cloud Licence'''
-* <u>[[WIBU_Cloud_Licence_Import | Importing a WIBU Cloud Licence]]</u>.
+* <u>[[WIBU_Cloud_Licence_Import | Importing a WIBU Cloud Licence]]</u>
 <br>
@@ Line 84: / Line 79: @@
 ==Diagnostics==
 ===cmDust===
-When the CodeMeter runtime kit is installed a diagnostics utility call '''cmDust''' is also installed.  Instructions for creating a diagnostics file:
+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 <u>support@tuflow.com</u> when solutions to licensing issues are being investigated:
 * <u>[[WIBU_create_cmDust | Create CM Dust Diagnostics File]]</u>
 ===Enabling Logging===
-Codemeter allows you to write extended log files to you local drive. To setup these features:
+Codemeter allows you to write extended log files to your local drive. The following link provides instructions how to enable this feature:
-* <u>[[Codemeter_Enable_Logging | Enable Codemeter Logging]]</u>
+* <u>[[Codemeter_Enable_Logging |Enable Codemeter Logging]]</u>
 === Enabling Network Server License Monitoring===
-Codemeter allows you to conduct real-time licence network monitoring. To setup these features:
+Codemeter allows you to conduct real-time licence network monitoring.  The following link provides instructions how to enable this feature:
 * <u>[[Network_Server_License_Monitoring | Network License Monitoring]]</u>

Difference between revisions of "Wibu Dongles"