MatrikonOPC Tunneller User Manual

Welcome to MatrikonOPC!Click here to find out what's new in this release MatrikonOPC™ provides equipment data connectivity software based on the OPC standard. The MatrikonOPC promise is to empower customers with reliable data access to all major automation vendors’ systems, provide practical OPC training and deliver superior client care. MatrikonOPC builds close relationships with its customers to best address their business and technical needs. With offices in North America, Europe, Asia-Pacific and the Middle East, MatrikonOPC provides local presence on a global scale. MatrikonOPC is a vendor neutral connectivity supplier. MatrikonOPC is the world's largest OPC developer, with a collection of over 500 interfaces, and provides connectivity to every major control system and application on the market. These products and devices are the culmination of MatrikonOPC's experience in the design and implementation of device-specific communication drivers. The MatrikonOPC Advantage MatrikonOPC: l l l l l l l Plays a key role in the OPC Foundation. Has expertise in OPC technology training. Has OPC expertise deployed all over the world. Has a breadth of OPC device connectivity. Serves as a focal point for all aspects of OPC connectivity. Works with all vendors to achieve true interoperability. Leads in technology innovation. MatrikonOPC - the Industrial Connectivity Experts! Release Notes MatrikonOPC Tunneller These are notes that are added to and sent with the latest release of MatrikonOPC Tunneller. Notes: l l Tunneller 5.0.0 is compatible with Tunneller version 3.0.4 and higher. Full testing of Tunneller is done with one, two, and three connections in our lab. Tunneller is partially tested against more than three connections. It is expected to support many connections provided that the CPU's, network, and OPC servers involved are able to handle the load. Release Notes for MatrikonOPC Tunneller v5.0.0 (September 13, 2013) New Features and Enhancements: l l l l User documentation suite converted to .chm format. Added support for 64 Bit OPC Clients connecting to the Client Side Component. Added support for the Server Side Component to locate and connect to 64 Bit Out-Of-Process OPC Servers. Added OPC DA items to the DA Client Side Component to monitor the connection status, licensing, and related diagnostic information about the connection. Numerous User interface improvements on the Client Side Component Configuration Tool: o o o l configuration import/export logging local and remote license status l l l Added support for Windows 7 and Windows Server 2008. Removed support for Windows 2000. Added additional methods to A&E IOPCEventSubscriptionMgt: o o Refresh CancelRefresh l l l Automatic refresh on connect to upate the state of subscribed condition events if the TCP/IP connection was lost. Client Side Config Tool support import and export of configured connections and settings. Client Side Component logging configuration is not part of the CSC Config Tool. Resolved Issues: l l 0014430: The Tunneller CSC Config Tool provides better feedback when a connection fails. 0015085, 0016016: Connections from hosts with multiple NICs or multi-homed machines will succeed when IP restrictions enabled on SSC. 0015948, 0011569: OPC Client data type change request transferred properly; improves interoperability with Citect OPC Server. l Known Outstanding Issues: l 0017046: Interpolated reads through Tunneller with the PI OPC server on certain tags returns an error. o Workaround: Perform the interpolated read with the start and end times reversed. l 0014498: If an OPC client connected to Tunneller performs multiple asynchronous writes to the same tag in very quick succession (i.e., in the same millisecond), Tunneller may transmit the writes out of order. o Workaround: Use synchronous writes or add a small delay between writes. l If there is a network failure while a browse command is being executed, the end OPC client and the CSC may need to be restarted. 0015085: Tunneller may not detect network status when using dual NICs. 0019191: SetState call on A&E Subscriptions may not work properly when multiple subscriptions are used and one is deleted. 0014498: When multiple writes are sent using separate write commands to a remote OPC server in a short period of time, the writes to the device may not happen in order. 0017046: Tunneller HDA queries for interpolated reads may fail against OSI PI. 0017872: A&E Events not received from Maestro OPC Server over a remote connection. l l l l l Release Notes for MatrikonOPC Tunneller v4.1.0 (October 24, 2012) New Features and Enhancements: l l l 0006806: Item IDs are now cached to speed up remote browsing. 0018160: Added ability to hide available DA3 interfaces. 0018324: Multiple clients using IOPCItemSamplingMgt DA3 interface improved. All clients with buffering and sampling options configured get all of the sampled values. Note that all clients must use the same sampling rate setting. The last client to set the sampling rate affects the sampling rate used for that item and all of the clients receive the updates based on that sampling rate. 0014502: The default Client-Side Gateway settings for Communications Timeout has been changed to 10 seconds and the default Communications Retry Attempts setting is now 5. This change improves compatibility in some circumstances. The installer has been updated to offer to make adjustments to the Windows TCP stack settings on Windows 7 and Server 2008 operating systems to improve communications stability and performance. If selected by the user, the AutoTuningLevel and RSS (Receive Side Scaling) settings are adjusted. The Troubleshooting section provides more details on these settings. l l Resolved Issues: l l l l l l 0017799: MatrikonOPC Funnel items fail to validate when encryption is used. 0015947: Tunneller does not put through the requested data type to the end OPC server. (Note: Only passing data types for new items has been resolved. Existing items must be removed and re-added by the client to change data type.) 0018419, 0018420: Handling of semi-compliant A&E servers should be improved. 0016934: Valid hostnames cannot be added to access list. 0018564: Exception could be thrown when deleting OPC groups. 0018607: The Retry Attempts option configured using the Client-Side Gateway Configuration Tool is incorrectly incremented by 1 by the CSC. If a subsequent network break occurs for longer than the session timeout. If there is a network failure while a browse command is being executed.2 (February 2.5 (June 6. The amount of memory increase may be significant for configurations that have large amounts of points. Release Notes for MatrikonOPC Tunneller v4.1 (November 3. o Workaround: Perform the interpolated read with the start and end times reversed. Release Notes for MatrikonOPC Tunneller v4.0..Known Outstanding Issues: l l l l 0017046: Interpolated reads through Tunneller with the PI OPC server on certain tags returns an error.0. 0015085: Tunneller may not detect network status when using dual NICs. 2012) Resolved Issue: l 0009480/0017778: Repeatedly connecting/disconnecting to/from ReLabs OPC server can cause the Tunneller Client-Side Component (CSC) to crash Release Notes for MatrikonOPC Tunneller v4. 2012) Resolved Issue: l 0018363: If a network connection break occurs while Tunneller is adding or validating items. 0014498: If an OPC client connected to Tunneller performs multiple asynchronous writes to the same tag in very quick succession (i. 2012) Resolved Issue: l 0018102: A data callback with a single item listed multiple times results in items having non-sensical HRESULT error values in *ppErrors. 2012) Resolved Issue: l 0018294: Tunneller memory use increases for approximately the first two hours. the end OPC client and the CSC may need to be restarted. the session becomes corrupt.4 (May 1. Resolved Issues: l l 0017696: Tunneller throws exceptions during Sync Writes. Release Notes for MatrikonOPC Tunneller v4. 2011) New Features and Enhancements: l 0017939: Tunneller Server-Side Gateway Configuration Tool includes the Commit All Log File Writes option.0. 0017846: Tunneller does not indicate the correct source of an exception when it caches from an OPC server.3 (March 5.e. all items go bad and never return to good quality. Release Notes for MatrikonOPC Tunneller v4. in the same millisecond).0. . o Workaround: Use synchronous writes or add a small delay between writes. Tunneller may transmit the writes out of order.0. the Acknowlege.Release Notes for MatrikonOPC Tunneller v4.0 (May 31. Tracking.0. Resolved Issues: l l l l 0015018: Resolved an issue where an exception was thrown while adding items from ODM if the Tunneller CSC was disabled. and Condition events are supported. 0016471: When re-establishing a session.0 (January 21. Condition Name browsing. Items that are momentarily unavailable after disconnection can now be retried passed the AddItemRetries setting when using the AddPendingItemsPeriod option in the TunnellerOpts. Supported A&E interfaces and methods: o IOPCCommon o IOPCEventServer n GetStatus n CreateEventSubscription n QueryAvailablefilters n QueryEventCategories n QueryEventAttributes o IOPCEventSubscriptionMgt n SetFilter n GetFilter n SetReturnedAttributes n GetReturnedAttributes Release Notes for MatrikonOPC Tunneller v3.1 (February 25.5. Release Notes for MatrikonOPC Tunneller v3. Simple.5. 0016969: When a server does not respond to an AddItems call within the processing timeout OPC_E_NOTFOUND is returned . Tunneller CSC may drop items not available at connection time. and Condition State Management operations are not supported. 2011) New Features and Enhancements: l l l l Added support for Microsoft Windows 7.ini. Condition events are subscribe-only. 0012285: Tag Security for the Simulation server cannot be launched from OPC Explorer if . 2011) Resolved Issue: 0017104: Displaying NAN using Float numbers will now show up properly. 2011) New Features and Enhancements: l l l Microsoft Windows Server 2008 added to minimum software requirements.Net is not already installed on the machine. Microsoft Windows NT is no longer supported. Refresh. The OPC Alarms and Events interface is now supported with an additional A&E-only Client-Side Gateway. 5. Resolved Issues: l l l l 0015184: Sentinel RMS Licensing library shows a message error. 0015366: Qualities do not go bad if service is stopped and Tunneller does not restart the end OPC server. Release Notes for MatrikonOPC Tunneller v3. 0014917: The hardware licensing drivers do not install on Windows 2000 SP3 or SP4.4.2. 2009) Resolved Issues: l l 0014786: Tunneller does not support the NotifyWhenOnlyTimestampChanges registry option. Increased the default value for Communication Timeout (Add Remote Tunneller Connection window) on the Client Side Component.05 compliant.2. 0015363: Tags stay good even when the end OPC server is restarted. 2010) Resolved Issues: l l l l l 0015635: Tunneller impersonation cannot distinguish between NT Authority\System users on different machines. Users may now have only one instance of the Client-Side Gateway Configuration Utility. which enables transmitting updates when just the timestamp has changed. 0014522: Tunneller hardware licensing is not compatible with 64-bit operating systems.0 (September 20. 2010) New Features and Enhancements: l l l l Product user documentation converted to stand-alone server standard.0 (November 9.0 (March 18. The minimum software requirements are: o Microsoft Windows XP SP2 o Microsoft Windows 2003 SP0 o Microsoft Windows 2000 SP4 Resolved Issue: l 0015018: Resolved an issue where an exception was thrown while adding items from ODM if the Tunneller CSC was disabled Release Notes for MatrikonOPC Tunneller v3. or the Server-Side Gateway Configuration Graphic User Interfaces (GUI). 0014150.3. Release Notes for MatrikonOPC Tunneller v3.2. Client-Side Gateway Key Manager. . from 3 seconds to 5 seconds. 0015623: The Tunneller Client Side Component (CSC) consumes 100% CPU if an OPC client is actively trying to write to an end OPC server that is currently unavailable.0 (June 1. 0015536: Access violation exception thrown when re-optimizing items in the Tunneller CSC. 0015530: Tunneller is not fully DA 2.3. 2010) New Features and Enhancements: l Added support for IPOCItemSamplingMgt DA3 interface.Release Notes for MatrikonOPC Tunneller v3. 0015540: The Tunneller Server Side Component (SSC) leaks memory which leads to a Tunneller Server (SSC) crash when the end OPC server is not available. open at the same time. An additional log file is created to diagnose connection failures. is improved Shutdown request sent by remote OPC server is handled properly. Release Notes for MatrikonOPC Tunneller v3.0. within the period defined by Communication Timeout option. especially on unreliable communication networks: Client-Side Component Option Server-Side Component Option Timeout Retries No matching option on SSC configuration utility GUI. Detecting of application instance that is already running. Session timeout No matching option on SSC configuration utility GUI.1. For more information. Client-Side and Server-Side Gateway Configuration Utilities are modified to warn the user if configuration changes disallow further communications.2. User’s Manual is updated.l l 0014017: Hardware licensing driver may cause the computer to freeze.Unable to browse remote OPC Server message displayed section in the MatrikonOPC Tunneller User’s Manual. please refer to the Problems and Solutions . or access to the system registry fails. Communication Timeout Retry Attempts Processing Timeout ReconnectTime ConnectDelay l l l The start-up type of CSC services (MatrikonOPC Tunneller CSC and MatrikonOPC HDA Tunneller CSC) is changed from Automatic to Manual. Error handling is improved to inform the user of cases when configuration files cannot be read or written. Logging is improved (some log message texts are modified and more detail logging is added for some cases). Client-Side Gateway Configuration tool now detects connection failures faster. .0 (January 20.2. Resolved Issues: l l l l l l l l l Synchronous HDA update history requests now return the same HRESULT code as returned by remote OPC server. 2009) New Features and Enhancements: l Logging is available in the Client-Side Gateway Configuration tool. 0013495: DCOM hyperlink in the User’s Manual points to old support site and does not find DCOM documentation. Release Notes for MatrikonOPC Tunneller v3.0 (March 11. Connection – reconnection algorithms are revised to provide more reliable communication on different network configurations. ProgId for Tunnelled OPC servers can be renamed without losing of functionality (on Client-Side Gateway configuration utility). 2009) New Features and Enhancements: l The following configuration options are passed from CSC to SSC to provide consistent behavior of SSC and CSC. Upgrading/repairing issues are resolved to keep existing configuration settings. o Connection between the Client-side gateway and Server-side gateway is establsihed via the Internet (with different Internet service providers). Default value for option DeactivateGroupWhileAddingfOfItems is changed to 1 in the tunneller. Resolved Issues: l l l l 0011117: Client-side Gateway Key Manager .ini configuration file. 0010672: If the end OPC server restarts. 2008) New Features and Enhancements: l l l Modified Server-Side Key Manager (renamed to Server-Side Gateway Configuration Tool) is used to configure all settings for the Server-Side Component including impersonation and restriction of the access to OPC servers in conjunction with encryption settings. 0009570: Cable pull results in perpetual reconnect attempts from CSC even though it connects to SSC.1. 0010909: An error message appears when trying to add an impersonation to the server-side gateway.2. For each Remote client (which can be authenticated by its IP address. and so on.0 (March 12. 0009724: TunnellerOpts.0.Resolved Issue: l 0012138: Client-side cannot connect to Server-side on some network configurations.web link on the About window does not work. Minor GUI changes on Client-Side Key Manager and Server-Side Configuration Tool. not msec.0 (August 15. 0009541: NT install needs "browse registry" checked to be able to browse.INI should specify Reconnect Time as being in sec. but this is not enabled by default. items stop being updated. Configuration of impersonation settings can be performed using the Server-Side Gateway Configuration Tool. Additional Advanced tab allows the user to configure settings stored in the tunneller. 0009558: Do not log "browse delimiter" option on SSC – unused option logging is eliminated. 2008) New Features and Enhancements: l Integration with MatrikonOPC Security Gateway is implemented. Tunneller SSC now has the ability to connect to the end OPC server using a certain local user account depending on the user of the OPC client process on client side. Added functionality to restrict access to OPC servers. 0009601: Expired license causes Tunneller to generate random data. 0009647: OPC Group or Item Deactivate/Activate causes extra callback with bad quality. using port forwarding.0 (February 26. then Tunneller Server-Side Component exposes only Security Gateway and allows connections only to it.ini file. 0011006: Impersonation changes do not trigger the Apply button to save the changes (SSC configuration panel). Release Notes for MatrikonOPC Tunneller v3. host name or . 2008) Resolved Issues: l l l l l l l l l l l 0008692: Installer does not work on NT4. Release Notes for MatrikonOPC Tunneller v3. 0009580: Cannot list OPC servers on encrypted connection.1.1. Now only part of OPC servers installed on the Server-Side host can be reachable for the Remote client. Release Notes for MatrikonOPC Tunneller v3. via router.1. If Security Gateway is installed and licensed on a remote (server-side) box. Added user impersonation functionality. Communication retries default value is changed to 0 on Server-Side Component. Resolved Issues: l l l l l l 0007074: Tunneller still tries to browse end server when no browse is available. it detects communication failure and disconnects. o If there are no requests being processed. the time interval between messages sent to Client-Side (Keep-Alive messages or regular communication messages) will be no longer than half of Timeout. Now the Server-Side Component can send Keep-Alive messages periodically if the execution time for a request takes a long time. Note: On the Server-Side Component. Now the Client-Side Component returns the E_NOTIMPL return code to OPC client’s browsing calls quickly. If DA data updates. If ProcessAffinity is set on system registry (see the Troubleshooting section for information about how to set this parameter). instead of the Network Timeout parameter. Now OPC clients can use CoCreateInstanceEx function as well as CoCreateInstance to connect to the Tunneller Client-Side Component. 0008286: Log file shows message that error occurred setting process affinity mask. that end OPC server does not support browsing and the Client-Side Component does not send more browsing requests to the ServerSide. o Communication Timeout should be configured to the value higher than the time required to send the largest message over the network. Socket error codes are logged. it will be set only if system does support it and setting does not match with current setting. timeout should be set to the value equal to or less than the minimum value of the Communication Timeout parameter configured on all clients. the error code is logged on both Client and Server-Side Components. once it is detected. Server-Side does not send Keep-Alive messages. In this connection.l l l l domain\user name or by a combination of them) the list of accessible OPC servers can be configured using Server-Side Gateway Configuration tool. Modified license checking algorithm. Moreover. Its default value is 60 seconds. received by OnDataChange call-back from the OPC DA server. so what CPUs will be used will be defined by system settings. 0007997: Tunneller does not respond to CoCreateInstanceEx calls. have a failed error code. .5 of the value set by Communication Timeout parameter. Now Client-Side Component by default does not try to set process affinity mask. Note: Un-registering of OPC servers using Client-Side Gateway Configuration Tool and re-registering them again is recommended if previous version of Tunneller was upgraded to this version. 0008081: Delay after connection is longer than configured by the PostConnectDelay parameter. l Revised communication algorithm. On the Server-Side Component. Handling of the case when end OPC server does not support browsing functionality is improved. User’s Manual is revised. two timeout parameters are used on the Client-Side Component: Communication Timeout and Processing Timeout. Its default value is 3 seconds. 0008287: IOPCHDASyncRead -> ReadAttribute call causes exception if number of values higher than number of attributes. o If Client-Side sends a request to Server-Side and does not get any response (neither normal response nor KeepAlive message) from it during the time more than 1.ini file and can be configured using the Server-Side Gateway Configuration Tool. o Processing Timeout and Communication Timeout are configured using the Client-Side Gateway Configuration Tool on the Client-Side component. Processing Timeout should be set to the value higher than the time required to execute a request taking the longest time. Timeout parameter used on Server-Side Component has the same meaning as Communication Timeout. o If there are any requests being processed. the corresponding timeout parameter is stored in the tunneller. checking and deletion of duplicate sessions will not be performed.ini file.2. If items are added by the OPC client during an attempt to reconnect. 0009451: PostConnect Delay not logged.0 (August 15. 0009504: Subnet mask algorithm should be changed to industry standard (Encryption settings). If this parameter is set to 1. Maximum size of log file increased to 500 Mb on Server-Side Component. the user should select option defining if Tunneller is being installed on a Stratus box (default value of the option – non Stratus box). Passing of Start and End Time arguments through Tunneller is modified additionally. only software licensing is supported.l l l l l l l l l l l l l l l l l 0008310: If items are added during an attempt to reconnect after a communication failure. their initial qualities are set to bad. empty time is allowed if the Start Time is equal to “NOW”. Default value for option DeactivateGroupWhileAddingfOfItems is changed to 0 in the tunneller. non-specific. . 0009180: Tunneller Server-Side component does not call RemoveGroup to remove OPCGroup. 2007) New Features and Enhancements: l Support for licensing on Stratus boxes has been added. At installation. Unused options are removed from TunnellerOpts.0 (November 16. Passing of End Time argument through Tunneller is modified additionally. failure actions are set to Restart the Service.ini configuration file. Release Notes for MatrikonOPC Tunneller v3. so current values for attributes are read correctly. Note: On the Stratus box. When the Server-Side Component service is registered by the TunnellerServer /Install command. 0009476: All Tunneller components should log their start-up parameters on level LOG_ALWAYS.0. items that were added before the communication failure will not update values or qualities.4. 2007) New Features and Enhancements: l New parameter is added (DeleteDuplicateSessionsOnNewConnection under TCConnection section) on tunneller. bad configuration. Potential exception causes are eliminated on GetItemAttrubutes and ReadAttribute calls to the end OPC HDA server. Logging of options is revised and now all configuration options are logged into a log file on both Client-Side and Server-Side Components.0. If its value is 0. 0009448: Tunneller CSC does not create log files until the logging settings are changed.ini configuration file. and OPC server ProgID and category. when SSC receives the request to create a new session from CSC. Please contact MatrikonOPC Support if support of a hardware license key is required. now one of them can have an empty value. Service Pack 6. 0009481: Config file has two copies of port number. item syntax was invalid. they are not updated after reconnection. first it will find and delete all sessions which belong to the same combination of CSC IP address. At this point. only one session and connection to the end OPC server will be created for each combination of "CSC IP address/OPC server ProgId". Note: During a reconnection attempt. 0008598: Installation on WinNT – Tunneller can be installed on Windows NT 4. 0009449: IOPCHDA_SyncRead::ReadRaw returns E_INVALIDARG when bBounds==TRUE and dwNumValues==1. 0009447: Tunneller still has Tunnneller2_2 in Tunneller Config INI file entries. Release Notes for MatrikonOPC Tunneller v3. 0008545: Log file displays AppID instead of ProgID 0009404: CoCreateInstance for connection to the end OPC server first should be called as for Local server. Requests made during the reconnection attempts (including GetStatus requests) will fail. but after reconnection its quality is changed to bad. So. 0009455: IOPCHDA_SyncRead::ReadAttribute returns E_FAIL instead of E_INVALIDARG. Release Notes for MatrikonOPC Tunneller v3. Addition of a Key Manager to manage encryption keys for both CSC and SSC. 0005026: SSC does not close connection to OPC server when HDA client disconnects from CSC. Tunneller CSC or Client Gateway Configuration Tool can not establish more than one connection. Some modifications are also made to minimize the number of connections to the end OPC server. The new file EventLogger.dll is included into install package which contains event IDs. this parameter should not be set to 0. 0005075: Tunneller server Private bytes ramps to ~1. 0005386: Tunneller does not pass HRESULT 80070057 (invalid parameter) to end OPC client. If CSC cannot process all update messages sent to it (due to high CPU load on the machine where CSC is running. In other words. the original return code that was returned by the remote OPC server. If execution of operation time-out is detected on CSC. Resolved Issues: l l l l l l 0005287: Tunneller does not connect to IP Addresses. New configuration parameter DelayAfterAddItems is added for CSC. 0005168: “Invalid Retry Parameter Specified” – when retry set to forever and after Client-Side Configuration tool is closed and re-opened. 2007) Resolved Issue: l 0007038: Dual-NICs are not handled correctly. (NoClientsDisconnectionDelay parameter in TSConnectDelay section of TunnellerOPts. an additional message with level 2 logging appears in the CSC log file: TIMEOUT WARNING: Probably the network timeout parameter should be increased by %d seconds. When user enters IP address or host name on Client-Side Gateway Configuration tool. If all connections to server side component are initiated from Tunneller client side components running under Windows operating system. 0005006: Application log showing missing event descriptions for HDA CSC.0 (March 9.0. Note: Two entries can be open for the same host. 2007) New Features and Enhancements: l l l l l l Optional encrypted communication between the Client-Side Component (CSC) and Server-Side Component (SSC) using shared key encryption. Now connection to the end OPC server from SSC will be closed if no more clients are connected to the CSC for more than configurable time interval.0. Handling of operations that require a long time for execution (with large number of items and/or data) is improved. . or due to slow network communication speed). Release Notes for MatrikonOPC Tunneller v3.20. the message queue is limited by a configurable number.ini file). SSC stores updated Value/Quality/Timestamps in its cache and sends them to the CSC when the message queue allows them to be sent. The algorithm of updating DA values on SSC and sending messages to the CSC is modified. both IP address and by host name. its value is stored as entered by the user.0.l The default value is 1. Now Tunneller HDA returns to the OPC client. Note that some optional methods are not implemented. Optional compression of communication messages between CSC and SSC added to reduce network traffic. HDA support is enhanced and now it is fully compliant with the OPC Historical Data Access Specification Version 1.1. The way events were logged on Window Event Logging system is modified.0 (August 1.7GB and declines with concurrent established connections. but later SSC sends response for that operation. ini file. If an attempt to launch another instance is made. Now all Tunneller services are registered with Windows-format path to executables and with description. Filemon tool from Sysinternals was showing buffer overflow messages.l l l l l l l l l l l l l 0005071: Once licensing expires . Spelling error on log files are corrected (bugs 5279 and 6405).log file: o COPCClient::LocalActivateItems ERROR .4. Other Changes: l l l l l Only one instance of Tunneller SSC. Configurable number of retries is introduced on CSC.) It should .0. it is modified to: “Could not register class factories.ini file).0) when OPC Group was always deactivated before adding of items and activated after. (Add Remote Tunneller Connection dialog window of Client-Side Gateway Configuration Tool. 0003630: Executable names should represent their function. connection to remote OPC server errors).) 0004165: Tunneller gives buffer overflow errors when accessing tunneller. Frequency of license checking is changed from every 3 seconds to every minute on SSC. Default value for MaxAddMessage parameter (in TunnellerOpts. It differs from previous version (2.ini file to control activation of group while adding of items.ini and TunnellerOPts.ini. The reason qualities of items were changing to bad. IP address and host name for both local and remote computers are logged on CSC and SSC. 0006480: Logging: Failed with DSResult: 8300000A. A warning message appears when Tunneller is configured to run as a service. Probably Tunneller CSC is configured to run as service.When retry is set to forever and after Client-Side Configuration tool is closed and reopened. The way Tunneller accesses tunneller. Default value for Session Timeout parameter (tunneller. Note: SSC terminates not immediately but after some delay (about 1 minute). 0005215: "Class not Registered" error if you try to run OPCTunneller.” 0003343: Failure to connect to server does not save server name. Its default value is 0. 0004050: Adding multiple items causes present items to go bad. Now the value of Retry Attempts parameter is stored separately even if Retry Forever check box is on.ini does not have all Options specified in configuration.ini files is modified so now there are no more buffer overflow messages.ini and tunneller. On Tunneller HDA wrong messages are eliminated from tunneller." . then dialog window will not be closed keeping current field values. Both TunnellerOpts. causing memory growth and high CPU usage on CSC and SSC. Issues.exe (Client-Side) if Tunneller client service is not running. Implementation of AddItems functionality is reviewed. are resolved in cases when large number of items and/or data is processed or error conditions happen (for example communication errors. 0005168: "Invalid Retry Parameter Specified.log files are spammed with excessive messages (40 per minute). (AddItemRetries and AddItemDelay parameters in TunnellerOpts. If connection with SSC cannot be established or fields are not validating. so OPC Group’s state is not changed while adding of items. applications show warning message and terminate. New parameter DeactivateGroupWhileAddingfOfItems is added for SSC (tunneller.ini file) is changed from 120 to 0 which corresponds to its pair on CSC (ReconnectTime parameter with default value 0).ini) is changed from 3000 to 1000. is that the SSC was deactivating OPC Groups before the adding of items and activating after adding. 0006381: TunnellerOpts. CSC and CSC HDA can be running at the same time. The new DeactivateGroupWhileAddingfOfItems parameter is added on tunneller.ini files are modified and include all configuration options. but was attempted to be run as a regular application is made. that means do no deactivate OPC Group before adding item. 0004562: Would like log file to show local computer name. which is used on AddItems call to the end OPC server.DA is not supported based on Tunneller client request o COPCClient::SyncItemStates Failed with DSResult: 8300000A 0005011: There are no descriptions for any of the Tunneller Services. The CSC now allows the use of two CPUs by default. the SSC can now retrieve the Program IDs (ProgIDs) of the local OPC servers. New option to control when items are validated. 2006) Release notes updated with HDA interfaces supported February 2. A memory leak in the SSC has been fixed when adding invalid DA items. The Client Configuration Tool (CCT) can now run on Windows NT and collect ProgIDs of remote OPC servers. Added an option in SSC to have a configurable delay after connecting to the end OPC server.3. Resolved deadlock that could happen when setting the client name. Release Notes for MatrikonOPC Tunneller v2.1. the HAD CSC would not detect a valid software license. When two OPC clients attempt to connect at the same time. Internal changes to isolate OPC clients in the SSC and improve communications when heavily loaded. All async communication would fail.0 (March 9. and if it takes an extended period of time to complete.4. Release Notes for MatrikonOPC Tunneller v2.0 (December 15. Memory leak in the SSC when polling has been fixed. Resolved Issues: l l l Slow memory leak removed when calling remote GetStatus. This allows timeouts to be reduced while allowing long commands to execute to completion. License fix for Multi-Processor Computers.0. On multi-processor computers. 2006. l l Resolved Issues: l l l l l l l l l l l When installed on Windows NT. Release Notes for MatrikonOPC Tunneller v2.3. 2006) New Features and Enhancements: l When a command is sent from the CSC to the SSC. the SSC will send “still processing” messages back to the CSC. The GetStatus call now returns a failed code until a running code is retrieved from the end OPC server.0 (January 31.eliminate issues when starting some end OPC servers that take a long time.0. ReadAttribute (HDA Data Type) now correctly returns the data type of the item. The CCT can now run on Windows NT and collect remote ProdIDs. . and attempting to add items can immediately fail after starting though GetStatus call receives Running status. a deadlock may occur. Communication problems when changing the state of a group when the TCP session is broken. 2006) New Features and Enhancements: l l Added an option in CSC to allow/disallow items that have never had at least one update from the end OPC server to be included in updates to the end client. Hardware for CSC and SSC is now implemented. Fixed browsing for OPC servers that only support flat browsing. Only items that have had at least one update from the end OPC server are included in updates to the end client. Supported HDA interfaces and methods: o IOPCCommon o IOPCHDA_Server n All but GetAggregates does not return a complete list of aggregates o IOPCHDA_Browser o IOPCHDA_SyncRead n ReadRaw n ReadProcessed o IOPCHDA_SyncUpdate n Insert n Replace n Insert/Replace Support for connecting to OPC servers that are DA 1. The number of items in one call is configurable. Validating an item no longer adds the item. Tunneller will now first try to reconnect to the same session (maintained state) on the SSC before trying a full connect and rebuilding the state. CCT now lets the user un-register all the connections to a single computer at once. GetStatus returns the status in the field of the status structure when the connection to the SSC has failed.New Features and Enhancements: l l l Added HDA support via an additional HDA-only CSC.2. Release Notes for MatrikonOPC Tunneller v2.2. Changed how we load the Tunneller COM object for more reliable object creation. Fixed reconnect code when the SSC needs to reconnect to a failed OPC server.0 only. 2005) New Features and Enhancements: l l l l l l l l Added configurable delay describing the minimum amount of time Tunneller will wait between initiating a TCP connection. Increased COM marshalling efficiency. .0 clients can now get string arrays in the subscribed updates. Implemented Tunneller client-side and server-side session reconnection. Connections made by DA 1. Added option to not overwrite the SSC log on start-up. Connecting the TCP link now re-establishes the connection by re-adding the items in bulk calls. Changes to have any updates sent out (subscribed. All non-OPC item types are returned as bad items. polled) have a bad quality before they are updated from the end OPC server.0 (November 4. Resolved Issues: l l l l l l l l l l Tunnelled ProgIDs are now registered only under the OPC category they are registered under on the remote machine. Resolved issues which resulted in memory leaks under certain situations. New Features and Enhancements: l Support for side-by-side install with Tunneller 1.x versions on the same machine. Mixed mode install logging will work for both Tunneller 1.2. 2005) New Features and Enhancements: l l l l l l l Service names have been changed to allow easier identification of components: o Client-Side Component (CSC) o Server-Side Component (SSC) Installation package allows for mixed install of Tunneller 1. Release Notes for MatrikonOPC Tunneller v2.1. Resolved SSC crash issue.0 and 2. the SSC will now retrieve the list of servers from the registry directly. “Remote” GetStatus call now propagates a failed code to the end OPC client.1 and Tunneller 1. Resolve issues regarding concurrent client browsing.0 (September 19.x and 2. Resolved Issues: l l l l l l l AddItems changed to allow multiple adds in a single call. Clients no longer block on calls when Tunneller is trying to connect. The installation package now offers customers the ability to install Tunneller 2.1.2.0 (February 21. If the enumeration of remote ProgIDs fails. OPC Shutdown message is now passed back to the OPC client.2. The CCT now clears bad entries and replaces them with default values.1.1.05 compliance with latest release of OPC Foundation test tool.2 has backward compatibility with Tunneller 2. IOPCSyncIO read call no longer misaligns data when some of the items are returned with E_FAIL.1. All OPC data types now supported (including currency and arrays).1 is not backwards compatible with 1. Numerous changes to increase stability. Release Notes for MatrikonOPC Tunneller v2.Resolved Issues: l l l l l l l l l l l l Items no longer become inactive when they are expected to be active. The networked computers dropdown list in the CCT no longer appends to the list every time it is opened.1. DA 2.0 at the same time. Add/Validate fix for not validating any items when any bad items exist. New communications options added.x.5. Resolved issues which resulted in memory leaks when not connected.1.1. Increased robustness of TCP communication. Hardware licensing is now working for both SSC and CSC. Updated Client Configuration Tool to allow user all available options at connection creation. .2. Tunneller 2.x versions of this product. 2005) Note: Tunneller v2. True asynchronous communication across TCP Link.1 and 2.0. 0 (May 6. Fixed bug: Disabled unsupported OPC interfaces DA 3. Tunneller 2. Short. This is the latest list of overrides. instead of the main Matrikon.OPC.0.Resolved Issue: l Locking issue fixed where a Tunneller client reconnecting to a Tunneller server would lockup-up and not respond. which would make the override enabled or disabled on ALL Tunnelled servers. Fixed bug: Modified DA Write() and Device Read() to return E_FAIL during network connection loss.0. l The override registry keys available in 1. Any customers currently running Tunneller 1.0.exe support tool from the install package. Tunneller 2.0.1.1_ER (December 4. A&E 1.OPC.1 and Tunneller 1. Fixed bug: Removed MTKTPC.Tunneller ProgID transparent to OPC clients.0.x must upgrade ALL Tunneller nodes in the system to version 2.1.0.0.x versions.x versions of this product.0 is not backwards compatible with 1. 2004) Notes: l Tunneller v2. Fixed bug: arrays of type smaller than int (Boolean.5. Resolved Issues: l l l l l l l l l Fixed bug: DA browsing aliases and multiple levels that required OPC_BROWSE_TO recursively browsed from the root of the browse tree. Tunneller 2.0. Any customers currently running Tunneller 1.0 (December 20. (Note that you will replace “**PROGID**” with the Tunnelled ProgID that you wish to add the override to): HKCR\**PROGID**\OPC\Overrides\ .0 and Tunneller 1.1. 2003) New Features and Enhancements: l Three new override registry keys were added.x versions cannot be installed on the same machine.x versions cannot communicate with each other. Release Notes for MatrikonOPC Tunneller v2. Fixed bug: memory leaks related to DA Device Read() and Write(). Fixed bug: during network failure DA item qualities change to OPC_QUALITY_COMM_FAILURE.0 and Tunneller 1. Release Notes for MatrikonOPC Tunneller v2. Robustness and stability of Tunneller has been significantly improved. 2004) Note: Tunneller v2. Fixed bug: DA flat browsing causes memory leaks.1 and Tunneller 1. Release Notes for MatrikonOPC Tunneller v1.x must upgrade ALL Tunneller nodes in the system to version 2. Tunneller 2.x versions cannot communicate with each other.Tunneller ProgID. When uninstalling Tunneller all Tunneller specific program IDs are now removed. etc…) were not read or written correctly. Fixed bug: DA browsing appears slow.0.x versions cannot be installed on the same machine. Made the Matrikon.x versions are no longer supported in 2.x versions of this product. You can put the ‘Overrides’ key under any Tunnelled ProgID now.0. New Features and Enhancements: l l l l l Tunneller Server-Side Gateway now runs as a service. and the previous three were moved so they are all now server-specific. Added version information reporting to the Tunneller server log file.1 is not backwards compatible with 1. This is to allow for fast reconnection to those items in the case of client reconnection. This is used when you change the Tunnelled ProgID.0 (November 4. o ItemsPerBundle (DWORD key) . Resolved Issues: l l l l l Includes all fixes in the ER releases described below.this override was to allow servers that do not implement the ValidateItems call the ability to add items. It allows you to specify a different timeout for adding items then for reading/writing to items. All TCP/IP calls will now timeout within the time specified in the client configuration. Increased overall stability with Tunneller connections.0 . UseAlternateProgID (String key) . MatrikonOPC no longer supports versions prior to 1. Tunneller Server-Side can now handle individual OPC servers dropping without affecting the connection to the client. 2003) New Features and Enhancements: l Three override registry keys were added: HKCR\**PROGID**\OPC\Overrides\ o DisableValidation (DWORD key) . This key allows you to change that. AddTimeout (DWORD key) . ItemsPerBundle (DWORD key) .this override was put in to support OPC servers that are slow to Add. Added flat browsing capability Improved server registry browsing.this override was put in for clients who are using Tunneller with an OPC server that needs to force the Tunneller server to restart if that OPC server goes down. Resolved Issues: l l l Fixed a problem with Tunneller server stability. Release Notes for MatrikonOPC Tunneller v1.o o o o o o DisableValidation (DWORD key) . Also note that Tunneller does not remove items from the Tunneller client if the OPC client disconnects.the default value for a reconnect delay is 5 seconds.This override was to allow servers that do not implement the ValidateItems call the ability to add items. o ReadWriteFailsDropConnection (DWORD key) .This override was put in to support slow OPC servers. ReadWriteFailsDropConnection (DWORD key) . ReconnectDelay (DWORD key) .5.this override was put in to support slow OPC servers.5.this key allows you to specify a different ProgID to connect to on the remote machine.this override was put in for clients who are using Tunneller with an OPC server that needs to force the Tunneller server to restart if that OPC server goes down. For More Information Should you require more details. If the port is open from the client PC to the server PC. Before you can begin. 3.Quick Start Guide MatrikonOPC Tunneller Quick Start Guide This document is designed to get you up and running on MatrikonOPC Tunneller as quickly as possible. contact MatrikonOPC Support. please check that all firewalls are set to allow traffic on the TCP port chosen for the MatrikonOPC Tunneller communications. Click Start and choose Run. refer to the Configuration section of this Online Help system. If not. Click on the Windows Start button and select Programs -> MatrikonOPC -> Tunneller. Open a command window. To set up and use MatrikonOPC Tunneller. 5. Set the Communication Retry Attempts to Retry Forever unless otherwise stated. In the Connect To field. Type telnet <Computer name or IP> <port> and press the ENTER key. 7. Working With MatrikonOPC Tunneller To launch MatrikonOPC Tunneller: Note: MatrikonOPC Tunneller is installed as a Windows service and is launched automatically at start-up. add the computer name or IP address of the computer to which you wish to connect. a. <port> is the TCP port you wish to use (default = 21379). 6. 2. For example. The MatrikonOPC Tunneller Client-Side Gateway Configuration window appears. telnet OPC_PC 21379. and then select Client-Side Gateway Config. Click OK and close the MatrikonOPC Tunneller Client-Side Gateway Configuration. A blank window appears. you should see a blank window with a flashing cursor. perform the following steps on the OPC Client PC: 1. b. Type cmd and press the ENTER key. For assistance.Installation. Close the window. refer to Licensing MatrikonOPC Tunneller. please perform the following tasks. Note: <Computer> is the name or IP address of the remote OPC server PC. refer to Appendix B . 4. Check to see if the desired TCP port is open from client PC to server PC as follows: a. Select File and choose Add Remote Tunneller Connection. For installation instructions. b. . and/or install the following tools/software on your machine: l License MatrikonOPC Tunneller. For details. Getting Started You must have already installed the product to use this Quick Start Guide. and Restriction of the Access to OPC Servers . l Bypassing of Microsoft Windows network authentication used by DCOM. BOLD Font displayed in this color and style indicates a hyperlink to the applicable/associated information within this document. This Online Help explains how to install and configure the software. technical information about OPC data items is included. Tunneller provides the following: l Cross-domain and cross-workgroup communication with minimal network configuration.Introduction Companies wishing to use OPC technology to link operators and engineers with plant devices. By eliminating common DCOM hurdles. as well as start-up and run-time permissions. along with sections on diagnostics and troubleshooting. This manual consists of several sections and is structured as follows: l l l Introduction – this introductory chapter. and menu commands. The majority of these problems occur not during normal operation. Overview of Online Help This Online Help uses icons to highlight valuable information. Configuration – shows how to start and configure the server. Failure to do so may result in the software not functioning properly. but at the time of installation. Remember these icons and what they mean. l l l l l .shows how to use Tunneller's Encryption and Compression features. Limitations – provides information on specific performance and operational limitations of the software.provides useful information about using Tunneller with Redundancy Broker (ORB). or if applicable. Tunneller enables the smoothest possible installation and operation of OPC technology in any environment. panels. l A finer level of control over communication timeouts. windows authentication. Tunneller with MatrikonOPC Redundancy Broker . tabs. Connection and Reconnection .presents a simple scenario demonstrating how Tunneller reacts to an interrupted network. In addition. Who Should Use This Online Help This Online Help system is intended for use by all users of the MatrikonOPC Tunneller. and describes each component in detail. MatrikonOPC™ Tunneller alleviates many of these problems by providing a mechanism for OPC data communication without the use of distributed COM (DCOM). Compression. Quite often plant engineers face difficulties configuring cross-network communication. as they will assist you throughout the Help system. Encryption. Getting Started – provides system requirements information. including windows/screens. and how to perform common tasks. OPC Data Items – describes the server’s items. often encounter communication problems. This symbol denotes important information that must be acknowledged. any external sources. User Impersonation. Installation C . solutions for common problems that may be encountered. MatrikonOPC Support contact information. and answers to frequently asked questions.Standard Data Types B . and data access. common interfaces. OPC Compliance – details supported interfaces with regard to installation. Appendices: o o o o l l A .Installed Files D .l Troubleshooting – provides licensing.Un-Installation . What's New? This version of the Online Help contains modified topics implemented for the newest release of this product.Installed Files . Following are links to the changed topics and the current Release Notes: Online Help Updated/New Topics l l l l Getting Started Remote Tunneller Connection File Menu Appendix C . Updated Tables 2. Checkbox description added to Table 8. Refer to What's New for the updated and/or new topics for this release. CGAP LB LB Author 2012-10-15 2012-09-17 2012-06-05 2012-04-30 2012-03-05 2011-12-16 2011-11-03 16. Updated software version to 4.0 Updated software version to 4. Updated Limitations and Troubleshooting sections. Software Requirements updated to included Microsoft Windows Server 2008.0.Installation. Updated Copyright InforLB mation and Contacting Support sections. Troubleshooting.1.0.5.1 17. Updated Figure 3 and Table 2 in Remote Tunneller Connection section. Updated the following sections to reflect A&E Support changes: References.0. The following sections were updated to reflect that A&E is now supported: Remote MJL. ISY LB 2011-06-03 2011-05-31 10. Converted user documentation suite to .Help File Revision History This information provided here summarizes the updates that were made to this Online Help.0 16.0. OPC Compliance.0.1.0. 2011-02-25 9. Date 2013-09-05 2012-12-05 2012-10-22 Document Version 17.0 15. Updated software version to 3.0. Connection Failure Scenario.chm format. Updated software version to 4.4. 3. Figure 5 replaced to show current MatrikonOPC marketing scheme in bottom screen section.3 10.0 11.0 2011-01-21 8.1 16. OPC Compliance.0 12.0. Limitations. Appendix C – Installed Files. Replaced Figure 21 screenshot to include Commit All Log File Writes checkbox. and Appendix C – Installed Files. LB Tunneller Connection. Updated software version to 4.2. LB Updated software version to 3. CGAP.1.5. Updated software version to 4.2 LB Updated Software Requirements and OPC Compliance secGEAK.1 2011-05-03 10. Typos fixed. Figure 21. LB LB LB LB Updated software version to 4. LB 2011-05-16 10.0 13.2 Description Updated for software version 5. and 8.0. New SN.3.5.0. LB tions. and Appendix B . Connection Failure Scenario.0 . LB sub-section added to Connection and Reconnection section.0 14. Added Pi usage item to Troubleshooting section. Updated software version to 4.0 CGAP.0. GetStatus Call.0.1 LB LB SN.4. Updated software version to 3.6 .1 7.0 Updated software version to 3.1.3. LB . and User SN. Communication Timeout field description updated to reflect same. ZA.2. Beta tag lines removed.0.2 Updated software version to 3. LB Impersonation sections Updated Software Requirements. Installed Files. Updated the following sections: Licensing.2.1.3 . and OPC Compliance sections. Add Remote Tunneller Connection screenshot updated to Communication Timeout field default value updated from 3 seconds to 5 seconds. Troubleshooting. Added the Handling Shutdown Request from Remote OPC Server section. updates to OPC Servers Access Restriction and MatrikonOPC Gateway Integration. Connection and Reconnection.8 RN.1 2009-03-11 3.3 Description Trademark Information and Introduction sections updated. Additional software version 3.2.1 2010-02-18 2009-11-11 5. Updated Appendix C . LB Author 2010-09-08 7.0 .5.0 Updated the Software Requirements.Date 2010-10-05 Document Version 7.0. Removed DEP warning. LB Table 15.0 6. Advanced SSC Settings. SL. Updates to Troubleshooting section. Updated Contacting Support section. OPC Compliance.3. Replaced screenshot (Figure 31) to include new field. LB LB 2010-03-17 5. User Impersonation and Restriction of 2009-04-23 3. Troubleshooting section updated.4. Installed Files. Software Requirements updated. Updates to Software Requirements and Troubleshooting sections. RN Access Restriction and MatrikonOPC Security Gateway Integration.0 changes: updates to Remote Tunneller Connection section. RN Updated to software version 3. Formatting fixes.2 LW. OPC Server LB. LB 2010-08-30 2010-06-24 2010-06-01 7. LB Updated Installation section. Software version updated to 3. Removed Product Registration screen and related procedural steps from Installation section.0 4. User's Manual converted to standard template.0. Updated to software version 3. Ported to TFS.0 2. Updated DCOM hyperlink.2. Contacting Support section updated.2. updates to Encryption.2.0. Compression. LB 2010-04-08 6.3 2009-11-09 4. User Impersonation.5 RN. LB 2.2.0. Added Limitations section.Installed Files. Added Get Status Ping description to SN.0. 0 1. general edit.2. Initial document. Updated to version 2. TNM. Updated for software version 3. LB LB RS. New installer/un-installer.1. minor revisions. added clarification.2 2. RN RT 2004-12-21 1. Added new section – Advanced SSC Settings.2. Converted to new template.0.1 .0 . added Analyzer install note to Installation section. RN.0.1 . added HDA. installed files updated.1. Author 2007-11-19 2007-04-23 2.6 Updates to Installation. Troubleshooting sections re: using Stratus box.Date Document Version Description the Access to OPC Servers section. Contact MatrikonOPC Support using the information below.com) is available 24 hours a day. Region All Contact Information +1-780-231-9480 . Region North America 8:00 am-5:00 pm UTC/GMT -7 hours (MST) Europe /Africa * 9:00 am-5:00 pm UTC/GMT +1 hours (CET) Australia/Asia * 9:00 am-5:00 pm UTC/GMT +10 hours (AEST) (Request OPC Support) (Request OPC Support) +61-2-4908-2198 +49-221-969-77-0 +1-877-OPC-4-ALL Office Hours Contact Information For after-hours support in all regions.Contacting Support The MatrikonOPC Customer Services department (www. For Monday to Friday daytime support requests. please use the following number.opcsupport. seven days a week. contact MatrikonOPC Support using the regional phone numbers provided below.com). There is no extra charge from MatrikonOPC for calling their after-hours support number. or send an email (support@MatrikonOPC. MatrikonOPC Tunneller supports both software and hardware] licensing. For upgrades from older versions. For all new installations.2. software licenses are of a different type than the ones used in previous versions. a new software licensing API is in use. Licensing information is described in detail within the Licensing section of this Help system. re-licensing is not required.0. .0. the existing software license is still valid and therefore.Licensing MatrikonOPC Tunneller Most MatrikonOPC products require that some form of licensing criteria be met for it to function correctly. Starting with Tunneller 3. agents. publish. The receiving party shall not disclose. without prior written permission of Matrikon Inc. LIMITATIONS Although every endeavor has been made to ensure that the information contained within this document is up to date and accurate. photocopying.2012. have been made aware of the confidential nature of this document and have executed a written employment or other confidentiality agreement party to maintain the confidential status of this document. and shall protect all information contained herein from unauthorized disclosure. Matrikon reserves the right to make any improvements and/or changes to product specifications at any time without notice.Copyright and Trademark Information SOFTWARE VERSION Version: 5. incidental or consequential damages which may arise in connection with the furnishing. directly or indirectly. LICENSE AGREEMENT This document and the software described in this document are supplied under a license agreement and may only be used in accordance with the terms of that agreement. Issue of this document does not entitle the recipient to access or use of the products described. electronic. translated. Matrikon cannot be held responsible for any inaccuracy or error in the information contained within this document.0 DOCUMENT VERSION Version: 17. Matrikon makes no warranty of any kind with regard to the information contained within this document and Matrikon shall not be liable for any direct. intended for general guidance. Matrikon Inc. . indirect. recording. communicate. CONFIDENTIAL The information contained herein is confidential and proprietary to Matrikon Inc. or otherwise transfer any information in this document to any third party. stored in a retrieval system. reliance. mechanical. report.0. and affiliates who reasonably require access to such information contained herein. The receiving party shall permit access to this document only to its employees. Specifications and statements as to performance in this document are Matrikon estimates. subcontractors.1 COPYRIGHT INFORMATION © Copyright 1997 . All rights reserved. No part of this document may be reproduced. to any third party without the explicit written permission of Matrikon Inc. or otherwise. Statements in this document are not part of a contract or program product licence insofar as they are incorporated into a contract or licence by express preference. or transmitted in any form or by any means. Matrikon reserves the right to change the information contained within this document and any product specification without notice. and such access or use shall be subject to separate contracts or licenses. or use of the information contained within this document. It may not be disclosed or transferred. openssl. All rights reserved.TRADEMARK INFORMATION The following are either trademarks or registered trademarks of their respective organizations: Matrikon and MatrikonOPC are trademarks or registered trademarks of Matrikon Inc. OTHER MatrikonOPC™ is a division of Matrikon™ Inc. . Copyright © 1998-2008 the OpenSSL Project. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.org/). opcfoundation.opcsupport.com www.0 OPC Data Access Specification 2.org www.com OPC Overview 1.05a OPC Data Access Specification 3.00 OPC Historical Data Access Specification 1.matrikonopc.0 OPC Common Definitions and Interfaces 1.References This Help system references information found within the following documents/sites: l l l l l l l l l l www.10 OPC Security Specification 1.00 .2 OPC Alarms and Events Specification 1. Matrikon’s brand name for its OPC servers and clients. Provides access to historical process data. 34-digit key provided upon purchase of MatrikonOPC software. Refer to www. Sample Lock Code: 0xABCDE Code provided by MatrikonOPC that determines the hardware to which the license will be locked. OPC Historical Data Access.org for more information. a temporary or demonstration version. Provides access to process alarm and event data. ignoring the 0x at the front. used to indicate the Client-Side machine. Modifying the system hardware invalidates the license. OPC Data Access. As in demo licenses. Programmable Logic Controller. Typically used in process control applications. Provides access to real-time process data. Tunneller Server-Side Component (or Server-Side Gateway). used to indicate the Server-Side machine. Allows the transfer of data between two running applications. In short form. specifying how to build components that can be dynamically interchanged. Usually two characters in length. Provides coded information on the PC hardware used for node-locked licensing. A communication standard. Device that allows interaction between the user and machine. Term/Abbreviation A&E Activation Key CCT COM CS CSC DA DCOM DDE Demo HDA HMI Lock Code Lock Selector Matrikon MatrikonOPC OPC ORB PLC SS SSC . Tunneller Client Configuration Tool Component Object Model. PC-specific code needed to perform web page or email licensing. MatrikonOPC Redundancy Broker. Usually five characters in length. Tunneller Client-Side Component (or Client-Side Gateway). Distributed Component Object Model.opcfoundation.Acronyms and Definitions The following terms are used interchangeably throughout the Online Help: l l l l screen and window tab and panel MatrikonOPC License Wizard and License Wizard MatrikonOPC Tunneller and Tunneller Description OPC Alarms and Events. Sample Lock Selector: 0x14 Matrikon Inc. Dynamic Data Exchange. ignoring the 0x at the front. Human Machine Interface. In short form. An extension of COM that allows communication between COM components over a network. A method for organizing software. . To verify that your hardware key is properly installed: 1. Common questions regarding licensing. such as printing. MatrikonOPC Licensing Utility that is used to license driver software. All licenses must exist on one physical key.e. However. This section of the Help system is intended to assist you in licensing MatrikonOPC products. the installation program installs a device driver for USB or HASP keys on the target system. At this point. Click on the Check Licenses button. some are software-licensed only. Software Keys For products that support feature-specific and computer-specific licensing. This key must be securely fastened to the parallel (or USB) port of the computer on which the software is installed. 2.exe utility located (by default) in the C:\Program Files\Common Files\MatrikonOPC\Common folder. Hardware Licensing To license with a hardware key. Some products are hardware-licensed only. all device communication will cease. a license is issued that is specific to a given set of features in the application. It functions for a demonstration period of two hours before “timing out”. The license will not work on another computer. either parallel or USB.. only the ability to retrieve data is affected. l References Licensing information is also provided online in MatrikonOPC's Knowledge Base. Run the MTKAuthorize. and to the computer on which it is installed. A license is required to enable the server's functionality. please contact your Account Manager. it does not interfere with hardware keys from other vendors. nor does it affect other normal parallel port applications. If the software uses hardware licensing. and supports only those . Please feel free to contact the MatrikonOPC Support group any time you require assistance. and some are both. a USB or HASP hardware key coded to that particular program can be purchased. For more information on MatrikonOPC products that are hardware-licensed only. MatrikonOPC parallel port keys cannot be combined in a series (i. and the variety of ways in which licenses can be obtained. This Licensing topic includes the following information: l l Hardware and software key licensing information. simply connect the key to the appropriate port.Licensing Introduction Most MatrikonOPC™ products require that some form of licensing criteria be met for it to function correctly. Note: No data is lost in the event of license failure. Hardware Keys For software that supports hardware key licensing. “daisy-chained”). features that have been purchased. Products that are software-licensed only, stop working once the license expires. Licensing MatrikonOPC Tunneller Most MatrikonOPC products require that some form of licensing criteria be met for it to function correctly. MatrikonOPC Tunneller supports both software and hardware] licensing. Starting with Tunneller 3.2.0.0, a new software licensing API is in use. For all new installations, software licenses are of a different type than the ones used in previous versions. For upgrades from older versions, the existing software license is still valid and therefore, re-licensing is not required. Licensing information is described in detail within the Licensing section of this Help system. Software Licensing Wizard MatrikonOPC provides a Software Licensing Wizard (i.e., Matrikon License Wizard) that is used to license their driver software. During the installation process, you are prompted to install either a 30-day evaluation license or a permanent license. If you have not purchased the software yet, select the 30-day option. The software can be permanently licensed at a later date without needing to re-install. If you have purchased the software and have your 34-digit activation key and lock selector, select the second option. The Matrikon License Wizard is launched later in the installation process and it can also be launched after the install has completed. To launch the Wizard after installation is complete: 1. Click on the Windows Start button. 2. Select Programs -> MatrikonOPC -> Tunneller -> License Wizard. 3. The Matrikon License Wizard appears. . Matrikon License Wizard with Internet Connection When the Matrikon License Wizard is launched. The Matrikon License Wizard attempts to license the software by connecting directly to the license server located at the MatrikonOPC head office. Step 2: License System of the License Wizard is displayed. 3. an error message appears informing you as such and provides a reason for the error. 2. To license via an Internet connection: 1. Note: The Next button is disabled until the Lock Selector and Activation key fields have been entered. Note: If there are problems licensing the software. . 5. Enter the Lock Selector (which is usually 0x14). the screen below appears. 4. Click on the Next button. Enter the Activation key. 6. . If licensing is successful. the Step 3: Review Licensing screen appears. Click on the Exit button to complete the licensing and close the License Wizard.7. Review the list of features that were licensed. . 8. Note: You can export this list to a file by clicking on the Save button. navigate to http://opclicensing. you will be directed to the following License Wizard screen after inputting the Lock Selector and Activation key. 4.matrikon. To license via a web page: 1. A licensing web page is displayed. 3.com. Using a web browser. This screen allows you to save the licensing details to a file using the Save button. 2. You can then transfer the saved file to a system that has Internet access.Licensing Via Web Page In the event that your system does not have Internet connectivity. . mtkl. After a short delay. Once all the fields are entered. The Print button allows you to output the license key code to a printer if you want to make a copy of the code or physically bring it to the system with the OPC software installed on it. which can then be transferred to the system with the OPC software installed on it. 7. click on the Request License Key button. Complete the following fields: Activation Key. All of this information is available in the file that was generated by the Matrikon License Wizard. 6.5. a license details screen appears and provides the following features: l The Copy button copies the license key code to the clipboard so that it can be pasted into another file or an email and then transferred to the system with the OPC software installed on it. and Computer Name (for the system on which the OPC software was installed). The Save button saves the license key code to a file named license. Lock Code. The Activate Another License button returns you to the main licensing webpage. l l l . Using the Browse button. Once you have located the file. Return to the system with the OPC software installed on it and launch the Matrikon License Wizard. 10. The License Wizard Step 2 screen should appear once again. click Next to continue. 9. 12. the Step 3: Review Licensing screen appears. 11. If the licensing is successful. locate the license file that contains the license key code.8. . Click on the Exit button to complete the licensing and close the License Wizard.13. Note: You can export this list to a file by clicking on the Save button. Review the list of features that were licensed. 14. . 7.com . the MatrikonOPC licensing department will email back a license. To license via email: 1. click Next to continue. From Step 2 (without Internet) of the License Wizard click on the Save button and save the file to your system. 5. Save the file you received from MatrikonOPC to your system. 2.mtkl file. 6. you can email the information from Step 2 to the MatrikonOPC licensing department.Licensing Via Email In the event that your system does not have Internet access. the Step 3: Review Licensing screen appears. A license file will then be emailed back to you. Navigate to the file using the Browse button shown. 4. Once you have located the file. Email the saved file to licensing@matrikonopc. After receiving the file. If the licensing is successful. 3. . nor can you access a web browser. 9. . Click on the Exit button to complete the licensing and close the License Wizard.8. Note: You can export this list to a file by clicking on the Save button. Review the list of features that were licensed. com to confirm the license removal. 4.License Removal To remove a license from a system: 1. Once the license is removed. or click No to exit. If successful. The listed file must then be emailed to licensing@matrikonopc. Confirm the removal by clicking on the Yes button. the License Removed window appears. to remove the license for the MatrikonOPC Omron Plug-In. 6. 5. Click on the Windows Start button. The Confirm License Removal window appears. 2. the following command must be executed: C:\Program Files\Matrikon\OPC\UCS>Licenseremover. license removal for individual UCS plug-ins can be done through the command line as follows: C:\Program Files\Matrikon\OPC\UCS>Licenseremover. 3. Note: If applicable to the product.exe ucs Driver_Omron . Select Programs -> MatrikonOPC -> Tunneller -> License Remover. the activation key is incremented by one license.exe ucs <feature name> For example. Or. select Programs -> MatrikonOPC . Click on a topic to display and read it in the topic pane on the right side of the Help screen. From the application Help menu. . either: 1. or the Related Topics button (if applicable.. Topics are grouped into Help books.> Tunneller -> Help.e. Click on a book icon to open it and view the topics within. MatrikonOPC Online Help consists of several topics and procedures: l l l l Limitations Troubleshooting Licensing Contacting Support Using Help To access the MatrikonOPC Online Help. or more books. Books can contain groups of topics. In some cases. Click your mouse anywhere in the application and press the F1 key on your keyboard. Or. Click on the word or phrase to view any additional information that is presented in a pop-up window. green text indicate that more information is available . Click on the Windows Start button.MatrikonOPC Online Help Overview The purpose of this Help system is to provide an overall understanding of how to use this product. select the Online Help option. represented by the book icon. windows. page) icon represents this information. and choose MatrikonOPC Tunneller Online Help. Words or phrases in bold. and perform the required procedures. the Help windows offer links to additional information. The information contained in the topics allows you to access descriptions of the MatrikonOPC screens. Click on a topic to view it. Help Topics From the Online Help Table of Contents. is found at the bottom of the topic page) to read more information. Click on any underlined text. You are presented with the Online Help window and table of contents. The topic (i. All of the information in the MatrikonOPC Online Help is contained in documents called topics. click on a book to open it and view the topics in that book. or panels. Note: At the end of the installation process you are presented with a Setup Complete window that gives you the option of launching the Online Help by selecting the Launch user documentation checkbox. Procedures in the Online Help are actionoriented and always refer to the screens.Procedures Procedural topics describe how to accomplish a particular task in MatrikonOPC products. and panels involved in the task. windows. . A book may contain a list of topics. place your cursor on the bottom right-hand corner of the Help window until a double arrow appears. see Printing a Topic in MatrikonOPC Online Help. This increases the height and width of the Help window. those keywords are highlighted in the applicable topics. Index tab .MatrikonOPC Online Help Window Online Help Window The MatrikonOPC Online Help window is divided into three panes: l l l Button bar Navigation pane Topic pane Some topics in the Online Help include screen images that may not fit within the size of the default Help window. Search tab .allows you to move backwards through the browse sequence. Help creates a database l l . Forward button . The Navigation pane contains four tabs: l Contents tab .lists all of the words you can use to search for topics in the Online Help. Click your left mouse button and drag the edge of the screen until it reaches the required size and then release the button. with the Online Help open. l l l l l Navigation Pane The Navigation pane on the left side of the MatrikonOPC Online Help window allows you to move through the books and topics.allows you to show or hide the Navigation pane.opens the print dialog box so that you can print the topic that is currently displayed. To do this. Use the Refresh button to remove the highlight from the keywords in the current topic. you can search for and go to a specific Help topic. Button Bar The Button bar is located across the top of the MatrikonOPC Online Help window. When you search for keywords in the Online Help using the Search tab. The Help window can easily be re-sized as needed by simply "grabbing" the end of the window and extending it for a complete view.lets you search the entire contents of the Online Help for individual keywords.allows you to move forward through the browse sequence.returns you to the first topic that was displayed when you opened the Online Help. By typing or selecting one of these words. and view its contents. Back button . To adjust either the height or width. Click on a book to expand or open it. Click your left mouse button and drag the edge of the screen until it reaches the required size and then release the button. Home button . place your cursor over the side or bottom edge of the Help window. or more books. You can toggle the button to hide the Navigation pane.displays a list of the available books of topics in the Online Help. For more information. To grab the end of the window. Print button . allowing the Topic pane to cover the entire window. There are several buttons included on the Button bar: l Hide/Show button . see Finding a Topic in MatrikonOPC Online Help. Scroll up or down to view all the information displayed in the topic. Pop-up definitions appear in text boxes within the topic from which the pop-up is selected. Many Help windows offer links to additional information which are identified by solid green underlined text. When you need to find specific information in the Online Help. To close the pop-up. Click on the underlined text to access and view another topic or pop-up definition.of keywords the first time you use this feature. and add them to the list for quick access. The selected topic is displayed in the main topic pane. The method of navigation is dependent on which tab is selected. tables and links to other topics. For a description on how to find a topic using the navigation tabs. Topic information consists of text. Topic Pane When you open a topic. the table of contents. . click the pop-up itself or anywhere in the displayed topic. and an index. the three most common methods used are: the search feature. l Favorites tab . the Topic pane appears on the right side of the Online Help window.allows you to identify those topics that you visit more often. If you do not enclose the phrase in quotation marks. The Contents tab uses an expandable/collapsible view to display topics contained in a book. Double-click your mouse on the required topic listed in the Topics section. The database is created the first time you use this feature. Search Tab The Search tab lets you search the entire contents of MatrikonOPC Online Help for individual keywords from a database of keywords. After selecting the required topic. . The Search tab also allows you to perform a search for topics containing a particular phrase. click on the Display button.Finding a Topic in MatrikonOPC Online Help There are four quick ways to find information in a particular topic in MatrikonOPC Online Help: l l l l Contents tab Index tab Search tab Favorites tab Contents Tab The Contents tab displays a list of the available books of topics in MatrikonOPC Online Help. select the Favorites tab and either: l l Select the required topic listed in the Topics section. you can search for and go to a specific Help topic . Any topics containing the exact phrase will then be listed in the Select Topic to display field. To display any of your "favorite" topics. By typing or selecting one of these words and clicking on the Display button at the bottom of the Navigation pane. Click on the Display button at the bottom of the tab. Index Tab The Index tab lists all the words you can use to search for topics in MatrikonOPC Online Help. or more books. all topics that contain the first word of the phrase are retrieved. The list of topics contained in the book is displayed and the plus icon changes to a minus icon (-). click on the plus icon (+). Enter a keyword in the Type in the keyword to find field to use the fulltext search that displays all the topics that contain the word you entered. A book may contain a list of topics. You can also click on a book to expand the view of topics in a book. Favorites Tab The Favorites tab allows you to manage accessibility of those topics in the Help system that you visit often. After entering the required phrase in the Type in the keyword to find field. You can narrow the search by selecting a word from the list of related words. To expand the view of topics in a book. you must enclose that phrase in quotation marks. select the Favorites tab. Click on the Add button located at the bottom of the tab. With a topic displayed in the Topic pane. The name of the topic is listed in the Topics section. Click on the topic to open it and view its contents in the Topic pane (refer to MatrikonOPC Online Help Window). Collapse the book view by clicking on the minus icon. Make your selection and click on the OK button. you can print topic and pop-up contents using the methods described here. right-click your mouse on the pop-up text box that appears. Click on the name of the topic to highlight it. you can print pop-up definitions by clicking on the required pop-up. right-click your mouse on the topic you would like to print. All methods direct you to the Print screen where you can define your printing options (e. you can print the current topic by clicking your mouse in the pane and then selecting the Print in the Button Bar at the top of the window. Click on the Print button on the Print window. printer. The Print Topics window appears asking if you would like to print just the selected topic.g. . Click on the Print button on the Print window.) Navigation Pane and Print Button With the Contents tab selected in the MatrikonOPC Online Help Navigation pane.Printing a Topic in MatrikonOPC Online Help In MatrikonOPC Online Help. or all topics in the selected heading. or all topics in the selected heading. The Print Topics window appears asking if you would like to print just the selected topic. Topic Pane and Context Menu From the Online Help Topic pane. The Print window appears where can define your printing options. Click on the Print button on the Button Bar at the top of the window. Navigation Pane and Context Menu With the Contents tab selected in the Online Help Navigation pane. Click on the Print button on the Print window. The Print window appears where you can define your printing options. The Print window appears where can define your printing options. Select Print from the displayed menu. etc. The Print Topics window appears asking if you would like to print just the selected topic. find the topic you would like to print. number of copies. and selecting the Print option from the displayed menu. Make your selection and click on the OK button. Make your selection and click on the OK button.. The Print window appears where can define your printing options. You can also print the current topic by right-clicking your mouse in the Topic pane and selecting the Print option from the displayed menu. page range. or all topics in the selected heading. Topic Pane and Print Button From the Online Help Topic pane. Click on the Print button on the Print window. Once the software is installed. refer to the Contacting Support section for information about how to contact the MatrikonOPC Support team for assistance. If any problems are encountered during installation or licensing. These requirements must be met for the software to function properly. Note: To install and configure a MatrikonOPC server.Installation walk you through the installation process. Detailed step-by-step instructions in Appendix B . or Microsoft Windows Server 2008 R2 SP0 Microsoft . The System Requirements section shows how to avoid future problems by ensuring that the system meets the minimum software and hardware requirements. System Requirements The software has minimum Software and Hardware system requirements. or Microsoft Windows 2003 SP0.Getting Started This chapter contains important information about installing Tunneller and how to contact the MatrikonOPC Support team. Hardware Requirements The server requires the following hardware: l l l l Intel® Pentium® 4 Processor 512 MB RAM 40 GB 7200 RPM Hard Drive TCP/IP connectivity . or Microsoft Windows Server 2008 SP0. or Microsoft Windows 7. refer to the Licensing section for information on how to obtain the appropriate license. Software Requirements The server requires the following software: l l l l l l Microsoft Windows XP SP2.NET Framework 2.0 (if included with this install program) Note: It is recommended that the most current service packs are installed. Appendix C – Installed Files lists the files that are installed during this process. you must be set up as an administrative user account rather than a restricted user account. 0.0.1.4.5.0 l 3.0 l 3.0.2.0.0.1294 l 4.0 l 3.0 .0 l 3.3.3542 MatrikonOPC Tunneller Client-Side Gateway Component Versions: l 3.0 l 3.0 MatrikonOPC Tunneller Server-Side Gateway Component Version 5.1.0 l 3.0.972 l 4.2.0 l 3.1.0.3542 MatrikonOPC Tunneller Client-Side Gateway Component Version 5.0.0.4.5.0.1 l 3.4.0.1294 l 4.1.0 l 3.0. generally only the features available in the oldest version used in a tunnel are available.2.2.Tunneller Version Compatibility MatrikonOPC Tunneller requires a minimum of two computers set up to provide the two ends of the tunnel.0 l 3.0.5.0 l 3. Component Is Compatible With MatrikonOPC Tunneller Server-Side Gateway Component Versions: l 3.1. The current version of MatrikonOPC Tunneller has been tested for backwards compatibility as follows: Note: It is recommended that both sides of the connection be upgraded to the latest version of MatrikonOPC Tunneller where possible to gain access to all the new features.2.1.5.669 l 3.1 l 3.0.4.0 l 3. efforts have been taken to maintain backwards compatibility with prior versions.2.972 l 4.0.2.1.1.3.1.0.0 l 3.0 l 3.0.669 l 3.3. Where new features have been added to tunneller between versions.0. In order to allow for each end of the tunnel to be upgraded to a new version of MatrikonOPC Tunneller with minimal impact.2.3.2.0 l 3.2.1. . Tunneller achieves this by acting as a pass-through between the OPC client and the OPC server (as demonstrated in the illustration below).Configuration MatrikonOPC™ Tunneller's goal is to provide trouble-free communication in a manner as transparent as possible to an existing OPC installation. Main Configuration Screen Basic Tunneller configuration is done with the MatrikonOPC Tunneller Client-Side Gateway Configuration Utility. From the Windows Start button. To add a connection: 1. This screen contains all Tunneller connections that have been added. Tunneller connections may now be added. it will require the user to provide local administrator credentials. These are connections to OPC servers located on machines where the Server-Side Tunneller files have been installed. which is available on any computer where the CSC files have been installed. To open the Client-Side Gateway Configuration Utility: 1. then the Client-Side Gateway Configuration Utility displays no available Tunneller connections. or CCT). From the Client-Side Gateway Configuration Utility screen. select Programs -> MatrikonOPC -> Tunneller. Note: The Tunneller Client Side Gateway Configuration Utility requires local administrator privileges to operate correctly. Open the Client-Side Gateway Configuration Utility (also known as the Client-Side Configuration Tool. either: l Press Ctrl+N . or . 2. If a user that does not have local administrator privledges runs the Client Side Gateway Configuration Utility. If there are no Tunneller connections configured. This means that Tunneller must be installed on a PC that is accessible via TCP/IP. Note: For Tunneller to operate. at least one connection to an OPC server must be configured (local connections are also allowed). select the Add Remote Tunneller Connection option. .l l From the toolbar. 2. click on computer icon button (displayed on the far left of the toolbar). or From the File menu. The Add Remote Tunneller Connection window appears. The Add Remote Tunneller Connection window components are described in the following list. Allows you to enter the port number on the remote PC to which Tunneller should establish a connection. Port Number . The default port is 21379. The OPC server to which Tunneller connects must reside on the same machine as the remote Tunneller install.Remote Tunneller Connection The Add Remote Tunneller Connection window contains all of the information necessary to set up a Tunneller CSC connection to a remote PC with the Tunneller SSC installed. the port number configured on the Client-Side Component must match with the port number configured on the Server-Side Component. Field Descriptions: Component Connect To Description Allows you to enter or select (from the drop-down list) the name of the computer referenced either by its IP address or by the specific computer name. Note: To successfully communicate. Restarting the Tunneller service is required when this option is changed. . This parameter defines how many attempts should be made after failure.0 of Tunneller. The default value is 10 seconds. enter the number of times Tunneller should try to resend requests/responses that have failed to send. A&E. Note: In version 3. Allows you to select an option to specify whether the failed communication is to be retried forever (Retry Forever). then the SSC can return a smaller.e. By default this check box is not selected. the SSC provides a list of installed OPC servers to the CSC. At that point. Allows you to enter the amount of time (in seconds) the network communication mechanism will try to send a request or receive a response from the SSC before it considers the communication failed. or only for a specified number of attempts (Retry Attempts). it considers the sending of the command as failed and does not attempt any retries.e. DA. the condition events will be updated through to the client when Tunneller reconnects following a lost TCP/IP connection. Processing Timeout should be set to a value higher than the longest time required to execute a request. Processing Timeout Communication Timeout Communication Retry Attempts Use Compression A&E: Send refresh on reconnection Note: If Tunneller detects that the network path to the remote computer is unavailable because of a physical break in the network or the remote SSC is not available. sending each request/response will be attempted up to six times). then the list contains one Tunneller entry for each interface for that OPC server. The Client-Side Gateway Configuration Utility (shown below) now displays the list of accessible (through Tunneller) OPC servers for the selected remote host. Communication Timeout should be configured to a value higher than the time required to send the largest message over the network.. new functionality is added to restrict access to OPC servers. or HDA). If the OPC server supports more than one OPC interface (i.0. The default value is 60 seconds. click on the OK button. in the adjacent field.By default this check box is not selected. If the Retry Attempts option button is selected. Once the settings have been configured to the user's specific network requirements.1. If this feature is turned on. Enable sending an A&E refresh call when an A&E tunnel is reconnected.Component Description Allows you to enter the amount of time (in seconds) the CSC waits for a response to a request before it considers the request failed and returns an error code to OPC client. If the specified port number is open and available. If the remote OPC A&E server supports condition events and those are subscribed by the OPC client. Enable compression for remote Tunneller connections. list of OPC servers. Note: A&E: Send refresh on reconnection can be adjusted later for each individual OPC A&E Server. Tunneller tries to reconnect to the remote computer. The default value is 5 (i. Note: The Compression setting can be adjusted later for each individual OPC server.. or empty. Compression can decrease the amount of data to transfer and can improve performance on low bandwidth connections such as radio or satellite links. . Tunneller DA OPC servers. The following diagram shows MatrikonOPC Explorer browsing for. OPC clients may browse for and connect to those OPC servers.When the Tunneller Configuration Utility shows a list of tunnelled OPC servers. and finding. Connection Properties By selecting the remote computer node from the tree. the Connection Properties panel is displayed for that remote server. . Licensing . By default. Changing this value affects all of the remote OPC server connections configured for that machine. the Client Side Gateway Configuration Tool will connect to the Server Side Gateway on the remote machine and query the license status and displays the list of license features and the current state of each feature.0 or newer versions of the Server Side Gateway can provide licensing information. port 21379 used.Field Descriptions: Component Port Number OK Description The port number that the Tunneller Server Side Gateway on that computer has been configured to listen for connections on. When this button is clicked.0. Click on this button to confirm that the port number should be changed. Only version 5. . and exit the program. start the key manager. Export Configuration The Client Side Gateway Configuration tool can export the list of configured remote tunneller connections and remote progids into an XML formatted file for backup or to aid in the configuration of multiple machines that use the same connections. A standard Microsoft Windows File selection dialog is provided to select the location and name of the file to save.File Menu The File menu allows the user to add a connection. Import Configuration The Client Side Gateway Configuration tool can load a previously exported configuration file to recreate a set of remote connections. Once the first machine has been configured. Exit Closes the Client Side Configuration Tool window. This option provides a standard Microsoft Windows file selection dialog to locate and select the file to load. This option is useful when several MatrikonOPC Tunneller Client Side Gateway machines are being configured to connect to the same Server Side Gateway machines and tunneled OPC servers. import and export the connections. and the file copied to the other machines for importing. the configuration can be exported. . MatrikonOPC Tunneller will continue to run as a windows service and is not stopped if the configuration tool is closed. Add Remote Tunneller Connection Open Key Manager Opens the Client Side Key Manager window to configure encryption settings. Options Menu The Options menu provides several functions. You can refresh all the tunnelled servers from the system registry. The refresh settings does not affect any current connections as it only refreshes the configuration display. To refresh the server list: 1. From the Client-Side Configuration Utility, either: l Select Refresh Server List from the Options menu, or l Press F5. The user can un-register certain Tunneller server connections from the toolbar. From the Options menu, select the Unregister Selected Server option, or press the black X ( ), to un-register the server in the Client Configuration Tool. ), to un-reg- From the Options menu, select the Unregister All Servers on Selected Connection option, or press the blue X ( ister all connections to the computer selected in the Client Configuration Tool. From the Options menu, select the Unregister All option, or press the red X ( nections. ), to un-register all configured Tunneller con- WARNINGS: l Before removing or modifying any Tunneller server connection, make sure that no clients are actively connected. If there are active connections, the OPC clients must be disconnected before the Tunneller server connection is removed. l When removing a Tunneller server connection and recreating it, ensure that any OPC client that has the connection information cached, clears its cache and obtains the new Tunneller Server connection information. Failure to do so may cause unpredictable behavior. From the Options menu, select one of the three logging options: DA Logging, HDA Logging, or A&E Logging to access the logging options for each of the three Client Side Gateway components. Choose the option or options appropriate to which remote OPC server types are in use. The logging options dialog will be displayed for the selected Client Side Gateway component. Logging Options Dialog The logging options dialog allows you to configure logging for the Client Side Gateway. There are three logging options dialogs, one each for the DA, HDA, and A&E Client Side Gateways. All three dialogs appear and operate in the same way. Only the DA Options dialog is shown here. General Logging Field Descriptions: Component Description Enable activity logging is used to activate logging, and select the log level. By default the checkbox is checked and the drop-down box set to Low. Medium and High log levels will provide more information for troubleshooting and support, but the log file will grow more rapidly. Enables keeping a backup of the last logfile. When checked, and the CSC is started, the old log file (if present) will be renamed with the addition of “.bak” to the filename. By default, this checkbox is cleared. Commit all log file writes, when checked, causes the logging system to force the log file to be written to disk after each log line. Selecting this option will cause a noticeable performance decrease in the CSC. Selecting this option is only recommended when Matri- Enable activity logging Keep backup of last log file Commit all log file writes 10 megabytes is set as the maximum file size. This option is normally used at the direction of MatrikonOPC Support to collect specific information for troubleshooting. or use the “…” browse button to choose a file. the CSC will start overwriting the file from the beginning when the file reaches this configured size. the CSC will write a second log file which will contain only those log messages that contain an exact match to the selected filter string. In order to prevent MatrikonOPC Tunneller log files from filling all available harddrive space. Changes made to interface logging settings cannot take effect until the CSC is restarted. If a filter string is entered. and the OPC Client has reconnected to it. You may type in a full path to a file. or use the “…” browse button to choose a file. the filter string is empty. You may type in a full path to a file. By default. Wrap log file if it exceeds Filename Filter String Filename Interface Logging Interface logging creates one log file per OPC Client connection to the CSC and is used for troubleshooting issues between the OPC Client and the MatrikonOPC CSC. this check box is cleared. By default. .Component Description konOPC support requests it for troubleshooting purposes. and the log file will grow to fill all available hard drive space. By default. The name of the file to write log information to. and a filename entered for a filtered log. By default. “C:\Program Files (x86)\Common Files\MatrikonOPC\Common”. By default. this option is ignored. Note: If Commit all log file writes is checked. the file is located in “C:\Program Files\Common Files\MatrikonOPC\Common” or on 64 bit operating systems. The file name to write a filtered log file to. this field is empty. and the interface log file may grow in size until all available disk space is used up. causes the interface logs to be stored to disk immediately after each log statement.Field Descriptions: Component Enable interface logging Description Enable interface logging for connections made to this CSC when checked. the option is unchecked. Commit all log file writes. when checked. When checked. Higher log levels will fill or wrap the log file faster. Commit all log file writes . the CSC will be noticeable slower. This option should not be enabled except at the direction of MatrikonOPC Support for troubleshooting purposes. or High. you may select a log level of Low. Medium. By default this checkbox is unchecked. When checked. By default. .NOTE: Changes made to interface logging will not take effect until the tunneller CSC is restarted. Tunneller CSC can also be loaded as a remote COM server (i. l Both 32 bit and 64 bit OPC Clients are supported. l Support the Shutdown call-back.e. using CoCreateInstanceEx function call). but on 64 bit operating systems a 64 bit inproc component and registration information are provided to allow the connection. A small portion of Tunneller will be loaded in proc.0. Note: Starting in version 3. It must be supported for Tunneller to relay communication failure information. The MatrikonOPC Tunneller CSC is a 32bit service.1.0. This is a required interface but some clients do not support it.OPC Client Requirements The OPC clients connecting to Tunneller are required to fulfill the following requirements: l Allow in proc servers.. . Field Descriptions: Component Use Remote Status Description Selecting this checkbox causes the GetStatus call to be made across the TCP line to the end OPC server. this option forces an internally generated GetStatus message to be sent to the end OPC server. Clearing the checkbox causes any GetStatus call made to Tunneller to be returned immediately with Tunneller's own status. depending on the required detection level. It will also detect a line that has gone down but has come back immediately. The diagram above shows the configuration options for the GetStatus call. Frequent calls (at approximately one second) will detect a line failure quickly. If there is a line interruption or some other form of communication failure between the two halves of Tunneller. but does not automatically detect TCP line failures if no requests are made by the OPC client. The remote call will be made as close as possible to the rate at which the end OPC client is calling GetStatus on Tunneller. These options are described the following list. the status field of the status structure returned by Tunneller will be set to failed.GetStatus Call Tunneller uses TCP connections to do its data transfer. Recommended by MatrikonOPC. If a communication failure is detected. The GetStatus call should be used as a heartbeat mechanism for line failure detection. Tunneller does not initiate the GetStatus call on its own. However. it returns Tunneller’s own status immediately to the calling client. This option is available only when the Use Remote Status checkbox has been selected. Options are common for all tunnelled OPC servers and available to configure when the root of the tree control (Tunneller Computer Connections) is selected on the Client-Side Gateway Configuration Tool. The status of the end OPC server is returned. The user’s specific requirements will indicate how often the GetStatus should be called. Whether the OPC client hangs or not is entirely Funneled (recommended) Remote . Tunneller’s status will be set to failed. If selected. In subsequent GetStatus calls. When selected. The OPC client must call GetStatus at regular intervals to ensure the line is available. Infrequent calls can allow a momentary interruption to pass but will not detect a prolonged failure until the line is needed by an actual call. This option is available only when the Use Remote Status checkbox has been selected. The call can be made as often as needed. so it is a “non-blocking call”. the calling OPC client may hang and become unresponsive (it is a “blocking” call). this option forces the calling OPC client’s GetStatus call to the end OPC server. It relies on the OPC client to make the GetStatus call. If a communication failure is detected.0 and higher. the time interval is equal to half of the Communication Timeout parameter which is configured using the Client-Side Gateway Configuration Utility. Tunneller’s status is set to failed.5 seconds (if the Timeout Parameter equals the default value of 3 seconds). In subsequent GetStatus calls.0.ini file on the SSC. If reconnection is not successful. For example. the CSC detects communication failure.0. the SSC periodically sends “KeepAlive” messages. If the CSC does not receive any message during the time interval set by the Communication Timeout parameter (which also has a default value of 3 seconds).1.2.ini file). when the completion of a request sent by the SSC takes too long. In this scenario.Component Description dependent on the OPC client and its implementation. the status field of the status structure returned by Tunneller is set to failed. disconnects from the SSC and tries to reconnect during the time defined in the ReconnectTime parameter (in TunnellerOpts. the SSC will send Keep-Alive messages every 1. The default time interval value is equal to half of the timeout parameter configured on the tunneller. Note: Starting in version 3. Click on this button to cancel any setting changes made in this window. adding 15. . then the add items request fails and the failed result is returned to the OPC client.000 items can take the OPC server 15 seconds to perform.0. If both the CSC and SSC are of version 3. OK Cancel Click on this button to save any setting changes made in this window. Statistical Tags Statistical tags are calculated on the Client Side Component. Requires SMS License Y Tag Name Description The number of seconds over which averages will be calculated for statistical items. @AverageCalculationWindow @ResetStats @Current_ItemUpdates @Minimum_ItemUpdates @Maximum_ItemUpdates @Total_ItemUpdates @Average_ItemUpdates @Current_ItemWrites @Minimum_ItemWrites @Maximum_ItemWrites @Total_ItemWrites @Average_ItemWrites @Current_ TxPackets @Minimum_ TxPackets @Maximum_ TxPackets Y Y Y Y Y Y Y Y Y Y Y Y Y Y . The minimum number of item updates per second. The rolling average number of item updates per second over the last {@AverageCalculationWindow} seconds.0. Read/Write Default: False The number of item updates transferred in the last second. licensing on both sides of the connection. These tags are intended to help users and MatrikonOPC Support with tracking the current status of the tunneller connection.0 adds a set of statistical and diagnostic tags to OPC DA clients accessing a tunneled DA server. and connection performance measurement. The minimum number of TCP/IP packets transmitted to the SSC per second. Minimum and Maximum items are reset to the next current value at this time. The maximum number of TCP/IP packets transmitted to the SSC per second. and can be browsed on the server. and only refer to the details of the OPC DA tunnell connection that the tags apply to. Write “true” to this item to reset the statistical tags and clear the average calculations. The total number of item writes processed. The total number of item updates processed. Total items and counter items are reset to 0.Statistical and Diagnostic Tags Tunneller 5. The rolling average number of item writes per second over the last {@AverageCalculationWindow} seconds. Read/Write Default: 30 seconds. The number of item writes transferred in the last second. The maximum number of item writes per second. Most of the tags require that the user has a valid SMS agreement with MatrikonOPC and requires the software license key to include the SMS feature. The maximum number of item updates per second. The number of TCP/IP packets transmitted to the SSC in the last second. All of the following tags are available under the branch named “#TUNSTAT#”. The information provided by these tags will aid in troubleshooting and system health monitoring. The minimum number of item writes per second. These tags appear as part of the normal server namespace. True if this connection is still connected. The amount of time passed since this connection was created in days:hours:minutes:seconds. The rolling average number of TCP/IP packets received from the SSC per second over the last {@AverageCalculationWindow} seconds. The ProgramID of the OPC Server connected over the tunnel. Requires SMS License Y Y Y Y Y Y Y Y Y Y Y The software version of the CSC. The local user name provided to the SSC for impersonation. * The software version of the SSC. The maximum number of TCP/IP packets received from the SSC per second. The number of TCP/IP packets received from the SSC in the last second. If the SSC is version Tag Name @CSCVersion @SSCVersion @CSCHostAddress @SSCHostAddress @ProtocolVersion @ProgID @Compressed @Encrypted @Connected @Uptime @ImpersonationUser Description . The rolling average number of TCP/IP packets transmitted to the SSC per second over the last {@AverageCalculationWindow} seconds. The IP Address of the CSC. The IP Address of the SSC for this connection. The Protocol Version used for this connection. True if this connection is compressed. The minimum number of TCP/IP packets received from the SSC per second. True if this connection is encrypted. Diagnostic Information Tags Diagnostic Information Tags are generally collected during connection and do not change as long as the connection remains active.Tag Name @Total_TxPackets @Average_TxPackets @Current_RxPackets @Minimum_RxPackets @Maximum_RxPackets @Total_RxPackets @Average_RxPackets @CriticalErrors @Errors @Timeouts @LostConnections @SessionReconnections @ConnectionAttempts Requires SMS License Y Y Y Y Y Y Y Y Y Y Y Y Y Description The total number of TCP/IP packets transmitted to the SSC. The total number of TCP/IP packets received from the SSC. True if the CSC has a valid license.0 or newer.Tag Name Requires SMS License Description 5.0. * The overall license state of the SSC.0. @CSCSMSLicense @SSCSMSLicence @CSCLicenseState @SSCLicenseState @CSCLicensed @SSCLicensed N N N N N N The license state and expiry date of the SMS license on the CSC. this field will only provide the local user name when impersonation is enabled on the remote SSC. * The license state and expiry date of the SMS license on the SSC. * True if the SSC has a valid license. The overall license state of the CSC. Note: * tag is only available if the SSC is version 5. .0 or newer. Encryption. user impersonation. and Restriction of the Access to OPC Servers Refer to the links below for more information pertaining to encryption. Compression. User Impersonation. compression. and/or server access restriction: Encryption Configuring Encryption Settings Using Server-Side Gateway Configuration Tool Client-Side Gateway Key Manager Compression User Impersonation OPC Server Access Restriction and MatrikonOPC Security Gateway Integration . Once the CCT is open. Both of them are installed by default in C:\Program Files\Matrikon\OPC\Tunneller in the Client-Side Gateway and Server-Side Gateway subfolders. or by pressing Ctrl+K. Since the Server-Side machine contains the data that the Client-Side machine wishes to access. the option to operate in a more secure mode is made available on the Server-Side. respectively. l Encrypted . this communication may be further regulated by the use of encryption keys. the Client-Side Gateway Key Manager may be opened by pressing the second button on the toolbar (the key icon ). Furthermore. By default. Tunneller will operate in Open mode. To access the Client-Side Gateway Key Manager on the Client-Side computer. There are two security modes in which Tunneller may operate: l Open . To access the Server-Side Gateway Configuration Tool on the Server-Side computer. or by selecting the Open Key Manager option from the File menu. Encryption is controlled by the Client-Side Gateway Key Manager (which is part of the CSC). Alternatively.no encryption will be used and there is no restriction as to which computers may connect through Tunneller. The information contained in this section is useful for those users who wish to operate in Encrypted mode.encryption may be used and the user will be able to control which computers are permitted to connect through Tunneller. click on Start -> Programs -> MatrikonOPC -> Tunneller -> Client-Side Gateway Key Manager. . the Client-Side Gateway Key Manager is accessible using the Client Configuration Tool (Start -> Programs -> MatrikonOPC -> Tunneller -> Client-Side Gateway Config). and the Server-Side Gateway configuration tool (which is part of the SSC). click on Start -> Programs -> MatrikonOPC -> Tunneller -> Server-Side Gateway Configuration Tool.Encryption It may be in the interest of the user to encrypt data on the Server-Side machine by selecting which computers may connect to the end OPC servers through Tunneller. . When the OPC client or clients connect again. Note: For successful communication to occur. both the SSC and the CSC must be set to the same mode (i.. If the SSC and CSC are set to Encrypted mode. this will cause the disconnection of the CSC from the SSC.e. connected sessions should be recreated. the encryption key is read when a new communication session is created. Encryption fields are described in the Field Descriptions list below. set both to either Encrypted or Open). On the Tunneller SSC. If all OPC clients connected to the particular end OPC server disconnect from the CSC. Alternatively. if a situation occurs such as no access to the OPC client machine. An existing connection will continue to communicate using their old encryption settings until the session has ended. the modifications will take effect. modifications to key mappings on the SSC will not affect existing connections. then restarting the Tunneller SSC service will disconnect clients and apply the SS key mappings on start up. allowing the user to configure key mappings which regulates Tunneller encryption. the Encryption tab is enabled. When Open mode is selected. To apply modifications on the SSC. Recreation of a session can be achieved from the Tunneller CSC. Therefore. When Encrypted mode is selected. the Encryption tab is disabled and Tunneller communication is not encrypted. then the encryption key must match on both ends. .Configuring Encryption Settings Using Server-Side Gateway Configuration Tool The Server-Side Gateway Configuration Tool allows the user to set the Encryption mode to either Open (the default mode) or Encrypted mode. In this case if the result of a bitwise AND operation of the CSC host’s address and Mask is equal to the result of bitwise AND operation of Address value and Mask. with IP address x. Similarly.y.y.x. and the encryption key must be the same for communication to be successful. in the CS computer’s Client-Side Gateway Key Manager.y. Address can be entered in three different ways: • Single – IP address is defined exactly. there should be a key mapping containing x. In this case the key will be used for all IP addresses belonging to the range. then the corresponding IP Address . • Address range – start and end addresses of the range are defined.Field Descriptions: Component Description To allow for Tunneller communication between the Tunneller SS machine (the machine where the Server-Side Gateway Configuration Tool is located.y.y should be entered in the IP address field and an encrypted key must be created.x.x) and the Tunneller CS machine (with IP address y. • Subnet – the mask is entered in the first field and the subnet address is entered in the second field. the CS machine IP address y.y).x.x.x. for example: o 255. If keys are different.0. 2. Encrypt When setting up a key mapping. If encryption is desired. not '1'. Second click changes Address field to the result of bitwise AND operation of local IP address and Mask. numbers.0 168.192. the same key must be entered on both the Client-Side Gateway Key Manager and the Server-Side Gateway Configuration Tool for that particular key mapping. Conversely.0. An Encryption key may contain letters.0. Update/Add Key Mapping buttons will be disabled.0 o 255. When this mode is selected. an encryption key may be entered.0. When Side Gateway Configuration the Encryption option is selected. Subnets in ascending order of address value. which indicates that no encryption will be used for the listed IP Address. So all valid subnet masks contain two parts: the left side with all mask bits set to '1' (the extended network portion) and the right side with all bits set to '0' (the host portion).0 o 255. Key mappings control which computers may connect through Tunneller and contain the encryption keys being employed.0 o 255. Address ranges in ascending order of “From” address. if encryption will be used for Tunneller communication with that specific IP address or range of addresses. In this case for all hosts belonging to the 192.0.0. its leftmost bits must be set to '1'.0. The Encryption key must be entered twice for validation. If the Encryption key field is empty.0. If a key mapping containing the specified IP addresses Encryption Key Add Key Mapping . Encryption mode (only in Server. the IP Address field will display the local computer’s IP address.0.0. Note that the list of keys is ordered in the following order: 1. For example. it must be decided if Tunneller communication for the selected IP address will be encrypted.168.Component Description key will be used for that particular address. and special characters available on a keyboard. then default hard-coded key will be used. Note that Subnet type entries are sorted in certain order taking into account how many bits define extended network portion. check this box. Get Local If this button is pressed. 3. For Tunneller communication to be successful. otherwise. Clicking on a key mapping will fill the current mapping fields with the selected key mapping settings.0 192. Using arrows the rightmost bit of Mask can be shifted to the left or to the right.0.0 local subnet the same key will be used. pressing this button will create a new key mapping.255. the user can select which computers may connect through Tool. the Mask = 255. The format of a key mapping is either: • IP address. ensure it is unchecked. Key Mappings Here IP address can be just single address or range of IP addresses or the subnet mask and address combination. the Encryption tab is disabled.0 and the Address = 192.0 168. Once the user has filled the IP address information and encryption key (optional). <#bits encryption> or • IP address <Non encrypted>.0.168.255. The first click on Get local button changes Address filed to local IP address. The first found entry in Key mapping is used for the given IP address.0. Note that for a subnet mask to be valid.0.0 192. Single address in ascending order. the rightmost bits in a valid subnet mask must be set to '0'. This field will display the user-created key mappings. When setting up a key mapping. Security Mode tab) Tunneller and may set up encryption.0.0.The default setting is Open.255.168.0. 24 17 . For example. Number of Characters in Encryption Key 1 . Encryption Key and IP address. a 12-character encryption key will be padded out to 16 characters. then the Apply button will be disabled. this button will be disabled. If the values on selected key mapping have not changed. Otherwise. This button acts exactly in the same way as the Apply button (changes are saved).Component Description already exists. Encryption keys will be padded out to the appropriate length (the greatest number of characters in that range) automatically.16 17 . Update Key Mapping Remove Selected Key Mapping Remove All Key Mappings OK Cancel/Close Apply The encryption level depends on the length of the user-entered encryption key. this button will not be enabled. and later their previous values are recovered. This button is used to update the selected key mapping with the values from fields Encrypt. Pressing this button removes all Key mappings from the list.24 Number of Bits Encryption 64 96 128 . If key mappings were modified but not saved. then this button is labelled Cancel. Note: If key mappings were modified. its label states Close. but not saved. To remove a Key mapping. select it from the list of Key mappings and press this button. The difference is that after saving of key mappings the dialog window will be closed. This button is enabled if changes to key mappings have been made. 10.100 = 192. In such a situation.10. Furthermore.168. Bitwise AND of CSC IP address and Mask is: 192. Note: In the example for the Server-Side Gateway Configuration Tool all of the lines under Key mappings are used to represent the CSC IP address.168. the first found key is used (line with 64-bit encryption). Computer 1 with IP address 192.168.0 & 192. In Encrypted mode.255.10. In the third line.200 is the Server-Side.10.10. the Server-Side Gateway Configuration Tool on Computer 2 must contain Computer 1’s IP address in a key mapping. in the event that the Server-Side Gateway Configuration Tool is configured for Encrypted mode.10.168. .168.10. the same encryption settings must be used.168. so this line could be used to represent given CSC address too.100 is the Client-Side.Client-Side Gateway Key Manager The Client-Side Gateway Key Manager allows the user to create key mappings on the CSC which will correspond to SS key mappings. <64 bit encryption>. Example A user wishes to use Tunneller to allow OPC Clients on Computer 1 to obtain data from end OPC Servers on Computer 2.200.168.168.10.255 is defined. Modifications of encryption key mappings become effective immediately on CSC.255.100. The ClientSide Gateway on Computer 1 must contain Computer 2’s IP address in a key mapping.168.0 Bitwise AND of Mask and Address is: 255. Similarly. If the key mapping on the CSC is: 192.10. both the Client-Side Gateway Key Manager and the Server-Side Gateway Configuration Tool must be configured properly with matching encryption keys.0 = 192. In the second line the range of addresses from 192.168. <64 bit encryption>.10.255.100 & 255. using the same encryption key. The fields in Client-Side Gateway Key Manager are the same as encryption related fields on the encryption mappings tab in the Server-Side Gateway Configuration Tool.0 to 192.255. and Computer 2 with IP address 192. then the corresponding key mapping on the SSC must be: 192.0 Results of both operations are equal. the subnet mask and address are defined. In the first line the IP address is defined exactly. . . Compression Compressing messages may speed up data transfer considerably if the communication channel has low bandwidth.0 of Tunneller.0. . If compression is enabled in an attempt to communicate with an earlier version of the Tunneller SSC then this option is ignored and does not affect communication behavior. The compression option is configured in the Client Configuration Tool by selecting the Use Compression checkbox.0. The Use Compression option is stored in the Windows system registry and is read each time an OPC client connects to the CSC. Compression was introduced in version 3. the fields on the Impersonation tab are enabled. The impersonation feature can be turned ON or OFF using the Security Mode tab of the Server-Side Gateway Configuration Tool. 4. select one or more entries and click on the Delete button. then the user account under which Tunneller SSC is running is used for impersonation. Enter the Remote User. MatrikonOPC Tunneller has user impersonation functionality. Select the OK button. the end OPC servers can behave differently based on what user is connected. 2. User impersonation mappings can be configured only using the ServerSide Gateway Configuration Tool. Remote user to Local user mappings can be configured. If at the time when the checkbox is turned ON and no such entry is found. By default this feature is turned off. for example restrict access. the entry for [Default] Remote User is used. Note: All impersonation mappings including passwords are stored in the configuration file using encryption. UseImpersonation parameter under the TCConnection section. User impersonation settings are configured using Server-Side Gateway Configuration Tool. To add a new entry into the User mappings: 1.0.0. The currently selected entry can be edited by double-clicking your mouse on the entry or by selecting the Edit button. Tunneller SSC looks for the entry for Remote user on User mappings. the Edit User Mapping window is opened and the entry added. Note: Remote User should be entered as Domain\User Name for domain accounts or Computer Name\User Name for machine specific accounts. . a warning message pops up when changes are applied. it takes Local user for that entry and performs impersonation using its domain. To delete an entry or entries from the User mappings. Local User. and passes that information to the Tunneller SSC. On the server side. Tunneller CSC retrieves information about domain and user name under which OPC client connects. Its default value is 0 (i. and Password. and the Default Account option is turned OFF. select the Impersonation tab. 5.User Impersonation Starting in version 3.. Local user corresponding to [Default] Remote User can be configured either as a specific local user account or as [Default]. user impersonation is OFF). Note: Impersonation can also be turned on or off through the tunneller. user name and password for the thread communicating with the end OPC server. If it is configured as [Default]. If the entry is found. If impersonation is turned ON. where hostname can be the fully qualified domain name (FQDN) hostname or simply the machine name.ini file. The Edit User Mapping window is displayed. If User Impersonation is turned ON but there are no mappings configured. 3. You can also specify the hostname of the end OPC client’s machine using the Domain\User Name:Hostname syntax. then the connection is rejected. The Local User field requires the user name only. From the Server-Side Gateway Configuration Tool window. As a result. If turned on.e. If it is turned OFF. If it is turned ON.1. Click on the Add button. The behavior of the system in case no entry is found for the provided Remote user or the Remote user is not defined (this can be possible if older version of Tunneller CSC is connected) depends on the state of the Use Default Account checkbox. . e. then the default list can be configured (all authentication fields set to [Default] on Remote clients list for this entry). Each Remote client can have a configured list of accessible OPC servers. a check is performed to see if the MatrikonOPC Security Gateway is installed and licensed. if licensing conditions are changed. Tunneller provides functionality to restrict access to OPC servers installed on the Server-Side Component depending on Remote client.1. OPC server access restriction is implemented differently in cases where the MatrikonOPC Security Gateway is installed on the same box as the Tunneller Server-Side Component. then the Access Lists tab becomes invisible. Therefore. If the Server-Side Gateway Configuration Tool detects that the MatrikonOPC Security Gateway is installed and has a valid license (including a demo license). remote OPC clients can only connect to OPC servers through MatrikonOPC Security Gateway.0. or Domain\User name. Components of this tab are described in the Field Descriptions section below. If the Remote client is unknown (i.OPC Server Access Restriction and MatrikonOPC Security Gateway Integration Starting in version 3. . Restriction of the access to OPC servers can be turned on from the Security Mode tab of the Server-Side Gateway Configuration Tool. Settings for what fields are used to authenticate the Remote client and what Remote clients can access which OPC servers.2. or a combination of these three fields. In that situation.0. Starting in version 3. or a fullyqualified host name.. As well. there is no configuration for it). Tunneller SSC returns only the ProgID of MatrikonOPC Security Gateway as the list of installed OPC servers. That provides functionality to control access rights per remote user at the OPC Items level. Remote clients can be authenticated either by their local IP Address (on their local network). Note: When the Server-Side Gateway Configuration Tool starts up. on the Security Mode tab the text Controlled by Security Gateway appears under the Restriction of the Access to OPC Servers group.0. are configured using the Access Lists tab.1. the Server-Side Gateway Configuration Tool should be restarted for changes to take effect. Therefore. Field Descriptions Component Authenticate Remote Client By Description Check boxes defining what data is to be used to authenticate remote client: IP address. access is refused and the empty list is returned to the Client-Side Gateway Configuration Tool. Host name. Remote Clients Use [Default] Access List for Unknown Clients Add Edit . If selected. or/and Domain\User name. Note: For each combination of selected Authenticate Remote client by check boxes. At least one checkbox must be checked. Opens the currently selected entry from the list of Remote clients for modifications. Opens a new window. then the list of accessible OPC Servers for [Default] entry will be used (all fields have [Default] value for this entry on Remote Clients list). Otherwise. The list of entries authenticating Remote clients. This check box defines the behavior of the system in case the Remote client could not be authenticated (unknown). The number of visible columns depends on the selected Authenticate Remote client by check boxes. Adds a new entry into the list of Remote clients. separate lists are stored on the Remote clients list. ini file). but they will not be used or displayed on GUI. Click on this button to clear (i. In either situation. Click on this button to select all OPC servers in the list. l All fields selected for use for authentication.Component Delete OPC Servers Accessible for Selected Client Check All Uncheck All Refresh OK Cancel Apply Description Deletes the currently selected entry from the list of Remote clients. then previous settings are still stored in the configuration file. but later IP address and Domain\User name are used). OPC servers are identified by their ProgID. initially only the IP address was used.e. The list of OPC servers installed on local computer (where Tunneller SSC is hosted). If the fields used for Remote client authentication are modified (for example.. Notes: l The [Default] entry on the Remote Clients list cannot be edited or deleted. Click on this button to accept the changes made. but there are no accessible OPC servers. Click on this button to apply and accept any changes made. . Components of that window are described in the Fields Description list following the diagram below. the Edit Remote client host info window is displayed. using OPCEnum service or direct access to the system registry (depending on Browse Registry parameter defined on tunneller. Refreshes the list of OPC servers. l If Access Restriction is turned ON . Click on this button to cancel any changes made. must have non-empty values. a warning message appears when changes are applied. Changing the selected entry in the list of Remote clients can be done by selecting the Edit button. Select the applicable checkboxes to determine whether the corresponding OPC server is accessible to the currently selected Remote client or not. Only entries which have non-empty IP Address and Domain\User name and empty host name will be used and will be visible on the Remote Clients list. deselect) all selected OPC servers in the list. New entries to the Remote clients list are added by clicking on the Add button. might be different than the currently logged-on-to remote host user. For example. including connections from the Client-Side Gateway Configuration Tool. Click on this button to open the Select Remote Client info from the list of connections window. if OPC Client Applications was launched using Run As utility or if it runs as a service. The window opened by this button contains a list of Remote client authentication data that can be selected and used to fill corresponding fields. A second click to this button retrieves the IP Address. Notes: • If no connections have yet been accepted by SSC. Saves changes in memory and closes the window. Tunneller SSC keeps track of which Remote clients were connected to it. one SSC log file client’s IP address can be shown differently). Note: User account. Note: This can be time consuming. Option is disabled if the IP address checkbox is not selected in the Authenticate Remote client by group of the Access Lists tab. Note: Changes will take effect when either the OK or Apply button on the main window is selected. Fully qualified Host name of Remote client. If the IP address option is disabled. A value can then be entered into the Host name field.Field Descriptions Component Description IP address of Remote client (on its local network). Option is disabled if the Host name checkbox is not selected in the Authenticate Remote client by group of the Access Lists tab. the button will be disabled and its text will be changed to “Getting…”. A value can then be entered into the IP address field. Domain\User name of the windows user account under which the OPC client application is running. click on this button to enable it. click on this button to enable it. Closes the window without saving changes. Get IP address by resolving Host name. Note that if there is a router between CSC and SSC hosts. While processing. Get IP address by IP address. A second click to this button will retrieve the Host name. Select from the list of connections that were opened Entering Remote client host information by selecting from the list of connections ensures that the authentication fields have correct values and the configuration process is sped up. If the Host name option is disabled. the list of connections will have a line with blank fields as older versions do not pass Remote client information to the SSC. the button will be disabled and its text will be changed to “Getting…”. the connections list is empty and the button is disabled. IP Address Get from Host Name Host Name Get from IP Address Domain/User Name OK Cancel . While processing. • If an older version of Tunneller CSC was connected to SSC. Note: This can be time-consuming. under which the OPC client application runs. .To ensure that the Remote client host information is entered correctly. it is recommended that you use the Select Remote client host info from the list of connections window. ini file.log.bak. Field Descriptions: Component Max File Size. Advanced settings are stored in the tunneller.log file in Kbytes. If this checkbox is selected. Otherwise. KB Level Log to Screen Overwrite Old File Log level. the previous log file’s copy is not made. If this checkbox is selected. Description Maximum size of the tunneller.Advanced SSC Settings Advanced configuration settings for the Server-Side Component can be modified using the Advanced tab on the Server-Side Gateway Configuration Tool window. backup is made named as tunneller. It does not disable logging to file. Tunneller SSC logs messages to the screen. Components of this tab are listed below. . 0. If the CSC version is 3. then ReconnectTime defined on CSC is used as a Session Timeout. The default value is 5. If the CSC version is 3.g. due to licensing or performance considerations.0 or higher. The TCP port address to which SSC listens for incoming connections. Forces the use of DA 1 interfaces on connection to OPC DA server. If a communication error occurs.0. before the Server Delay After Adding of DA Group Side Gateway will start adding tags to those groups or execute similar operations. Deactivate DA Group at adding of items Force DA 1 Deactivates the DA Group before the adding of items. Defines the delay (in milliseconds) after connection to the end OPC server. Used when communication failures occur. all information written to the log file is immediately written to disk instead of being cached.0. this value is ignored and the CSC’s Communication Timeout option is used. If both CSC and SSC are of version 3.e.0. the Tunneller service must be restarted.) and one of the following two situations might cause a connection to fail. During the Session Timeout period. that session can be reused so that recovering does not take a long time. This option should have the same value as the ReconnectTime option configured on Client-Side Component versions prior to 3. the Client-Side Component can send a request to create a new session at that time.0 or higher. Port Number Timeout Retries Maximum Size of Queue Session Timeout Delay After Connection Defines the delay (in milliseconds) after adding of group to OPC DA server. Therefore. then the Server-Side first waits for disconnection from the OPC server and deletion of the previous session.g. e. If this option is changed. This option will not allow multiple Client Side Gateway machines to share a single connection to an OPC server. and then only creates a new session. it specifies that only one connection at a time is created to the OPC server on behalf of each Client Side Gateway connected to the same end server and using the same user id. Note: This can slow down the operation of Tunneller as operations must wait for log lines to be flushed to disk before continuing.0. only one connection to the end OPC server will exist at any time (that can be Only One Connection .2. Number of retries after communication failure.2. if the server is not already running when the Tunneller SSC connects to it. Note: To successfully communicate.. Some OPC Servers may need this delay after the initial connection before they are ready for use.2.Component Commit All Log File Writes Description If this checkbox is selected. and activates after adding. Some OPC Servers may need this delay after the group is created before items can be subscribed to. Communication timeout in seconds. If this option is selected. before the Server Side Gateway will start creating groups or performing other operations. this value is ignored and the CSC’s Retry Attempts option is used. This option should be selected when the OPC server has a limitation on connections (e. OPC groups and items are not deleted).2. then the session is waiting for reconnection for a defined session timeout period. 1. the port number configured on Server-Side Component must match with the port number configured on Client-Side Component. causing it to start up. If this checkbox is selected. Maximum number of outgoing messages on the communication messages queue.0 or higher. But. the connection to the end OPC server is not closed and the session stays open (i. See Update of large amount of items fails in the Troubleshooting section for more details. When the Client-Side Component reconnects to the Server-Side Component. When selected. But.2. Tunneller SSC accesses Windows system registry to retrieve the list of installed OPC servers. which can be changed by adding the ConnectDelay option into the tunneller. Browse Registry Get Status Ping Every X Sec OK Cancel Apply If checked.0. In this case. ScanTask for RTAP).ini file ([TCConnection] section). OpcEnum service is used. Client-Side Component Option Communication Timeout Retry Attempts Timeout Retries No matching option on the SSC configuration utility GUI. the default value of 600 seconds is used for that session.2.2. Click on this button to cancel any changes made. This default value can be changed by adding the ProcessingTimeout option into the tunneller. the default value of 1000 ms is used. Click on this button to accept the changes made. multiple instances can run on the client-side and the Only One Connection checkbox must be cleared. for a session timeout period. Otherwise. so that each session can have its own settings. Otherwise.0. Click on this button to apply and accept any changes made. ConnectDelay For connections from a CSC version prior to 3. Its value is used when processing a shutdown request from OPC server: SSC waits during this time for the current operation (if there is any) completion before disconnecting.0 connects to SSC version 3. If an CSC version prior to 3. the Tunneller SSC periodically (period set in seconds) sends a Get Status request to verify whether the end OPC server is still running. Server-Side Component Option Processing Timeout . The table below describes those settings that can be overridden. Should be turned ON for Windows NT4. only one instance of the Client-Side Component can run at the same time.0. for example due to licensing).2. more than one open connection to the end OPC server can exist.Component Description required if the end OPC server can accept only one connection at a time. ReconnectTime Session Timeout No matching option on the SSC configuration utility GUI. there are installations where the Client-Side Component runs under Linux (for example. On the Windows box. 2.0 or higher.0.0.0.ini file ([TCConnection] section). Note: Some settings on the Server-Side Component can be overridden by Client-Side Component settings if both SSC and CSC are of version 3. If no connection is re-established. The default value is 0 indicating that no reconnection attempts will be performed. only latest updates are kept in memory. Tunneller will attempt to re-establish the link during the time period specified by the ReconnectTime option.e. for example) maintained in the CSC will be sent to the SSC recreating the state on the SSC. the state information is reused and Tunneller continues on as normal.0. Delay between retries is defined by the ConnectDelay option. detects that the SSC has the correct current state available).. qualities. Note: For versions prior to 3. .e. The ReconnectTime option is configured in the TunnellerOpts. has not been terminated) it will save the session’s current state for some configurable period of time.0. If the reconnect command fails. Any items that had their qualities set to bad will have their qualities set to good only when a new value is received for the item. during that time the CSC tries to re-establish a connection to the SSC using a reconnect command. Tunneller CSC waits for the delay defined by the ReconnectDelay parameter (default value is 10 seconds) and retries a reconnection during the time period defined by the ReconnectTime parameter (default value is 0 seconds).Connection Failure Scenario  Tunneller maintains a connection-oriented TCP link between the CSC and the SSC whenever there is an OPC client connected to a Tunnelled ProgID. If the connect command fails it will re-try the full connect command until it either succeeds or the end OPC client disconnects from the Tunnelled ProgID.0. If the SSC is still active (i. its value is the same for all sessions which is defined by the Session Timeout parameter under the TCConnection section in the tunneller. a. A connection is established and normal communication is underway.2. If reconnection could not be established during ReconnectTime. SSC sends these updates to CSC as a single update. b. If this link fails and is detected by the CSC or SSC. Tunneller will set all of its items qualities to bad informing the end OPC client that a failure has occurred. 4. or communication is established but the Server-Side Component does not have a matching session in correct state. If the reconnect command succeeds (i. A failure is detected (either a broken link is detected or a Communication Timeout has been passed).e. In Tunneller SSC version 3. In version 3.0. 0 seconds). At no time during this phase has Tunneller changed the item values. If the ReconnectTime option is more than 0. Connection/reconnection is performed in the following order: 1. the ConnectDelay option also defines the delay between attempts to connect to the remote OPC server on SSC.. 2.ini file on the Client-side Component. All alarms and events received during communication failure are buffered (as long as the SSC Session Timeout has not expired) and will be sent upon reconnection. Communication will continue on as normal. If the connect command succeeds. or timestamps.0. Tunneller will start full connection attempts. any session state information on the SSC will be removed after the configurable time period defined by the Session Timeout. a. Note: During communication failure period SSC handles DA OnDataChange call-backs from the end OPC server differently. At this point.ini configuration file (by default. The CSC will attempt to connect to SSC using the full connect command. b.2. When reconnection is established. 6.2. the state (items. it is equal to the ReconnectTime option defined on the CSC (i.. a different session can have a different session timeout depending on the CSC settings). 5. 3.0. 2. on Tunneller SSC the number of connections to the end OPC server for each combination of Tunneller CSC IP address/OPC Server ProgID/Category (A&E.1.ini file) in case of communication failure. this restriction can be turned off by setting the DeleteDuplicateSessionsOnNewConnection parameter to 0 (under the TCConnection section on tunneller.0. .0.ini configuration file).7. additionally local Domain\User) is restricted to 1. SSC will disconnect from the end OPC server immediately after the normal disconnection of CSC. By default.ini file. on CSC. The connection between CSC and SSC is terminated when. Starting in version 3. or when the session has timed out (defined by the Session Timeout parameter in the tunneller.0. DA or HDA) (starting in version 3.0. there are no more connected end OPC clients during the period of time defined by the NoClientsDisconnectionDelay parameter in the TunnellerOpts. the detection will be quick. up to the retry amount). reading a very large number of items or browsing very large address spaces on the end OPC server) and the Processing Timeout value is not high enough. Note that if the Use Remote Status checkbox is selected.0 can detect the network timeout state if the execution of operations on the remote OPC server takes a long time. but it is configured using different option: the AddItemRetries parameter defined in the TunnellerOpts. A longer time also causes the responsiveness of Tunneller to go down because more time is spent testing the link. and Retries Note: Please refer to Connection Failure Scenario before reading this section. Tunneller allows the user to set the Processing Timeout. The value of the Communication Timeout parameter affects the network link failure detection time because it is the time the network will spend testing the link for the ability to perform the required operation (send/receive request/responses over the network). If the network was unable to get the command to its destination because of a network problem. If the OPC client is not sending or receiving data for extended periods. if the remote OPC server returns an error result code for an update history call. additional attempts to update will not be made. prolonged execution of operations by the OPC server does not cause communication timeout.. CSC waits for Processing Timeout before detecting operation as failed. Timeouts. it will retry sending the command. For example. However. routers. If the break occurs within the network (e. If processing timeout . sending and receiving data will happen at least as frequently as the OPC client calls GetStatus.e. For example. default timeout and retry values are acceptable. the processing timeout can elapse before the command completes. and Communications Retry values using the Client-Side Gateway Configuration Utility. This could be because of a bad connection or interference caused by electrical equipment.g. The longer the timeout value. The retry value is used when the network itself has problems but the link to the SSC is maintained. then SSC starts to send Keep-Alive messages letting CSC know that the communication channel is alright. If it is the local connection.Connection Time. These values are used by Tunneller when sending and receiving data on the network. A retry happens if adding items returns S_FALSE and error codes for all items indicate the process was unsuccessful. the longer failure detection will take. Notes: l Tunneller versions prior to 3. the time it takes Tunneller to detect the break depends on where the link broke. If the operation execution takes too long. adding a large number of items.1..0.0.0.ini configuration file.1. Communication Timeout. switches). The AddItems call can be retried. The detection also depends on network usage. Problem: Timeout Expired When running under normal conditions. l The Communication Retry Attempts parameter does not affect OPC calls to the remote OPC server. many retry times are needed (i. When an unusually long command is executed (e.g. The result will be returned to the OPC client as is. Tunneller will not detect that the link is broken until communication resumes. it may take Tunneller several additional seconds to detect it. Starting in version 3. Problem: Network Link is Broken If the network link is broken.. the Server-Side Component is restarted. or during Communication Timeout (in the case when ReconnectTime is less than Communication Timeout). Increasing the retry amount allows the network link to continue when otherwise it would have been considered as failed. so a lesser Processing Timeout value can be used. CSC does not break the connection. Note: If processing timeout occurs while running an add items request. this option can be important if the total number of added items is considerable.g. If the connection between the Client-Side and Server-Side components is closed due to some reason (e. the network link will be considered failed and Tunneller will start the reconnect procedure. The Communication Retry Attempts parameter can come into effect when network communication is not reliable. by using the MaxAddMessage parameter (configured in the TunnellerOpts.ini file on CSC).ini file) the request can be split into sub-requests with a smaller amount of items added at once. the message (level 2) will be printed on a log file: TIMEOUT WARNING: Probably the processing timeout parameter should be increased by X seconds. but SSC later completes it and CSC receives a response with results. . The Processing Timeout value must be set to allow the longest expected command. or there was a network disconnection). items must be added again to the end OPC server. If reconnection is not established during the time defined by ReconnectTime parameter (set in TunnellerOPts. when the Client-Side Component establishes reconnection to the ServerSide Component without disconnection of the OPC client. Even if the OPC client adds items by small portions so that each initial add item request does not take a long time.. When Communication Timeout elapses. then the command is also considered failed.elapses. If CSC detects a Processing Timeout for the operation. The Communication Timeout can come into effect when the command being sent is very long and the network has a low ability to transfer data. but returns the error to the OPC client. where X is an estimated increase value. Handling Shutdown Request from Remote OPC Server Note: This section is relevant for Tunneller SSC version 3.2.0.0 or higher. When a remote OPC server sends a Shutdown Request to the SSC (which acts as an OPC client), then SSC performs the following steps: 1. Sends notification to the CSC, so the shutdown event can be tracked on the CSC log file. 2. If there is any call to the OPC server in process, it waits until it is finished (while Processing Timeout is not elapsed). 3. Disconnects from OPC server. The connection to the OPC server is restored and items are re-added when the SSC receives the next request from the CSC. Reconnection occurs with certain delay after disconnection, which is 10 times the ConnectDelay defined by the CSC. In most cases this delay is enough for the remote OPC server to stop and be ready to start again. Handling Items Momentarily Unavailable After Disconnection Note: This section is relevant for Tunneller SSC version 3.5.0.0 or higher. When a connection to the OPC server is restored (after a disconnection), the CSC will attempt to re-add the items. If the add operation fails, a certain number of retries are performed. The number of retries are determined by the AddItemRetries parameter (in the TunnellerOpts.ini file, the default is set to one retry). If all of the retries fail, or if the items are partially added (some items are added and some are not), then the CSC will not perform any more attempts. To make the CSC periodically attempt to add the pending items, set the AddPendingItemsPeriod parameter to a specific period in milliseconds (in the TunnellerOpts.ini file, by default it is set to 0 which disables the feature). It is recommended that you set this period to a value that is large enough to avoid eventual impact on the ongoing communication. Note: When upgrading from a version prior to 3.5.0.0, the AddPendingItemsPeriod parameter may or not be present in the TunnellerOpts.ini file. If the parameter is not present in the options file, it can be added manually, as follows: 1. In the TunnellerOpts.ini file, locate the section called [TSAddItems]. 2. Under the line DelayAfterAddItems=0, insert AddPendingItemsPeriod=some period in milliseconds (zero if you want this initially disabled). 3. Save the file and then restart the CSC service. Tunneller with MatrikonOPC Redundancy Broker When connecting MatrikonOPC Redundancy Broker (ORB) to Tunneller (OPC Client -> ORB -> Tunneller -> OPC Server), ORB’s Standby becomes primary after failover option must be selected (for versions prior to ORB 2.2.0.0). Deselecting this option (for older ORB versions) will cause ORB to failover and fail back repeatedly. Because ORB is connected to the local Tunneller client, ORB cannot detect when the OPC server on the end of the Tunnelled connection goes down. Therefore, ORB requires that failover conditions be configured through “watchdog tags” (i.e., advanced failover conditions) which will detect an unresponsive OPC server. For more information regarding ORB, refer to ORB documentation. 0 of MatrikonOPC Tunneller provides subscribe-only access to A&E Condition events. A&E Support for A&E conditional events . The last set of sampling rate and buffering parameters set apply to all of the clients. but cannot acknowledge them OPC Alarms and Events specification .0 support is limited to the IOPCItemSamplingMgt interface. and have IOPCItemSamplingMgt in use. 2. If multiple clients are accessing the same item. The client may subscribe to and receive conditional events.0. . OPC DA 3. all clients must use the same IOPCItemSamplingMgt parameters. Refer to the MatrikonOPC Tunneller Release Notes for known issues.OPC DA 3.A&E Support does not include the optional Area and Source browsing portions of the OPC Alarms and Events specification.0 support .Limitations MatrikonOPC Tunneller has the following limitations: 1.the A&E Support starting in version 4. 0 server and cannot access data through the DA 3. but server had died "Unable to browse remote OPC server" message displayed Browsing not returning anything AddGroup. ValidateItems behave the same HDA client used. AddItems.0 interfaces Communications problems when CSC or SSC is on Windows 7 or Windows Server 2008 Licensing FAQs General Licensing Using the old license method How can I view the status of my MatrikonOPC licenses? Demo License Can I re-install my MatrikonOPC product to obtain another 30 days? My license has expired. or returns only part of OPC servers installed on Server-Side Cannot connect to the tunnelled OPC server from certain computers/OPC clients Tunneller returns different set of historical data when connection to remote OPC server is made via Tunneller and start or end time is defined as relative time ORB fails over constantly when used with Tunneller OPC A&E client have problems when receiving A&E Condition events OPC DA server is disconnected frequently when there are no active subscribed groups or items OPC client detects the Client-Side Gateway as a DA 3. while using this OPC server. Who do I talk to about a new one? Permanent License Trying to install my permanent license using my activation key . and questions asked.Troubleshooting This section is intended to assist you by providing licensing information and MatrikonOPC Support contact information. Problems and Solutions Using the Pi OPC client OPC client not responding when connected to Tunneller GetStatus indicates OPC server is OK. Also addressed here are some of the most common problems encountered. but calls not successful Getting incorrect values of 0 Fail to add items on first try Update of large amount of items fails Adding multiple items causes present items to go bad Tunneller does not work on Stratus box Add Remote Tunneller Connection returns no OPC servers. Please check the following Problems/Solutions and Licensing FAQs sections before contacting the MatrikonOPC Support team. .opcsupport.Where do I find the lock code? Where do I find my activation key and lock selector? Why do I need to enter the PC name on the licensing web page? Hardware License Can I install multiple keys on the same parallel port? Will the system recognize multiple USB keys? Search the MatrikonOPC Support Knowledge Base at www.com to find the answers to other commonly-asked MatrikonOPC Tunneller and/or Licensing questions. Un-Installation .Appendices Additional product information is available in the following appendices: Appendix A .Installed Files Appendix D .Standard Data Types Appendix B .Installation Appendix C . Appendix A . Hex 0000 0002 0003 0004 0005 0006 0007 0008 000A 000B 0011 0012 0013 0014 2002 2003 2004 2005 2006 2007 2008 200A 200B 2011 2012 2013 2014 0 2 3 4 5 6 7 8 10 11 16 17 18 19 8194 8195 8196 8197 8198 8199 8200 8202 8203 8208 8209 8210 8211 Dec VT_I2 VT_I4 VT_R4 VT_R8 VT_CY VT_DATE VT_BSTR VT_ERROR VT_BOOL VT_I1 VT_UI1 VT_UI2 VT_UI4 VT_ARRAY | VT_I2 VT_ARRAY | VT_I4 VT_ARRAY | VT_R4 VT_ARRAY | VT_R8 VT_ARRAY | VT_CY VT_ARRAY | VT_DATE VT_ARRAY | VT_BSTR VT_ARRAY | VT_ERROR VT_ARRAY | VT_BOOL VT_ARRAY | VT_I1 VT_ARRAY | VT_UI1 VT_ARRAY | VT_UI2 VT_ARRAY | VT_UI4 Data Type VT_EMPTY Description Default/Empty (nothing) 2-byte signed integer 4-byte signed integer 4-byte (single-precision) real 8-byte (double-precision) real Currency Date Text (UNICODE) Error code Boolean (TRUE = -1. Array of 1-byte unsigned integers Array of 2-byte unsigned integers Array of 4-byte unsigned integers .Standard Data Types The Standard data types and their descriptions are listed in the following table. FALSE = 0) 1-byte signed integer 1-byte unsigned integer 2-byte unsigned integer 4-byte unsigned integer Array of 2-byte signed integers Array of 4-byte signed integers Array of 4-byte (single-precision) real Array of 8-byte (double-precision) real Array of currency values Array of dates Array of text values Array of error codes Array of Boolean values Array of 1-byte signed integers. or you are taken directly to the Licensing Agreement screen.exe file. If the Licensing Agreement screen is the displayed screen. you are ready to install the software. . 4. then click on the Next button to install the listed pre-requisites. 2.Appendix B . The InstallAware Wizard verifies its contents. To install the software: 1. go to step 5. Insert the MatrikonOPC Tunneller CD into the CD drive. Either a Pre-Requisites screen appears.Installation Once the system requirements have been met. the MatrikonOPC Analyzer tool is installed and used to detect the system settings that affect the use of this software. If the MatrikonOPC InstallAware screen does not automatically appear. double-click the installation . if required. If the Pre-Requisites screen appears. Note: As part of the installation process. No information is communicated back to MatrikonOPC. Information is stored on this system only for future use by MatrikonOPC Support to assist with troubleshooting. 3. After all pre-requisites have been installed. you have the option of selecting the I reject the license agreement option. or select the I accept the license agreement option button enabling you to proceed through the install. Note: From the License Agreement screen. cancel the install by clicking on the Cancel button. . the License Agreement screen appears. Selecting the I reject the license agreement option button disables the Next button so your options are to return to the previous screen.5. Read the Software License Agreement. . Select the I accept the license agreement option button. Click on the Next button. using the scroll bar to view the entire message. 8. 7.6. The Setup Type screen appears. The Destination Folder screen appears. Note: MatrikonOPC recommends that you select the Complete Setup option.9. 10. Select the type of setup to be performed. . Click on the Next button. The Start Menu screen appears. .11. Select the folder in which to install the MatrikonOPC server. Click on the Next button. or accept the default location displayed in the Folder path field. 12. by selecting the applicable option button. . The Licensing screen appears. or for all users.13. Click on the Next button. Select the Start Menu group and specify whether you want shortcuts created only for yourself. 14. 16. Click on the Next button. Select the applicable licensing option. . The Ready to Install screen appears.15. The Installing MatrikonOPC Tunneller screen appears. and the product files are copied to the computer. Click on the Next button.17. you have the option of clicking on the Back button to change any of the installation information. installation begins. Note: Prior to starting the installation. Click on the Cancel button if you wish to stop or cancel the installation. . the MatrikonOPC Tunneller Setup Complete screen appears stating that the MatrikonOPC Server has been successfully installed. When the installation has finished.18. . and shortcut icons are created in the Start menu. Reference to the DCOM configuration can be found in the DCOM Manual. Note: At this point. At this point. the software components are registered. . it is recommended that you verify the DCOM settings. you have the option of launching any or all of the following by selecting the necessary checkbox or checkboxes: l l Configuration panel User Documentation 20. 21. Click on the Finish button to complete the installation and exit the Wizard.19. This configuration varies for different operating systems. The necessary files have now been copied to the target computer. dll OPCTunneller.Appendix C .exe RmsApiProxy.dll TunnellerClient.dll EventLogger.exe Description Tunneller Server-Side Gateway Executable Tunneller Server-Side encryption key management and configuration tool executable .dll lsapiw32.exe SSKeyManager.chm TunnellerOpts.exe OPCTunnellerHDA.mkf Description Encryption configuration file C:\Program Files\Matrikon\OPC\Tunneller\Server-Side Gateway File Name TunnellerServer.Installed Files The installation program copies all necessary files to the target computer and creates shortcut icons in the Start menu.exe OPCTunnellerAE.exe DSClientConfig.ini Online Help Manual Configuration File C:\Program Files\Matrikon\OPC\Tunneller\Client-Side Gateway File Name CCT.dll TunnellerClientConfig. The files listed in the following table are installed by default.dll TunnellerClientx64. installed on 64 bit OS’s only) Client-Side Gateway Configuration Tool Client-Side Gateway (DA) executable Client-Side Gateway (HDA) executable Client-Side Gateway (A&E) executable Description Client-Side Configuration Tool Configuration file Client-Side Encryption Key Manager Description C:\Program Files\Matrikon\OPC\Tunneller\Client-Side Gateway\Security File Name KeyFile.exe inproc component (32 bit) Inproc component (64 bit. in the following location: C:\Program Files\Matrikon\OPC\Tunneller File Name MatrikonOPC Tunneller Online Help.ini CSKeyManager. dll Tunneller Server-Side configuration file Description C:\Program Files\Matrikon\OPC\Tunneller\Server-Side Gateway\Security File Name KeyFile.File Name Tunneller.exe LicenseRemover.pdf HASP.doc Opchda10_auto.dll OPCHDAAuto.dll lsapiw32.exe MTKAuthorize.exe LicenseWizard.dll RmsApiProxy.doc Description End User License Agreement Hardware License Key Executable License Removal Tool License Wizard Tool Legacy Licensing Tool MatrikonOPC Automation Library MatrikonOPC DA Automation Library MatrikonOPC HDA Auotmation Library MatrikonOPC DA Automation Library documentation MatrikonOPC HDA Automation Library documentation .dll OPCDAAuto.exe OPCAuto.ini EventLogger.mkf Description Encryption configuration file C:\Program Files\Matrikon\CommonFiles\MatrikonOPC\Common File Name EULA.dll Opcda20_auto. select Add or Remove Programs. To un-install MatrikonOPC Tunneller: 1. 2. From the displayed menu. Click on the Start button and highlight the Control Panel item.Un-Installation To successfully un-install MatrikonOPC Tunneller. The Add or Remove Programs window is displayed. Click on the Remove button associated with the MatrikonOPC Tunneller program to initiate the un-install process. 5. Scroll through the list of currently installed programs and updates to find and select MatrikonOPC Tunneller. . and the Welcome to MatrikonOPC Tunneller Maintenance screen is displayed. using the Add or Remove Programs from the Microsoft Windows Control Panel is recommended. 6. 3. The MatrikonOPC Tunneller – InstallAware Wizard appears.Appendix D . 4. . 8. Select the Remove option button to un-install MatrikonOPC Tunneller entirely. The Ready to Uninstall screen is displayed.7. Click on the Next button. 10. . Click on the Next button. The Uninstalling MatrikonOPC Tunneller screen appears and the un-install takes place.9. The program no longer appears listed in the Add or Remove Programs window.11. . When the un-install has finished. 12. 13. Click on the Finish button to complete the un-install and exit the Wizard. the MatrikonOPC Tunneller Setup Complete screen appears stating that MatrikonOPC Tunneller was successfully un-installed.