In-Situ HydroVu Agent
Copyright © 2018 EarthSoft, Inc • Modified: 12 Dec 2018
The In-Situ HydroVu Agent is a data loading agent available in EQuIS Live for obtaining data from In-Situ HydroVu.
Before using the In-Situ HydroVu Agent, add one or more locations to the DT_LOGGER table:
1.Execute the equis.get_ids stored procedure to get a new LOGGER_ID or add the location (DT_LOGGER row) in EQuIS Professional.
2.Set LIVE_DATA_SOURCE to In-Situ HydroVu.
3.Set LOGGER_CODE to a location's ID. To get a location ID:
a.Go to In-Situ HydroVu.
b.Click Authorize, enter your credentials (not the demo credentials), and click Authorize.
c.Under the Locations header, click - View the list of locations accessible to your account > Try it out > Execute.
d.The location ID(s) are under the Responses header (e.g., 5175941652283392).
4.Set CUSTOM_FIELD_1 to your encrypted authorization credentials. The credentials can be client IDs and client secrets (e.g., grant_type=client_credentials&client_id=PublicApiDemo&client_secret=PublicApiSecret), or usernames and passwords (e.g., email@example.com&password=letmein). Please contact firstname.lastname@example.org to encrypt your authorization credentials. If the authorization credentials are too big to fit in CUSTOM_FIELD_1, they can overflow into CUSTOM_FIELD_2 and CUSTOM_FIELD_3.
5.Set STATUS_FLAG to 'A' to activate the logger.
Before using the In-Situ HydroVu Agent or Historical Data Loader, the parameters and units must be added to the RT_REMAP and RT_REMAP_DETAIL database tables, for example by using this SQL file. The file contains all of the parameters and units that are recognized by HydroVu (In-Situ HydroVu > Authorize > Friendly Name Lookup > Try it out > Execute). (The parameters and units are the same as those used by In-Situ probes, which are listed in the In-Situ Modbus Communication Protocol document, in Appendices D and E.)
After the parameters and units have been added to the RT_REMAP and RT_REMAP_DETAIL tables, and the In-Situ HydroVu Agent or Historical Data Loader is run, the remapped parameters will be added to DT_LOGGER_SERIES.SERIES_DESC, and the units will be added to RT_UNIT.UNIT_CODE and DT_LOGGER_SERIES.SERIES_UNIT (when a new series is added).
Note: The RT_REMAP_DETAIL internal_values and external_values are swapped, so that multiple 'external' values can be remapped to the same 'internal' value. See the example below.
Adding these two rows is not possible due to the unique key constraint AK_RT_REMAP_DETAIL
•One row with external_value = 'Micrograms Per Cubic Meter', internal_value = 'ug/m3'
•One row with external_value = 'Micrograms / Cubic Meter', internal_value = 'ug/m3'
Rather, these two rows must be added as
•One row with internal_value = 'Micrograms Per Cubic Meter', external_value = 'ug/m3'
•One row with internal_value = 'Micrograms / Cubic Meter', external_value = 'ug/m3'
The In-Situ HydroVu Agent or Historical Data Loader can be run as a scheduled EQuIS Information Agent (EIA), at the desired frequency, to automatically load data as often as needed.
The In-Situ HydroVu Agent or Historical Data Loader can also be run in EQuIS Professional or Enterprise (using the EZView widget) to load the data manually, without having to schedule an EIA.
The In-Situ HydroVu Agent will load data for all loggers with LIVE_DATA_SOURCE set to In-Situ HydroVu. The agent will request data from the logger's most recent date (in DT_LOGGER_DATUM.DATUM_UTC_DT) until today's date. If a logger does not have any values, the agent will get values for the past month.
The In-Situ HydroVu Historical Data Loader allows for the selection of the loggers, date range, and whether or not to update existing values.
The In-Situ HydroVu Agent and Historical Data Loader adds a DT_LOGGER_SERIES for each of a location's parameters. A series can be deactivated, by setting its STATUS_FLAG = R, to stop obtaining data for it. A series' SERIES_DESC and SERIES_UNIT may be changed, but not the SERIES_NAME; it uniquely identifies the series using the parameter IDs and unit IDs from the In-Situ HydroVu API.