Revision as of 13:33, 29 July 2021

Introduction

This page contains a brief introduction to the Wibu dongles.

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.
If you are installing on a Linux computer from the command line, refer to Installing Wibu CodeMeter Linux.
The latest version can be downloaded from CodeMeter site:
https://www.wibu.com/support/user/downloads-user-software.html
The correct file to download is the CodeMeter Runtime Kit for Windows

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 Request a licence update 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 configure network server and configure network access 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:
CodeMeterRuntime.exe /ComponentArgs "*":"/qn"

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:

Updating

There are a number of reasons that the Wibu licence may need to be updated, for example:

To add additional modules
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 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.
Hardware Licence (USB)

Unless specified otherwise by the TUFLOW staff, this option is the correct one to chose (please click the link to the right): Wibu licence update request (normal)
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 (uncoded or blank dongle)

Software Licence (File)

If you would like a software licence instead of a hardware licence: Wibu software licence update request

After creating the licence update request, please email the created file (.WibuCmRaC) to sales@tuflow.com.

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. To import the file please follow the steps below, the same method is used for network and local licences. Importing a Wibu licence update
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!

Troubleshooting

Dongle Not Working Correctly

If the drivers have been installed, the colour of the CodeMeter icon in the taskbar indicates if a dongle is being detected correctly.
--- Grey, No CM stick detected.
--- Green, CM stick detected.

A range of other colors are also available but not frequently used:
--- Yellow, CM stick enabled until unplugged (password protected).
--- Red, CM stick disabled (password protected).
--- Blue, Multiple CM sticks.

If the CodeMeter icon remains grey (not detected) when the dongle is inserted, please follow the steps below:
WIBU Dongle Not Detected

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:
WIBU Dongle Not Running TUFLOW

If you are having trouble accessing a network dongle from a remote computer, please follow the steps below:
WIBU Network Dongle Issues

Diagnostics

cmDust

When the CodeMeter runtime kit is installed a diagnostics utility call cmDust is also installed. Instructions for creating a diagnostics file can be found on create CM Dust diagnostics file page.

Enabling Logging

Codemeter allows you to write extended log files to you local drive. To setup these features please follow the instruction on our Enable Codemeter Logging page.

Enabling Network Server License Monitoring

Codemeter allows you to conduct real-time licence network monitoring. To setup these features please see our Network License Monitoring page

@@ Line 69: / Line 69: @@
 [[File:CM CM Stick Blue.jpg|20px]] --- Blue, Multiple CM sticks.<br>
 <br>
-If the CodeMeter icon reamins grey (not detected) when the dongle is inserted, please follow the steps below:<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>
@@ Line 79: / Line 79: @@
 <br>
 <br>
 =Diagnostics=
 ==cmDust==

Difference between revisions of "Wibu Dongles"