|
=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.<br>
This page contains a brief introduction to the Wibu dongles.
* '''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.<br>
The following pages provide details how to install, update and manage TUFLOW licences using all of the above forms.
<br>
<br>
=Installation=
==Installing CodeMeter RunTime Kit==
The first step in using the Wibu licence is to install the CodeMeter Runtime Kit. This needs to be installed for any computers that will be running TUFLOW (from either local or network licence) as well as for the network licence server.<br>
If you are installing on a Linux computer from the command line, refer to <u>[[Installing_Wibu_CodeMeter_Linux|Installing Wibu CodeMeter Linux]]</u>.<br>
The latest version can be downloaded from CodeMeter site:<br>
<u>[https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]</u>
<br>
The correct file to download is the '''CodeMeter Runtime Kit for Windows'''<br>
[[File:CodeMeter RuntimeKit Download.jpg|400px]]
<br>
<br>
Once installed the configuration depends on if the TUFLOW licence is a Local or Network 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 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.
=Installation of CodeMeter RunTime Kit=
===Silent Install===
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.
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>
<tt>CodeMeterRuntime.exe /ComponentArgs "*":"/qn"</tt>
==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:<br>
*<u>[[WIBU_Configure_Network_Server_2016| WIBU Configure Network Server]]</u>
==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:<br>
*<u>[[WIBU_Configure_Network_Client_2016| WIBU Configure Network Client]]</u>
* <u>[[Installing_Wibu_CodeMeter_Windows|Installing Wibu CodeMeter Windows]]</u>.
* <u>[[Installing_Wibu_CodeMeter_Linux|Installing Wibu CodeMeter Linux]]</u>.
<br>
=Updating a Licence=
There are a number of reasons that the Wibu licence may need to be updated, for example:
* To add additional moduleslicences
* 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> 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 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.
The instructions for creating a licence request differ slightly depending on the licence container type and operating system. <br>
==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>
'''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 tofor chosea (please clickUSB-2 thehardware link to the right): <u>[[WIBU_Licence_Update_Request | Wibu licence update request (normal)]]</u>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: <u>[[WIBU_Licence_Update_Request_Uncoded | Wibu licence update request (uncoded or blank dongle)]]</u>.<br>
* <u>[[WIBU_Licence_for_Linux | Wibu licence update request for Linux]]</u>
'''Software Licence (File)''' <br>
* If you would like a software licence instead of a hardware licence: <u>[[WIBU_Software_Licence_Update_Request | Wibu software licence update request for Windows]]</u>
* <u>[[WIBU_Licence_for_Linux | Wibu software licence update request for Linux]]</u>
After creating the licence update request, please email the created file ('''.WibuCmRaC''') to sales@tuflow.com.
After creating the licence update request, please email the created file ('''.WibuCmRaC''') to <u>[mailto:sales@tuflow.com sales@tuflow.com]</u>.<br>
'''Cloud Licence''' <br>
* Contact <u>[mailto:sales@tuflow.com sales@tuflow.com]</u>.
==Import a licenceLicence updateUpdate==
Once a licence update has been created, an update file will be provideprovided to you via email. This update file will have the extension '''.WibuCmRaU'''. When Toan importupdate theis fileapplied, pleasethis followmodifies the stepscontents below,of the samelicence methodcontainer is(eg. usedUSB-2 forhardware networklock, andsoftware locallock), licences.it does not need to be applied on each computer that will be used for TUFLOW modelling!<br><br>
'''Hardware Licence (USB)'''
[[WIBU_Licence_Update_Import | Importing a Wibu licence update]]<br>
* <u>[[WIBU_Licence_Update_Import | Importing a Wibu licence update for Windows]]</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!
* <u>[[WIBU_Licence_for_Linux | Importing a Wibu licence update request for Linux]]</u>
'''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>
<br>
=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:<br>
*<u>[[WIBU_Configure_Network_Server| WIBU Configure Network Server]]</u>
==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:<br>
*<u>[[WIBU_Configure_Network_Client| WIBU Configure Network Client]]</u>
<br>
=Troubleshooting=
==*<u>[[WIBU_Dongle_Not_Working_Correctly | Hardware (USB) Dongle Not Working Correctly==]]</u>
*<u>[[WIBU_Configure_Network_Client#Troubleshooting | Network Connectivity Issue]]</u>
If the drivers have been installed, the colour of the CodeMeter icon in the taskbar indicates if a dongle is being detected correctly.<br>
*<u>[[WIBU_Configure_Network_Server#Troubleshooting | Network Server Issue]]</u>
[[File:CM CM Stick Grey.jpg|20px]] --- Grey, No CM stick detected.<br>
*<u>[[WIBU_Unable_to_Remove_Licence_Container | Unable to Remove Licence Container]]</u>
[[File:CM CM Stick Green.jpg|20px]] --- Green, CM stick detected.<br>
*<u>[[WIBU_Cloud_Licence_Import#Troubleshooting|Unable to Connect to Cloud Licence]]</u>
<br>
A range of other colors are also available but not frequently used:<br>
[[File:CM CM Stick Yellow.jpg|20px]] --- Yellow, CM stick enabled until unplugged (password protected).<br>
[[File:CM CM Stick Red.jpg|20px]] --- Red, CM stick disabled (password protected).<br>
[[File:CM CM Stick Blue.jpg|20px]] --- Blue, Multiple CM sticks.<br>
<br>
If the CodeMeter icon remains grey (not detected) when the dongle is inserted, please follow the steps below:<br>
[[WIBU_Dongle_Not_Detected | WIBU Dongle Not Detected]]
<br><br>
If the dongle is correctly detected (the icon changes colour to green), but you are unable to run a TUFLOW simulation, please follow the steps below:<br>
[[WIBU_Dongle_Not_Running | WIBU Dongle Not Running TUFLOW]]
<br><br>
If you are having trouble accessing a network dongle from a remote computer, please follow the steps below:<br>
[[WIBU_Network_Dongle_Connectivity | WIBU Network Dongle Issues]]
<br>
<br>
==Diagnostics==
===cmDust===
When the CodeMeter runtimeRuntime kitKit is installed a diagnostics utility call '''cmDust''' is also installed. InstructionsThe forfollowing creatinglink provides instructions how to create a diagnostics file. This file canmay be foundrequest onby <u>[[WIBU_create_cmDustmailto:support@tuflow.com | create CM Dust diagnostics file]support@tuflow.com]</u> page.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 youyour local drive. ToThe setupfollowing theselink featuresprovides pleaseinstructions followhow theto instructionenable onthis our [[Codemeter_Enable_Logging | Enable Codemeter Logging]] page.feature:
* <u>[[Codemeter_Enable_Logging |Enable Codemeter Logging]]</u>
=== Enabling Network Server License Monitoring===
Codemeter allows you to conduct real-time licence network monitoring. To setupThe thesefollowing featureslink pleaseprovides seeinstructions ourhow [[Network_Server_License_Monitoringto |enable Networkthis License Monitoring]] pagefeature:
* <u>[[Network_Server_License_Monitoring | Network License Monitoring]]</u>
<br>
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}
|