Maxum OPC Server /Client

Transcription

1 Maxum OPC Server /Client New Features / Changes document February 4, 2019 Requirements Maxum Workstation Software will operate best on computers equipped with a multi-core processor, with at least 4 GB RAM (8+ GB recommended). This installation needs up to 2 GB of free disk space. You must log in with Administrator privileges. This will ensure unrestricted access to the system registry. Otherwise, the installation will fail. Internet Explorer 8.0 or higher must be installed. Maxum OPC Server Software has been tested successfully with the following operating systems: Windows 7 Professional SP1 (32 bit and 64 bit) Windows 8.1 Pro (64 bit) Windows 10 Enterprise (64 bit) Windows Server 2008 Standard SP2 (32 bit and 64 bit) Windows Server 2012 R2 Standard (64 bit) Windows Server 2016 Standard (64 bit) Note 1: OPC Server is a full installer. (OPC Server 2.x.x, or must be un-installed prior to installing version ) Note 2: OPC Server must be installed on drive C:

2 Legal information Warning notice system This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. DANGER indicates that death or severe personal injury will result if proper precautions are not taken. WARNING indicates that death or severe personal injury may result if proper precautions are not taken. CAUTION indicates that minor personal injury can result if proper precautions are not taken. NOTICE indicates that property damage can result if proper precautions are not taken. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens Process Analytics products Trademarks Note the following: WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Industry Sector Postfach NÜRNBERG GERMANY P 01/2019 Subject to change Copyright Siemens AG All rights reserved

3 Maxum OPC Server Corrections 1.)Issue: Maxum OPC Server utilizes a Protocol Bridge when communicating with older Maxum analyzers. Older meaning analyzers with a Syscon1/+ controller board running version software. The previous version of the Protocol Bridge (Pb.exe) had a limit of 64 analyzer connections. This limited the maximum number of OPC Server connections for older analyzers to 64 total. Correction: The maximum number of analyzer connections was increased to 128 in both the Protocol Bridge and version Maxum OPC Server. 2.)Issue: Occasionally the Protocol Bridge would fail to re-start after losing connection when attempting to communicate with an older analyzer (Syscon1/+ controller board running version software). Correction: This problem has been corrected in version Maxum OPC Server New Features - New Component Detail Tags Name Description Maxum DB Table Current_RF RespFactLx (0-9) (Levels 0-9) A single point calibration factor is titled: RespFactL0 The Response Factor used to calculate the current component s value. May be a Manually entered RF or Calibration RF. The calculated Response Factor(s). Supports multipoint calibration. Levels 0-9 Ezchrom_result_peak for a peak type or Ezchrom_result_group for a group type Calibration_level RespFactL0.. RespFactL9 Maxum DB Column current_rf response _factor Data Type 8-byte real 8-byte real Access Rights Read- Only Read- Only

4 Changes - 1.) The component tags ValCompare, ValMagin, and ValState were created automatically when adding component tags to any stream type (Process, Validation, Calibration) starting in OPC Server Version The creation of these tags will only occur on Validation streams starting in this release ( ). Note: To add these tags to a configuration file created with an earlier version of OPC Server (< 3.0.0) you will have to delete the stream and/or application and then add the components back to see the new tags. 2.) Fixed OPC Server memory leak that occurred with certain OPC clients. 3.) Fixed problem with Response Factor tag creation. 4.) Fixed problem that appeared to lock-up user interface when the Cancel button was selected on the Component Detail dialog box. 5.) Corrected problem when saving a file with the Save As command where an extra file extension was added to the file name. ex. Anlz101.cfg on save would become Anlz101.cfg.cfg. 6.) Corrected problem that would occasionally cause an error when closing a large number of analyzer network connections (63 anlz.) prior to opening a new configuration file. 7.) Corrected problem where unchecking the Response Factor checkbox located on the Detail Dialog box did not delete the existing ResponseFactor tag(s). 8.) Corrected problem where selecting File > New would stop all tags from being updated. After adding one or more new devices/apps/streams none of the OPC tags would get updated until the user saved the new file and restarted OPC Server. 9.) Corrected minor problem on Component Detailed dialog where the Group: Area and Area Percent checkboxes state info was incorrectly saved on exit.

5 Maxum OPC Server New Features OPC Tags New Stream Level Tags Name Description Maxum DB Table CycleLength DataReady MethodID Stream cycle length in seconds End of cycle Data Ready indicator Method number used to calculate the streams results Maxum Data Type DB Column OPC cyclelength 4-byte signed int Access Rights Read-Only N/A N/A Boolean Read/Write Result method_id 4-byte signed int Read-Only New Component Level Tags Name Description Maxum DB Table Maxum DB Column Data Type ValCompare Validation Result compare_value 8-byte Compare Value real ValMargin Validation Result compare_margin 8-byte ValState Compare Value Validation state: 0 = Unkn 1 = Pass 2 = Fail 8 = In-Progress real Result compare_state 8-byte signed int Access Rights Read-Only Read-Only Read-Only 1. new Separate graphical user interface program. (MaxumOPCClient.exe) In previous versions of Maxum OPC Server the user interface was integrated with the OPC Server executable. When installed as a Windows service a feature called Allow service to Interact with Desk Top allowed the logged on user to view and edit the OPC Server tag database. Starting with Widows Vista Microsoft discourages the use of the Interact with Desk Top feature. Microsoft explicitly states that services running in an elevated security context, such as the LocalSystem account, should not create a window on the interactive desktop because any other application that is running on the interactive desktop can interact with this window. Starting with Maxum OPC Server 3.0 the graphical user interface functionality is provided in a separate application program, MaxumOPCClient.exe. The OPC Client application is only needed when the user wishes to create, delete, modify, monitor, or save OPC Tags database. MaxumOPCServer.exe runs as a Window s service providing the OPC Data Access interfaces and Tag database management combined with the Maxum analyzer communications driver. The OPC Client may be started and stopped without affecting normal operation of the OPC Server service.

6 2. new Data Ready tag A new stream level tag has been added in this release. Named DataReady this boolean OPC tag may be used as an alternative indication that new stream results are available for the OPC Client to read. Previous OPC Server versions relied only on the update of the SampleTime tag as an indication that new data is available. While the SampleTime tag is still available for reading the time the analysis sample was injected the DataReady tag provides a boolean indication of when new data is available to a client. The DataReady tag value is set to True at the end of cycle and remains True for a variable period between 6 25 seconds. The default value is 10 seconds. The variable period can be specified by the user by editing a *.ini file. Located under the main Maxum OPC Server directory is a sub-directory titled System. Located under the System directory there is a file named OPCServer.ini. ( Maxum OPC Server/System/OPCServer.ini) To change the default value using a text editor simply modify the line: DataReadyNegate=10 The value must be between If an invalid number is entered the system will default to 10 seconds. After changing the values in the.ini file you must restart the server for the change to take effect. 3. new CycleLength tag - A new stream level tag, CycleLength was added in this release. The CycleLength tag allows a user to read the Stream s cycle length in seconds. The CycleLength tag is a read-only, 4 byte integer data type. 4. new MethodID tag - A new stream level tag, MethodID was added in this release. The MethodID tag allows a user to read the Method number used to calculate the stream s results. The MethodID tag is a read-only, 4 byte integer data type. 5. new ValCompare tag - A new component level tag, ValCompare was added in this release. The ValCompare tag allows a user to read the Validation compare value (compare_value) from the result table. Compare_value is used in validation cycles to calculate the difference between ideal and actual Buffered_value. The ValCompare tag is a read-only, 8 byte real data type. Note: This tag is created automatically on Validation streams only. 6. new ValMargin tag - A new component level tag, ValMargin was added in this release. The ValMargin tag provides the user a way to read the Validation Margin value (compare_margin) from the result table. Compare_margin is used during validation cycles to determine if the compare_value is within an acceptable range. The ValMargin tag is a read-only, 8 byte real data type. Note: This tag is created automatically on Validation streams only. 7. new ValState tag - A new component level tag, ValState was added in this release. The ValState tag provides the user a way to read the Validation State value (compare_state) from the result table. This tag is provides the state information for a cal/validation cycle. 0 = Unknown 1 = Pass 2 = Fail 8 = In-Progress The ValState tag is a read-only, 8 byte real data type. Note: This tag is created automatically on Validation streams only.

7 8. new Configurable Connection Timeout variable A new user configurable Connection Timeout variable was added in this release. This feature was specifically added for systems with a limited number of networked analyzers requiring fast link failure recognition for redundancy switch over activation. It is not recommended that the user change this value without a good understanding of their network latency. Setting the ConnectionTimeOut interval too short will result in frequent aborts and reconnection attempts significantly degrading system performance. The default ConnectionTimeOut is 60 seconds. The time out period can be changed in the OPCServer.ini file. ( Maxum OPC Server/System/OPCServer.ini) Use a text editor, like Notepad, to change the line: ConnectionTimeOut=60. The ConnectionTimeOut value must be in the range of seconds or the system will default to 60 seconds. OPC Server must be closed and re-started for the changes to take effect. OPC Server retains a record of the last time a message was received on each connection. If no message is received in over 10 seconds a query is sent. If the server receives no response after the ConnectionTimeOut period then the connection to the device is aborted and the Server will attempt to re-connect to the device. 9. new Configurable AutoDisplayClient variable A new user configurable variable named AutoDisplayClient was added in this release. This variable enables or disables the automatic display of the MaxumOPCClient when the OPC Server is started. If the AutoDisplayClient variable is set to a one then everytime the OPCServer service is started the Client program will be automatically started. The default setting is AutoDisplayClient= Enhanced debug file The debug log file is used to troubleshoot and tune the performance of the server. The server will append new messages to the log file if it already exists or it will create a new log file if one doesn t already exist. The debug log file is named OPCError.log and is located under the sub-directory System. (Maxum OPC Server/System/OPCError.log). The log file may be viewed from the main menu. Select View -> Debug from the main menu. The log file is displayed in Notepad. The file is written as a ring buffer. Each entry has the date and time the information was recorded. Use the Scroll bar to move to the time period of interest. A user configurable variable was added to the OPCServer.ini file to control the amount of debug information saved to the OPCError.log file. The default value is 1. DebugLevel=1 The greater the number the greater the amount of debug information added to file. The DebugLevel variable can be set to a value between 1 12.

8 MaxumOPCServer directories and files: The default installation path for MaxumOPCServer is: C:\Program Files (x86)\siemens Industry\Maxum OPC Server MaxumOPCServer.exe - OPC Server runs as a service. MaxumOPCClient.exe - OPC Server graphical user interface. Launch.exe used to launch OPCClient from security context of OPCServer provided to allow non-administrator s the ability to start/stop MaxumOPCServer. MAXUMOPCSERVER.chm compiled HTML Help file. PB.exe Database bridge for communicating between newer and older versions. SwKey.dll copy protection System OPCError.log debug log can be display from MaxumOPCClient main menu Go to View > Debug. OPCServer.ini user configurable variables. DataReadyNegate=10 - turns off DataReady signal, default set to 10 seconds. range (5-30 seconds) ConnectionTimeOut=60 periodic KeepAlive timeout. default set to 60 seconds. range( - ) DebugLevel=1 this value is used to determine the type and amount of debug information saved to the OPCError.log file. default level 1, range ( 1 12) AutoDisplayClient=1 determines if the OPC Client will be started automatically when the OPC service is started. 0 = no client, 1= client started. default = 1, Start client. OPCClient AutomationClientEx.xls example VBS, Excel base OPC Client Factory Soft OPC Client Simple OPC Client may be used to troubleshoot and prove out COM/DCOM settings. DOCUMENTS MaxumOPCServer manual.

9 MaxumOPCServer programs: 1.) MaxumOPCServer.exe (runs as a Windows service) This is the OPC Server executable. This program provides the OPC Server Data Access interfaces to facilitate interoperability with 3 rd party OPC DA compliant Clients integrated with a highly optimized, Siemen s Maxum analyzer communications driver. MaxumOPCServer.exe provides all of the OPC Server functionality, except for the user interface functions. A second program, MaxumOPCClient.exe, is provided to create, modify, and monitor the OPC tags contained in the Server database. MaxumOPCServer.exe runs as a Windows service. A Windows service provides certain advantages over a normal Windows application. A service can run with or without a Logged On user and can be started automatically at power-up. 2.) MaxumOPCClient.exe (runs as a Windows application) This is the OPC graphical user interface program. This program communicates with the OPC Server service and provides the functionality to create, delete, modify, monitor, and save OPC Tags in the MaxumOPCServer tag database. MaxumOPCClient, runs as a Windows application. The User interface program may be started and stopped without affecting normal operation of the OPC Server service. A user must have administrative permission to run MaxumOPCClient and communicate across Window s session boundaries with the OPC Server service which runs in session 0. A third application Launch.exe is provided as one solution for allowing non- administrator accounts to run MaxumOPCServer and MaxumOPCClient. This requires modifying MaxumOPCServer service s security descriptor to allow Start/Stop access for the Interactive user. (explained below in item #3) Once the interactive user has Start/Stop permissions the Launch program should be used to start MaxumOPCClient. Launch uses the SCM to signal the OPC Server service to start the OPC Client in the current user s session. 3.) Launch.exe (runs as a Windows application, communicates with service through SCM) The Launch program is provided to allow user s without administrator permissions a way of using the MaxumOPCClient program to create, delete, modify, monitor, and save OPC Tags in the MaxumOPCServer tag database. Typically the MaxumOPCServer service is run under the localsystem account. The localsystem account is a predefined local account used by the service control manager. It has extensive privileges on the local computer, and acts as the computer on the network. A service that runs in the context of the localsystem account inherits the security context of the Service Control Manager (SCM). A user must have Administrator privileges to access a service running under the Service Control Manager. To use the Launch.exe program successfully from a Windows User account that doesn t have Administrator permissions you must modify the MaxumOPCServer service s security descriptor to allow Start/Stop access for the Interactive user. There are two methods to accomplish this: Method #1 using Security templates Follow the steps listed under the section titled How to run MaxumOPCServer service from a nonadministrator account.

10 Method #2 using Service Descriptor Definition Language (SDDL) This method has been automated and provided as a Utility program on the installation disk. Run the program titled SetServiceSecurity.exe Once the OPC Server service security descriptor has been modified to allow the Interactive user to Start/Stop the service the Launch program should be used to start MaxumOPCClient. Launch uses the SCM to signal the OPC Server service to start the OPC Client in the current user s session. How to run MaxumOPCServer service from a non-administrator account. MaxumOPCServer installs and runs as a Windows 32-bit service. A windows service is a program that runs in the background typically requiring no user intervention. A service can be automatically started when the computer boots with or without any user being logged on. Windows services are controlled by the Service Control Manager (SCM). The SCM maintains a database of installed services in the registry. The database includes information on how each service should be started. It also enables system administrators to customize security requirements for each service and thereby control access to the service. MaxumOPCServer runs as a Windows 32-bit service and is typically configured to run under the LocalSystem account. The LocalSystem account is a predefined local account used by the service control manager. This account has extensive privileges on the local computer, and acts as the computer on the network. MaxumOPCServer requires access to local memory, the network adapter, and various services including COM/DCOM. A service that runs in the context of the LocalSystem account inherits the security context of the SCM. (Service Control Manager) A user must have Administrator privileges to access a service running under the LocalSystem account. Windows services are designed to run unattended without a graphical user interface (GUI). Starting in Windows Vista Microsoft services are not allowed to directly interact with a user. MaxumOPCServer can run unattended without a user interface or even a logged on user. A separate Windows application (MaxumOPCClient.exe) provides a graphical interface to create, modify, or monitor the OPC tags available in the MaxumOPCServer service. To overcome the limitation of requiring everyone who needs access to MaxumOPCServer to have Administrator privileges a third application called (Launch.exe) is provided. Launch uses the Service Control Manager (services.msc) to signal the OPC service to start MaxumOPCClient from the security context of the LocalSystem account. This ability requires only that the interactive user have start/stop privileges for the MaxumOPCServer service. One method to provide this capability is to use Security Templates to configure the system services ACLs ( Access Control List). You must have Administrator privileges to perform the following steps: 1.) Create a new custom mmc (Microsoft Management Console) with Security Templates and Security Configuration and Analysis snap-ins. Go to Start > Run, type: mmc, press enter. Add the two snap-ins from the main menu: Select File > Add/Remove Snapins From the Available Snap-ins drop down box: Select Security templates then click on Add. Select Security Configuration then Add. Click on OK.

11 2.) From the Console Tree (left window panel) expand the Security Templates and right click on [DriveLetter]:\Windows\security\templates. Select New Template. Enter a name for the new template in Template Name. Click on OK. 3.) From the Console list (middle window panel): Double click on the newly created template name. Or, from the Console Tree (left window panel) expand the Security Templates then expand the [DriveLetter]:\Windows\security\templates. Select the newly created template. Select System Services. From the Console list scroll down to MaxumOPCServer. Double click on MaxumOPCServer to bring up the Service Properties. Check the Define this policy setting in the template checkbox. Click on the Edit Security button. Add the account to delegate permission for. Suggest using INTERACTIVE account. Check the Start, stop and pause checkbox under permissions. Click on OK to exit Security for MaxumOPCServer dialog. Click on OK to exit MaxumOPCServer Properties dialog. 4.) Save the new template. Right click on the new template name in the Console Tree (left pane). Select Save from the pop-up menu. 5.) From the Console Tree (left window panel): Right click on Security Configuration and Analysis. From the pop-up menu select Open Database. Under File Name enter a unique name for the security database and select Open. Select the Security template name entered in step 2 above. Click on Open to import the new template. 6.) From the Console Tree (left window panel): Right click on Security Configuration and Analysis. From the pop-up menu select Configure Computer Now. 7.) If no errors are displayed this procedure is complete. To verify: LogOff and then LogOn as a non-administrator. Go to Start > Run, type service.msc, press enter. Scroll down to the MaxumOPCServer service. Double click MaxumOPCServer to bring up the Properties dialog. Verify that the Start button is not grayed out and the MaxumOPCServer service can now be Started and Stopped. 8.) Verify that the Launch.exe program works correctly. Go to Start > Run, browse to: C:\Program Files(x86)\Siemens Industry\Maxum OPC Server Select Launch.exe. The MaxumOPCClient should now be running.