One variable MUST be linked to the Utility. This variable can be cross referenced to statistics that the utility returns.
Example:
Return Type: Required, must be set to UTILITY. This field tells the utility to return a value from the run of the utility.
Statistic: Required. The utility can return the COUNT of records written to the DCS_POINTS_TO_PROCESS. At this time, COUNT is the only statistic supported.
The Utility pushes data requests for a specified interface. See Source Configuration, Link to Interface Setting. Each statistic on the Interface tab has different rules associated with it on how the data request should be made. The following table summarizes those rules. NOTE: The utility is running at 5AM on Janurary 2nd, the last time it ran was Jan 1st at 5AM therefore it is getting data for any variables whose time periods (defined by WIMS Start Time, Stop Time, and InterfaceType) have been completed (past).
WIMS Stat |
WIMS Start Time |
WIMS Stop Time |
WIMS Stop Time Type(InterfaceType) |
Request Statistic_dt |
Request Statistic_Start |
Request Statistic_End |
Statistic_Interval |
Statistic_Agg |
Legacy Aggregate(WIMS.UD7) |
Legacy Interval(WIMS.UD8 |
Legacy Flag (WIMS.UD9) |
Average |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
AVERAGE |
AVG |
DC |
B1 |
UVSET |
00:00 |
03:00 |
After |
1/2/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_SET |
SET |
DC |
UV |
UVRAW |
00:00 |
03:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/1/2012 00:00:00 |
1 |
RAW |
RAW |
NONE |
UV |
FIRST |
00:00 |
00:01 |
Same |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/1/2012 00:00:00 |
1 |
RAW |
RAW |
NONE |
NONE |
LAST |
00:00 |
04:00 |
After |
1/1/2012 00:00:00 |
1/2/2012 03:59:59 |
1/2/2012 04:00:00 |
1 |
RAW |
RAW |
NONE |
X1 |
LAST |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
1/1/2012 23:59:59 |
1/2/2012 00:00:00 |
1 |
RAW |
RAW |
NONE |
B1 |
MAXIMUM |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
MAXIMUM_VALUE |
MAX |
DC |
B1 |
MINIMUM |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
MINIMUM_VALUE |
MIN |
DC |
B1 |
TIMESET |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_SET |
SET |
DC |
B1 |
TIMEMAX |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_OF_MAXIMUM |
TMAX |
DC |
B1 |
PREVMAX |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
MAXIMUM_VALUE |
MAX |
DC |
NONE |
PREVMIN |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
MINIMUM_VALUE |
MIN |
DC |
NONE |
PREVSET |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_SET |
SET |
DC |
NONE |
TOGS |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TOGGLE_SET |
TOGS |
DC |
B1 |
RESET |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_RESET |
RSET |
DC |
B1 |
TIMEMIN |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TIME_OF_MINIMUM |
TMIN |
DC |
B1 |
TOG |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TOGGLE |
TOG |
DC |
B1 |
TOGR |
00:00 |
00:00 |
After |
1/1/2012 00:00:00 |
12/31/2011 23:59:59 |
1/2/2012 00:00:00 |
86400 |
TOGGLE_RESET |
TOGR |
DC |
B1 |
FIRST |
08:00 |
09:00 |
Same |
1/1/2012 00:00:00 |
1/1/2012 07:59:59 |
1/1/2012 08:00:00 |
1 |
RAW |
RAW |
NONE |
Z1 |
The Utility will also set the following fields:
FACILITY: Set by the WIMS Facility (i.e. the Oracle User/Schema Owner).
- OPSPL - Set to PL
- OPSNC - Set to NC
- OPSSB - Set to SB
- OPSPS - Set to PUMP STATIONS
- OPSMB - Set to MBC
POINT_ID: Set the WIMS VARDESC.VARID
POINT_NM: Set to the WIMS VARDESC.SCADATAG
POINT_COLLECTION_ID: Set to the WIMS VARDESC.VARNUM
EXAMPLES:
1. Legacy settings of:
- Aggregate: AVG
- Interval:DC
- Flags:B1.
Inserts the following record (request) in DCS_POINTS_TO_PROCESS:
2. Legacy settings of:
- Aggregate: SET
- Interval:DC
- Flags:UV
Inserts the following record (request) in DCS_POINTS_TO_PROCESS:
3. Legacy settings of:
- Aggregate: RAW
- Interval: NONE
- Flags: UV
Inserts the following record (request) in DCS_POINTS_TO_PROCESS: