DOC UDG1000 Online Help. Software Manual. 05/2013, Edition 1

Transcription

1 DOC UDG1000 Online Help Software Manual 05/2013, Edition 1

2

3 Table of Contents Section 1 Product overview...3 Section 2 Basic steps...5 Section 3 Installation PC requirements Software installation...7 Section 4 Menu overview and navigation...9 Section 5 Startup...11 Section 6 Input setup Add an input collector Add a parameter Add a parameter manually Edit a parameter Set up the scheduler Import parameters manually Select more input settings...15 Section 7 View data Monitor the data...17 Section 8 Output setup Add an exporter Select the parameters to export Set scaling and filtering Send parameter values to manual export Select more output settings Set the default settings for parameter output cross-references creation...22 Section 9 System information Review the log files Change the selectable units Software licensing Activate the software license online Activate the software license offline Add additional licenses Move software licenses to another computer Enable an OPC DA server Make a system backup Show software information and updates...27 Index

4 Table of Contents 2

5 Section 1 Product overview The UDG1000 is a universal data gateway (UDG) software package. A collector is used to get data from a source (e.g., HACH sc1000/sc200/sc100 controllers, Allen Bradley PLCs, OPC Servers, SCADA systems). The UDG1000 software operates in the background and collects, stores, shows, aggregates and exports the data. The data can be exported to CSV, WIMS solutions and more. 3

6 Product overview 4

7 Section 2 Basic steps N O T I C E Push F1 on the computer keyboard any time for help. To get started: 1. Install the software. Refer to Installation on page Configure an input driver to connect the software to your system. Refer to Input setup on page View data to confirm the collection of the data. Refer to View data on page Configure an output driver to export the data. Refer to Output setup on page Activate the software license. Refer to Software licensing on page 25. 5

8 Basic steps 6

9 Section 3 Installation 3.1 PC requirements The UDG1000 software operates on Microsoft Windows PCs with.net Framework 4.0. UDG1000 monitors up to 50 secondly parameters or 200 minutely parameters on one PC. PC requirements are shown in Table 1. Table 1 PC requirements Specifications Processor Disk space RAM Supported clients operating systems Supported server operating systems Details Minimum 1 GHz Recommended: 10 GB free (minimum: 2 GB free) Recommended: Microsoft Windows with 64 bit: minimum 2 GB RAM, Microsoft Windows with 32 bit: minimum 1 GB RAM Microsoft Windows 2000 Service Pack 4 Microsoft Windows XP 32-bit Service Pack 3 Microsoft Windows Vista 32-bit Microsoft Windows Vista 64-bit Microsoft Windows Vista 32-bit Service Pack Microsoft Windows Vista 64-bit Service Pack Microsoft Windows 7 32-bit Microsoft Windows 7 64-bit Microsoft Windows 7 64-bit Service Pack 1 Microsoft Windows 8 Microsoft Windows 2003 Server 32-bit Service Pack 1 Microsoft Windows 2003 R2 Server 32-bit Service Pack 2 Microsoft Windows 2003 Server 64-bit Service Pack 1 Microsoft Windows 2003 R2 Server 64-bit Service Pack 2 Microsoft Windows bit Microsoft Windows bit Microsoft Windows bit Service Pack 1 Microsoft Windows bit Service Pack 1 Microsoft Windows bit Service Pack 2 Microsoft Windows bit Service Pack 2 Microsoft Windows 2008 R2 64-bit Microsoft Windows 2008 R2 64-bit Service Pack 1 Microsoft Windows 2012 Server 3.2 Software installation Prerequisites: The user must have Windows Administrator rights to install the software. Make sure that the PC has all the necessary requirements. Refer to PC requirements on page 7. Use a computer that is expected to be on all the time. 1. Open an internet browser. 2. Download the UDG installer from 3. Unzip the file. 4. Double-click on setup.exe. The setup wizard starts. Note: If.Net Framework 4.0 is not installed on the PC, the setup wizard will automatically install the software. A reboot will be necessary before the UDG1000 software installation is completed. 7

10 Installation 5. Obey the screen prompts to complete the installation. When the installation is complete, a new shortcut icon "UDG1000" shows on the PC desktop. 6. Activate the software license. Refer to Activate the software license online on page 25. 8

11 Section 4 Menu overview and navigation Figure 1 Menu overview Refer to Figure 1 for a menu overview and navigation icons. 1 Main menu tabs 6 Add icon (green arrow) 2 Help file icon 7 Refresh icon 3 Sub-menu tabs 8 Search function 4 Column headers with filter to sort the column 9 Drop-down menu 5 Edit, delete, cancel or save buttons (contextual) 10 Drop-down menu to select the collector 9

12 Menu overview and navigation 10

13 Section 5 Startup Start the UDG1000 software from the icon on the desktop or select Start>All Programs>Hach UDG1000. The View Data tab opens. Refer to Figure 2. Figure 2 View data 1 View Data: shows the configured parameters with the most recent values 2 Input: configures collectors, shows collectors, parameters, schedules and imports data manually 3 Output: gives export options 4 System: shows log files, supplies options to set up the units, gives backup, licensing activation and options 11

14 Startup 12

15 Section 6 Input setup 6.1 Add an input collector 6.2 Add a parameter The collector is the configured driver per source, e.g., one COM port, LAN connection or database file etc. An existing collector can be updated to get additional data points from the source. A new collector is necessary if the same driver type is used for another source. Select the collector that aligns with the source. Collectors can be Historical or Live depending on how the source shows the data. Note: One license is necessary for each collector that is added. To see the number of collector licenses that are available, select System>Licensing. Live collects live data at configurable intervals. The Live collector polls the source, reads the current data and saves the values. Historical collects data from a system that saves time stamped data (e.g., SCADA Historian) 1. Click Input from the main menu. The Collectors tab opens. 2. In the CONFIGURED COLLECTORS column, click Add. A window that shows the available drivers opens. 3. Select an applicable collector from the list or use the search function or the dropdown column header to define the search. Click Add. Note: Push F1 on the computer keyboard any time for help. 4. A pop-up window shows for a collector name. Enter an applicable name for the collector and click Save. 5. In the configuration screen, enter the applicable information. Refer to the driver documentation for more information about configuration. 6. Click Test connection to make sure that the connection is set. 7. Click Save Add a parameter manually After the input and any exporters are configured, the program can be closed. The data collection operates in the background with Windows Services. When the connection to the source is set, select the parameters. 1. Click Input>Parameter. If possible, the software shows the available auto-detected parameters. 2. Highlight the applicable parameter and click the Add icon. The parameter is then shown in the right column. The name color changes to blue when the software starts to collect the data. Note: Use the Ctrl or Shift key to select multiple items and then click the Add icon. 3. Repeat step 2 to add more parameters as necessary. Add a parameter manually with the driver specific information if a parameter is not autodetected. 1. Click Input>Parameter, then Manual in the drop-down menu. Refer to Figure 1 on page Enter the specifics. Option Device Name Tag Description Enter the source name for the parameter. Enter the parameter name. 13

16 Input setup Option Address bus Data Type 3. Click the Add icon. Description Enter the device address. Select the data transfer type. 6.3 Edit a parameter To change some parameter details: 1. Click Input>Parameter. 2. In the right column, highlight the parameter to change in the parameter list. 3. Click Edit. 4. Select an option. Option Name Description Data Type Units Description Changes the name of the parameter. Adds some information for the parameter. Selects Integer, double or string. Selects and adds a measurement unit that should show for the calculated value. 6.4 Set up the scheduler Decimal Places Selects the number of digits that are shown after the decimal point. 5. Click Save. Refer to the driver documentation for more information. This task works for historical drivers only. N O T I C E An import schedule can be enabled to get data daily, hourly or every minute. Example: Data is collected from a SCADA system. The historical data store uses the ODBC driver. The SCADA system writes all the data for the last hour to the database once an hour. Enable the scheduler so that data gets imported hourly (e.g., 2 minutes after each hour). The scheduler triggers a data import at 2 minutes after each hour. 1. Click Input>Scheduler. 2. Highlight the applicable configured collector in the left column. 3. Select Enable and the necessary time schedule (daily, hourly or every minute). 4. Set the operation time to start the import. Keep the Last Run Date blank unless historical data from the source system is necessary. 5. Click Save. 6.5 Import parameters manually 14 Historical data that is already logged can be imported. The entered date and time range will be the time range for the data supplied. 1. Click Input>Manual Import. 2. Select the historical collector in the right column to import the necessary data.

17 Input setup 6.6 Select more input settings 3. Enter the start and end date for the data collection at the bottom of the window. 4. Click Import. The general settings for a collector can be changed. 1. Click Input>More Settings. 2. Select or enable an option. Option Collection Enabled Logging enabled Description Enables or disables the data collection. If the source system is set to off, disable the data collection to avoid error messages. Note: The collector status on the View Data tab will show Collector is Disabled. Records log files which can be used to troubleshoot issues with the software. The system tab shows the collector log files and the error and warning messages. Logging verbosity Sets the level of messages to be logged. Note: Do not change the default setting unless it is necessary for technical support to get some more information. Log rotation interval in days Enters the number of days to keep the collector log files. 15

18 Input setup 16

19 Section 7 View data 7.1 Monitor the data The View Data tab shows the configured parameters with the most recent values. Note: The data shows when the input is configured. Refer to Input setup on page Click View Data. The collected data is shown. 2. Double-click on a parameter to see the value history for the last 24 hours. For a different date range, add a start and end date, then click Submit. Note: To copy values to a different document, highlight the value(s) and push Ctrl-C. 17

20 View data 18

21 Section 8 Output setup 8.1 Add an exporter Data is collected from the configured input parameters and saved to data files. These data files are then sent/saved to the exporters according to the parameter output crossreference settings. For example, data can be exported to a CSV file. Note: One license is required for each exporter that is added. To see the number of exporter licenses that are available, select System>Licensing. 1. Click Output>Exporters. The exporters that have been added show in the left column. The settings for the selected exporter show in the right column. 2. Click Add, select an exporter and click Add. Refer to the exporter documentation to select the correct exporter. 3. Enter a descriptive name for the exporter (e.g., instrument name, location, type of data). 4. Click Save. 5. Obey the screen prompts to specify the exporter. Refer to the exporter documentation for more information. 8.2 Select the parameters to export Note: A red asterisk or red field identifies that the value selected is not valid. 1. Click Output>Cross References. 2. Select the exporter at the top of the right column. The available parameters show in the left column. The parameters that have been selected show in the right column. 3. Select a parameter and click the Add icon to add the parameter to the right column. A pop-up window opens. 4. In the Frequency field, select how often the parameter value is sent to the exporter. Option Hourly Daily Description The parameter value is sent at the end of each hour at xx:59:59 (hh:mm:ss). The parameter value is sent at the end of the day. Time Range Select the start time and end time for the day (24-hour clock format). The time range can be 1 hour to 23 hours 59 minutes. The end time does not have to be on the same day as the start time. A red asterisk shows by this field when Day After Start should be selected. Same Day As Start Select this checkbox when the end time for the day is on the same day as the start time. Day After Start Select this checkbox when the end time for the day is not on the same day as the start time. 15 Min The parameter value is sent every 15 minutes at xx:14:59, xx:29:59, xx:44:59, xx: 59:59 (hh:mm:ss). Minutely The parameter value is sent at the end of each minute at xx.xx.59 (hh:mm:ss). 5. In the Statistic field, select the parameter value that is sent to the exporter. Option TimeGT First Description The number of minutes the parameter value was more than the value selected in the Value Greater Than field during the time interval. The time interval is selected in the Frequency field. The first parameter value that occurred during the time interval. The time interval is selected in the Frequency field. 19

22 Output setup Option Last Min Max Description The last parameter value that occurred during the time interval. The time interval is selected in the Frequency field. The smallest parameter value that occurred during the time interval. The time interval is selected in the Frequency field. The largest parameter value that occurred during the time interval. The time interval is selected in the Frequency field. Average The average of all the parameter values that occurred during the time interval. The time interval is selected in the Frequency field. 6. In the Store Time field, select the time stamp for the parameter value sent. Option Start Date End Date Value Date Constant Date Description The start time of the interval, e.g., for an hourly, will always be the beginning of the hour xx:00:00. The time interval is selected in the Frequency field. The end time of the interval, e.g. for an hourly, will always be the ending of the hour xx:59:59. The time interval is selected in the Frequency field. The time when the parameter value selected in the Statistics field occurred. This option is typically selected when Min or Max is selected in the Statistics field. Note: This option is not available when Average is selected in the Statistics field. Lets the user select the minutes of the hour for the time stamp. For example, when 00:11 is selected: Hourly = xx:11, Daily = 23:11, 15 Min = xx:11, xx:26, xx:37 and xx:52. Note: This option is not available when Minutely or Secondly is selected in the Frequency field. 8.3 Set scaling and filtering 7. Click Next. The parameter shows in the right column. The parameter value starts being sent to the exporter. 8. Do steps 3 7 again to select another parameter as necessary. Note: Use the Ctrl or Shift key to select multiple parameters. Any parameter that is sent/saved to an exporter can be: Scaled by a multiplication factor to convert the parameter to a different unit of measure. Filtered so that parameter values that are outside the selected range are not sent/saved. Filtered so that when another input parameter (i.e., turbidity) is more than a selected value the parameter values are not sent/saved. 1. Click Output>Cross References. 2. Select the exporter at the top of the right column. 3. Select a parameter in the right column and click Edit. 4. Select the Scaling/Filtering tab. 5. Select an option. Option Scale Factor Low Range Description Enter the value the parameter will be multiplied by to convert the parameter to a different unit of measure. Select the minimum value that is sent/saved to the exporter. 20

23 Output setup Option High Range Description Select the maximum value that is sent/saved to the exporter. Enable Filtering Select this checkbox to not send/save parameter values to the exporter when another parameter is more than an entered value. 6. When Enable Filtering is selected: a. In the Filter Parameter field, select the parameter. b. In the Value field, enter a value for the parameter. 7. Click Save. 8.4 Send parameter values to manual export All of the parameter values that are selected as an input are continuously saved to a database. Any of the parameter values in the database can be manually sent to the exporter for a selected range of dates and according to the parameter output crossreference setting(s) selected. Note: Parameter values that are sent manually are added to the end of the current (daily) exporter file if applicable. 1. Click Output>Manual Export. 2. Select the exporter in the left column. 3. Select the parameter(s) output cross-reference to send to the exporter. To select all, select the upper checkmark box in the header row. Note: Add a new parameter output cross-reference as necessary to the exporter to send the necessary parameter values. 4. In the Start Date and End Date fields, select the range of dates to send to the exporter. 5. Click Export. 8.5 Select more output settings 1. Click Output>More Settings. 2. Select the applicable exporter in the left column. 3. In the Timestamp Preference field, select Local (local time zone) or UTC (coordinated universal time). This time stamp will be included in the output. 4. To stop data from being sent to the exporter, unselect Automatic Export Enabled (default = enabled). Note: When export is enabled again, the data that was not sent to the exporter can be manually sent to the exporter. Refer to Send parameter values to manual export on page To stop event data from being saved to the log files, unselect Logging Enabled (default = enabled). Do not disable logging unless requested by technical support. 6. In the Logging verbosity field, select the type of data to log (default = Error). Do not change the logging verbosity setting unless requested by technical support. Option Fatal Error Description Fatal errors are saved to the log files. Error messages and fatal errors are saved to the log files. Warning Warning messages, error messages and fatal errors are saved to the log files. 21

24 Output setup Option Info Description Information messages, warning messages, error messages and fatal errors are saved to the log files. Debug Debug messges, information messages, warning messages, error messages and fatal errors are saved to the log files. 7. In the Log rotation interval in days field, enter the number of days the event log files are saved (default = 30 days). Do not change the log rotation interval unless requested by technical support. 8.6 Set the default settings for parameter output cross-references creation Note: A red asterisk or red field identifies that the value selected is not valid. When a parameter output cross-reference is added to an exporter, the default settings show in the fields of the popup window. 1. Click Output>Defaults. 2. In the Frequency field, select how often the parameter value is sent to the exporter. Option Hourly Daily Description The parameter value is sent at the end of each hour at xx:59:59 (hh:mm:ss). The parameter value is sent at the end of the day. Time Range Select the start time and end time for the day (24-hour clock format). The time range can be 1 hour to 23 hours 59 minutes. The end time does not have to be on the same day as the start time. A red asterisk shows by this field when Day After Start should be selected. Same Day As Start Select this checkbox when the end time for the day is on the same day as the start time. Day After Start Select this checkbox when the end time for the day is not on the same day as the start time. 15 Min The parameter value is sent every 15 minutes at xx:14:59, xx:29:59, xx:44:59, xx: 59:59 (hh:mm:ss). Minutely The parameter value is sent at the end of each minute at xx.xx.59 (hh:mm:ss). 3. In the Statistic field, select the parameter value that is sent to the exporter. Option TimeGT First Last Min Max Description The number of minutes the parameter value was more than the value selected in the Value Greater Than field during the time interval. The time interval is selected in the Frequency field. The first parameter value that occurred during the time interval. The time interval is selected in the Frequency field. The last parameter value that occurred during the time interval. The time interval is selected in the Frequency field. The smallest parameter value that occurred during the time interval. The time interval is selected in the Frequency field. The largest parameter value that occurred during the time interval. The time interval is selected in the Frequency field. Average The average of all the parameter values that occurred during the time interval. The time interval is selected in the Frequency field. 22

25 4. In the Store Time field, select the time stamp for the parameter value. Output setup Option Start Date End Date Value Date Constant Date Description The start time of the interval, e.g., for an hourly, will always be the beginning of the hour xx:00:00. The time interval is selected in the Frequency field. The end time of the interval, e.g. for an hourly, will always be the ending of the hour xx:59:59. The time interval is selected in the Frequency field. The time when the parameter value selected in the Statistics field occurred. This option is typically selected when Min or Max is selected in the Statistics field. Note: This option is not available when Average is selected in the Statistics field. Lets the user select the minutes of the hour for the time stamp. For example, when 00:11 is selected: Hourly = xx:11, Daily = 23:11, 15 Min = xx:11, xx:26, xx:37 and xx:52. Note: This option is not available when Minutely or Secondly is selected in the Frequency field. 5. Click Save. 23

26 Output setup 24

27 Section 9 System information 9.1 Review the log files The log files are used by technical support to troubleshoot problems. 1. Click System>Logs. 2. Click the function Application, Scheduler, Collector or Exporters. 3. Select the applicable option in the left column. 4. Select a log file. The log file shows in the Log Preview window. 5. To open a log file, double-click the log file. 9.2 Change the selectable units 9.3 Software licensing Units are used to identify the measurement unit for a parameter. To add or remove measurement units from the unit drop down menus or change a measurement unit: 1. Click System>Units. 2. To add a measurement unit: a. Click Add. b. Enter the measurement unit, then click Save. 3. To change a measurement unit: a. Select the measurement unit, then click Edit. Note: Any input parameters configured to use this measurement unit will use the new measurement unit when the change is saved. b. Change the measurement unit, then click Save. Note: The measurement units setting does not convert parameter values to a different measurement unit. To convert parameter values to another measurement unit, refer to Set scaling and filtering on page To remove a measurement unit, select the measurement unit, then click Delete. Note: Any input parameters configured to use this measurement unit will not have a measurement unit setting when the change is saved Activate the software license online If an internet connection is available, activate the software license after the software is installed and after the trail version has expired. The software license includes unlimited licenses of the free collectors/exporters and any licenses purchased for the standard collectors/exporters or custom collectors/exporters. Refer to for more information. 1. Click System>Licensing. The license status shows. 2. Click Activate. 3. Select Active UDG1000 online now. 4. Enter the product key, then click Next. A message shows when the license has been activated. The number of collector and exporter licenses installed is shown below "Total" Activate the software license offline If no internet connection is available, activate the license after the software is installed as follows. 1. Click System>Licensing. The license status shows. 2. Click Activate. 25

28 System information 3. Select Activate UDG1000 online now. 4. Enter the product key, then click Next. 5. When an activation error occurs, click Manually Activate Offline. 6. Click Save to save the Activation request file "ActivationRequest.xml". Save the file on a removable device so that the file can be sent via to iimsupport@hach.com as a UDG activation request. An with an "ActivationRespose.xml" file will be sent in return by the manufacturer. 7. Copy the file to the computer that has the UDG1000 software. 8. Click Open the Activation Response file and browse to the ActivationRespose.xml file on the computer. A message shows when the license has been activated Add additional licenses To install additional collector/exporter licenses after the software license has been activated, deactivate the software license and then activate the new software license supplied by the manufacturer. Click Deactivate. Refer to Activate the software license online on page Move software licenses to another computer To move the software license to another computer, deactivate the software license and then activate it on the other computer. Click Deactivate. Refer to Activate the software license online on page Enable an OPC DA server N O T I C E UDG1000 OPC DA server is only OPC DA V2/V3 compliant. UDG1000 can be configured as an OLE for Process Control (OPC) DA server. The OPC server lets MODBUS devices easily connect to OPC clients. These clients can be SCADA (Supervisory Control and Data Acquisition) packages or any other application designed to connect to OPC servers. 1. Click System>Settings. 2. Enable OPC DA Server. 9.5 Make a system backup Save a copy of the collected data and configuration files to a backup file so they can be restored in the event of data loss. Log files are not saved to the backup. Contact technical support to restore a backup. Note: When a backup is restored, the collected data and configuration files on the computer are replaced with those in the backup. Collected data will be lost. 1. Click System>Settings. 2. Select the location to save the backup, then click OK. 3. Click Backup. "Backup Complete" shows. The backup is saved to a zip file. Note: Each backup is saved to a separate zip file. 26

29 System information 9.6 Show software information and updates Note: An internet connection is necessary to show the software updates. 1. Click System>About. The software version and support contact information show. 2. To show the software updates: a. Click Check for update. A message identifies whether a software update is available. b. If a software update is available, click Install to install the update or Cancel to not install the update. 27

30 System information 28

31 Index B Backup...26 C Collector Installation...13 Settings...15 D Data...17 E Exporter...19 Parameter...19 L Log files...25 N Navigation...9 P Parameter...13 Edit...14 Exporter...21 Import...14 S Scheduler Historical driver...14 Software Description...3 Installation...7 PC requirements...7 U Units

32

33

34 HACH COMPANY World Headquarters P.O. Box 389, Loveland, CO U.S.A. Tel. (970) (800) (U.S.A. only) Fax (970) HACH LANGE GMBH Willstätterstraße 11 D Düsseldorf, Germany Tel. +49 (0) Fax +49 (0) info@hach-lange.de HACH LANGE Sàrl 6, route de Compois 1222 Vésenaz SWITZERLAND Tel Fax Hach Company/Hach Lange GmbH, All rights reserved. Printed in U.S.A.