Live Outpost Central Agent

<< Click to Display Table of Contents >>

Navigation:  Live > Agents > Web API Agents > Web API Vendor >

Live Outpost Central Agent

The Outpost Central Agent is a data loading agent available in EQuIS Live that is used to obtain sensor data from the Outpost Central web API.

 

Adding Station

 

Before using the Outpost Central Agent, add one or more stations to the DT_LOGGER table:

1.Execute the equis.get_ids stored procedure to get a new LOGGER_ID, or add the station (DT_LOGGER row) in EQuIS Professional.

2.Set LIVE_DATA_SOURCE to https://www.outpostcentral.com.

3.Set LOGGER_CODE to an Outpost Central Outpost ID (e.g., op1234). Note, these are not available to the general public.

4.Set CUSTOM_FIELD_1 to an encrypted username and password. Please contact EarthSoft to encrypt your username and password.

5.Set STATUS_FLAG to 'A' to activate the logger.

 

Loading Data

 

The Outpost Central 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  Outpost Central Agent and 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 Outpost Central Agent will load data for all loggers with LIVE_DATA_SOURCE set to https://www.outpostcentral.com.

 

When the report is run initially, the agent will retrieve values from a logger's site (DT_LOGGER.LOGGER_CODE) for the past one month. If data has been previously loaded for that logger, the agent will request data from the logger's most recent date (in DT_LOGGER_DATUM.DATUM_UTC_DT) until today's date.

 

The Outpost Central Historical Data Loader allows you to select the loggers and date range. It has the following input parameters:

Logger(s) Select the stations for which to load data. If no stations are selected, the agent will load data for all Outpost Central stations.

Date Range – Select a date range; choose from recent, period, or start and end dates. The recent option works the same way as the Outpost Central Agent. If the period option is selected, a period must be specified in ISO-8601 duration format. If the start and end dates option is selected, start and end dates must be specified.

Update existing values? – Check this box to update existing EQuIS Live data values.

 

A series can be activated or deactivated, by setting its STATUS_FLAG = "A" or "R", to start or stop (respectively) obtaining data for it. A series' SERIES_DESC may be changed, but not the SERIES_NAME and SERIES_UNIT; they uniquely identify the series using the parameter names and units from the Outpost Central API.