RTCU Gateway 2 Control Panel User`s Manual
Contents
1. lt gt Status Configuration Plug ins Property Value El Client Port 5001 Max clients 25 Timeout 14400 Encrypt False Encrypt Key 000000000000000000000 Compress True Time service True Keul AABBCCDD Create Remove Port Maximum clients Timeout Encrypt Encrypt Key Compress Time service Key1 Key2 Key3 Key4 Key5 The IP port where the gateway instance will listen for clients The maximum number of clients that are allowed to connect to the gateway instance This number is dictated by the license The time without transactions before the gateway disconnects a client This is used to clean up inactive connections that for various reasons have not been closed correctly by the network Time is given in seconds Enables disables encryption of client communication The encryption key used to encrypt decrypt client communication The key is 16 bytes long and is written in HEX numbers Note that all 32 characters must be present or the key s rejected Enables disables compression of client communication Enables disables the Time service Enabling the Time service will allow clients to request the local or UTC time from the gateway instance by using the gwTimeGet function Disabling the Time service will return zero to the clients requesting the time The access key 1 for the gateway instance clients The access key 2 for the gateway instance clients The access key 3 for th2. Blackist 1 00 Namelist when a login request is received from a client the blacklist plug in will lookup the requested Node ID and if the Node ID is found the login is denied The blacklist plug in reads the list of denied Node 1D s from a XML File The list will be updated at a user defined time interval The File must Follow this Format lt blacklist gt lt node gt lt id gt 2000001 lt jid gt lt text gt Message log text lt text gt When removing a plug in with the Remove button it is removed from the configuration of the gateways but not from the hard drive Any running gateways will continue to use the plug in until they are restarted 3 1 4 Menu item Help By using the Help menu it is possible to receive help regarding specific items Help Topics About The individual items e Help topics e About 3 141 Help Help topics This command will start the Windows Help system You will be presented with the contents of the Control Panel help manual 3 1 4 2 Help About This command shows the current version number of the Control Panel program and a copyright notice About RTCU Gateway 2 Control Panel Version 3 10 Copyright C 2014 by Logic 10 Denmark 2015 Logic 10 12 RTCU Gateway 2 Control Panel 3 2 Gateway List The list on the left side of the Control Panel contains all installed gateway instances Gatewa Status Pro El E El Jem Cr
3. Support LPS supports the transmission of extended size data packets over the RTCU Gateway 2 The standard packet size over the RTCU Gateway 2 is 480 bytes and by using LPS this is increased to 4064 bytes RTCU IDE RACP operations such as transfer or large files or applications to from the device automatically take advantage of the LPS functionality when available The application can take advantage of LPS by using gwSendPacket gwReceiwPacket Please consult the RTCU IDE documentation Limitations e Supported by all NX32 architecture devices e Requires firmware V4 40 or later Requires RTCU Gateway 2 V3 20 or later 2015 Logic 10 Introduction 3 Time Service The RTCU Gateway 2 has an inbuilt Time Service which allows central synchronization of the real time clock for connected clients The clients can request the local time or the UTC time for a truly universal time synchronization service For more information please consult the RTCU IDE online documentation and the RTCU Gateway Configuration section License The RTCU Gateway 2 supports 25 clients as default To allow additional clients further licenses must be ordered Please contact Logic IO for more information 2015 Logic 10 The RTCU Gateway Architecture 5 2 The RTCU Gateway Architecture The RTCU Gateway 2 is a middleware solution which is used for communicating with remote RTCU units by using any TCP IP enabled communication media e g GPRS or L
4. The service will be removed including its configuration and the maximum number of clients will be freed for the other gateway instances The log files will not be removed To ensure that no gateway instance is removed accidentally a pop up dialog is shown which asks for verification The gateway instance must be stopped before removing it 3 3 Gateway management The right side of the control panel contains the management pages 2015 Logic 10 14 RTCU Gateway 2 Control Panel Status Configuration Plug ins j Value Property El Monitor Port 5002 Key GATEWAY Max clients 4 Client Log Monitor Jove Reset Apply The management pages consist of e Gateway Status e Gateway Configuration Gateway plug ins Any change made on these pages will be committed to the current selected gateway instance in the gateway list 3 3 1 Gateway Status The Status page is where the gateway instances are controlled and monitored Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help Actions Information Start Gateway Gateway Not installed Startup type Automatic St op Gateway Max Clients Unknown Change startup Time service UTC Unknown Local Unknown lt gt 2015 Logic IO Control Panel 15 The Actions group contains options for changing the status of the selected gateway instance The actions supported include starting
5. from Logic lO follow these steps 1 Open the Control Panel 2 Go to the Licenses dialog 3 Press the Install License button 4 Select the license file in the file dialog RTCU Gateway 2 Licenses Date Clients Gateways Machine ID 2012 11 07 500 4 BWPC License holder Logic IO Aps Holmboes All 14 8700 Horsens Denmark Clients used O of 500 Gateways used D of 32 Install License It is now possible to change the maximum number of clients in the Gateway configuration 3 1 3 Menu item Plug ins Plug ins are DLL libraries that can be installed dynamically to extend the functionality of the RTCU Gateway 2 A plug in can be developed by using the free RTCU Gateway 2 plug in developers kit The Plug In Manager dialog is where available plug ins are added and removed 2015 Logic 10 10 RTCU Gateway 2 Control Panel Plug in manager To add a plug in follow these steps 1 Copy the plug in DLL to the Plugins folder in the Gateway install directory This step is not necessary for the standard plug ins that come installed with the RTCU Gateway 2 2 Open the Control Panel 3 Go to the Plug Ins Manager dialog 4 Press the Add button and select the plug in DLL in the pop up list Select plug in Namelist dll When a plug in is added the Plug In Manager displays the available information about it 2015 Logic IO Control Panel 1 Plug in manager CET
6. name gt lt date gt For example C Logs Gateway 2012 08 24 file001 log Level The level of logging that is used by the gateway instance for the log files Time kept The number of days the log files are stored on the server before being deleted File size The maximum size of a log file before the gateway starts on a new file The size is given in MB 2015 Logic 10 z RTCU Gateway 2 Control Panel 3 3 3 Gateway plug ins The Plug Ins page is where the plug ins in the gateway instance are configured RTCU Gateway 2 Control Panel File Licenses Plug ins Help Status Configuration Plug ins Property lt gt Create Remove On the left side of the page a list of the plug ins added in the Plug in Manager can be seen On the right of the page the available properties for the selected plug in can be seen Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help Status Configuration Plug ins Blacklist Property Value Namelist Enable False File Refresh interval 10 The actual properties are specific for the individual plug ins and the details can be found in the description 2015 Logic IO Control Panel 21 The Enable property is used to enable or disable the selected plug in for the gateway instance A disabled plug in will not be loaded by the gateway service When the configuration is changed the Ap
7. AN One of the most important function of the RTCU Gateway 2 is to allow access to connected units that operate with a private and or dynamic IP address by mapping the private IP address of a unit to a global IP address that is accessible by other gateway clients The RTCU Gateway 2 also includes e Security functions e Local remote maintenance Logging features e Unit recovery after application failure The merging of SMS and TCP IP technology is made possible with the Logic IO proprietary VSMS Virtual SMS technology which allows any RTCU application that uses SMS messages to transparently send receive messages by using either SMS TCP IP data call or a cable connection without any changes to the software already developed The RTCU Gateway 2 defined protocol is named RACP2 Remote Access Communication Protocol REV 2 and is based on the RACP protocol that is used for communicating with RTCU units by using a serial line connection please see the separate document that describes the RACP and RACP2 protocols By using a standard TCP IP socket interface the protocol is made extremely simple and easy to implement by the clients Logic IO offers a free software library DLL that implements the client side of the RACP2 protocol for use in a Microsoft Windows environment The source code written in C can also be supplied By using the RACP2 protocol the RTCU Gateway 2 architecture can be illustrated like this RTCU2 RT
8. CU Gateway 2 RTCU 3 The client is communicating with the RTCU Gateway 2 by using the RACP2 protocol The message that has been sent from the client to the gateway will be forwarded to the RTCU unit by using the TCP IP connection again by using the RACP2 protocol The response sent from the RTCU unit to the client will be forwarded back to the client in the same way It should be noted that communication between two clients and two RTCU units is also possible by using the RTCU Gateway 2 To use the RTCU Gateway 2 the client and the RTCU unit need to be supplied with the IP address port number and password of the the RTCU Gateway 2 The RTCU Gateway 2 runs as a Windows service and therefore it runs independently of user logon A complete RTCU Gateway 2 setup consist of RTCU Gateway 2 service for managing the message routing and logging to file system on the server 2015 Logic 10 6 RTCU Gateway 2 Control Panel e RTCU Gateway 2 guard service whose only task it is to restart the gateway service if it stops unexpectedly e RTCU Gateway 2 Control Panel which handles creation and management of RTCU Gateway 2 services 2015 Logic 10 s RTCU Gateway 2 Control Panel 3 Control Panel The RTCU Gateway 2 Control Panel is where the gateways are managed All configuration of the gateways must be done through this interface Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help Gateway Status Conf
9. RTCU Gateway 2 Control Panel User s Manual Version 3 20 2015 Logic IO RTCU Gateway 2 Control Panel Table of Contents Part Part Il Part Ill 1 Part IV 1 2 Part V Introduction The RTCU Gateway Architecture Control Panel Menulite ms z LL Menuitem File 2 254 214552222822 Menu item Licenses zioni ann Menu item Plug ins sisi Menu items Help Eee Create gate Rem ove Gate WAY A S EE T Gateway management esee Gate W ay Status MD Gateway Configuration ins Monitor parameters neto ire ri irren eee re P rae eere Client pa AMES iii prote eee m repete pie eda Log parameters nv nen fn er E E Re nn Gate EVAUIEU TE mme Standard Plug ins Blacklist EUER NaMeElIST 2 Diada Trouble Shooting Guide Index 2015 Logic 10 2 RTCU Gateway 2 Control Panel 1 Introduction The RTCU Gateway 2 is a middleware solution that allows easy communication and access to remote units connected by using TCP IP communication technology The product works in any network architecture and constitutes a backbone in the communication between RTCU units and back end client applications The RTCU Gateway 2 fully supports the advanced RTCU Deployment Server RDS which is available as a free add on The features include e Advanced server architecture that supports thousands of clients and massive traffic It ru
10. and stopping the gateway instance and changing the startup type The Information group contains the status ofthe gateway instance The items can have the following states Gateway Running The gateway instance has been started and is running Stopping The gateway is currently stopping Stopped The gateway instance is not running Not installed No gateway instances are installed Startup Type Automatic The gateway instance starts automatically with Windows Manual The gateway instance must be started manually from the Control Panel Unknown No gateway instances are installed Maximum Clients Clients The maximum number of clients that can connect to the gateway instance Unknown The gateway instance is not running Time Service Time The current time of the gateway instance shown in both UTC and local time DST is added if Daylight Saving Time is in effect Unknown The gateway instance is not running and or no time information is available Disabled The time service is disabled for the gateway instance Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help Gatewa Status Configuration Plug ins A Information ctions Start Gateway Gateway Running Stop Gateway Startup type Automatic Max Clients 25 Change startup Time service UTC 2012 11 07 19 50 31 Local 2012 11 07 20 50 31 gt Create Remove 2015 Logic 10 16 RTCU Gateway 2 Control Panel 3 3 2 Gateway Co
11. e failed buffer overflow Client or monitor cannot connect An elevated log level may lead to a huge amount of storage data The log file system cannot keep up This may be a result of 1 No more disk space 2 Slow disk performance Please note that when this message occurs the log information will be incomplete as not all messages are saved Normally this is the result of 1 Missing port forwarding in gateway 2 Connection block by firewall Please check your Log parameters Possible solutions 1 Remove old log files 2 Lower the log level in Log arameters Possible solutions 1 Check your gateway configuration 2 Check your firewall configuration 2015 Logic 10 about 11 Ls close 8 configuration 16 configuration client 18 configuration log 19 configuration monitor 17 create gateway 12 H help 11 help about 11 help topics 11 ls license 9 plugins 20 plugins manager 9 R remove gateway 13 Su Standard Plug ins 23 Standard Plug ins Blacklist 23 Standard Plug ins Namelist 23 Status 14 2015 Logic 10
12. e gateway instance clients The access key 4 for the gateway instance clients The access key 5 for the gateway instance clients 2015 Logic 10 Control Panel 19 Key6 The access key 6 for the gateway instance clients Key7 The access key 7 for the gateway instance clients Key8 The access key 8 for the gateway instance clients Key9 The access key 9 for the gateway instance clients Key10 The access key 10 for the gateway instance clients All access keys are equal and work similarly and up to 10 available keys can conveniently be managed 3 3 2 3 Log parameters RTCU Gateway 2 Control Panel File Licenses Plug ins Help Gatewa Status Configuration Plug ins Property Monitor Client El Log Max entries 50000 Folder C Program FilessLogic 101 Level Errors and events Time kept 14 File size 50 Log lt gt Maximum entries The maximum number of log entries that can be held in the server buffer The server buffer is used by the monitor tool clients to read past log entries The default is 50 000 entries Legal values range from 1 000 to 500 000 Increasing this number will also increase the memory footprint of the gateway instance Folder The directory path the gateway instance uses when logging to files The gateway instance will create a folder with the gateway name in this directory and in this a folder for each day is created The log files are stored in lt folder gt lt gateway
13. eate Remove To manage a gateway instance select it in the list and use the gateway management pages to configure it A new gateway can be created with the Create button if there are gateway licenses left To remove a gateway select it a press the Remove button 3 2 1 Create gateway Pressing the above button will open a dialog to create a new gateway instance on the server Create Gateway Mame of the new Gateway instance E Client Port 5001 Max clients 25 Key AABBCCDD E Monitor Port 5002 Key GATEWAY 2015 Logic IO Control Panel 13 Press the OK button to create the gateway instance Press the Reset button to reset the configuration back to default values Press the Cancel button to abort creating the gateway instance Name of the Gateway Instance The name of the gateway instance is used to identify the instances and differentiate them from each other both for the server and the administrator The name is a Unicode string that can be up to 30 characters long For example Gateway 5001 Configuration The description of the configuration parameters and additional options for client and monitor can be found here Client parameters Monitor parameters The parameters that are not included in this dialog will hold default values and cannot be changed until after creation 3 22 Remove gateway Pressing the above button will completely remove a gateway instance from the server
14. iguration Plug ins Actions Information Start Gateway Gateway Running Stop Gateway Startup type Automatic Max Clients 25 Change startup Time service UTC 2012 11 07 19 50 31 Local 2012 11 07 20 50 31 gt i Remove The interface can basically be split into two areas the Gateway list and the Gateway management areas 3 1 Menuitems The following pages describe all the different menu items that are available in the Control Panel Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help e File e icenses e Plug ins Help 3 1 1 Menu item File The Exit command ends the Control Panel program AER Licens Exit 2015 Logic IO Control Panel 9 3 1 2 Menu item Licenses The Licenses dialog shows the licenses that are installed on the server When no license is installed the RTCU Gateway 2 accepts 25 clients on a maximum of 32 gateways For example it is possible to create one gateway with all 25 clients or two gateways one with 15 clients and one with 10 clients RTCU Gateway 2 Licenses Machine ID Clients Gateways BWPC License holder Unlicensed Clients used 0 of 25 Gateways used 0 of 32 Install License Additional licenses can be ordered from Logic IO to support more clients and gateways Each license is bound to the Machine ID of the server This information is therefore required when ordering To use the license file received
15. nfiguration The Configuration page is where the configuration of the selected gateway instance is managed RTCU Gateway 2 Control Panel File Licenses Plug ins Help ELITR Property Value El Monitor Port 5002 Key GATEWAY Max clients 4 Client Log Monitor lt gt When the gateway configuration is changed the Apply and Reset buttons are enabled T Press the Apply button to save the configuration The gateway will use the new configuration when it is restarted Press the Reset button to clear all changes made to the configuration For a description of the individual parameters follow the links below Monitor parameters e Client parameters Log parameters 2015 Logic IO Control Panel 3 3 2 1 Monitor parameters RTCU Gateway 2 Control Panel File Licenses Plug ins Help Status Configuration Plug ins Property Value E Monitor Port 5002 Key GATEWAY Max clients 4 Client Log Create Remove Port The IP port where the gateway instance listens for any monitor tool clients Key The access key for the monitor tool clients Maximum clients The maximum number of monitor tool clients that are allowed to connect to the gateway instance The default is 4 clients but up to 10 is supported 2015 Logic 10 18 RTCU Gateway 2 Control Panel 3 3 2 2 Client parameters Y RTCU Gateway 2 Control Panel File Licenses Plug ins Help Gatewa
16. ns as a Windows service This means that the gateway service will start without Windows log on and can also be managed remotely as a service Available in a 32 bit and a high performance 64 bit version Support for up to 32 separately configurable and isolated gateway instances Remote access via the included Monitor tool client Full password protection for remote access Up to 10 client keys are supported for more flexible password management Disconnect timeout for inactive clients Advanced filtering feature which allows monitoring logging on a specific client and or logging level Encrypted traffic for safer communication Compressed traffic This reduces the cost of communication Comes with a comprehensive user documentation Time service for centralized client time management local UTC Up to 10 monitor tool clients can be connected simultaneously Plug in architecture for extending functionality and integration to backbone applications Plug in developers kit available for free Free for use of up to 25 clients The license must be purchased for additional clients gateways System Requirements Operating Windows 8 Windows 7 Vista 2003 Server 2008 Server 2010 Server System Memory 200 MB 4 kB per client Hard disk 3 MB space Additional space required for log to files Other Network card TCP IP network protocol Permanent Internet connection with fixed IP address is recommended Large Packet Support Large Packet
17. nutes Blacklist Data File The data file used by the Blacklist plug in is an XML file with the following format blacklist node lt id gt 2000001 lt id gt lt text gt Message shown in log on rejection lt text gt lt node gt lt node gt lt id gt 2000002 lt id gt lt text gt lt node gt lt blacklist gt 4 2 Namelist The Namelist plug in allows the monitor tool to show a symbolic name text in the Clients list instead of the Node ID The Node ID to name mapping is read from a data file at regular intervals This ensures that the list of names for the Node IDs can be changed without having to restart the gateway instance 2015 Logic 10 z RTCU Gateway 2 Control Panel Namelist Configuration File The name of and the path to the data file Refresh The number of minutes between the plug in checks the data file for changes interval The default is 10 minutes This must be a value between 1 and 30 minutes Namelist Data File The data file used by the Namelist plug in is an XML file with the following format lt namelist gt lt node gt lt id gt 11110000 lt id gt lt name gt RDS server lt name gt lt node gt lt node gt lt id gt 11110001 lt id gt lt name gt RDS monitors lt name gt lt node gt lt namelist gt 2015 Logic 10 z RTCU Gateway 2 Control Panel 5 Trouble Shooting Guide Error Reason Server is running low on disk space Logging to fil
18. ply and Reset buttons are enabled T Press the Apply button to save the configuration The gateway will use the new configuration when it is restarted Press the Reset button to clear all changes made to the configuration 2015 Logic 10 Standard Plug ins 23 4 Standard Plug ins The RTCU Gateway 2 includes a plug in framework for easy extension of the gateway functionality The following standard plug ins are included in the RTCU Gateway 2 server installation e Blacklist This plug in will prevent clients from connecting to the gateway based on their Node ID e Namelist This plug in allows the monitor tool to show a text string instead of the Node ID for clients A plug in can be developed by using the free RTCU Gateway 2 Plug In Developers Kit that also includes the full source code to the above plug ins 4 1 Blacklist The Blacklist plug in will compare the Node IDs of all clients that try to log on to the gateway with an internal list and if the Node ID is found on the list the logon is denied The internal list is read from a data file at regular intervals This ensures that the list of Node IDs that are denied logon can be changed without having to restart the gateway instance Blacklist Configuration File The name of and the path to the data file Refresh The number of minutes between the plug in checks the data file for changes interval The default is 10 minutes This must be a value between 1 and 30 mi
Download Pdf Manuals
Related Search