OPC Gateway Server
Contents
1. Accel Unit 3 Power Current Power Min Original name Accel Current Original 1D Engine Accel Current Canonical data type vT_14 0003 Name accel Current Data type conversion Qons DK Cancel Accept Help Connected with OPC Server 1 4 The configuration dialog is separated in three sections On the upper left the source server and its namespace is shown On the right you will see the namespace of the OPC Gateway Server also called the public or published namespace lf an element of one the namespaces is selected and properties are available for this element these properties will be shown in the lower part of the dialogue where the property editor is lo cated User s Manual OPC Gateway Server User Interface e 16 Source server namespace The OPC source server can be selected using the drop down list in the upper left area After selecting a source server the OPC Gateway Server will try to start the source server and fetch its namespace to display it in the tree view below the list box When the namespace is available single items or entire branches can be published either by using drag n drop the A publish button between the two tree views or by using the Pub lish command from the pop up menu Already published items are marked with the Bi icon the publication can be removed by using the a unpublish button or the Unpublish com mand from the pop up menu Below th2. ial Source server namespace OPC Server 1 iz at B 8 OPC Server 1 2 B IXTS OPCGWS 21 ae Engine El Speed Current if Speed Current a Speed Min E Power Current Speed Max E Temp Current Speed Average Speed Unit Accel Min Gf Accel Max Accel Average Accel Unit a Power Current Power Min j Original name Accel Current Original 1D Engine Accel Current Canonical data type VT_14 0003 Name Jaccel Current D Engine Accel Current Data type conversion Connected with OPC Server 1 DK Cancel Accept Help I 4 Published elements and branches can also be renamed by highlighting them in the right tree view and selecting the command Rename Alias from the pop up menu that will be shown on a right mouse click Setting up the server name and ID The OPC Gateway Server is an OPC server on its own You may change the server identification by selecting the root node of the published namespace and changing the respective properties in the property editor below The server name the server ID and the vendor information can be set according to the personal needs The format of server name is not stan dardized so any combination of chars can be set here The format for the server ID is defined in the OPC specification and should therefore have the format lt Vendor gt lt Servername gt or lt Ven dor gt lt Servername gt lt Version gt As the ser
3. s Manual OPC Gateway Server User Interface e 24 Setting the environment options By setting the environment options the overall behavior of the OPC Gateway Server can be adjusted to the personal needs The settings are divided into three categories General options General Start options Reg Default values nas Ps start with empty configuration Event log re4oad last configuration 7 load this configuration J al System check an validation P Validate configuration after loading it I Ehedk system environment when selecting an OPC server Program settings Selected language English Splash and info window Default bd The general options include the start options which control the applica tion behavior regarding the server configuration at startup Available op tions are to start with empty configuration which under normal cir cumstances doesn t make much sense The default setting is re load last configuration which means that the application will try to re load the last used configuration from the previous run Maybe it is also desir able to define a fixed configuration file which always will be opened with out regarding what was opened before In this case use the option load this configuration The option Enable validation controls the validation of the OPC items when a configuration is loaded In general the validation makes sense to assure that th
4. are planning to buy one please contact us at Licensing Gixts de License key The license key may be copied from the Windows clipboard into the re spective edit control or a license file lic can be imported If you still do not have your valid license file please contact us via e mail at Licensing ixts de Depending on the license file product activation may be necessary Please refer to the section Product activation to learn more about this procedure Product activation Depending on the type of license you are using a product activation may be necessary After activating the OPC Gateway Servers program execu tion in non demo mode will be enabled on the activated sys xi How do you want to activate your product Please select one of the following options to activate your product Auto activation internet connection necessary Using the auto activation all information necessary for the activation will be transmitted to IXTS and your product will be activated within seconds An internet connection is required to use this option Product activation via the the web site Using the activation process via the iXTS web site you may activate your product using a service on our web site The activation may be carried out on any system C Product activation by e mail For the activation via e mail please send the activation request file to licensing ixts de You will receive your activation code within a s
5. ta iras 30 Diagnostics 32 LOgd Md cita des os 32 User s Manual OPC Gateway Server Contents e iv Introduction What is the OPC Gateway Server To make it as short as possible The OPC Gateway Server is an OPC DA 2 05 Server which forwards a subset of OPC data items from a so called source OPC server to OPC clients It acts as a gateway between the source server and the clients which allows to hide and or rename OPC elements of the OPC namespace OPC Server OPC Gateway OPC Client OPC Namespace OPC Namespace E HL Node A a roses _ Data element A1 a Data element 94 N1 C Data element N1 O Data element A2 LX ata element A Data element A3 _ Data element Ae Data element N2 i Data element A4 7 Data element 4 N3 7 Data element N3 LFT Node B DR Node B Data element B1 Data element B1 i Data element B2 Data element B2 _ Data element B3 Data element B3 Data element B4 Data element B4 Who should use this manual This manual is intended for all users of OPC Gateway Server It explains how to install and configure the software as well as how to perform common tasks Overview of the manual This manual consists of several chapters and is structured as follows Introduction This introductory chapter Getting started Setting up t
6. with OPC Server 1 ment Click on the arrow on the right side of the 3 button to add a statistical value as a new OPC element to the published namespace The following statistical elements are available Statistical element Heartbeat Time stamp of last call Description A continuously incrementing number which allows a connected client to verify that the connection to the OPC Gateway Server is still established Contains the time stamp of the last callback received back from the remote OPC server i e time stamp of the last refresh Number of available Contains the total number of published elements elements Number of elements Contains the number of published elements with with Good quality good signal quality Number of elements with Bad quality Number of elements with Uncertain quality Number of elements with a specific signal quality Available Bytes memory Used memory Contains the number of published elements with pad signal quality Contains the number of published elements with uncertain signal quality Contains the number of published elements with a signal quality corresponding to a user defined quality mask You find more information regarding quality masks in the section Setting the quality mask of sta tistical elements Contains the size of the available memory of the system where the OPC Gatewa
7. Maximum buffer size per element 100 Forwarding strategy for the buffered values C Only last value Al data recently added to the buffer OK Cancel Help By default the OPC Gateway Server will register itself on the remote server with its EXE Name but this default value can be changed by enter ing the desired name in the edit Name used by the OPC Gateway Server to register with the remote server Check the option Publish array elements also as single items when added if the elements of a newly published array element should be published individually You will find more information regarding this fea ture in the section Publish array elements individually If additionally the OPCltemSamplingMot interface should be used be de fault if the remote server supports it check also the Use IOPltemSam plingMgt interface option and set the Requested sampling rate using the spin edit More information about using the OPCltemSamplingMot in terface can be found in the section using the OPCltemSamplingMot in terface and in the OPC Data Access Custom Interface Specification Ver sion 3 00 Remark A requested sampling rate of 0 will lead to the fastest sam pling rate supported by the remote server If local data buffering should be enabled by default the option Enable data buffering must be checked This will enable the spin edit to set the Maximum buffer size per element and the radio buttons to define the forwarding strate
8. PC Server 1 VT R4 0004 I Ai VT_R8 0005 vT_CY 0006 VT_DATE 0007 VT_BSTR 0008 bd Note Please be aware that the data type conversion is not for every combination of data types possible as not all values can be represented in any data type e g string Hello world gt Integer Conversion fails and possible conversion errors are not always identifiable before real data is tried to be converted e g string 2 gt Integer Conversion ok Local Data buffering To prevent data loss when high speed data must be transferred to slower clients or via networks with temporarily high load the OPC Gateway Server can buffer the incoming data so that it can be forwarded when the client is again ready to receive it This feature is especially necessary when the OPCltemSamplingMat interface of the remote server is used please refer to section using the IOPCltemSamplinghMgt interface to learn more about using this interface When local buffering is enabled every incoming data will be stored in a FIFO First In First Out buffer and the OPC Gateway Server keeps track for every client which was the last transmitted data item and forwards all new data with the next callback Note When local data buffering is used callbacks may contain more than one value for the same OPC item Some OPC DA 2 05 clients may not be able to process such callbacks correctly If you notice any misbehavior with your client set the Forwarding strategy in t
9. always be desired and this is the main situation where the OPC Gateway Server comes into the play User s Manual OPC Gateway Server System description e 12 Another even though less important reason to use the OPC Gateway Server is when the namespace of the original server is not very well or ganized and it is e g desired to change a flat unorganized namespace into a hierarchical one The technique behind To make the data of an OPC source server available for an OPC client the OPC Gateway Server must act as a server for the external client and as client for the external server In fact the OPC Gateway Server is an in dependent server This makes it necessary that it must have its own data cache to store the data provided from the source server also called the remote server Any OPC client also called remote client connecting to the OPC Gateway Server receives its data from this data cache External OPC Gateway Server External Internal server 1 Remote Client 1 Remote i Internal server 2 Remote Client Sawer Internal Client Data cache Internal server 3 Remote Client 3 User s Manual OPC Gateway Server System description e 13 User Interface The main window The main window of the OPC Gateway Server has a tree view on the left side with the title View which allows selecting the information that should be displayed on the right side of the window FRxrs opcews 21 opc Gat
10. at interface of the remote server select the top node of the source server namespace and change the re spective properties in the lower pane of the window Zox Source server namespace OPC Server 1 s s Q OPC Server 1 E 8 Engine 53 Speed Current Speed Min Speed Max Speed Average Speed Unit m Accel Min Accel Max Accel Average Accel Unit 65 Power Current Power Min j Client name to register with the server Jews Workbuild Client 21 2 Use the IOPCItemSamplingMat interface m S W Buffer values locally 1 Max size of local buffer 100 Transition strategy al data recently added to the buffer Y OK Cancel Connected with OPC Server 1 The following properties are available to use the OPCltemSamplingMgt interface Property Description Use the IOPCltem Enables or disables the data buffering on the remote SamplingMgt interface server Enabling data buffering allows a loss free data transfer even at higher sample rates Requested sampling Sets the interval sampling rate of the remote server rate This settings takes effect for all elements an indi vidual setting for each element is not possible Remark A requested sampling rate of O will lead to the fastest sampling rate supported by the remote server The default settings for this options can be set in the environment optio
11. ay Server oooocccocccoccconnconnonanonanon The technique behind oooocconconccnncnnonanonncnononarorarnrnrncro ner neo User Interface The main WINKOW eee eee eeeeeeeeeeeeeeeeeeaeecaeeeeaeteaeeeaeetaeeeeaee The File MON coi ay The Edit Menu 0 0 iii eal dannii Gee The View Menu es cescceeceseseeeseeeerereeeresetesnersnereaees The Extras MNU posie aeania aii Setting up the server configuration oooonocccnnnnnoconocnconncnnnnnnnnnos Source Server NAMESPACE coccccccocncccncnonnonnnonnncnnncnononos Public NAMespace coococnnccnoncconccoononararonnnnncronarararnnnanos Property EditOr nki secete ali Changing canonical data typOS ooooccocccocccocccocnnaonnnos Local Data buffering ooooononnnononnnnccnnccnnccnnonncnrnnno nono Using the OPCltemSamplingMat interface Add statisticdata ici caso Setting the quality mask of statistical elements Publish array elements individually Setting the environment options ooooococcconcccoconocononnnoncnannnanannns General OPtiONS ooooocccnoconocinnononcnonancnnononanonnnnanarancnnns Default VallOS cocoa creen Event ivi Checking the system ENnvirOnMeNt eee eeeeeeeeeeeeeeeeeeeee User s Manual OPC Gateway Server Contents e iii Licensing and Activation 29 Genial ined ol edad AA Re ae a ay 29 LICGNSING ii tel eti kde thet eels eeeed dinar Breet cont einer dn nein aves 29 Product activation srao ur la
12. ble with all published elements and their current value Clients Show the state of the connected remote client Event log Show the event log Refresh Forces a refresh of the currently shown information User s Manual OPC Gateway Server User Interface e 15 The Extras menu The following commands are available in the Extras menu Command Description oy DCOM Configuration Start the Microsoft DCOM configuration tool to set up access rights for the OPC environment Close current event log Close the current event log file This option is only file useful in conjunction with the automatic event log saving to hard disk to finalize the currently opened file and start a new one Environment options Open the environment option dialog to set startup options event logging and default values Please refer to section Setting the environment options for detailed information Setting up the server configuration The server configuration can be changed using the OPC Gateway server configuration dialog which can be opened using the Configure Server command in the Edit menu FG orc Gateway server configuration E Ioj x Source server namespace OPC Server 1 Q OPC Server 1 E GB Engine G iXTS OPCGWS 21 m peed Current TA Speed Current Speed Min ower Current Speed Max a E Temp Current Speed Average Speed Unit Accel Min Accel Max Accel Average
13. ck Bad Speed Unit T Quality check Uncertain mil Accel Min Fi Quality check Accel Max Accel Average Accel Unit fe Power Current Power Min El EXT properties Name Quality check 1D Statistics QualityCheck Statistic value Number of elements with a specific signal qua Y Indude statistic items O Mask Connected with OPC Server 1 By using the statistical element Number of elements with a specific sig nal quality the number of OPC elements whose quality bit mask corre spond to a user defined bit mask can be determined To do this first of all a quality mask need do be defined According to the OPC specification http www opcfoundation org the signal quality of an OPC element contains 16 bits 2 Byte whereby the upper byte Bit 9 to 16 is reserved for vendor specific values and the lower byte Bit 1 to 8 is used in a standardized manner The OPC Gate way Server supports bit mask with up to 16 bits but typically only the lower byte is used Bit 7 and 8 contain the main quality and can contain the values Good Bad and Uncertain Bit 1 to 6 contain the sub quality which may give some more specific information By providing a user defined bit mask nearly any quality value can be monitored A bit mask can contain the chars 0 1 or x representing bits which must be cleared set or may be of any value As an example the following bit masks may be used
14. e loaded configuration does correspond to the remote serv ers configuration This allows immediate user information in case of a changed configuration of the remote server The option Checking the system environment when selecting an OPC Server enables or disables the environment check Under normal circumstances it is recommended to enable the environment check Please refer to the section checking the system environment to learn more about this feature By changing the language settings the language for the applications GUI can be set Available languages are German and English Under certain circumstances you might encounter problems with the transparent window style which is used for the splash screen on applica tion startup and in the about dialog If so try to change the option Splash and info window to fix the problems User s Manual OPC Gateway Server User Interface e 25 Default values Lk xi Default values Default values for internal dient Name used by the OPC Gateway Server to register with the remote server IXTS OPCGatewayServer 21 QB Default values Event log Default settings for publishing P Publish array elements also as single items when added Use the IOPCItemSamplingMat interface when the source server is OPC DA 3 0 compliant Requested element sampling rate o ms Note The default value Oms will request the fastest sampling rate F V Enable data buffering
15. e tree view the property editor is located This editor shows the properties like e g the element name of ID of the currently selected element Typically the namespace is shown as a hierarchical tree but it can also be shown as a sorted or non sorted list by using the amp button Public namespace The public namespace is the namespace offered by the OPC Gateway Server to connected clients lt can be configured by adding or deleting elements and branches from the source server namespace Also addi tional branches can be created by using the button or the Create new node command from the popup menu All elements and branches can be renamed by using the p button If the items in a branch and all sub branches should be sorted alphabeti cally use the 12 button or the Sort command in the popup menu To display the public namespace as a list the 8 button can be used Please note that the namespace itself will remain hierarchical it will only be displayed as a list For this reason it is not possible to make any changes to the public name space while it is displayed this way This op tion is only included as a preview of what a client will see when he browses the namespace in flat mode If you want to create a flat name space use the hierarchical namespace with one single branch Property Editor The properties of the currently selected element are shown in the lower section of the dialogue in the property editor Select an e
16. ed and executed several times on the same system Every instance of the OPC Gateway Server will be registered as an individual OPC DA 2 05 server in the system and will have its own program settings The term instance refers here to each copy of the file OPCGatewayServer exe in an individual directory User s Manual OPC Gateway Server Getting started e 7 First steps After installing and starting the OPC Gateway Server for the first time you will see the following screen focrs opccws 21 opcGatewayServer21_ Lo File Edit View Extras Oal kis balan Welcome to the iXTS OPC Gateway Server 2 1 9 lt No source server selected gt the OPC server which protects your privacy Current data Gients 0 First steps E Event log Server configuration The gateway server needs an OPC Source Server to publish some of its data Click on Configure server in the Edit menu to make these settings A step by step guide for the initial configuration can also be found in the online help in the chapter First steps To start working with the gateway server an OPC Source Server needs to be defined and the desired subset of the source servers namespace needs to be configured To select the server and make all necessary setting select Configure Server from the Edit menu or click to the corresponding link in the Wel come panel or on the E icon in the toolbar The following dialog will ap pear ff orc Gat
17. ent will also remain in the published namespace Note You can specify if the elements of new arrays are published indi vidually by default on the page Default values of the Environmental Op tions dialog User s Manual OPC Gateway Server User Interface e 23 Maximal number of elements Normally array elements have a fixed array length which can be deter mined by the OPC Gateway Server during the publishing process But in some cases the length of the array data varies In this case the maximal number of elements must be adjusted using the property editor Note The OPC Gateway Server creates the stated number of array ele ments after closing the setup dialog If the current array has fewer ele ments the OPC Gateway Server will return NULL values and BAD Out of service signal quality when one of the extra elements is requested by a client Namespace organization of published array elements The branch containing published array elements will be organized by the OPC Gateway Server as follows CS XTS OPC Gateway Server 2 0 D1 El SpectrumAnalysis SpectrumAnalysis 0 SpectrumAnalysis 1 SpectrumAnalysis 2 SpectrumAnalysis 3 SpectrumAnalysis 4 SpectrumAnalysis 5 SpectrumAnalysis 6 SpectrumAnalysis 7 SpectrumAnalysis 8 SpectrumAnalysis 9 SpectrumAnalysis After setting up the server configuration click on Accept to keep the dia log open or on OK to close it User
18. er overflows can be monitored using the overflow counters see add statistic data Forwarding strategy Determines how local buffered values should be transferred to the connected clients Only last value A compatibility mode for older clients where only the last value will be transferred All data recently added to the buffer This option enables the forwarding of all buffered values to the client This may lead to callbacks with more than one value per element Note The default settings for this options can be set in the environment options dialog Using the OPCitemSamplingMgt interface The OPC Gateway Server can on the server side make use of the IOP CltemSamplingMat interface as defined in the OPC DA 3 0 specification if the remote server supports it to allow higher internal sample rates on the server side without increasing the callback rate by the same amount This goal can be achieved by enabling the server side buffering which is independent of the local buffering together with a higher sample rate on the remote server without changing the group sample rate While the callbacks will still be triggered with the lower group sample rate they will then contain more than one value per OPC item To learn more about the lOPCltemSamplingMot please refer to the OPC Data Access Custom In terface Specification Version 3 00 User s Manual OPC Gateway Server User Interface e 19 To make use of the I OPCltemSamplingM
19. ers nearly the entire functionality with some limitations and for a maximum run time of one hour To learn more about licensing please refer to the section Licens ing e License with product activation This kind of license requires explicit product activation for the OPC Gateway Server The activation enables the software to be executed on the current system The software will run in the demo mode while no activation has been done Learn more about activation in the section Product activation e Open license An open license has no restriction regarding functionality and is not associated to a certain system Please take care of the regulations in the End User License Agreement EULA Licensing If the OPC Gateway Server is still not licensed this can be done immedi ately after starting the software If the software is already running you may open the license dialog via the menu item Help Enter license key Demo version i Thank you for testing this product After the waiting period the application may be started in the demo mode You can start the appliation in 10 seconds Start Cancel After clicking on License now the following dialog will appear User s Manual OPC Gateway Server Licensing and Activation e 29 Enter icense rev n S License key If you are in possession of a valid license you may enter the contents of the license file here or import the file If you still do not possess a license but you
20. eway server 21 Dx File Edit View Extras D0a n F 4 u Xi lt Unnamed configuration gt FE lt Unnamed configuration gt Local server N Local server Source server OPC Server 1 a A Current data current configuration of the OPC Gateway Server Y cients 0 Source server E Event log Shows information about the OPC Source server A Current data Shows the current data in a grid View Clients Shows a list of all dients connected to the Gateway Server Connected with OPC Server 1 The first node shows the file name of the current configuration and below this node four sub nodes are available Local Server Source server Current data and Clients By clicking to one of these sub nodes the re spective status page will be shown The second top level node is called Event log and clicking this node will switch to the event log where all error warning or other information is logged The amount of information shown here depends on the respec tive settings in the environment options Please refer to the section Setting the environment options to learn more about this User s Manual OPC Gateway Server User Interface e 14 The File Menu The following commands are available in the File menu Command Description L New Clear the configuration and start with a new one Prompts the user for confirmation before continuing if OPC clients are still connected to the server A Open Load a previousl
21. eway server configuration lol x Qo OPC Source Server selected Please note that right now no OPC Source Server is selected XTS OPCGWS 21 Please select a source server using the drop down box above to show its namespace Server name iXTS OPCGWS 21 Server ID fors opcews 21 IXTS GmbH Germany http www ixts de Vendor information B Update interval ms 1000 y Client name to register with the server GWS Workbuild Client 21 a DK Cancel Reser Help I I A User s Manual OPC Gateway Server Getting started e 8 Selecting the source server Now first an OPC source server must be selected using the dropdown list in the upper left side of the dialog To connect to a remote OPC source server which is not listed in the dropdown you mal also enter its IP address in the edit control If a sys tem with the provided address is available in the network a list of avail able OPC servers will be acquired and shown When a source server has been selected its namespace will be retrieved and filled into the tree view on the left side of the dialog Setting up the public namespace Now all items and or branches from the source server that should be available at the OPC Gateway Server can be dragged from the left tree view to the right tree view The right tree view shows the namespace of the OPC Gateway Server as it will be available for OPC Clients connect ing to it
22. excellent software by excellent software OPC Gateway Server User s Manual OPC Gateway Server User s Manual This manual is a product of iXTS GmbH Germany iXTS GmbH RotwandstraBe 12 85609 Aschheim Germany Phone 49 89 95 84 08 0 Fax 4989 95 84 08 19 http Awww iXTS de XTS GmbH does not assume any liability either implicit or explicit for this publication This limited liability also includes though not exclusively the economic use of this product and its suitability for certain pur poses The user bears all risks which arise from the use of this information In no event will iXTS GmbH be liable for direct or indirect incidental consequential or special damages arising from any defect in this documentation even if iXTS GmbH has been notified of the possibility of such damages Furthermore iXTS GmbH reserves the right to occasionally revise and modify this publication without be ing obliged to notify any person or organization that such a revision or modification has taken place Trademarks All trademarks and product names mentioned in this manual but not listed here are trademarks or regis tered trademarks of their respective owners Technical Support Should you have any questions about the use of this product please contact us by e mail support iXTS de Confidentiality The information contained herein is confidential and proprietary to iXTS GmbH Germany It may not be disclosed or tra
23. gy Please refer to section local data buffering to learn more about local data buffering User s Manual OPC Gateway Server User Interface 26 Event log xi T General Event logging Ra Default values Logging level Normal v Y Limit event rate IV Propagate errors and warnings to windows event log Storing the event log J Save eventlog Log events from the following sources DK Cancel Help The event log is used to log all relevant information including errors and warnings which occur during the applications lifetime Depending on the situation a more or less communicative system may be desirable This can be controlled by setting the logging level Six different levels are available Nothing Very little Little Normal Extended and All The de fault value is normal which means that all important information is logged without flooding the log with irrelevant details This setting should nor mally not be changed except for diagnostic purposes See section Logging to learn more about this The Limit event rate checkbox is by default checked which means that in case that an excessive amount of events is created by the system e g due to a malfunction or due to a high OPC load in conjunction with the logging level set to All the rate is limited by dropping events This option is included to prevent the system from hanging due to a overload caused by consecutive repaint operations T
24. he OPC Gateway Server in a couple of min utes User s Manual OPC Gateway Server Introduction e 5 System description A short technical description of the OPC Gateway Server User Interface A detailed description of the user interface including all dialogs and menus Diagnostics Makes familiar with the logging features of the OPC Gate way Server OPC Compliance The OPC Gateway Server is compliant to the OPC DA 2 05 Specification It supports all required interfaces and additionally the optional OP CBrowserServerAddressSpace interface Public groups are not sup ported as well as the legacy interfaces OPCAsynclO and IDataObject as these are more a relict from the 1 0 specification and are usually not used in OPC DA2 05 servers and clients As an additional feature the OPC Gateway server can on the server side make use of the OPC temSamplingMot interface defined in the OPC DA 3 0 specification if the remote server supports it However an entire im plementation of the OPC DA 3 0 standard is not provided i e the OPC Gateway Server itself does NOT provide this interface or any other OPC DA 3 0 functionality to the connected clients Compliance is tested using the official OPC Compliance Test Tool V 2 10 from the OPC Foundation References To learn more about OPC visit the website of the OPC Foundation at http www opcfoundation org The OPC Gateway Server is based on the OPC Data Access Custom In terface Specif
25. his option should only be un checked if under certain circumstances the dropping of events is not de sired This may lead to the described consequences The meaning of Propagate errors and warnings to windows event log is quite self explaining This option is checked by default If desired the logged events can also be stored on hard disk by checking the Save event log checkbox In this case a directory for the log files must be selected and a maximum file and directory size must be given When the maximum file size is reached the current file is closed and a new file is created When the maximum directory size is reached the old est log file will be deleted automatically Another possibility to limit the number of logged events especially when the logging level is set to All is given by the option Log events from the following sources By un checking some of the listed event sources all events from these sources will be dropped The list is dynamically cre ated so at the first start up the list will be empty When the first message from a new source is received this sender will be added to the list By de fault all senders are enabled and changing this setting should only be necessary for diagnostic purposes See section Logging to learn more about how to use this feature User s Manual OPC Gateway Server User Interface e 27 Checking the system environment Checking the system environment xi amp Checking the system env
26. hort period of time to complete the product activation C Activation with activation code You already have an activation code or you received one via the e mail activation Then you may activate your product now Privacy policy la es tn There are three different ways to activate the OPC Gateway Server The easiest and quickest way is the auto activation via internet If you have access to the internet from the system where the OPC Gateway Server resides all necessary information may be exchanged automati cally so the OPC Gateway Server will activate itself without further user interaction and the entire functionality of the system is instantly available Please note that for the automatic activation a direct connection to the internet is necessary The use of a proxy server is not supported The product activation using our web site is the first choice if the sys tem where the OPC Gateway Server resides does not have a direct con nection to the internet To activate the OPC Gateway Server using the web site a activation request file must be created on the target system which the will be transferred to the iXTS web site Within a few seconds an activation code will be created and the activation can be completed The activation service is available under http Awww ixts de activation User s Manual OPC Gateway Server Licensing and Activation e 30 Another possibility is the product activation via e mail which may al
27. ication Version 2 05 which is also available from the OPC foundation The description of the IOPCltemSamplingMat interface can be found in the OPC Data Access Custom Interface Specification Version 3 00 User s Manual OPC Gateway Server Introduction e 6 Getting started System requirements Installation The OPC Gateway Server hat both Software and Hardware minimum system requirements These requirements must be met in order for the server to work properly Software requirements The OPC Gateway Server requires at a minimum the following software e Micosoft Windows 2000 Microsoft Windows XP or higher e Internet Explorer 4 01 Service Pack 1 or better e OPC DA 2 0x client and server applications Hardware requirements The OPC Gateway Server requires at a minimum the following hard ware e Intel Pentium II 500 MHz e 128 MB RAM e 20 MB fee hard disk space Once you are certain that your system meets the system requirements you are ready to install the OPC Gateway Server To install the OPC Gateway Server double click setup exe on your OPC Gateway Server media and follow the instructions on the screen The setup includes the OPC Core components from the OPC Founda tion which are necessary for any OPC application to work properly If these components are not installed on your system the OPC Gateway Server will not work correctly neither any other standard OPC applica tion The OPC Gateway Server may be install
28. ironment to assure a steady operation Messages 18 46 06 Trying to create a group at the OPC server ms 18 46 06 All OPC elements were added to the group 18 46 06 Trying to refresh the OPC elements of the group ReadSync 18 46 06 Refreshing all OPC items of the group was successful ReadSync 18 46 06 A callback is requested to refresh all OPC elements ReadAsync E A a 18 46 06 The group has been added to the OPC server Update rate 1000 Y OPC DA3 0 interface IOPCItemSamplingMat supported Every time when connecting to an OPC Server the OPC Gateway Server will perform a system environment check to assure a steady operation of the application During this environment check some selected methods of the offered OPC interfaces are called to ensure their correct execution and the correct setting of the DCOM rights Under normal circumstances the environment check should always re main enabled to assure the steady operation of the OPC Gateway Server lf for any reason the environment check should be disabled re move the checkmark of the respective checkbox in the general options section of the environment option dialog User s Manual OPC Gateway Server User Interface e 28 Licensing and Activation General There are three possibilities how the OPC Gateway Server can be li censed e Demo version Without licensing the OPC Gateway Server is running in the demo mode which off
29. lement in the published namespace to check or to change its properties here Changing canonical data types As defined in the OPC specification OPC clients can request the data type of the data to be received from the server If no specific data type is requested the data will be delivered in the default or canonical data type By default the canonical data type of the published items is the same as of the original item on the remote server To change the canonical data type of the published items the value of the property data type conversion in the property editor must be set to respective value The OPC Gateway Server will then request the desired data type from the remote server using its data type conversion possibili ties User s Manual OPC Gateway Server User Interface e 17 or cateway serverconfguraton T Source server namespace OPC Server 1 3 OPC Server 1 E Gj Engine 3 Speed Current Speed Min El Power Current Speed Max a E Temp Current Speed Average Speed Unit Accel Min Accel Max iXTS OPCGWS 21 E Speed Current Lam e Accel Average Accel Unit 55 Power Current Power Min El Original name Accel Current Original 1D EnginelAccel Current Canonical data type VT_14 0003 Name Accel Current 1D Engine Accel Current Data type conversion None E 2 vT_12 0002 ncel Accept Help v4 0003 Connected with O
30. nce of the OPC Gateway Server may decrease at higher log levels The recommended logging level is Normal In most cases the Ex tended logging level should be sufficient to troubleshoot the problem If not the All logging level will record all information available within the server In general the server logs all errors and other information of immediate importance to the user at the Little or Very little logging level all warn ings and other information of not immediate but still significant impor tance to the user at the Normal logging level Information of moderate importance to the user will be logged at the Extended logging level and further information especially for the support personnel will be recorded if the logging level is set to All Especially in higher logging levels a lot of events may be produced so the server load may increase significantly To avoid this effect the OPC Gateway Server allows restricting which software classes are allowed to send events to the event log To configure this feature a deeper under standing of the software architecture is necessary so under normal cir cumstances all classes should remain enabled as event sources User s Manual OPC Gateway Server Diagnostics e 32
31. ns dialog Note An entire implementation of the OPC DA 3 0 standard is not pro vided i e the OPC Gateway Server itself does NOT provide this interface or any other OPC DA 3 0 functionality to the connected clients User s Manual OPC Gateway Server User Interface e 20 Add statistic data The OPC Gateway Server provides so called statistical data about the server itself and the system environment which may be exposed in form of OPC elements in the published namespace So any connected OPC client can retrieve this statistical data like any other OPC ele lol Source server namespace Public namespace Pal a E XTS OPC Gateway Server 2 0 EG Heartbeat iq Last callback i Number of available elements La Quality check Good 9 Quality check Bad El O Engine El Simulation_1 2 Simulation_2 E 1 Simulation_3 H O Simulation_4 Simulation _5 Eg Quality check Uncertain E 5 Simulation_6 ES Quality check E Simulation_7 ES Available memory H E Simulation_8 i Used Memory Simulation_9 E Simulation_10 Simulation_11 ao Simulation_ ES Total number of buffer overfiows EG ID of the last overfiowed element buffer 4 Server runtime in seconds Quality check Good D Statistics QualityCheck Good Statistic value Number of elements with a specific signal qua y Include statistic items m 1100000 Y Mask Connected
32. nsferred directly or indirectly to any third party without the explicit written permission of iXTS GmbH All rights reserved No part of this document may be reproduced stored in a retrieval system translated or transmitted in any form or by any means electronic mechanical photocopying recording or other wise without prior written permission by iXTS GmbH Copyright 2008 XTS GmbH Germany All rights reserved V 2 1 5 2008 Contents Introduction What is the OPC Gateway Server cc eeeeeeeseeseeneeeneeeeaees Who should use this manual ccccccccnninonococococononnnnnanacacananos Overview of the Manual 0 0 0 cceccesceeesseeeseeeeeeeeeeeeeeeeeees OPC Compliance iii card References do ei a a Dee loci Getting started System requirements oooccoccccccooccononcccnnnccnonncnnnnccnnnnccnnnncnnnnncnnnns Software requirements eee eeeeeeeeeeeeeeeeeeeeeeeeeees Hardware requirements esseere Installation aa 0 i cates ane hee a Aa First Ste pS iii da Selecting the Source Server eccceeeeeeeeeteeeeeees Setting up the public namespace ceeeeeees Setting up the server name and ID eeeee Setting up the update interval cceeeeeeeeeees Accepting CHANGES ce eeeeeeeeseeereceeeeeeteeeeeeeeneeeeaees Saving the Configuration ee ee eee eeeeeeeeeeeeeeeeeeeeee System description INTO UC iia ias Why to use the OPC Gatew
33. o Only last value Using this option may lead again to data loss as not all data can be transferred to the client To enable and configure the local buffering select the top node of the published namespace and change the respective properties in the lower pane of the window User s Manual OPC Gateway Server User Interface e 18 mixi Source server namespace ETF A G IXTS OPC Gateway Server 2 0 E Engine Speed Current Lu Speed Min Speed Max a Speed Average Speed Unit Accel Current Accel Min Accel Max Accel Average Accel Unit Power Current Power Min xl Original name OPC Server 1 Original ID OPC Server 1 IXTS GmbH Germany http www ixts de Vendor information y Use IOPCItemSamplingMgt interface Vv Requested sampling rate ms ll DK Cancel Accept Help 4 Connected with OPC Server 1 The following properties are available to configure the local buffering Property Description Enable local buffering Enables the buffering of data within the OPC Gate way Server Although this option is actually inde pendent of using the OPCltemSamplingMagt inter face of the remote server both options will normally be used together Maximal buffer size Sets the maximum size of the local buffer per item Increase this value if you detect buffer overflows when transferring fast data to slower clients Buff
34. oduction The OPC Gateway Server is an OPC DA 2 05 Server but also an OPC DA 2 05 Client The purpose of the gateway server is to make an inter connection between external OPC clients and OPC servers whereby the OPC items in the namespace provided by the OPC Gateway Server are either only a subset of the namespace of the external server or the gateway s namespace has a different organization with renamed ele ments or branches OPC Server OPC Gateway OPC Namespace OPC Namespace OPC Namespace e E Node A m Node an Lam Node N Data element A1 Data element 4 N1 Data element N1 Data element A2 Xara element A Data element A3 Data element X N2 Data element N2 ij Data element A4 i Data element M4 N3 1 Data element N3 7 Node B 36 Node B L Data element B1 Data element B1 _ Data element B2 Data element B2 Data element B3 Data element B3 Data element B4 fN Data element B4 Why to use the OPC Gateway Server Using the OPC Gateway Server maybe especially useful when the pos sibilities of controlling the access right provided by COM DCOM as the underlying technique for OPC are not sufficient COM DCOM does not al low to set individual access rights for each OPC item hence a client which can access an OPC server always has access to all of its items This may not
35. pective value in the property editor User s Manual OPC Gateway Server Getting started 10 Accepting changes After confirming all changes and closing the dialog the server settings will be changed and the new OPC server is available in the network fElxts opcews 21 OPC Gateway Server2 1 o File Edit View Extras DaAlW Fl o iis F lt Unnamed configuration Local server DAI Shows information about the EY Current data current configuration of the OPC Gateway Server cients 0 Source server E Event log Shows information about the OPC Source server E Current data Shows the current data in a grid Clients Shows a list of all dients connected to the Gateway Server By selecting the Local server Source server Current data or Clients screen some status information can be displayed If something went wrong the respective error messages can be found in the Event log Saving the configuration To store the configuration for the next time the OPC Gateway Server will be started select Save from the File menu ccc ax Speichem in E OPCGWS21 J e Be E The configuration will be loaded automatically the next time when the OPC Gateway Server is started To change this behavior please refer to the chapter General options Congratulation The configuration is completed and the server is now ready to be used User s Manual OPC Gateway Server Getting started e 11 System description Intr
36. so be an alternative when no direct connection to the internet is available on the target system To use this way the activation request file is also nec essary but instead of uploading it via the website you just send it to licensing ixts de and you will receive your activation code within a short period of time If you already have an activation code or if you received one by e mail or from the web site use the option Activate with activation code to enter the code in the edit field If the activation code is correct you gain full and unlimited access to all functions of the OPC Gateway Server User s Manual OPC Gateway Server Licensing and Activation e 31 Diagnostics Logging The OPC Gateway Server generates a variety of so called events which contain information about the current program state occurred error or other details These events are always logged within the application in the event log and may also be automatically written to the hard disk If a problem with the gateway server occurs then the log files can be ex tremely valuable for troubleshooting By default the automatic saving to hard disk is disabled and must be enabled when necessary Also by de fault the application logs not very much information i e that the logging level is set to normal Both settings can be changed in the Event log tab of the Environment options dialog The higher the log level the more information is recorded However the performa
37. to filter the main quality User s Manual OPC Gateway Server User Interface e 22 Main quality Mask Good Bad Uncertain 11xxxxxx OOXXXXXX Olxxxxxx So a statistical element with the provided bit mask for the Bad quality would count also a quality like 00011010 because only bit 7 and 8 are relevant and must be 00 Publish array elements individually The OPC Gateway Server offers also the possibility to publish the ele ments of arrays Datatype VT_ARRAY individually which means that each array element will appear as individual OPC element in the pub lished namespace FG opc Gateway server configuration Ioj x Source server namespace OPC Server 1 NE E OPC Server 1 Edit properties aa Canonical data type VT_ARRAY of VT_R8 2005 Name Spectrumanalysis AA Data type conversion Mo E Publish elements individually v Maximal length number of elements 5 I Y Connected with OPC Server 1 When an OPC element of the type VT_Array is published it will be dis played in the published namespace with the D symbol By checking the checkbox Publish elements individually the symbol will change to E and after accepting the configuration a new branch with the same name and the suffix will be created Within this branch an individual OPC element will be added for each array element starting with the index 0 The original array elem
38. ver ID is also used to build unique identifiers for the elements in the published name space the ID must also meet some internal restrictions i e it may not contain one of the reserved characters V and User s Manual OPC Gateway Server Getting started e 9 ff orc Gateway server configuration SER gt a ls i E Speed Current E Accel Current E Power Current Temp E Temp Current El Server name XTS OPCGWS 21 Server ID icts oPcews 21 IXTS GmbH Germany http www ixts de Vendor information Update interval ms ooo Client name to register with the server 6ws workbuld Cient 21 Fl OK Accept Help I 4 Setting up the update interval Speed Current E Accel Current E Power Current E Temp Current iXTS OPCGWS 21 Server ID iXTS OPCGWS 21 IXTS GmbH Germany http www ixts de 1 Vendor information Update interval ms 1000 Y Client name to register with the server 6ws Workbuld Cient 21 OK Cancel Accept Help I Connected with OPC Server 1 The update interval determines how often the data of the OPC Gateway Server should be updated and hence this interval will be also be used as the update interval for the OPC source server The default is once per second each 1000ms To change this value select the root node in the published namespace and change the res
39. y Server resides in bytes Contains a percentage value representing the used portion of the memory of the system where the OPC Gateway Server resides User s Manual OPC Gateway Server User Interface e 21 Total number of buffer Contains the total number of buffer overflows when overflows local buffering is enabled ID of the last overflowed Contains the ID of the OPC element where the last element buffer buffer overflow was detected The element can only be used when local buffering is enabled Server runtime in sec Contains the number of seconds since the local onds server within the OPC Gateway Server application has been started On a system with a steady and not too high load this value should be identical to the value of the statistical element Heartbeat Note By default statistical elements whose value is calculated by count ing elements e g depending on their quality do ignore the statistical elements themselves If the statistical elements should also be consid ered when counting elements please set the respective option in the properties of the statistic item Setting the quality mask of statistical elements aioli Source server namespace Public namespace OPC Server 1 E Dala E OPC Server 1 al 69 XTS OPCGWS 21 E Engine E Speed current Speed Current qe E Speed Min Speed Max a Speed Average E Quality check Good ES Quality che
40. y saved configuration from disk Prompts the user for confirmation before continuing if OPC clients are still connected to the server Ll Save Save Save the current configuration to a file as Quit Shut down the server and quit the application The Edit Menu The following commands are available in the Edit menu Command Description a Copy Copy the selected entries of the event log to the clip board Only available when the event log is displayed and not empty Exports the currently displayed event log to a file Note This command is intended to be used to save only the currently displayed events to a file To save events automatically the auto store function should be used Please refer to the section Setting the environment op tions ay Export event log Clear current event Clears the currently displayed event log This command log has no effect to already saved event logs Reset overflow Resets all overflow counters Note Overflow counters counters are used in conjunction with the local buffering of data y Configure Opens the configure server dialog Please refer to sec S 9 tion Setting up the server configuration for detailed in erver formation The View Menu The following commands are available in the View menu Command Description Local server Show the state of the internal server Source server Show the state of the remote OPC server Current data Show a ta
Download Pdf Manuals
Related Search