eGuard Fundamentals

Basic concepts and eGuard usage

eGuard: Groups

eGuard has a hierarchical group structure. Devices exist in a top-level group or sub-group of a top-level group. Sub-groups are separated by the parent group with a colon. There is no defined limit for the number of sub-groups that can exist.

An eGuard user may have access to multiple top-level groups and sub-groups, if for example they manage devices for multiple companies.

 

image-1593537573061.png

From main eGuard Portfolio view

The above image, taken from the main eGuard Portfolio view, shows 6 devices. They all exist under the Sunnyvale top-level group. There are 4 devices in two sub-groups: "Main Housing" and "Shared Space 1" are both sub-groups to Sunnyvale.

Groups Management Page

The Groups Management Page can be found in eGuard at the top tab bar.

image-1593471317012.png

eGuard Groups Management Page

The top page allows you to set a default group to display in the Portfolio view if you have access to multiple groups, or you have multiple sub-groups of devices.

Create Group

Here you can create sub-groups in any of the groups you administrate. Sub-groups can be created under sub-groups.

For example, this would create a sub-group "East" under the "Main Housing" sub-group of Sunnyvale:

image-1593471525666.png

There would now be a group called Sunnyvale: Main Housing: East

 

Descriptive Example of hierarchy

Fruit: Pear
Fruit: Apple: Fiji
Vegetable
Vegetable: Garlic
Vegetable: Lettuce
Vegetable: Lettuce: Iceberg
Vegetable: Lettuce: Romaine

Here, Fruit is the parent to Pear, and Fruit is also the parent to Apple (it is a top-level group). If a user has access rights to group Fruit, those access rights also apply to Pear and Apple, and any sub-groups of those such as Fiji. No access to Vegetable or the sub-groups of Vegetable are granted.

If a user has access rights to Pear, those rights would not apply to Apple Or Fiji or any devices directly under Fruit.

Similarly, a user with rights to Fiji would have no rights to devices under Pear or Apple or Fruit, only access to those devices under the Fiji sub-group.

 

Fruit contains no devices in the Vegetable group. Vegetable: Garlic is separate from Vegetable: Lettuce and all its sub-groups of Iceberg and Romaine.

 

A user can have access to any mixture of sub-groups with different permissions. For example, a user can have administrative access over devices in Vegetable: Lettuce and also have management access to Fruit: Apple. They would not have access to devices directly in Fruit, Fruit: Pear, Vegetable, and Vegetable: Garlic.

 

eGuard: Permissions

The eGuard Permissions page can be found in eGuard at the top tab bar. Permissions allow you to grant and manage user privileges, as well as request access from other eGuard users.

image-1593469697276.png

eGuard Permissions Page

Permissions for each level are described at the top of the page:

Request Access

If you have no privileges, you may request access from another eGuard user via username. If no other user has permission to the group, eGauge Support will need to be contact to grant initial access to a user.

Create Group Permission

You can only create permissions for users that already have some type of access to a group you administer that appears in the User Permissions table.

You can grant additional privileges to users here, such as to additional sub-groups for groups you administrate.

User Permissions

A table displays of all user permissions to groups you administrate, displaying the group and permission level for each user login. Sub-groups are separated by colons.

Edit Permission Change the user's Group or Permission level.
Delete Permission Revoke the user's access to the group. Only applies to that row permission, if user has access to multiple groups (multiple permission entries) each entry needs to be deleted.

Permission Examples

General Description

For example, given groups:

Fruit:Pear
Fruit:Apple:Fiji

Here, Fruit is the parent to Pear, and Fruit is also the parent to Apple. If a user has access rights to group Fruit, those access rights also apply to Pear and Apple, and any sub-groups of those such as Fiji.

If a user has access rights to Pear, those rights would not apply to Apple Or Fiji or any devices directly under Fruit.

Similarly, a user with rights to Fiji would have no rights to devices under Pear or Apple or Fruit, only access to those devices under the Fiji sub-group.

 

Example from eGuard

image-1593469308386.png
Portfolio page showing 6 Sunnyvale devices

 

image-1593469729133.png

Permissions page showing Sunnyvale permission management

Here is the effective user permission list:

Username Group Device Permission
user Sunnyvale eGauge9996 Administrator
user Sunnyvale eGauge9998 Administrator
user Sunnyvale: Main Housing eGauge9992 Administrator
user Sunnyvale: Main Housing eGauge9993 Administrator
user Sunnyvale: Shared Space 1 eGauge9994 Administrator
user Sunnyvale: Shared Space 1 eGauge9995 Administrator
user2 Sunnyvale eGauge9996 Manager
user2 Sunnyvale eGauge9998 Manager
user2 Sunnyvale: Main Housing eGauge9992 Manager
user2 Sunnyvale: Main Housing eGauge9993 Manager
user2 Sunnyvale: Shared Space 1 eGauge9994 Manager
user2 Sunnyvale: Shared Space 1 eGauge9995 Manager
user3 Sunnyvale: Main Housing eGauge9992 User
user3 Sunnyvale: Main Housing eGauge9993 User

 

If there were additional groups and devices under Sunnyvale: Main Housing such as Sunnyvale: Main Housing: East and Sunnyvale: Main Housing: West, then user3 would also have user permissions to devices in that group.

eGuard: Alerts

eGuard offers limited alert functionality. eGuard processes alerts once a day (around midnight). If there are devices that change from non-alert status to alert status, or change from alert status to non-alert status, they will be listed in an email sent to the eGauge.net user's email.

You will only receive emails when devices change into an alerted state, or when that alerted state is resolved. If eGuard sends a low production alert for eGauge1234 and it continuous to have low production for the next week, you will only have received an email the first time it entered low production. A new email will be sent when that device leaves the low-production alert state (starts producing minimum levels).

Alert types

Creating Alerts

The eGuard Alert page can be found in eGuard at the top tab bar.

image-1593541893651.png

eGuard Alerts Page: Create an Alert

In the above example, we are creating an alert for if Usage in the past 24 hours exceeds 1,000 kWh. This alert is only for devices in group "Sunnyvale: Shared Space 1" that is, for only devices under the sub-group "Shared Space 1" in "Sunnyvale". Any devices directly under "Sunnyvale", or other sub-groups such as "Sunnyvale: Main Housing" will not be monitored for this alert.

From a previous eGuard group example:

image-1593537573061.png

The above alert configured will only affect eGauge9994 and eGauge9995. No other devices will be affected by this alert.

 

Deleting existing rules

image-1593546791151.png

Viewing 3 configured alerts

Any configured alerts will show in the Alert Management table. Above image shows an Energy Generated (low generation) alert for the "Solar Farm" sub-group of Sunnyvale, an Energy Used (high usage) alert for devices under the "Shared Space 1" sub-group of Sunnyvale, and finally a Lack of Connection alert configured for all devices under the Sunnyvale top-level parent group.

You may edit an alert configuration by using the "Edit Alert" button. To delete an alert rule, use the "Delete Alert" button.

Viewing triggered alerts

image-1593547287799.png

Viewing 3 triggered alerts

Any triggered alerts will display in the "Active Alerts" table. An entry remains in this table until it is no longer in the triggered state. For example, if eGauge9996 produces more than 72 kWh of energy before the next daily alert check, it will no longer be triggered and entry removed from this page.

Any time an entry is added or removed from this page, it is included in the daily email. If no entries are added or removed from this table during the daily alert check, no email is generated.

 

eGuard: Sites

Sites allow for a grouping of devices based on location, and has fields to add information relevant to that
particular location, geared towards solar production. Multiple devices can be added to a single Site where they can easily be cross-referenced for troubleshooting or other purposes. Devices can be added or removed from Sites as needed.

The eGuard Sites page can be through eGuard at the top tab bar.