Installation Guide V1.0

Transcription

1 MULTICODER MC-TRANS Teracue eyevis GmbH Schlossstr Odelzhausen Germany Tel: +49 (0) Fax: +49 (0) Document Version 1.0/

2 COPYRIGHT This document may not be reproduced in any form, in whole or in part, without the prior permission of Teracue eyevis GmbH. Copyright 2014 by Teracue eyevis GmbH, all rights reserved. DISCLAIMER This publication supersedes all previous publications. Information and specification in this documentation is subject to change without notice. Please make sure you have the latest document version. User guides are located at: If you find some points in this user guide unclear then please let us know, so we can improve this documentation. Thank you! Mail to: All information within this document is confidential to Teracue eyevis GmbH costumers and should not be copied or distributed to non Teracue eyevis GmbH customers. TRADEMARKS MultiCoder and all of its components are registered trademarks licensed to Teracue eyevis GmbH. All other logos and trademarks both marked and not, may be trademarks or registered trademarks and therefore property of their respective owners. 2

3 I. Information about the manual This documentation is designed to help administrators and users to install the MultiCoder MC-TRANS on their computer. If you received this publication as a PDF, then it's a good idea to print it out for future reference. It is best to use this user guide directly in front of your computer, by doing so you try out everything at once..!. Important features are marked by this sign. 3

4 II. Content 1. MICROSOFT.NET FRAMEWORK INSTALL MULTICODER MC-TRANS REGISTERING MULTICODER SERVER MANAGER OF MC-TRANS Server settings Tab Advanced settings Tab Watchdog settings Tab Task scheduler settings Tab Application monitor settings Tab Udp listener settings Tab Web settings Tab CHANGE THE IP-ADDRESS OF THE MC-TRANS APPLIANCE

5 1. Microsoft.Net Framework Before you install the MultiCoder MC-TRANS make sure that.net Framework 4.0 is installed on your system. You can check this by opening the control panel and clicking to Add or Remove Programs. If.Net Framework 4.0 is installed, you will find the program in the list of the Add or Remove Programs window. If.Net Framework 4.0 is not installed on your system, please download the.net Framework (dotnetfx.exe) from the Microsoft web page. After you have installed the.net Framework, please make a Microsoft-Update. 5

6 2. Install MultiCoder MC-TRANS The following section describes the MultiCoder MC-TRANS installation. Please execute the Multicoder.MC-TRANS.Install.exe of the MultiCoder MC-TRANS. It opens the install assistant for the MultiCoder MC-TRANS application, see Figure 1. Click there on Next>. Figure 1: Install assistant for the MultiCoder MC-TRANS application Now will be defined where the MultiCoder MC-TRANS files should be stored, see Figure 2. In the shown field the storage path of the MultiCoder MC-TRANS binaries files is indicated, which are needed for the MultiCoder MC-TRANS. These binary files are elementary components of the MultiCoder MC-TRANS. The default value of the storage path is C:\Program Files\Teracue\MultiCoder\MC-TRANS. We do not recommend changing the path. Click Next > to continue the MultiCoder MC-TRANS installation. Figure 2: Installation directory of the MultiCoder MC-TRANS installation 6

7 As next, please select the installation volume. We recommend selecting the Full installation and enabling the Web page control check-box. See Figure 3. If you enable the Web page control check-box, you can control MC-TRANS via webpage. If you disable the Web page control check-box, you need a client application to control MC-TRANS. Click Next > to continue the MultiCoder MC-TRANS installation. Figure 3: Installing volume of MC-TRANS installation Please enter in the Username and Password fields of the login information section the administrator login data of the system on which you install the MC-TRANS. See Figure 4. The MC- TRANS uses the internet information service (IIS) and needs therefor administrator access. Click Next > to continue the MultiCoder MC-TRANS installation. Figure 4: 'Login information' section of the MC-TRANS installer 7

8 Now, please enable the Install Multicoder Service check-box and press the Next > button. We recommend not disabling this check-box, because the MultiCoder Services are needed, therewith the MC-TRANS can work. See Figure 5. Figure 5: 'Service settings' section of the MC-TRANS installer The Select Start Menu Folder section specifies the folders of the start menu about which you can launch the MC-TRANS. The default folder structure is: Teracue/Multicoder/MC-TRANS. We recommend not changing this path. See Figure 6. Click Next > to continue the MultiCoder MC-TRANS installation. Figure 6: 'Start Menu Folder' section of the MC-TRANS installer 8

9 As next, you can enable / disable the Create a desktop icon check-box in the Select Additional Tasks sections. See Figure 7. With this check-box you can create a MC-TRANS short cut icon at the desktop. Click Next > to continue the MultiCoder MC-TRANS installation. Figure 7: 'Additional Tasks' section of the MC-TRANS installer After you have finished your installation settings, the installer asks you to confirm your settings with Install, see Figure 8. Please click the Install button, to start the MC-TRANS installation. Figure 8: Ready to Install section of the MC-TRANS installer 9

10 The installer begins to install the MC-TRANS application, see Figure 9. Figure 9: Installer installs the MC-TRANS application If the installer has installed the MC-TRANS, your computer must be restarted. Not till then the MC- TRANS installation is completed successfully. Therefor, please select the radio button Yes, restart the computer now and please click Finish to exit the install assistant, see Figure 10. Figure 10: Installation Complete window of the MultiCoder Server installation 10

11 2.1 Registering MultiCoder After you have installed MC-TRANS successfully, you must register your MC-TRANS. If you have enabled the creation of a desktop icon in the installation process, you find after the successfully MC-TRANS installation on your desktop a shortcut called MC-SERVER. This shortcut opens the server manager of the MC-TRANS in which you can start the registering process. If you have disabled the creation of a desktop icon in the installation process, you must go to the start menu and click to Programs > Teracue > Multicoder > MC-TRANS > MC-SERVER to open the server manager of the MC-TRANS. Please double click on the shortcut MC-SERVER or open the server manager via start menu, to start the registering process. To register your MC-TRANS you must click the License button in the server manager. The License button is located in the left bottom corner of the server manager. After clicking this button, it opens the Register Teracue product window, see Figure 11. Figure 11: Register Teracue product window Registering a FULL VERSION: For registering with a FULL VERSION, click on Ask for a Request Code. It opens the New license request window, see Figure 12. Registering a DEMO VERSION: For registering a limited trial DEMO VERSION, click on Register Version and enter the demo license key and your name in the Registration window, see Figure 13. You can get the demo license key form the Teracue AG. After you pressed Ask for a Request Code, the New license request window will appear, see Figure 12. It displays your request code, which is needed to obtain a full version license key. Please right-click on the blue marked request code and copy it. Paste it into an along with your name, your company details and your project number and send it to: support@teracue.com You will shortly receive an answer supplying you with your full license key. 11

12 Figure 12: New license request window After you have received your full license key, you can continue with the registration of your MC- TRANS. Therefor double click on the shortcut MC-SERVER or open the server manager via start menu (Programs > Teracue > Multicoder > MC-TRANS > MC-SERVER), to continuo the registering process. It opens the server manager window, see Figure 14. Please click the License button of the server manager again. It opens the Register Teracue product window, see Figure 11. Click in this window the Register Version button. After that it opens the Registration window, see Figure 13. Figure 13: Registration window Please enter your name in the top entry field. And paste your full license key from the into the lower field. Simply click OK. Close the Register Teracue product window by clicking the OK button of this window. Your product is now fully licensed. To use the MC-TRANS, you must configure the server manager now. 12

13 2.2 Server Manager of MC-TRANS If you have enabled the creation of a desktop icon in the installation process, you find after the successfully MC-TRANS installation on your desktop a shortcut called MC- SERVER. This shortcut opens the server manager of the MC-TRANS. To use the MC- TRANS, you must configure the server manager at first. If you have disabled the creation of a desktop icon in the installation process, you must go to the start menu and click to Programs > Teracue > Multicoder > MC-TRANS > MC-SERVER to open the server manager of MC-TRANS. Please open the server manager of MC-TRANS now. At first click the Install button of the MultiCoder.Server.Manager window to install the MultiCoder Service. The Service status changes from Not Installed to Stopped. Select in the drop-down field Profile name your desired MC-TRANS module, which shall be loaded. If your hardware has several network cards, please select in the Server NIC drop-down field your desired network card, which the MC-TRANS should be used. Please click the Apply button when you finished the MultiCoder Server configuration and the Start button to start the MultiCoder Service. The status of the Service status field changes to Running. The MultiCoder Service starts only when you have registered the MC-TRANS. After the MC-TRANS is successfully installed and the MultiCoder Service is started, you can close the server manager and you can use the MC-TRANS now. Figure 14 shows the server manager of the MC-TRANS. The server manager has four tabs which are described in the following subchapters. 13

14 2.2.1 Server settings Tab This tab contains the main features, e.g. installing/uninstalling and start/stop the services. Figure 14: The 'Server settings' tab of the 'MultiCoder.Server.Manager' window Table 1 describes the respective text fields and buttons of the Server settings tab. Buttons, Text- / Check-Boxes: Description: Service name: Specifies the name of the server service. This service is elementary component of the MC-TRANS and it is needed for the operation ability. Install: Installs the MC-TRANS server service. Uninstall: Uninstalls the MC-TRANS server service. Service status: Displays the service status. It exist three services statuses Not Installed, Stopped and Running. Start: Starts the MC-TRANS server service, but the service must be already installed. Stop: Stops the MC-TRANS server service. Use Watchdog: Enables / Disables the watchdog of the MC-TRANS server service. Profile name: Defines the module which shall be used. Server name: Specifies the MC-TRANS server name. This is not to be confused with the server service name. Server NIC: Specifies the used IP-address for the MultiCoder Server. Server port: Specifies the used port number for the MC-TRANS Server. This port is used to send control information by using TCP..!. We recommend do not changing this server port number. The default server port number is !. If you use a firewall on the system, on which you install the MC-TRANS, please allow in the firewall the server port number (Default port number 9101) of the MC-TRANS. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 1: Description of the 'Server settings' tab of the server manager 14

15 2.2.2 Advanced settings Tab This tab contains the advanced settings for the MC-TRANS for example when you want use MC- TRANS as client/server model. Figure 15: The 'Advanced settings' tab of the 'MultiCoder.Server.Manager' window Table 2 describes the respective text fields and buttons of the Advanced settings tab. Buttons, Text- / Check-Boxes: Communication IP: Communication Port: App data directory: Log directory: Authentication required: Synchronization required: Description: Specifies a multicast IP-address for the multicast announcement which will be sent into the network. This multicast announcement will be received from the Client, when you use the MC-TRANS as client/server model. The Client lists all received multicast announcements and on the basis of this list the user can select the desired MultiCoder from a list..!. We recommend do not changing the communication IP-address. The default IP-address is Specifies a multicast port for the multicast announcement which will be sent into the network via UDP. This multicast announcement will be received from the Client, when you use the MC-TRANS as client/server model. The Client lists all received multicast announcements and on the basis of this list the user can select the desired MultiCoder from a list..!. We recommend do not changing this communication port number. The default communication port number is !. If you use a firewall on the system, on which you install the MC-TRANS, please allow in the firewall the communication port number (Default port number 9100) of the MC-TRANS. Specifies the storage path of the user.config file. The user.config file saves your last configuration settings. Specifies the storage path of the MC-TRANS log files. Activates/Deactivates the authentication table below. If the checkbox is checked, the user will be asked to enter his username and password before the MC-TRANS opens. Activates/Deactivates the synchronization between the server and the client, when you us the MC-TRANS as client/server model. If the check-box is checked and it exist different moduleversions on the server as well as on the client, the server synchronizes the client to the current version. 15

16 User list: Contains the existing usernames for a login. Therefor the checkbox Authentication required must be checked. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 2: Description of the 'Advanced settings' tab of the server manager Watchdog settings Tab The following subchapters describes the tabs which are included in the Watchdog settings tab. With these settings you can set the watchdog service. The watchdog triggers a MC-TRANS restart if the main program due to some faults condition Task scheduler settings Tab Here you set the task scheduler of the watchdog. Figure 16: The 'Task scheduler settings' tab in the 'Watchdog settings' tab Buttons, Text- / Check-Boxes: Description: Enabled: Enables / Disables individual tasks of the watchdog. Watchdog daily restart Watchdog daily restart restarts the watchdog server daily. Daily task Daily task / Weekly task / Monthly task : Every day / week / Weekly task month the watchdog restarts the MC-TRANS services or reboots Monthly task the whole system depending on what is selected on the Action area. Schedule time: Specifies the time at which the task shall be executed. Day if week/month: Specifies the day at which the task shall be executed, when Weekly task and/or Monthly task is enabled. For example: Every second day of the week the watchdogs executes the restart or at each 23th of the month the watchdogs executes the restart. Action: Specifies which action shall be executed. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 3: Description of the 'Task scheduler settings' tab in the 'Watchdog settings' tab of the server manager 16

17 Application monitor settings Tab The watchdog offers not only a task scheduler option but also a monitoring option at which the watchdog checks whether the MC-TRANS service is alive. Figure 17: The 'Application monitor settings' tab in the 'Watchdog settings' tab Buttons, Text- / Check-Boxes: Description: Check period (secs): Specifies the period in seconds how often the watchdog shall check whether MC-TRANS service is alive. Start delay (secs): Specifies the timeout in which the MC-TRANS service can show, that the MC-TRANS service is alive. When this time has elapsed and the MC-TRANS service does not response, the watchdog restarts the service. Applications: Specifies the application which shall be monitored by the watchdog..!. We recommend do not changing the application entry for the MultiCoder server which is the MC-TRANS service. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 4: Description of the 'Application monitor settings' tab in the 'Watchdog settings' tab of the server manager 17

18 Udp listener settings Tab Concerning of the monitoring option the watchdog listens at a specific port number for responses of the MC-TRANS service. This specific port number can be defined here. Figure 18: The 'Udp listener settings' tab in the 'Watchdog settings' tab Buttons, Text- / Check-Boxes: Description: Ip Address: Specifies the IP-address at which the watchdog listens for responses of the MC-TRANS service whether the service is alive..!. We recommend do not changing this entry. Port: Specifies the port number at which the watchdog listens for responses of the MC-TRANS service whether the service is alive..!. We recommend do not changing this entry. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 5: Description of the 'Udp listener settings' tab in the 'Watchdog settings' tab of the server manager 18

19 2.2.4 Web settings Tab You have the possibility to remote control the MC-TRANS via web interface. Therefor the MC-TRANS web pages needs administrator access of the operating system on which the server manager of MC- TRANS runs. Here you can enter for the web pages the username and password of the system administrator. Figure 19: The 'Web settings' tab of the 'MultiCoder.Server.Manager' window Buttons, Text- / Check-Boxes: Description: Log on webpage as: Enable this check-box when you want remote control via web page. When this check-box is not enabled, the remote control via web page does not work. User name: Enter here the username of the system administrator on which the server manager of MC-TRANS runs. Password: Enter here the password of the system administrator on which the server manager of MC-TRANS runs. License: If you do not have registered the MC-TRANS, this button opens the Register Teracue product window for the registration of the MC-TRANS. Apply: Confirms and saves your settings. Table 6: Description of the 'Web settings' tab of the server manager 19

20 3. Change the IP-address of the MC-TRANS Appliance If your want to change the IP-address of your MC-TRANS appliance, you must do the following steps to ensure that the MC-TRANS runs correctly after changing the IP-address of the MC- TRANS appliance. At first please connect a screen, a keyboard and a mouse to the MC-TRANS Appliance. Please change the IP-address under Windows of your MC-TRANS Appliance and make afterwards a reboot. Open the server manager. Press in the Server settings tab of the server manager at first the Stop button and then the Uninstall button. Select now the new IP-address in the drop-down field Server NIC. Press the Apply button, then the Install button and Start button. Now you can close the server manager. 20

21 III. List of figures FIGURE 1: INSTALL ASSISTANT FOR THE MULTICODER MC-TRANS APPLICATION... 6 FIGURE 2: INSTALLATION DIRECTORY OF THE MULTICODER MC-TRANS INSTALLATION... 6 FIGURE 3: INSTALLING VOLUME OF MC-TRANS INSTALLATION... 7 FIGURE 4: 'LOGIN INFORMATION' SECTION OF THE MC-TRANS INSTALLER... 7 FIGURE 5: 'SERVICE SETTINGS' SECTION OF THE MC-TRANS INSTALLER... 8 FIGURE 6: 'START MENU FOLDER' SECTION OF THE MC-TRANS INSTALLER... 8 FIGURE 7: 'ADDITIONAL TASKS' SECTION OF THE MC-TRANS INSTALLER... 9 FIGURE 8: READY TO INSTALL SECTION OF THE MC-TRANS INSTALLER... 9 FIGURE 9: INSTALLER INSTALLS THE MC-TRANS APPLICATION FIGURE 10: INSTALLATION COMPLETE WINDOW OF THE MULTICODER SERVER INSTALLATION FIGURE 11: REGISTER TERACUE PRODUCT WINDOW FIGURE 12: NEW LICENSE REQUEST WINDOW FIGURE 13: REGISTRATION WINDOW FIGURE 14: THE 'SERVER SETTINGS' TAB OF THE 'MULTICODER.SERVER.MANAGER' WINDOW FIGURE 15: THE 'ADVANCED SETTINGS' TAB OF THE 'MULTICODER.SERVER.MANAGER' WINDOW FIGURE 16: THE 'TASK SCHEDULER SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB FIGURE 17: THE 'APPLICATION MONITOR SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB FIGURE 18: THE 'UDP LISTENER SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB FIGURE 19: THE 'WEB SETTINGS' TAB OF THE 'MULTICODER.SERVER.MANAGER' WINDOW

22 IV. List of tables TABLE 1: DESCRIPTION OF THE 'SERVER SETTINGS' TAB OF THE SERVER MANAGER TABLE 2: DESCRIPTION OF THE 'ADVANCED SETTINGS' TAB OF THE SERVER MANAGER TABLE 3: DESCRIPTION OF THE 'TASK SCHEDULER SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB OF THE SERVER MANAGER TABLE 4: DESCRIPTION OF THE 'APPLICATION MONITOR SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB OF THE SERVER MANAGER TABLE 5: DESCRIPTION OF THE 'UDP LISTENER SETTINGS' TAB IN THE 'WATCHDOG SETTINGS' TAB OF THE SERVER MANAGER TABLE 6: DESCRIPTION OF THE 'WEB SETTINGS' TAB OF THE SERVER MANAGER