Difference between revisions of "Softlok Dongles"

From Tuflow
Jump to navigation Jump to search
(Created page with "=Introduction= This page contains a brief introduction to the Softlok dongles. =Installation= ==Installing CodeMeter RunTime Kit== The first step in using the Wibu licence is...")
 
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
This page contains a brief introduction to the Softlok dongles.
+
This page provides information pertaining to the Softlok (blue) dongles. These dongles are no longer issued as of August 2010 as the vendor after several requests could not provide 64-bit support, however they continue to be supported by future 32-bit versions of TUFLOW.  SoftLok dongles can be exchanged for a new WIBU (metal) dongle for a nominal fee (please contact <u>[mailto:sales@tuflow.com sales@tuflow.com]</u>). <br>
 +
 
 +
The [[Wibu_Dongles | WIBU (metal) dongles]] have several advantages over the Softlok dongles: <br>
 +
* Support for 64-bit platforms;
 +
* Network licence manager runs as a service (ie. the computer with the network dongle needs to be on, but no one needs to be logged in);
 +
* Much more flexible licensing options (for example, it is now possible to have a Network 10 TUFLOW licence with a Network 5 Multiple 2D Domains Module licence – with the SoftLok dongles a Network 10 Multiple 2D Domains Module would have to have been purchased);
 +
* Multiple WIBU dongles (local and/or network licensed) are accessible together (ie. if all licences from one dongle are taken, licences from other dongles are automatically checked and taken);
 +
* No network ghost licences (thus far!); and
 +
* No need for TUFLOW to control limiting of local licences (TUFLOW’s run key is not used if the number of CPUs/cores exceeds the local licence limit).
  
 
=Installation=
 
=Installation=
==Installing CodeMeter RunTime Kit==
+
==Installing a Softlok Standalone (Local) Dongle==
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>
+
To install the SoftLok software drivers that TUFLOW uses to access the dongles, download the latest drivers from https://www.tuflow.com/downloads/#tuflow. Make sure that “Dongle Drivers.003.zip” or later is used as there are known problems with earlier drivers.  Unzip the file and follow the steps below: <br>
The latest version can be downloaded from CodeMeter site:<br>
+
<li>To allow access to a SoftLok dongle the computer’s operating system requires a device driver that interfaces between TUFLOW and the dongle. Install the device driver by running '''sl2inst.exe''' found in the Dongle\Drivers\Install folder.  Depending on your permissions, you may need to be logged in as an Administrator.  The following dialogue appears:</li> <br>
[http://www.codemeter.de/us/service/downloads.html http://www.codemeter.de/us/service/downloads.html]
+
[[File:Softlok Driver.png]] <br>
 
<br>
 
<br>
The correct file to download is the '''CodeMeter Runtime Kit for Windows'''<br>
+
<li>Click on “Install” to install the drivers.  “Uninstall” is used to remove the drivers if you need to at a later date.</li>
[[File:CodeMeter RuntimeKit Download.jpg|400px]]
+
Alternatively, a command line version '''drvinst.exe''' is also provided.  Type ''drvinst install'' from a DOS window to install, or ''drvinst uninstall'' to remove the drivers.
 +
Please note if you move either of these programs to a different folder ensure to copy both of the driver files windrvr.vxd and windrvr.sys to the same folder.
 +
It is not necessary to reboot the computer – the drivers are available for use immediately.
 +
<li>Insert the TUFLOW SoftLok standalone dongle in the USB port.  This allows you to initiate several TUFLOW processes from this computer (subject to the licensing of your Standalone dongle, and computer hardware and processor limitations).
 +
If a TUFLOW SoftLok network dongle is also available across your network, the standalone dongle takes precedence.  That is, running TUFLOW from a computer with a standalone dongle does not take up a TUFLOW network dongle user site.</li>
 +
</ol>
 +
<ol>
 +
==Installing a Softlok Network Dongle ==
 +
 
 +
Note:  For the computer with the network dongle attached and for all computers accessing the network licence, first install the device drivers as described above.<br>
 +
Note:  If setting up a computer on the network to act as the host or server for the network dongle refer to [[ Softlok_Dongles#SoftLok Dongle Security Server | SoftLok Dongle Security Server]]. If setting up a computer that wishes to access the network dongle on the dongle server refer to [[ Softlok_Dongles#Client Computers | Client Computers]].
 +
 
 +
===SoftLok Dongle Security Server===
 +
Installation of a network dongle requires one computer on your network to be designated as the dongle security server.  This computer does not have to be the network server, but must be accessible by any other computer you plan to run TUFLOW on, and must be running Windows 95, 98, NT or 2000.  It must remain on and connected to the network at all times you wish to run TUFLOW, and have a parallel port.
 +
<li>Install the dongle security server software by running setup.exe in the Dongle\Server folder and follow the on screen prompts.  If you are running Windows NT or 2000, you must be logged in as Administrator.  The required device drivers as described in the previous section are automatically installed.
 +
Connect the TUFLOW network dongle to the USB port and start the dongle driver by selecting it from the Start menu (Start/Programs/Security Server/Security Server).  The following dialog box appears. </li>
 
<br>
 
<br>
 +
[[File:Softlok Security Server.png]] <br>
 
<br>
 
<br>
Once installed the configuration depends on if the TUFLOW licence is a Local or Network licenceFor a local licence, the dongle can now be inserted into the machine and TUFLOW simulations can be started.
+
<li>The first time the dongle security server software is run the program attempts to start for a few seconds and then fails because it has not yet been set upClick the Set up button and enter the server name or IP address (IP address is preferred as problems with server names that start with a number have been experienced), usually leave the port as 6666 (see note below) and click ''Apply'' and ''Close''.</li>
==Configuring Network Server==
+
'''Note: Some System Administrators have discovered that particular firewall and anti-virus software block port 6666 (popular amongst hackers apparently!)If problems occur in accessing a network dongle, try using another port numberThe port number may also need to be freed by your organisation’s IT department.'''<br>
If the TUFLOW licence is a network licence, the computer hosting the dongle will need to be configured as a TUFLOW serverThis is required even if the simulations are to be performed on the serverInstructions for configuring the network licence are detailed in the following page:<br>
 
[[WIBU_Configure_Network_Server | 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 machineOnce installed, CodeMeter needs to be configured to use the network licence.
 
Instructions for configuring the network licence are detailed in the following page:<br>
 
[[WIBU_Configure_Network_Client | WIBU Configure Network Client]]
 
=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.<br>
 
[[File:CM CM Stick Grey.jpg|20px]] --- Grey, No CM stick detected.<br>
 
[[File:CM CM Stick Green.jpg|20px]] --- Green, CM stick detected.<br>
 
 
<br>
 
<br>
A range of other colors are also available but not frequently used:<br>
+
[[File:Softlok Network Setup.png]] <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>
 
<br>
If the CodeMeter icon reamins grey (not detected) when the dongle is inserted, please follow the steps below:<br>
+
<li>Now click the ''Retry to start server'' button, which should successfully start the server.  (Note: there seems to be a problem with starting the server on machines with a name starting with a number.  Therefore, avoid these names or use the IP address.) Don’t worry about the message “IP Security not loaded” as this is set up later if required.  Now click ''OK'' to place the Security server in the system tray (icons at bottom right of taskbar). <br>
[[WIBU_Dongle_Not_Detected | WIBU Dongle Not Detected]]
+
You can at any time double click the Security Server icon to either change the settings or to view the current status as shown below.  Note that if the below is opened before any TUFLOW processes have been initiated, the Security Server shows no active keys (ie. the below is blank).  In this case, to check if the Security Server is working double click on TUFLOW.exe and one License in use should eventually appear along with the maximum number of licenses available. <br>
<br><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>
+
[[File:Softlok Activated Keys.png]] <br>
[[WIBU_Dongle_Not_Running | WIBU Dongle Not Running TUFLOW]]
+
<br>
<br><br>
+
<li>To close the dialog box and return it to the system tray click the ''close'' dialog button in the top right.  To stop the server click the ''Exit/Stop Server'' button. The Activated keys tab shows the current activity of the Security Server.  The ‘Index’ column indicates whether the dongle is being accessed.  The ‘Licenses in use’ column indicates how many TUFLOW processes are currently using the network dongle.  The ‘Max Licenses’ column shows the maximum number of licenses that can be allocated by the dongle.</li>
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]]
 
  
=Updating=
+
As of Build 2007-07-AA, the Security Server can be exited and restarted while there are simulations (of this build or later) underway.  This allows any ghost licences to be cleared (ghost licences are unreleased licences that occur on some networks when the network is disconnected from a computer running a TUFLOW simulation). TUFLOW Build 2007-07-AA or later enters a 3 minute holding pattern until a spare network licence becomes available.
There are a number of reasons that the Wibu licence may need to be updated, for example:
+
By default when first installed the dongle security server accepts TUFLOW processes from any other computer (or IP address)If you wish to control which computers can run TUFLOW this can be set up from the IP Security tab. Further documentation on this feature can be supplied upon request.<br>
* 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.<br>
 
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, if the dongle has not previously been coded for TUFLOW simulations or if the dongle has not been provided by BMT WBMUnless specified by the TUFLOW staff, the first option below is the correct one to chose.<br>
 
[[WIBU_Licence_Update_Request | Wibu licence update request (normal)]]<br>
 
 
<br>
 
<br>
If you have been provided with a blank dongle or are using a non BMT WBM dongle the TUFLOW producer code needs to be added when requesting the licence updateInstructions for creating a licence request for an uncoded or non BMT WBM dongle are provided belowIf asked by TUFLOW staff, please use the method below.<br>
+
[[File:Softlok Security Server Setup.png]] <br>
[[WIBU_Licence_Update_Request_Uncoded | Wibu licence update request (uncoded or blank dongle)]]<br>
+
<br>
 +
<li>The Setup tab allows you to change the IP address or name of the TUFLOW dongle server and also the port.  Normally port 6666 is used, but other ports may need to be tried as noted previously.  If the server name or port is changed, all computers that run TUFLOW also need to be changed as described in the following section.</li>
 +
<li>Checking the ''Run in system tray'' box allows the security server to run in the system tray.  </li>
 +
<li>Checking the ''Show starting Window'' box displays a dialog box when the server starts'''The usual procedure is to set the dongle security server to start automatically by placing it in the startup folder of the server.'''  This ensures that the dongle security server is always started in case the server is rebootedIn this case you can clear ‘Show starting Window’ checkbox to cause it to run in the system tray only.</li>
 +
<li>Click ''Apply'' and/or ''Save'' for any changes you make on the Setup tab.  The Security Server may need to be exited and restarted to effect the changes.</li>
 +
</ol>
 +
<ol>
 +
 
 +
===Client Computers===
  
 +
For the server or any other computer on the network to access the network dongle, the following steps are required: </li>
 +
<li>Follow the steps outlined for a Standalone Dongle (if not already done) as described above in [[ Softlok_Dongles#Installing a Softlok Standalone (Local) Dongle | Installing a Softlok Standalone (Local) Dongle]]. </li>
 +
<li>Run '''nsl2set.exe''' under Dongle\Drivers\NetSet to display the dialogue below. </li>
 +
<br>
 +
[[File:Softlok Client Computers.png]]<br>
 
<br>
 
<br>
After creating the licence update request, please email the created file ('''.WibuCmRaC''') to sales@tuflow.com.
+
<li>Enter the name or IP address of the dongle server and the Port (this must be the same as set for the server – default is 6666). </li>
 
+
<li>Click Apply and Exit. </li>
==Import a licence update==
+
You are now ready to access the network dongle from your computer.  To test if the network licence is working, double click on TUFLOW.exe.  The console window displays whether or not it can find a Standalone or Network dongle, and the modules valid for the licence.
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.
 
[[WIBU_Licence_Update_Import | Importing a Wibu licence update]]<br>
 
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!
 

Latest revision as of 11:20, 8 August 2024

Introduction

This page provides information pertaining to the Softlok (blue) dongles. These dongles are no longer issued as of August 2010 as the vendor after several requests could not provide 64-bit support, however they continue to be supported by future 32-bit versions of TUFLOW. SoftLok dongles can be exchanged for a new WIBU (metal) dongle for a nominal fee (please contact sales@tuflow.com).

The WIBU (metal) dongles have several advantages over the Softlok dongles:

  • Support for 64-bit platforms;
  • Network licence manager runs as a service (ie. the computer with the network dongle needs to be on, but no one needs to be logged in);
  • Much more flexible licensing options (for example, it is now possible to have a Network 10 TUFLOW licence with a Network 5 Multiple 2D Domains Module licence – with the SoftLok dongles a Network 10 Multiple 2D Domains Module would have to have been purchased);
  • Multiple WIBU dongles (local and/or network licensed) are accessible together (ie. if all licences from one dongle are taken, licences from other dongles are automatically checked and taken);
  • No network ghost licences (thus far!); and
  • No need for TUFLOW to control limiting of local licences (TUFLOW’s run key is not used if the number of CPUs/cores exceeds the local licence limit).

Installation

Installing a Softlok Standalone (Local) Dongle

To install the SoftLok software drivers that TUFLOW uses to access the dongles, download the latest drivers from https://www.tuflow.com/downloads/#tuflow. Make sure that “Dongle Drivers.003.zip” or later is used as there are known problems with earlier drivers. Unzip the file and follow the steps below:

  • To allow access to a SoftLok dongle the computer’s operating system requires a device driver that interfaces between TUFLOW and the dongle. Install the device driver by running sl2inst.exe found in the Dongle\Drivers\Install folder. Depending on your permissions, you may need to be logged in as an Administrator. The following dialogue appears:

  • Softlok Driver.png

  • Click on “Install” to install the drivers. “Uninstall” is used to remove the drivers if you need to at a later date.
  • Alternatively, a command line version drvinst.exe is also provided. Type drvinst install from a DOS window to install, or drvinst uninstall to remove the drivers. Please note if you move either of these programs to a different folder ensure to copy both of the driver files windrvr.vxd and windrvr.sys to the same folder. It is not necessary to reboot the computer – the drivers are available for use immediately.

  • Insert the TUFLOW SoftLok standalone dongle in the USB port. This allows you to initiate several TUFLOW processes from this computer (subject to the licensing of your Standalone dongle, and computer hardware and processor limitations). If a TUFLOW SoftLok network dongle is also available across your network, the standalone dongle takes precedence. That is, running TUFLOW from a computer with a standalone dongle does not take up a TUFLOW network dongle user site.
    1. Installing a Softlok Network Dongle

      Note: For the computer with the network dongle attached and for all computers accessing the network licence, first install the device drivers as described above.
      Note: If setting up a computer on the network to act as the host or server for the network dongle refer to SoftLok Dongle Security Server. If setting up a computer that wishes to access the network dongle on the dongle server refer to Client Computers.

      SoftLok Dongle Security Server

      Installation of a network dongle requires one computer on your network to be designated as the dongle security server. This computer does not have to be the network server, but must be accessible by any other computer you plan to run TUFLOW on, and must be running Windows 95, 98, NT or 2000. It must remain on and connected to the network at all times you wish to run TUFLOW, and have a parallel port.

    2. Install the dongle security server software by running setup.exe in the Dongle\Server folder and follow the on screen prompts. If you are running Windows NT or 2000, you must be logged in as Administrator. The required device drivers as described in the previous section are automatically installed. Connect the TUFLOW network dongle to the USB port and start the dongle driver by selecting it from the Start menu (Start/Programs/Security Server/Security Server). The following dialog box appears.

    3. Softlok Security Server.png

    4. The first time the dongle security server software is run the program attempts to start for a few seconds and then fails because it has not yet been set up. Click the Set up button and enter the server name or IP address (IP address is preferred as problems with server names that start with a number have been experienced), usually leave the port as 6666 (see note below) and click Apply and Close.
    5. Note: Some System Administrators have discovered that particular firewall and anti-virus software block port 6666 (popular amongst hackers apparently!). If problems occur in accessing a network dongle, try using another port number. The port number may also need to be freed by your organisation’s IT department.

      Softlok Network Setup.png

    6. Now click the Retry to start server button, which should successfully start the server. (Note: there seems to be a problem with starting the server on machines with a name starting with a number. Therefore, avoid these names or use the IP address.) Don’t worry about the message “IP Security not loaded” as this is set up later if required. Now click OK to place the Security server in the system tray (icons at bottom right of taskbar).
      You can at any time double click the Security Server icon to either change the settings or to view the current status as shown below. Note that if the below is opened before any TUFLOW processes have been initiated, the Security Server shows no active keys (ie. the below is blank). In this case, to check if the Security Server is working double click on TUFLOW.exe and one License in use should eventually appear along with the maximum number of licenses available.

      Softlok Activated Keys.png

    7. To close the dialog box and return it to the system tray click the close dialog button in the top right. To stop the server click the Exit/Stop Server button. The Activated keys tab shows the current activity of the Security Server. The ‘Index’ column indicates whether the dongle is being accessed. The ‘Licenses in use’ column indicates how many TUFLOW processes are currently using the network dongle. The ‘Max Licenses’ column shows the maximum number of licenses that can be allocated by the dongle.
    8. As of Build 2007-07-AA, the Security Server can be exited and restarted while there are simulations (of this build or later) underway. This allows any ghost licences to be cleared (ghost licences are unreleased licences that occur on some networks when the network is disconnected from a computer running a TUFLOW simulation). TUFLOW Build 2007-07-AA or later enters a 3 minute holding pattern until a spare network licence becomes available. By default when first installed the dongle security server accepts TUFLOW processes from any other computer (or IP address). If you wish to control which computers can run TUFLOW this can be set up from the IP Security tab. Further documentation on this feature can be supplied upon request.

      Softlok Security Server Setup.png

    9. The Setup tab allows you to change the IP address or name of the TUFLOW dongle server and also the port. Normally port 6666 is used, but other ports may need to be tried as noted previously. If the server name or port is changed, all computers that run TUFLOW also need to be changed as described in the following section.
    10. Checking the Run in system tray box allows the security server to run in the system tray.
    11. Checking the Show starting Window box displays a dialog box when the server starts. The usual procedure is to set the dongle security server to start automatically by placing it in the startup folder of the server. This ensures that the dongle security server is always started in case the server is rebooted. In this case you can clear ‘Show starting Window’ checkbox to cause it to run in the system tray only.
    12. Click Apply and/or Save for any changes you make on the Setup tab. The Security Server may need to be exited and restarted to effect the changes.

      Client Computers

      For the server or any other computer on the network to access the network dongle, the following steps are required:
    1. Follow the steps outlined for a Standalone Dongle (if not already done) as described above in Installing a Softlok Standalone (Local) Dongle.
    2. Run nsl2set.exe under Dongle\Drivers\NetSet to display the dialogue below.

    3. Softlok Client Computers.png

    4. Enter the name or IP address of the dongle server and the Port (this must be the same as set for the server – default is 6666).
    5. Click Apply and Exit.
    6. You are now ready to access the network dongle from your computer. To test if the network licence is working, double click on TUFLOW.exe. The console window displays whether or not it can find a Standalone or Network dongle, and the modules valid for the licence.