OVERVIEW CODEMETER.

Transcription

1 OVERVIEW CODEMETER

2 Copyright: 2014 PTV AG, Karlsruhe PTV Visum is a trademark of PTV AG PTV Vissim is a trademark of PTV AG PTV Viswalk is a trademark of PTV AG PTV Vistro is a trademark of PTV AG All brand or product names in this documentation are trademarks or registered trademarks of the corresponding companies or organizations. All rights reserved. Disclaimer: The information contained in this document is subject to change without notice and should not be construed as a commitment on the part of the vendor. This document may not be used for any other purpose than the personal use of the purchaser. No part of this handbook may be reproduced, stored in a retrieval system, or transmitted, in any form, or by any means, electronic, mechanical, photocopying, recording, or otherwise, edited or translated, except as permitted under the terms of the copyright, without the prior written permission of PTV AG. Impressum - legal notice: PTV AG Traffic Software Haid-und-Neu-Straße 15 D Karlsruhe Germany Tel Fax info@vision.ptvgroup.com PTV AG, Karlsruhe Overview CodeMeter PTV AG 2

3 1 Table of Content 1 Table of Content 3 2 Update of the CodeMeter Runtime Kit Which version is in use? How to update the CodeMeter Runtime Kit? 4 3 Set up CodeMeter as dongle server Conditions Setting up the corresponding CodeMeter software Starting the CodeMeter server 8 4 CodeMeter server Conditions Connecting one CodeMeter dongle Connecting several CodeMeter dongles Starting the Vision Traffic software Reliable check of connection between Client and Server 17 5 Error handling Licence key not found CodeMeter error 18 6 Remote programming of the dongle Creating a context file Applying a context update file Update the firmware of the CodeMeter dongle Proxy Settings 25 7 Support Direct Support Indirect Support 27 Overview CodeMeter PTV AG 3

4 Update of the CodeMeter Runtime Kit 2 Update of the CodeMeter Runtime Kit With the introduction of PTV Visum 14 and PTV Vissim 7 respectively, we have introduced a new version of the CodeMeter Runtime Kit. The software now requires version 5.10c of the Runtime Kit. 2.1 Which version is in use? To find out the currently used version of the Runtime Kit, use one of the following options: 1. Make a right click on the CodeMeter symbol in Windows s system tray in the lower right corner of the screen. Select the entry About of the context menu. The following dialog shows the version number of the currently used Runtime Kit. 2. Open up the CodeMeter Control Center from the start menu: Start -> Programs -> CodeMeter -> CodeMeter Control Center In the menu Help chose the entry About. The following dialog shows the version number of the currently used Runtime Kit. 3. Open up the CodeMeter WebAdmin, e.g. from the CodeMeter Control Center, Button WebAdmin in the lower right corner or from the CodeMeter symbol in Windows s system tray in the lower right corner of the screen. Make a right click on it and select WebAdmin. In the Home section of the WebAdmin, the Server version will be displayed. 4. Create a so called CmDust report, see chapter 7.1 and send it to the Traffic Customer Service: customerservice@vision.ptvgroup.com 2.2 How to update the CodeMeter Runtime Kit? The latest version of the CodeMeter Runtime Kit can be retrieved from the webpage of the manufacturer WIBU SYSTEMS AG under In the Downloads section, the manufacturer provides the latest installers of the Runtime Kit for free. There are installers for Windows, 32bit and 64bit operating system, Linux and Mac OS X. Linux and Mac OS X can only be used for dongle servers. The choice of 32bit or 64bit depends on the operating system and not on the edition of the Vision Traffic software. After the installation of a new version of the Runtime Kit, it is required to reboot the computer. We do not recommend to use the latest version of the CodeMeter Runtime Kit. Instead, we strongly recommend the use of version 5.10c of the Runtime Kit. You can download it from our web server. Overview CodeMeter PTV AG 4

5 Set up CodeMeter as dongle server 3 Set up CodeMeter as dongle server In this chapter, we would like to inform you of the requirements to run your CodeMeter dongle as a server dongle within your network. 3.1 Conditions The CodeMeter dongle requires the software CodeMeter Runtime Kit, which is available on the web site of CodeMeter 1. The CodeMeter Runtime Kit software is available for 32bit and 64bit architectures. Usually, this software will be installed during the default Vision Traffic software setup process. During the default installation of a Vision Traffic product, a CodeMeter start menu entry will be created. The corresponding software is started each time you start up your Microsoft Windows operating system. The CodeMeter software can be identified through a small icon in the Windows status bar, on bottom right of the desktop. The corresponding CodeMeter software is independent of the Vision Traffic software and can be installed on any computer (see chapter 3.2). The computer which shall serve as a dongle server must have an USB interface and a Microsoft Windows operating system installed. It is not possible to virtualize the server! Usually, an operating system uses a so-called firewall to protect itself. It permits or denies network access according to certain rules. If a firewall is active on your PC (this is by default the case for Microsoft Windows XP and other operating systems), you have to check whether or not it permits incoming and outgoing access on port for all clients on which the Vision Traffic software will be run. Please note: it is a security issue to permit network access. If you are not sure what to do, please contact the administrator of the firewall or an IT specialist. 3.2 Setting up the corresponding CodeMeter software The CodeMeter Runtime Kit which is required for use of the CodeMeter dongle is usually installed during the Vision Traffic software setup process. If you wish to run the CodeMeter dongle on another computer, where the Vision Traffic software is not installed (e.g. a server), simply install the corresponding CodeMeter software manually. This software is independent from the use of any Vision Traffic software. Just navigate to the directory Installers\win32x64\wibu on the installation DVD included in your delivery. Start the setup of the software by a double-click. Alternatively, visit the web site of the manufacturer 1 and download the corresponding version of the software. Double-click the CodeMeterRuntime.exe file to start the installation process.. Then click the 1 Overview CodeMeter PTV AG 5

6 Set up CodeMeter as dongle server Next button. Independent on how much CodeMeter dongles will be plugged to the server, the software has to be installed just once. Figure 1: CodeMeter setup process, dialog 1 Figure 2: CodeMeter setup process, dialog 2 Please accept the license agreement shown in Figure 2. Then click the Next button again. Overview CodeMeter PTV AG 6

7 Set up CodeMeter as dongle server Figure 3: CodeMeter setup process, dialog 3 In the window shown in Figure 3, please enter your name and the name of your organization. You can choose to install the software for an individual or anyone using the machine. It is recommended to choose the option for anyone. Then, click the Next button again. Figure 4: CodeMeter setup process, dialog 4 In the window shown in Figure 4, please confirm the settings. Then click the Next button. The installation process may take a couple of minutes. Overview CodeMeter PTV AG 7

8 Set up CodeMeter as dongle server Figure 5: CodeMeter setup process, dialog 5 If the CodeMeter software is successfully installed, another window is opened (see Figure 5). After you click the Finish button, you might be asked to restart your computer. 3.3 Starting the CodeMeter server After you have successfully installed the CodeMeter software and restarted your computer, a new grey symbol will appear in the Windows status bar, on the bottom right of the desktop. This means the software has been started, but has not yet found a valid Code- Meter dongle. As soon as you plug in the CodeMeter dongle, the corresponding software will recognize it and the status of the symbol changes to. By default, the CodeMeter software will not be set up for a server. Servers which are not configured reduce the performance of your computer network! To set up the dongle server, right-click the CodeMeter symbol on the status bar, on the bottom right of the desktop. A context menu will be shown. Choose the WebAdmin entry (see Figure 6). Figure 6: CodeMeter context menu, WebAdmin This opens the web browser (for Windows XP, this is Internet Explorer by default). The web site as shown in Figure 7 is displayed. Overview CodeMeter PTV AG 8

9 Set up CodeMeter as dongle server Figure 7: CodeMeter WebAdmin Please take note of the URL of the browser shown in Figure 7. The name localhost determines the computer itself on which you have opened the browser window. The number specifies the network port which must be accessible (see chapter 3.3). In order to be able to use the CodeMeter WebAdmin properly, your browser must accept JavaScript. By using the WebAdmin user interface, the CodeMeter server can be configured remotely with the following URL: Please replace <name or IP address of the server> by the name or IP address of the server. If necessary, ask your local network administrator. As you can see in Figure 8, the server is not started yet because the checkbox Run Network Server is not activated. To activate the server next time the CodeMeter software is started, please select the checkbox as marked in Figure 8. To apply the changes, click the Apply button. Overview CodeMeter PTV AG 9

10 Set up CodeMeter as dongle server Figure 8: CodeMeter WebAdmin, configuration network Now, the dongle server will be started the next time the CodeMeter software is started. To activate the changes now, restart the CodeMeter software. The simplest way to restart it is to open the CodeMeter control center. Please right-click the CodeMeter symbol again, on the status bar on the bottom right of the desktop. Figure 9: CodeMeter context menu: Show A context menu will be displayed (see Figure 9). Click Show to open the CodeMeter Control Center. Overview CodeMeter PTV AG 10

11 Set up CodeMeter as dongle server Figure 10: CodeMeter Control Center, stop service To stop the CodeMeter software, choose Process on the menu bar, then select Stop CodeMeter Service (see Figure 10). All buttons in the control center disappear. The CodeMeter symbol on the status bar changes its color to grey. The software is now stopped, which can be seen in the status bar on the bottom right of the CodeMeter control center (see Figure 11). Figure 11: CodeMeter control center, service stopped To start the CodeMeter software again, click Process. Select the entry Start CodeMeter Service, (see Figure 12) Overview CodeMeter PTV AG 11

12 Set up CodeMeter as dongle server Figure 12: CodeMeter control center, start service As seen before, the controls of the current window are activated again. And the Code- Meter symbol, on the status bar, on bottom right of the desktop, changes its color to green. Again, the status bar of the CodeMeter control center informs you that the CodeMeter has been started (see Figure 13). Figure 13: CodeMeter control center, service started Overview CodeMeter PTV AG 12

13 CodeMeter server 4 CodeMeter server This chapter describes the requirements for use of your CodeMeter dongle as a dongle server in your network. 4.1 Conditions As described in chapter 3.3, the CodeMeter server has to be started and must be accessible via your computer network. You can check the accessibility of the server by typing the following URL in your web browser (e.g. Microsoft Internet Explorer): Please replace <name or IP address of the server> by the name or IP address of that PC, which will act as a CodeMeter dongle server. Contact your administrator in order to find out the name or IP address. If the CodeMeter WebAdmin window is displayed (see Figure 7), the accessibility check was successful! 4.2 Connecting one CodeMeter dongle The CodeMeter dongle provides a built-in Flash memory. Usually, Microsoft Windows operating systems recognize it as a mass storage device and assign a new disc drive letter. In some cases this leads to the start of the Microsoft Windows AutoPlay functionality. Then, the following dialog is displayed, (see Figure 14). Figure 14: Microsoft Windows, Autoplay Please do not cancel this process. 4.3 Connecting several CodeMeter dongles It is possible to plug in several CodeMeter dongles to one server. This is necessary when different Vision Traffic software configurations are in use (e.g. two versions of PTV Visum with different network sizes). For several CodeMeter dongles the small icon on the bottom right of the window will change its status into. Overview CodeMeter PTV AG 13

14 CodeMeter server If more than one dongle is plugged into the server, make sure that you have selected the correct dongle (see Figure 15),. Figure 15: CodeMeter control center, selection of dongle serial number 4.4 Starting the Vision Traffic software Now you can start your Vision Traffic software. If there is only one CodeMeter server in your network, the software is immediately started and you can begin your work. If there is more than one CodeMeter dongle server, it may occur that the Vision Traffic software cannot find a valid dongle. In this case, the following error message is displayed (see Figure 16). Figure 16: Dongle not found In order to specify which CodeMeter dongle server has to be used, change the following settings in the CodeMeter WebAdmin application of the PC on which you want to use the Vision Traffic software. It has to be specified, where the CodeMeter software has to search for a valid CodeMeter dongle. Click the add button (see Figure 17). Overview CodeMeter PTV AG 14

15 CodeMeter server Figure 17: WebAdmin, Setup Server Search List A new dialog is displayed. Enter an IP address or server name (see Figure 18). Please enter a valid IP address or the server name of the PC that shall act as your CodeMeter dongle server. Note that the CodeMeter dongle has to be plugged into that PC. Figure 18: WebAdmin, enter IP address Click the OK button to confirm your entry. Then, click Apply to activate your changes to the server search list. Please note that too many IP addresses in the server search list reduce the performance of the CodeMeter software and may prevent the start of your Vision Traffic software. Overview CodeMeter PTV AG 15

16 CodeMeter server Figure 19: WebAdmin, Changed Server Search List As shown in Figure 19, the checkbox Run Network Server must not be selected. The CodeMeter software searches exclusively on the servers in the server search list for a valid CodeMeter dongle. You may now start the Vision Traffic software. The license window provides more information about the license and the dongle used, (see Figure 20). Figure 20: Example PTV Visum license overview Overview CodeMeter PTV AG 16

17 CodeMeter server 4.5 Reliable check of connection between Client and Server The following chapter describes how the connection between the client and your license server can be checked. There are two preconditions: The license server where the CodeMeter software has been started as service must be accessible over the computer network. In addition, the server and the client have to be in the same subnet. Otherwise, the server name or its IP address has to be added to the server search list on the client side. If all preconditions have been checked, proceed as follows. Right click on the CodeMeter icon on the status bar and select WebAdmin. In the following dialog click Home, and then on the green button with the Host Name of the computer. This opens a second small Browser windows (see Figure 21). Figure 21: Result of Server search This window contains a drop down box with all CodeMeter license servers available in the network. By default, your own computer, localhost, is selected. In addition, the list should include the license servers which have been added to your server search list. If available, the list shows computer name and IP address of all availabe license servers. Select your license server in the list of available servers and click the Select button. This will close the small windows and you will return to the WebAdmin user interface. Check the host name in the menu Home of this WebAdmin and the web address shown in the Browser s address field. The host name should be the one of your license server. And the web address should be the name or IP address of your license server. If this is correct, you have successfully and reliably checked the connection between your client and the license server. This ensures that the PTV software will be able to establish the connection as well. Overview CodeMeter PTV AG 17

18 Error handling 5 Error handling Before and while working with your software protected by a dongle, you may encounter some error messages. The following sections list errors and their solutions when working with a CodeMeter dongle. 5.1 Licence key not found If the error message as shown in Figure 16 appears while starting your software, a valid CodeMeter dongle could not be found. Please check the following issues and correct as required: Did you plug in the correct CodeMeter dongle on your local machine or on a machine, which is accessible via the network? Did you start the CodeMeter software? (Can you see the corresponding CodeMeter symbol in the status bar on the bottom right of the desktop)? If you have plugged the CodeMeter dongle into another machine, is this machine accessible via the network? If you have plugged the CodeMeter dongle into another machine, did you start the CodeMeter software on that machine? If you have plugged the CodeMeter dongle into another machine, did you set up the firewall on that machine to permit access to port (this can be checked by typing in the corresponding URL into your web browser, (see chapter 3.3))? 5.2 CodeMeter error If you are using your Vision Traffic software as network version, i.e. the CodeMeter dongle is not plugged into your local machine, you have to make sure that the connection to the CodeMeter dongle is never interrupted. If the connection is interrupted, an error message is displayed, (see Fehler! Verweisquelle konnte nicht gefunden werden.). Possible reasons are: The CodeMeter dongle has been unplugged accidentally The network connection has been interrupted The CodeMeter software on the remote machine has been stopped The CodeMeter server has been turned off The CodeMeter software on the local machine has been stopped Overview CodeMeter PTV AG 18

19 Error handling Figure 22: CodeMeter error The CodeMeter error message will be followed by another error message shown in Figure 23. Please check whether the connection has been lost and try to reconnect. Figure 23: CodeMeter, execution error Please press the Retry button in any case to reconnect! Otherwise, the software will be shut down and you will not be able to save your work. Check the possible reasons listed above and correct as required to reconnect. Alternatively, you can proceed as follows in order to continue working with your software: You can plug the CodeMeter dongle into your local machine You can plug the CodeMeter dongle into another machine, which has to be accessible via the network (please change the server search list, if necessary (see chapter 4.4)). If you have plugged the CodeMeter dongle into your or another machine please click the Retry Button. Now, the CodeMeter software is searching for a valid CodeMeter dongle again. In case of success, you can continue working with your Vision Traffic software. Otherwise, the error message shown in Figure 23 appears again. Overview CodeMeter PTV AG 19

20 Remote programming of the dongle 6 Remote programming of the dongle 6.1 Creating a context file To exchange the key file of your software licence, we have to know which individual Code- Meter dongle you are using. Each CodeMeter dongle has its own serial number. Therefore, we need to have its individual context file, as this file contains a licence overview and the serial number. Please start the CodeMeter control center (see chapter 3.3, Figure 12). Then, navigate to the Licence tab as shown in Figure 24. Please note that the CodeMeter dongle must be plugged into your local machine. Click the License Update button, a new window with the CmFAS Assistant will open up (see Figure 25). Click Next. Figure 24: CodeMeter control center, "license update" button On page 2 of the CmFAS Assistant, please click the radio button Create license request and then Next (see Figure 26). On page 3, select option Extend existing license and then Next (see Figure 27). On the next page, keep the selected entry PTV AG (100321) and click Next (see Figure 28). Overview CodeMeter PTV AG 20

21 Remote programming of the dongle Figure 25: CmFAS Assistent, page 1 Figure 26: CmFAS Assistent, page 2 Figure 27: CmFAS Assistent, page 3 Overview CodeMeter PTV AG 21

22 Remote programming of the dongle Figure 28: CmFAS Assistant, page 4 In order to save the context file, click the Commit button (see Figure 29). You may change the directory in which you save the file. Please do not change the name of the file! (ex WibuCmRaC). The extension WibuCmRaC identifies the file as a context file. Figure 29: CmFAS Assistant, page 5 Figure 30: CmFAS Assistant, page 6 Go to the directory as shown in Figure 29 and send us the context file you created with the file extension WiBuCmRaC. Overview CodeMeter PTV AG 22

23 Remote programming of the dongle 6.2 Applying a context update file Usually, we will send you a new context file for your CodeMeter dongle by . In order to import this context file and to extend your license, please open the CodeMeter control center (see chapter 3.3, Figure 12). Then, click the License Update button, a dialog is shown (see Figure 31). Click Next. The CodeMeter dongle must be plugged into your local machine. Then, as shown in Figure 32, select the Import Licence Update radio button and click Next. Now, select the CodeMeter update file (with file extension WiBuCmRaU), which you received (see Figure 33). Then click Commit to apply the update to the dongle. Figure 34 indicates that this process has been successful. Figure 31: CmFAS Assistent, page 1 Figure 32: CmFAS Assistent, page 2 Overview CodeMeter PTV AG 23

24 Remote programming of the dongle Figure 33: CmFAS Assistent, page 3 Figure 34: CmFAS Assistent, page Update the firmware of the CodeMeter dongle It might be necessary to update the firmware (the software which is installed on the dongle itself) of the CodeMeter dongle in order to be able to execute the context update file provided. The process to update the firmware requires a valid internet connection. In some cases, this requires to have configured the proxy settings of the CodeMeter Runtime Kit. Check the proxy settings under: To do so, please start the CodeMeter control center (Figure 35). In tab Licence, click the icon on the right side of the control center. Please note that the CodeMeter dongle must be plugged into your local machine. This may require the password CodeMeter. Overview CodeMeter PTV AG 24

25 Remote programming of the dongle Figure 35: CodeMeter control center Do not unplug the dongle until the update process has been finished (see Figure 36). Figure 36: Do not unplug CodeMeter At the end of the update process a message will be displayed. Figure 37 shows the message if the update has been successful. Otherwise, an error message is shown. Figure 37: Firmware successfully updated 6.4 Proxy Settings In some companies and organizations, your computer is able to connect to the internet but this is not a direct connection but it is redirected through a proxy. The CodeMeter Runtime Kit requires this information as well. There are two ways to do this: You can try to find out the correct proxy settings automatically, or You can change the proxy configuration manually Automatically you can identify the proxy settings: Go to Start -> All programs -> CodeMeter -> Tools -> CodeMeter Command Prompt. This Overview CodeMeter PTV AG 25

26 Remote programming of the dongle opens the MS DOS box. Please insert the command: cmu32 --detect-proxy --write --force Hit the Enter key to confirm the command. The output looks like this: Figure 38: Output of Command Prompt Change the proxy settings manually: Instead of working with the Command Prompt, you can do the required changes directly in the WebAdmin user interface under menu Configuration, sub menu Proxy. Your IT department will help you to get all required information. See the following link: Overview CodeMeter PTV AG 26

27 Support 7 Support This chapter deals with the two support possibilities for Vision Traffic customers who are using CodeMeter dongles. 7.1 Direct Support Please feel free to contact our Traffic Customer Service in case of problems regarding the CodeMeter dongle. To be able to provide fast and efficient support, we would like to ask you to do the following before contacting us: 1. Check the version of the CodeMeter Runtime Kit (see chapter 2.1) 2. First, update the firmware of your CodeMeter dongle (see chapter 6.3). 3. Then, create the context file of the dongle under consideration (see chapter 6.1). 4. Finally, we need the CmDust report. To create this report go to the start menu. Navigate to All programs and then CodeMeter. Under the CodeMeter entry, gclick Tools, and then the CmDust entry. This will create the report file CmDust- Result.log. In case of the use of a network dongle, please provide CmDust reports of both, the server and all clients for which problems with the CodeMeter dongle are encountered. 5. For an efficient support, please send us also the installation log files from the installation of the Vision Traffic software named Setup Log **.txt which can be found in the directory: %tmp% (enter without in address line of the Windows Explorer) Please send us all these files including your PTV customer ID to the address customerservice@vision.ptvgroup.com 7.2 Indirect Support By purchasing a CodeMeter dongle, the user automatically has the right to contact the technical support of the manufacturer for free. The WIBU-Systems AG company provides excellent support. The company can be contacted as follows: Web: support@codemeter.de Phone: Overview CodeMeter PTV AG 27

28 PTV AG Haid-und-Neu-Straße Karlsruhe Germany Telefon +49 (0) Fax +49 (0)