Hach WIMS Indirect Server-Side Interface To OPC DA Server Q12373 .

10m ago
9 Views
1 Downloads
3.80 MB
51 Pages
Last View : 6d ago
Last Download : 5m ago
Upload by : Maxton Kershaw
Transcription

Hach WIMS Indirect Server-Side Interface to OPC DA Server Q12373 Documentation

Table of Contents 1 - Documentation : Introduction.1 1.1 Interface Introduction.1 1.2 Overview of Indirect Interface Concepts.1 1.3 Source versions tested.2 2 - Documentation : How To.3 2.1 Step-by-Step Instructions on How to Configure Interface.3 2.2 Change Configuration Protection Password.4 2.3 Configuration is Password Protected.5 2.4 Configure the Hach WIMS Client for a Server-Side Interface (SCADA2OPSSQL).5 2.5 Hach WIMS Super User Credentials.7 2.6 Using Common Buttons.7 2.7 Using Main Interface Screen.8 2.8 Using Select Date Range to Import.9 3 - Documentation : Main Menu.12 3.1 Automated Import - Activity Log View.12 3.2 Automated Import - Modify Last Ran Dates.13 3.3 Automated Import - Status and Control.13 3.4 Configuration - Advanced Configuration : Source Input Cache.14 3.5 Configuration - Advanced Configuration: Additional Info.14 3.6 Configuration - Advanced Configuration: Additional Info : Pick WIMS Facility Additional Info Field.16 3.7 Configuration - Advanced Configuration: Unit Conversion.16 3.8 Configuration - Automated Import Configuration.18 3.9 Configuration - Collector Configuration.19 3.10 Configuration - Connection To Hach WIMS.20 3.11 File - Exit.21 3.12 File - Import All.22 3.13 File - Import For Selected Variables.22 3.14 Test - Source Read Test SCADA to Hach WIMS.22 3.15 Test - Test Connection to Hach WIMS.23 3.16 Test - Test Import All.23 3.17 Utilities - Upload Definition File to Hach WIMS.24 4 - Documentation : Release notes.25 4.1 Release Notes for SCADA2OPSSQL Type of Hach WIMS Direct Server-Side Interface.25 5 - Documentation : Collector.28 5.1 Collector Interactive Main Screen.28 5.2 Collector Proxy Settings.30 5.3 Common Collector Configuration.31 5.4 Custom Collector Configuration.32 5.5 Generate Example OPSDATAXML File for Hach WIMS Client.34 5.6 Historical Data Import.34 i

Table of Contents 5 - Documentation : Collector 5.7 Install Collector as a NT Service.35 5.8 NT Service Collector Interactive Screen.36 5.9 NT Service Log View.37 5.10 NT Service Status and Control.38 5.11 Release notes for collector Q12370.38 6 - Documentation : Topics specific to the operation of this interface.39 6.1 Configuration - Source Configuration Q12373.39 6.2 Release notes for interface Q12373.39 6.3 Supported variable configurations for interface Q12373.41 6.4 Using Inteface Browser Q12429.43 6.5 Using the OPC DA Server Collector (Q12370).45 ii

1 - Documentation : Introduction 1.1 Interface Introduction The Hach WIMS Server-Side Interface to an OPC DA Server imports data from a single OPC DA Server into Hach WIMS. The Interface uses a Collector (Q12370) that continuously monitors the OPC Data and generates OPSDATAXML files that will be read by the Interface. The Collector(See Section 6.5) generates one of these files every minute and contains 1 data point for each OPC Item that is being monitored. [Reference ID: 12430] 1.2 Overview of Indirect Interface Concepts The main components that collaborate on getting source data from SCADA or LIMS systems into the Hach WIMS database are the: Collector, Dispatcher, and Interface. The reason there are these components is to provide flexibility, to be more robust, and to overcome disconnected system conditions. 1. Source Data The source data is typically a database of SCADA or LIMS type data stored by some automated or manual system 2. Collector The Collector is responsible for polling source data periodically and creating XML files in a specific format (i.e., OPSDATAXML file format) 3. Dispatcher(See Section ) 1

Hach WIMS Indirect Server-Side Interface to OPC DA Server 1 - Documentation : Introduction The Dispatcher is optional and is used for dispatching XML data files from source computer systems to the Hach WIMS computer when these two are not the same network. The Dispatcher transfers XML data files to the Hach WIMS computer system via File Transfer Protocol (FTP). If the source data is on the same computer as the Hach WIMS database, then this component is not needed. 4. Interface(See Section ) The Interface reads in XML files created by the Collector, summarizes the data based on variable setup in Hach WIMS Client, and imports the data to the Hach WIMS database. The Interface must be able to connect to the Hach WIMS database. 5. Hach WIMS Database End point for data storage. The Database needs to know how the interface is defined, allows you to uniquely name the interface, and provides place holders, called "variables", that hold the data imported from the interface. 6. Hach WIMS Client The Hach WIMS Client is the part of the system that allows you to read data and generate reports. Hach WIMS Client reads data from Hach WIMS Database. [Reference ID: 12559] 1.3 Source versions tested KEPServer 4.5 (OPC 1.0, 2.0, 3.0 tested) Matrikon OPC Server 1.4.1 [Reference ID: 12431] 2

2 - Documentation : How To 2.1 Step-by-Step Instructions on How to Configure Interface You will need to follow these steps in order to configure your interface : 1. You must have Hach WIMS Database Management System installed and running. This can be running from anywhere on your network, but can also be running on the same computer as your interface. 2. You must have Hach WIMS Client installed. Make sure you can log into Hach WIMS Database Server using Hach WIMS Client. 3. Run your interface in Interactive mode by clicking on its entry in your windows Start Menu. 4. Configure a connection to your Hach WIMS Server. Use Configuration - Connection to Hach WIMS(See Section 3.10) to do this. 5. Make sure you are properly licensed to run this interface. In Main Menu, select Support - Am I licensed for this Interface. If you pass this test, continue to step 6. If not, contact Hach Company Sales at 800-677-0067. 6. Upload interface definition file to Hach WIMS Server. Use Utilities - Upload definition file to Hach WIMS(See Section 3.17) to do this. 7. You will need to assign a collector record to your interface. First the record must be created. You will need to configure Hach WIMS Client for a server side interface(See Section 2.4) . 8. Now you are ready to assign the collector record created in the previous step to your interface. Use Configuration Collector Configuration(See Section 3.9) to do this. 9. The Configuration - Collector Configuration will provide an opportunity to configure the Collector component. Click on Collector Configuration Settings button and follow the instructions in Collector - Common Collector Configuration(See Section 5.3) . 10. You need to link at least one Hach WIMS variable to the chosen collector record. 11. Configure the source so that interface can read from the source system. Locate the 'Configuration - Source Configuration' article in the 'Topics specific for operation of Interface' chapter to gain instructions on how to do it. 12. Save all configuration Settings by clicking on Configuration - Save All Configuration. 13. You are now ready to test the interface. Use Test - Test Import All(See Section 3.16) to do this Furthermore, You may want to configure Automated Import. Use Configuration - Automated Import Configuration(See Section 3.8) to do this. 3

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To [Reference ID: 12563] 2.2 Change Configuration Protection Password Requiring a password for configuration changes will prevent unauthorized or accidental tampering with your configuration from within the interactive mode. From the interface, select Configuration and Advanced Configuration. Click on the Protection tab. Click on the box next to Require Password to Change Configuration and Save Settings button. Use this screen to set a new configuration protection password. NOTE: The default password is '12345'. If you configure the interface to use a password and later remove the password check, it will reset to '12345' again. 4

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To [Reference ID: 12055] 2.3 Configuration is Password Protected The configuration is password protected if you changed it in Change Configuration Protection Password(See Section 2.2) . You must enter the correct password in order to save any changes to the configuration of this interface. See Advanced Configuration(See Section ) if you want to disable the password protection. NOTE: If your configuration is protected with a password, you must know the password before you can disable the password check. [Reference ID: 12056] 2.4 Configure the Hach WIMS Client for a Server-Side Interface (SCADA2OPSSQL) In order to use a Hach WIMS Server-Side Interface, you must do the following: 1. Start your Hach WIMS Client and navigate to the System Setup - System Tables - Entire System - Server-Side Interface Setup menu selection: 2. If the "Server-Side Interface Setup" screen shows no interfaces, or the one you want to configure is not shown, you have to: Is the interface definition file uploaded? Click the New button to determine if the definition file is uploaded, and see if it appears in the list of interfaces. If it is there, continue to step 3. 5

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To If the definition file is not uploaded, click the New Definition button and navigate to the g2 server lu file located where the interface is installed. (Alternatively, you can select Utilities - Upload Definition File to Hach WIMS(See Section 3.17) ) 3. With the definition uploaded (or present), click the New button and create an instance of the server side interface. You can have multiple interface sources for the same definition. In this example, we are using the Random Number Generator interface. Select the name of your interface, click Next, and select the version. 4. Configure the interface: Make note of the "Name of Interface" field - this is how your interface will be identified. In this case - it is "Random Number Generator". Fill in a "Description" and select the "Collector Time Zone", in this case, it is set to Mountain Time (US & Canada). Click OK to create the interface record. 5. Configure Browser - Click on the Browser tab and enter the requested information to allow the Hach WIMS Client the ability to browse tags from the source system. In some cases, you will need to install an OLE DB driver, on the Hach WIMS Client computer, that will allow communications to the source system. If it is impossible to configure this option, or you wish to do this later - uncheck the Enable button on the Browser tab. 6. Go to System Setup - Edit/View Variables. 7. Go to the variable you wish to configure for storing interface data: 6

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To Click the Interface tab on the variable you are configuring, then click the Interface To radio button and select the interface needed for this variable. The area below will fill up with the settings needed to finish configuring this variable. 8. For detailed instructions on configuration of variables, look for the 'Supported Variable Configurations For Interface .' article in the 'Topics specific to the operation of this Interface' chapter. [Reference ID: 12041] 2.5 Hach WIMS Super User Credentials To enable this feature, select Configuration - Advanced Configuration(See Section ) . Then check the "Require Hach WIMS Super User Login Credentials to Import Data In Interactive Mode" setting. You must provide the correct user name and password in order to import data in interactive mode. Contact your Hach WIMS Administrator for help if you do not know the username and/or password. [Reference ID: 12057] 2.6 Using Common Buttons Common Hach WIMS Interface Buttons: Displays help for the current interface screen. Applies the current settings. 7

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To Attemps to apply the current changes and save them permanently. The save will fail if the settings cannot be applied first. Closes the current window - no changes are saved. Cancel the current activity/operation. [Reference ID: 12039] 2.7 Using Main Interface Screen This is the main interface interactive screen. When running in interactive mode, you can set the various interface configuration settings, monitor & control the interface service, as well as interactively collect data. The main parts of the of the screen of interest are: Main Menu The Shortcut Buttons: Import all data(See Section 3.12) . Import data for selected variables(See Section 3.13) . Monitor service activity(See Section 3.1) . Display help for the current window. Display general interface information. Exit the interactive interface session. The Interface Messages & Notification area - the white background area displays scrolling text regarding the interface's activity. All manner of data is logged here, including data collection status, errors, warnings and other 8

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To general information regarding the interface's current activity. Depending on the Verbosity(See Section ) level set, you may or may not see all information. If there is a directory called "Log" in the interface directory, the interface will also log to a text file of the form: mm dd yyyy hh mm ss interactive.log E.g., if the current date is 2/26/2009 and the current time is 3:02:13 PM, the file will be called: 02 26 2009 15 02 13 interactive.log. The status bar, at the bottom of the screen, displays miscellaneous information regarding the interface. [Reference ID: 12036] 2.8 Using Select Date Range to Import When importing data for one or more specified variables, you have to specify the date range of the source data you want to get. You can do this in 2 ways: 1. Use both the Start & End Date Pickers - OR 2. Use a start/end date quick shortcut: 9

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To Buttons: Import data for the selected dates Other buttons are described in Using Common Buttons(See Section 2.6) . Principle 1: Data will be imported based on the Start and End Date and Time and how the variable's Stop Time is set up. The Stop Time must fall within the date range requested. Principle 2: Data is stored on the date and time of the variable's Start Time. For example: We set a variable with Start Time of 08:00 and a Stop Time of 08:00, and select Day After Start as shown below. Then I run the interface to pull data for March 3, 2009 00:00:00 to March 4, 2009 08:01:00. The interface will return a value for March 2 and March 3. Why? The stop time is our requested date range starting on March 3, 2009 with a stop time of 8 AM. The stop time is computed to March 3, 2009 08:00:00. Since we selected the stop as day after start, the start time is March 2, 2009 at 08:00:00. According to principle #2, the data point is stored on the start time. So for our example: 10

Hach WIMS Indirect Server-Side Interface to OPC DA Server 2 - Documentation : How To Requested Date Start Date and Time Stop Date and Time March 3, 2009 March 2, 2009 08:00:00 March 3, 2009 08:00:00 March 4, 2009 March 3, 2009 08:00:00 March 4, 2009 08:00:00 If we had set our date range from March 3, 2009 00:00:00 to March 4, 2009 07:59:59, then the interface would return only the first record, because stop time of March 4, 2009 08:00:00 in the second record, is past the end date and time of our range. If we had set our date range from March 3, 2009 08:01:00 to March 4, 2009 08:01:00, then the interface would return only the second record, because the Stop Date and Time of the first record (March 3, 2009 08:00:00) does not fall within our start and end date range. [Reference ID: 12058] 11

3 - Documentation : Main Menu 3.1 Automated Import - Activity Log View For Automated Import options, click the Automated Import button on the top menu bar of the interface. The Activity Log View lets you view the interface NT Service log. Buttons: Force refresh of the service log view. To shorten the refresh interval, see Configuration - Advanced Configuration(See Section ) . View the full service log. The rest of the buttons are explained in Using Common Buttons(See Section 2.6) . NOTE: If the log cannot be read, make sure the service name is correct and that it's running. See Automated Import - Status and Control(See Section 3.3) on how to start the service if it's not running (assuming the service name is correct) and see Configuration - Advanced Configuration(See Section ) on how to view/change the service name. [Reference ID: 12049] 12

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu 3.2 Automated Import - Modify Last Ran Dates This screen lets you modify the per-facility Last-Ran Date of the interface. NOTE: This is different than the default Last-Ran Date described in Configuration - Automated Import Configuration(See Section 3.8) , which is the default Last-Ran Date for ALL facilities that have not had any data imported. [Reference ID: 12051] 3.3 Automated Import - Status and Control The NT Service Status and Control screen lets you monitor the state of interface service, and start or stop the service (Note: you must be logged in as a Windows Administrator): The name of the service is displayed in the bottom left (see screenshot) corner of the screen. This is the name of the service that the interactive program is configured to monitor. If this is NOT the name of the service, you can change it from the Configuration - Advanced Configuration(See Section ) screen. Buttons: Start the service, if it is not running. Stop the service, if it is running. All other buttons are explained in Using Common Buttons(See Section 2.6) . [Reference ID: 12047] 13

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu 3.4 Configuration - Advanced Configuration : Source Input Cache Source Input Cache Configuration, is used to configure criteria for caching, if the interfaces supports caching and the option is Enabled. Caching is used to load more data into memory at one time, and retain it for processing variables instead of continuously rereading source data from disk. This will speed up processing, but uses more computer resources - such as memory. Set the parameters to set thresholds for processing chunks of data and so that the interface does not surpass the limitations of your computer. (Note: Not all interfaces have this feature available) Click Apply Settings to apply changes and return to parent form. Click Close to return without applying changes. [Reference ID: 12132] 3.5 Configuration - Advanced Configuration: Additional Info Additional Info, if enabled, is used to configure a cross reference map between fields in the source system and result additional info fields in Hach WIMS. This cross reference map will be then used by the interface during data import. This feature can be turned off. Simply click the Disable radio button under Write Data Into Additional Info Fields in Hach WIMS. The number of successful writes to additional information can be Enabled or Disabled. Click the appropriate radio button under Log Number of Successfully Written Fields during Import. (Note: Not all interfaces have this feature available) 14

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu 1. Click on any button in the Source Field Identifier column to pick a source field. 2. Click on any button in the Target WIMS Facility Identifier.Field Identifier column to pick a target field. 3. Right click on any button, and click on Clear Cell to erase contents of a cell. Notice the example output below from Hach WIMS Client Spread Report Design, additional info is only imported when there is a valid result imported. Also notice how we have the field set up in Additional Info and how we recall the data in Spread Reports. NOTE: When interfacing to two (2) or more facilities you MUST map each facility. For example, I am importing data into the OPSEID facility database and the OPSDEERCRK facility. I would map AI COLUMN 1 thru AI COLUMN 4 for each facilty: 15

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu [Reference ID: 12598] 3.6 Configuration - Advanced Configuration: Additional Info : Pick WIMS Facility Additional Info Field Pick WIMS Facility Additional Info Field window lists all available additional info fields for all facilities connected to your Hach WIMS server. Select a row to highlight a field, and click the Pick button. [Reference ID: 12599] 3.7 Configuration - Advanced Configuration: Unit Conversion Unit Conversion, if enabled, is used to configure unit conversion when the "units" from the source are different than the "units" in Hach WIMS. 16

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu This feature can be turned off, simply click the Disable radio button under Convert Result from Source Unit to Hach WIMS Unit. (Note: Not all interfaces have this feature available) 1. Under Source Unit enter the text value as it is in the source 2. Select the Conversion Algorithm Multiplication - Multiply the source result by the Factor before writing to Hach WIMS Degrees F to C - Convert degrees Fahrenheit to degrees Celsius Degrees C to F - Convert degrees Celsius to degrees Fahrenheit 1. Enter the Factor amount, how much to multiply the source result by before writing to Hach WIMS. When using the Degrees conversion, enter a 1 (one) 2. Enter the Hach WIMS Unit that the Hach WIMS variable will be using For example, the source result is stored in parts per million ("ppm") and it needs to be converted in Hach WIMS as parts per billion ("ppb"). You could add the following conversion: (Note: this is one of the default conversions included) Click Apply Settings to apply changes and return to parent form. Click Close to return without applying changes. 17

Hach WIMS Indirect Server-Side Interface to OPC DA Server 3 - Documentation : Main Menu [Reference ID: 12328] 3.8 Configuration - Automated Import Configuration Each interface can be configured to run as a service. This is when you want to schedule an automatic retreival of data, without user intervention. The Automated Import Configuration screen allows you to configure the schedule, whether to submit calculation requests, the Last-Ran Date, and the import operation mode: Automated Import Schedule - configure when the interface service is scheduled to run: Daily -the interface will run ONCE per day, at the specified schedule. E.g., to run it at 2:30 am, you would enter "2" into the hours box and "30" into the minutes box. Note that time is entered in "military" format. To enter 4:45 pm, you would enter "16" into the hours box, NOT 4. Hourly - the interface will run every hour at the specified minute after the hour Minutely- the interface will run every X minutes where X is a number between 1 and 1440. E.g., to run it every 5 minutes, you would enter "5". Calculations After Automated Import - select this option if you would like the Hach WIMS AdoCalc service to recalculate all variables within every facility after an import operation completes. Default Last Run Date - this is the point in time from which the interface service will try to retrieve data, up until the current point in time. After a successful run, the current time will become the last run time. By default, this is set to one day prior to the current day. E.g., assume today is February 25, 2009, if you have just installed the interface and have 3 months of historical data you want imported into Hach WIMS. You should enter November 25, 2008 as the Last-Run Date (3 months prior to February 25th). Once the interface completes its run, the Last-Run Date will be set to February 25, 2009 automatically. The next time it runs (assuming it runs Daily), February 26, 2009, it will only fetch one day's worth of data. Constant to Add to Start Date Each Time Import Runs - Enter the number of minutes to add to the Sta

Upload interface definition file to Hach WIMS Server. Use Utilities - Upload definition file to Hach WIMS(See Section 3.17) to do this. 6. You will need to assign a collector record to your interface. First the record must be created. You will need to configure Hach WIMS Client for a server side interface(See Section 2.4) . 7.

Related Documents:

Dec 03, 2015 · The Hach WIMS Server-Side Interface to HACH SC1000 via Modbus TCP imports data from the Hach SC1000 over TCP into Hach WIMS. The Interface uses a Collector (Q12678) that continuo

Upload interface definition file to Hach WIMS Server. Use Utilities - Upload definition file to Hach WIMS(See Section 3.16) to do this. 6. You will need to assign a collector record to your interface. First the record must be created. You will need to configure Hach WIMS Client for a server side interface(See Section 2.4) . 7.

Dec 02, 2015 · 1 - Documentation : Introduction 1.1 Interface Introduction The Hach WIMS Direct Server-Side Interface to GE Fanuc FIX / iFIX HMI imports summarized values into Hach WIMS. The Hach FIX2XML (See Section 5.6) utility queries historical H files (.h04,.h08, or .h24 classic historian files) generated from FIX / FIX32 / iFIX (by

The Hach WIMS Indirect Server-Side Interface to Rockwell FactoryTalk SE transfers summarized values from the FactoryTalk archive database to Hach WIMS DBMS. FactoryTalk must log real time data to an MS SQL database in uncompressed fashion. Data is read from the FactoryTalk database, summarized based upon the user specified statistic, and

User Manuals Simplified. HACH 2100Q Portable Turbidimeter User Manual March 4, 2022March 5, 2022 Leave a comment on HACH 2100Q Portable Turbidimeter User Manual Home » HACH » HACH 2100Q Portable Turbidimeter User Manual DOC022.97.80041 2100Q and 2100Qis 03/2021, Edition 5 Contents hide 1 Section 1 Specifications 2 Figure 1 Product overview

Malvern Zetasizer Nano Basic Operating Instructions. 08/14/2015 S.V. Location: 1238 Hach Hall . Contact: Steve Veysey, 1234 Hach Hall . All researchers using the Zetasizer Nano instrument in 1238 Hach Hall must complete the EH&S course: “Fire Safety and Extinguisher Training”. When preparing samples in this room, please wear all

The USEPA letter dated February 26, 1997, accepts Hach Method 10014, Ultra Low Range Total Residual Chlorine (DPD Method), and Hach M

and more importantly out of the tank while the pump is running. This constant flushing ensures that the water in the tank remains fresh and eliminates the risk of stagnant water during normal system operation. See fig 2. GT-C, composite tank The GT-C pressure tank is a lightweight pressure tank. The diaphragm is a chlorine-resistant 100 % butyl