Variable Setup for Hach WIMS Direct Server-Side Interface to Custom DCS_Points_Retrieved
To configure a variable to get values from source, select System Setup, Edit/View Variables in WIMS and select the Interface tab.
Then click Interface To radio button. The drop down box next to the option is now enabled, click the drop down arrow and choose the interface name (name given when configuring the interface).
- TAG: Required. The source identifier for the samples to retrieve results for this variable.
- Statistic: Required. The summary (aggregate) to calculate when pulling data from the source. The Statistic Field is actually used by the Utility This is a listing of all the statistics supported by this interface.
WIMS Stat |
Requested Statistic_Agg |
Description |
Average |
AVERAGE |
The time weighted average for the requested time period. |
UVSET |
TIME_SET |
Time in seconds that the point was set. Result is stored in the next WIMS data slot. For example, data is requested for 1/1/2012, the value is stored for 1/2/2012. |
UVRAW |
RAW |
First Raw value in the requested time period |
FIRST |
RAW |
First Raw value in the requested time period |
LAST |
RAW |
Last Raw value in the requested time period |
MAXIMUM |
MAXIMUM_VALUE |
Maximum value in the requested time period |
MINIMUM |
MINIMUM_VALUE |
Minimum value in the requested time period |
TIMESET |
TIME_SET |
Time in seconds that the point was set. Use Scale Factor of 0.01667 to convert to minutes, 0.000278 to convert to hours. |
TIMEMAX |
TIME_OF_MAXIMUM |
Time of Maximum returned as a string. Format mm/dd/yyyy hh:mm:ss, example 01/17/2012 14:33:25 |
PREVMAX |
MAXIMUM_VALUE |
Maximum value in the requested time period |
PREVMIN |
MINIMUM_VALUE |
Minimum value in the requested time period |
PREVSET |
TIME_SET |
Time in seconds that the point was set |
TOGS |
TOGGLE_SET |
Count of digital transitions to set state over interval |
RESET |
TIME_RESET |
Time in seconds that the point was reset. |
TIMEMIN |
TIME_OF_MINIMUM |
Time of Minimum returned as a string. Format mm/dd/yyyy hh:mm:ss, example 01/17/2012 14:33:25 |
TOG |
TOGGLE |
Count of digital transitions over interval |
TOGR |
TOGGLE_RESET |
Count of digital transitions to reset state over interval |
This is the value to multiply the result by when using parameter variable types. Commonly used to convert from one unit base to another. For example to convert gallons per minute (GPM) to gallons per day (GPD), set the scale factor to 1440 (1440 minutes per day). To convert seconds to hours use a Scale Factor of 0.000278.
The Filters are used to filter out unwanted values. Blank or the work 'None' means to ignore this option. A Low Range value tells the interface to use this value instead of the value returned. For example, if we set Low Range to 0 (zero), then any negative result returned is set to 0 (zero). A High Range value tells the interface to use this value instead of any values above the value. For example, if we set the High Range to 10, then any value greater than 10 will be set to 10.
NOTE: The Filter is applied first and then the Scale Factor. For example, if the DCS_POINTS_RETRIEVED value is 5 and our Low Range is set to 10 and the scale factor is 3 we will return 30. The value 5 is below the low range of 10, so 10 is used, then the scale factor of 3 is applied (10 * 3) and 30 is returned.