Event Triggered Reports

(Continued from Creating a Report)

You can configure a report to be sent on an event by selecting Send Report: On Event:

You will then need to choose the event to trigger the report. You must select from among configured notifications, so you will need to configure one if you haven't already. In this example we'll configure a trigger for Site 1/battery/1/lifetimeWh <= 100 Wh. To do so start by searching for the lifetimeWh tag and clicking it:

In the menu that pops up, click Tag Settings:

Then in the Tag Settings Dialog that appears, click Notifications:

And in the Tag Notifications dialog that appears, click Add Notification:

Enter the following values for the notification condition:

And then we'll change the severity from Alarm to None, since we only want to this to trigger our report, not send us an alarm notification:

Finally, click OK to create the trigger and click OK in the Tag Settings dialog:

Now we can connect this to our report. Under Report End Event, click Choose Trigger:

A Select Trigger dialog will appear that allows you to search for a trigger event among notifications you've configured. In this example we'll search for "lifetime":

Then click on the trigger row (trigger rows are blue) to select it:

Click OK and then you should see this trigger event displayed as the Report End Event. When this event occurs, it creates a report ending at the event time and sends it.

You can configure the Report Length to be either a Fixed Time Length before the Report End Event, or Since Another Event:

Fixed Time LengthSince Another Event

If you select Since Another Event, you'll need to select the Report Begin Event in the same manner as you selected the end event, and enter the Max Report Length (if the begin and end events occur farther apart in time than the max report length, the report will only go back to the max report length amount of time before the end event).

Next enter the Minimum Time Between Reports. Clarity will not send reports more often than this time interval, even if the trigger event occurs more frequently:

The Data Interval controls the amount of time between individual data points in the report. For example with a Data Interval of 1 hour, each row of the report will summarize one hour of historical data:

And you can select whether to include the Average, Min, and/or Max tag values for each data interval in the report:

To select email recipients, click the + button in the Report Recipients panel:

Then in the dialog that appears, check all the users and groups you want to receive emails:

After you click OK you should see the selected users and groups in the Report Recipients panel:

To download a sample of what the CSV report will look like, click Download Sample at the bottom of the form:

Finally, click Save Settings at the bottom of the page to create the report:

Last updated