Green Power Monitor

JVM AGENT

Overview

The Green Power Monitor connector enables Seeq to access data from Green Power Monitor’s GPM Portal, a cloud-based offering. GPM’s Plants and Elements are indexed as a Seeq asset tree with GPM’s Datasources as signals.

Prerequisites

There are no prerequisites for connecting to Green Power Monitor.

Configuration

This is an example configuration template that is displayed in the Additional Configuration box that appears when you click Configure for an existing datasource (or if a new datasource is being created, in the Create new datasource connection modal that appears after clicking Add Datasource) on the Datasources administration page.

JSON

{
    "BaseUrl" : "<Insert the base URL for accessing the GreenPowerMonitor API>",
    "Username" : "<Insert the username or a reference to a Secrets file containing it>",
    "Password" : "<Insert the password or a reference to a Secrets file containing it>",
    "MaxRequestIntervalDays" : 20,
    "IndexThrottleAllowedApiCallsPerSecond" : 19.0,
    "ConnectTimeoutInSeconds" : 10,
    "ReadTimeoutInSeconds" : 30,
    "CallTimeoutInSeconds" : 30
  }

Green Power Monitor Additional Configuration

Property Name	Default Value	Data Type	Description
`BaseUrl`	A help text that must be replaced	String	The URL for accessing Green Power Monitor’s API for a specific GPM Portal instance. It might look like `https://webapi<CUSTOMER_NAME>.horizon.greenpowermonitor.com/`.
`Username`	A help text that must be replaced	String	The username to access the GPM API.
`Password`	A help text that must be replaced	String	The password to access the GPM API.
`MaxRequestIntervalDays`	`20`	Integer	The largest interval (in days) that Seeq is allowed to request in a single GPM API call to obtain signal data. Requests larger than this value will be split into smaller ones. This is used to address a GPM API limitation where requests that are too large return errors.
`IndexGPMPropertiesAsScalars`	`false`	Boolean	Whether Plant parameters should be indexed as Scalars instead of Asset properties.
`IndexThrottleAllowedApiCallsPerSecond`	`19.0`	Number	The maximum number of GPM API calls per second that Seeq is allowed to make during indexing. This is used to avoid going over GPM API rate limits. For example, if a GPM instance only allows 6,000 API calls per 5 minutes, this value should be set to less than 6,000/(5 * 60) = `20`.
`ConnectTimeoutInSeconds`	`10`	Integer	The maximum number of seconds to wait for API connections.
`ReadTimeoutInSeconds`	`30`	Integer	The maximum number of seconds to wait for API reads.
`CallTimeoutInSeconds`	`30`	Integer	The maximum number of seconds to wait for API calls.

Known Issues

Due to a current limitation of Green Power Monitor’s API, samples that occur during the fall back of Daylight Saving Time (DST) might not be displayed in Seeq. For example, samples occurring on 11/06/2022 from 1 am to 2 am for Plants in the US are not displayed. The API limitation has been reported and acknowledged by Green Power Monitor.

Please report any issues you find to our support portal.

Troubleshooting

If you are running into issues with connecting to or accessing data from Green Power Monitor, view our guide for troubleshooting datasource issues.

Performance considerations

View our guide on optimizing datasource performance for general guidance.