Portal's Event Overview
Portals provides a management interface for the Data Rule and Dispatch resources of One Platform Clients and calls these Events and Alerts. Events (Data Rules) are triggered true or false resources, much like Data Ports (Data Sources) hold time series data. Data Rules can only be in a state of 1 (active) or 0 (inactive). Within Portals a user can add new events, edit them, and use different visualization widgets within dashboards to show event periods and status. Not only can it be important to see when and for how long a condition occurred, but also to trigger some action, like an email alert.
The data rules used by events have a set number of logical conditions which the Portal's event setup wizard walks the user through.
Thinking about a basic event condition on temperature data, an event could be set up to look for a condition in which the temperature is below a value, let’s use 40 degrees. Perhaps you want to know when this happens and how long, so the logged activity and timeline graph is important to look at. You may also want to be notified of this using an alert, say receive an email.
The Portals Event creation includes the following event condition types:
True while the condition is met, False otherwise.
True if no data has been received for the duration specified, False otherwise
True if the condition is met for the specified duration, False otherwise.
True if the condition is met the number of times specified by the Count Limit during the specified duration, False otherwise.
Adding a new Event
Let’s assume no events or alerts have been set up. Your screen should look something like the image below.
Let’s add a new event and assume there are active data sources, most likely the default public temperature data sources that are added with each new account. Start by clicking the ‘Add Event’ button. At wizard box should open up and look like this figure. Choose the data source you want to event on. Click ‘Continue’.
Next give the event a name, for example “Cold Temperature” in this diagram. Select a event condition type, like ‘Duration’ as shown here. The duration event type looks for the event condition to be true for some amount of time. In this example the comparison is ‘Less than or Equal to”. You might ask why we use a duration, in this case I know that temp data can sometimes hover around a value going back and forth just slightly. By asking for a duration, it essentially lets the value settle, so that the event condition does not trigger multiple times in a short span of time.
Click ‘Continue’ and you should see this new event added to your list on the event page.
Clicking on an event will open a configuration pop-up window that shows logged information on the event and a timeline graph.
That’s it, you have a new event.
Alerts are dispatch client resources from the platform, triggered by a logica data rule (event) or a script. Within Portals a user can add new, edit, and check logs of alerts. These can be useful to be notified that an event condition has occurred. Multiple alerts can be created for an event, perhaps if notification needs to go to multiple individuals.
Alerts available to users in Portals include email and SMS text messages. Other dispatch alerts are available for developers from the Platform using API or scripting functionality
Important Note: SMS Phone Numbers should include the “+1″ (country code) at the beginning. (e.g. for a US number: +16121234567 for 612-123-4567; for a Taiwan number: +886912345678 for 0912-345-678)
Adding a new Alert
Now with an event created (you can not have an alert without an event). Your screen should look something like the image below. Let’s add an alert.
Start by clicking the ‘Add Event’ button. At wizard box should open up and look like this figure. Choose the event you want to alert on. Click ‘Continue’.
Next give the alert a name, for example “Cold Alert” in this diagram. Set the interval, which is the time period in which it will resent the alert if the event stays true. (Be careful with the interval, if you set it at 5 seconds, you’ll get your alert every 5 seconds). The suggested value is 0, which will only allow it to be sent once, when the event first becomes true.
Select an action, like email or SMS. (Your plan may or may not include SMS) Set the contact information, in this example an email address, the email subject and email body message.
Click ‘Continue’ and you should see this new alert added to your list on the event page.
Clicking on an alert will open a configuration pop-up window that shows logged information on the alert and a timeline graph.
That’s it, you have a new alert.