Data

Events

Purpose: Different events could be created in the Upkip Administration. They are built with a specifically designed expression language that supports a limited amount of operations and functions. Event triggers when defined expression in it returns true. Events trigger warnings and notifications.

When Tags of type Int have defined MIN/MAX values, events are created automatically if the tag value is outside of the defined region.

Create Events manually

Precondition: User with role Administrator is logged in the Upkip Administration.

Select the menu Data/Events.

Figure 1: Upkip Administration - Events

Click the New button to create a new Event.

Figure 2: Upkip Administration - Events - New event fields

Enter the data:

To save the event click Add button.

Search and Add Tag

After selecting the built in function and it includes a tag, the tag can be searched and selected from the organization tag list.

Figure 3: Upkip Administration - New event - add expression with tag

Click on Add Tag button.

Search Tag from all tags

Figure 4: Upkip Administration - new event - search tag

Select tag from Organization tree

The tag can be searched and selected through organization tree with departments and machines.

Figure 5: Upkip Administration - new event - search tag from organization tree

Event could be saved by clicking the Save button.

Create Events and Warnings from Tag limits

Purpose: It is possible when adding a Tag to specify Min or Max values of the tag. It is usually used for numeric tags. To configure the tag limits follow the steps below:

Select the menu Organization.

Browse and locate the machine of interest and click on it.

To the right open Tags tab and use the Filter field to locate the target tag or click on the button Edit at to bottom to edit the tag.

Figure 6: Upkip Administration - Select machine tag

Figure 7: Upkip Administration - Add tag limits with created warnings

Enter the tag value limits for Min and/or Max. You can input only one limit or both.

Below the Min and Max fields there are checkboxes:

Select Menu Warnings and search in the list – e.g. Temp-Pump1

Figure 8: Upkip Administration - Automatically created warnings from tag limits

Select Menu Events and search in the list – e.g. Temp - Pump1

Figure 9: Upkip Administration - Automatically created events from tag limits

Edit Tag with Delete warning checked

It is possible to Delete warnings from Edit tag form.

Edit tag with created warnings for MIN and MAX limits.

Check both checkboxes and click the Save button.

Figure 10: Upkip Administration - Edit tag with checked Delete warning

Warnings

Precondition: Log in to the Upkip Administration. Select menu Warnings.

Purpose:

Figure 11: Upkip Administration - Warnings

Create or Edit Warning

Click on the New button.

Figure 12: Upkip Administration - New warning fields

Enter in the form the following data:

Figure 13: Upkip Administration - Warnings with different severity

Select some warning from the list and lick Edit.

Warning can be edited by changing Name, Severity, Start and Stop event. Click Save button.

Figure 14: Upkip Administration - Edit Warning fields

Delete Warning

Select some warning and click the Delete button.

Figure 15: Upkip Administration - Delete warning

Create Warnings from Tag Limits

Warnings could be created automatically by entering the tag limits min and/or max with selected checkboxes Create Warning. Follow the steps Create warnings from tag limits.

For example: Select machine M45 and tag 27.Override feed. Enter Min=40and Max=80 with checked Create warnings.

Figure 16: Upkip Administration - Warnings of type Alarm

Type of the warning could be edited from Edit warning form and selecting value from the dropdown - Information, Warning or Alarm.

Figure 17: Upkip Administration - Edit warning - change severity

Trigger the warning by submitting value by IoTHub Tester to tag that is outside and entered min-max limits. For example submit telemetry.json

Figure 18: Upkip Administration -Triggering warning by IoT Hub Tester

Visualizing alarms on dashboards

The warnings of type Alarms, Warnings or Information could be visualized on the dashboard panel.

Figure 19: Upkip Visualization -Active warnings on dashboard

Closing alarms and removing warnings from the list

Submit by IoTHub Tester value that trigger stop event for the warning.

For example: for machine M45 and tag 27.Override feed with limits Min=40and Max=80, submit value 90 and it will stop the warning.

Figure 20: Upkip Visualization -Active warnings - removed closed warnings

Notifications

Purpose:

Precondition: Log in the Upkip Administration. Select menu Data/Notifications.

The notifications are shown in a table with columns: Name, Subject and Text. At the last column there is a checkbox – personal or not. There are button for adding New, Update or Delete** notifications.

There are the following types of notifications:

Notifications from Machine Alarms

Purpose: To create automatically email notification from the machine alarms list.

Precondition: User with role Administrator is logged in the Upkip Administration

Create Notification by selecting machine alarm

Select the menu ORGANIZATION. In the organization tree select the machine.

Click on the ALARMS

Figure 21: Upkip Administration - Create notification by selecting machine alarm message

Submit created notification from machine alarm

Find by the filter some alarm(s), select them by the checkbox

Click on the button Create Notification.

Figure 22: Upkip Administration - Edit notification automatically opened

The created automatically notification that is prefilled could be edited and saved.

Figure 23: Notifications - placeholders list

After selecting from the list and click the Add button, the placeholder is inserted in the notification message text.

If alarm message is sent to the machine tag of type Alarm, the event is triggered.

Notification email configured with it also is executed (For example submitted email to user).

Notifications to User Emails

Purpose: Notifications could be configured to submit messages to user email. Notifications are triggered by the events. In the Event is defined expression on some machine or sensor tag. If the event has occurred then the notification is triggered and the defined message in the notification is submitted to the user email.

Configure User in Upkip Administration

Users in the Upkip Administration are configured following the steps Users Management

Log in as a user with the role System Administrator in Upkip Administration.

Find in Users list the user and click Edit. Make sure that user email is configured in the E-Mail field. This is the email to which will be sent an email notification. This email could be different from the username email. In the user's details is entered phone number with area code.

Figure 24: Upkip Administration - User configuration with email

Configure Event and Notification to User Email

Select the machine (or sensor) ID and tag which will be used in the Event configuration.

Select the machine tag by following the steps in Search and add Tag

To create an event see Create event manually

Select menu Notifications.

Figure 25: Upkip Administration - Create notification with media type email

Enter the Name, Message Subject, and Message text.

The Notification will be saved to the Notification list.

Submit Notification to User Email

Simulate event by IoT Hub Tester

Submitted data to the machine tag will trigger the related event.

Notification to email with this event will be executed and submited email to user email.

The email will be from a sender noreply@i4sbased.com (for test environment) with

Figure 26: Notification email with configured message text

Notifications by SMS

Purpose: Notifications could be configured to submit messages to the user phone by SMS. Notifications are triggered by the Event. In the Event is defined expression on some machine or sensor tag. If the event has occurred then the notification is triggered and the defined message in the notification is submitted to the user mobile phone as SMS.

Configure User in Upkip Administration

Configure Users in Upkip

Configure Notification by SMS

Select the machine (or sensor) ID and tag which will be used in the event configuration.

Select the machine tag by following the steps in select machine or sensor Tag

To create an event see Create event manually

Select menu Notifications.

Figure 27: Upkip Administration - Create notification with media type SMS

To create a notification enter:

The Notification will be saved in the Notification list.

Submit Notification by SMS

Simulate event by IoT Hub Tester

Submitted data to the machine tag will trigger the related event.

Notification as SMS with this event will be executed and submitted SMS to user's phone.

Message Text from Notification will come as SMS text.

Notifications to User Viber

Purpose: Notifications could be configured to submit messages to Viber public account. Users subscribed to this account can receive a message from configured Notifications. Notifications are triggered by Events. In the Event is defined expression on some machine or sensor tag. If the event has occurred then the notification is triggered and the defined message in the notification is submitted to Viber Upkip Notifier.

Precondition: Setup Viber account

Configure User in Upkip Administration

Precondition: Users in Upkip Administration have configured following the steps Configure Users in Upkip

Log in as a user with the role System Administrator in Upkip Administration.

Find in Users list the user and click Edit. Enter in the Phone Number with Area code the user phone number that will be used for Viber notification.

Figure 28: Upkip Administration - User configuration with phone number

Configure Event and Notification to Viber

Precondition: User logged in Upkip Administration. Select organization. The left menus for the selected organization are shown.

Select the machine tag by following the steps in Search and add Tag

To create an event see Create event manually

Select menu Notifications. Click New.

Fill in the Notification form the data:

Figure 29: Upkip Administration - Create notification with a message to Viber phone number

Click Save

Figure 30: Upkip Viber invitation email

Subscribe to Upkip Viber Notifier

Precondition: User has received Viber invitation email. The invitation email contains a QR code for Upkip Viber Notifier.

Scanning QR code or clicking on the link is possible only from mobile device.

Оpen the link by clicking on the URL link from the email to gain access to Upkip Notifier Viber public account.

Figure 31: Upkip Viber Notifier

Till a minute user will receive a message to the Viber Upkip Notifier

Figure 32: Upkip Viber Notifier prompt for subscribe message

Type on the chat and submit a message with text

.subscribe [email_address@example.net]

Figure 33: Upkip Viber verification email

Open the received email and click on the link Verify to make email verification.

Figure 34: Upkip Viber Verification confirmation page

Figure 35: Upkip Viber successful subscription

Submit Viber Notification

Preconditions:

Simulate the event with IoT Hub Tester to trigger the event and notification to Viber

Simulate event by IoT Hub Tester

When some event is triggered, a notification with Media Type=Viber and Destination=User has to submit a message to the user Upkip Notifier Viber account.

Notifications to Microsoft Teams

Purpose: Notifications could be configured to submit messages to Microsoft Teams channel were invited to Team peoples can read them and reply. Notifications are triggered by the Event. In the Event is defined expression on some machine or sensor tag. If the event has occurred then the notification is triggered and a defined message in the notification is submitted to configured teams channel. To work notifications to Teams, the member Upkip.Notifier@icb.bg has to be added to the Team.

Microsoft Teams Configuration

The user should be the owner or invited to some Team in Microsoft Teams.

The user has opened Microsoft Teams and views created Teams and channels

Figure 36: Microsoft Teams Configuration

After creating some Team default channel General has created.

Additional channels can be added to the team.

Figure 37: Microsoft Teams Configuration - Add channel

Right-click on the Team menu and select Manage Team

Figure 38: Microsoft Teams Configuration - Manage Team

Type in the member search field – Upkip Notifier. If the member is not added to the team click Add member and type Upkip.Notifier@icb.bg and add to the team.

Figure 39: Microsoft Teams Configuration -Manage Team - Add member Upkip Notifier

Get the channel link by right-clicking on the channel menu and selecting Get link to channel.

Figure 40: Microsoft Teams Configuration - Channel - Get link to channel

Copy the link to the clipboard by clicking on the Copy button

Figure 41: Microsoft Teams Configuration -Copy link to channel

Configure Event and Notification to Teams

Precondition: Log in to the Upkip Administration.

Select organization for which will be configured events, notifications and messages submitted to the Microsoft Teams.

Select Machine or Sensor Tag

Select menu Organization and expand the organization tree. Find the machine, its sensor ID, and Tag, for which will be created Event.

Figure 42: Upkip Administration - Get machine ID

Sensor ID will be used when simulating and submitting telemetry for the machine tag.

Click on the tab TAGS and select machine TAG. Tag Name and Payload are important when submitting and simulating telemetry for the machine and tag

Figure 43: Upkip Administration - Get machine tag payload

Configure Event for the selected Tag

Select menu Events.

Figure 44: Upkip Administration - Create event with expression

Create a new event for the selected tag name. Click on the New button, enter event name, enter expression and click Save.

Figure 45: Upkip Administration - Created event in events list

Configure Notification with created Event

Select menu Notifications.

Figure 46: Upkip Administration - Create notification with destination Teams

To create notification enter:

The created Notification will appear in the Notifications list.

Simulate event by IoT Hub Tester

Configure Azure IoT Hub Tester in the selected environment. The application will be used to submit telemetry to the selected machine tag with data that will trigger the created event and then notification. The message text in the notification will be submitted to the Microsoft team channel.

Prepare Telemetry JSON

Figure 47: IoTHub Tester - simulate submitting value to machine tag

IoT Hub Tester is connected to Azure Environment and created device.

Submit Telemetry JSON Important data in the Telemetry.json are: Sensor ID, Payload Type, and Payload Data, submitted to machine tag. The timestamp could be changed.

View submitted data in Upkip Visualization In the document Telemetry DataFlow.docx, in the topic Visualize Data, is described how to view in created dashboard submitted data for tag.

Figure 48: Upkip Visualization - View submitted data on test dashboard

If simulated data are visible in the visualization application, event and notification are configured properly, the message from notification should be listed in the Microsoft Team channel.

Submit Messages to Microsoft Teams

Open Microsoft Teams and select created channel for notifications.

Figure 49: Microsoft Teams - View submitted message from notification

When event and notification are triggered, the message is submitted to the Teams and will be visible to all members of the team.

Figure 50: Microsoft Teams - Reply to Upkip Notifier message

The members of the Team can click Reply, notify someone about the message by typing ‘@’ before their name.

Notification channels allowed time interval

Purpose: Configuration of the allowed time interval for notifications for the user allows to disable receiving notifications by Viber, Email, or SMS for time outside of the defined allowed time interval.

Precondition: User with role administrator is logged in Upkip Administration.

Configure Notification channels for a user with allowed time interval

Open the users list by clicking on the users' icon.

Figure 51: Upkip Administration - Open users list

From the users' list select the user and click Edit.

Figure 52: Upkip Administration - Configure user with an allowed time interval for notifications

Configure Notifications to Email, SMS, Viber

Configure events and notification to user email following the steps Configure Event and Notification to User Email.

Configure events and notification to user phone by SMS following the steps Configure Event and Notification to User phone by SMS

Configure event and notification to Upkip Viber Notifier following the steps Configure Notification to Viber and Subscribe to Upkip Viber Notifier

Submit Notifications within or outside of the allowed time interval

Submit notification to user email following the steps Submit Notification to User Email.

Submit notification to user phone by SMS following the steps Submit Notification to User Phone by SMS

Submit notification to user phone by Viber Upkip Notifier following the steps Submit Viber Notification.

Trigger the event and notification for each notification channel during the specified time interval.

Trigger the event and notification for each notification channel outside the specified time interval.

Calculated Tags

Purpose: Calculated tags are used to execute expressions on the base tag values and assign results to the Result tag. To create the expression built-in functions can be used.

Base and Result Tags

Create Base and Result tags that will be used for the definition of the calculated tag.

Select Organization and some machine under department – e.g. Legiomix

Figure 53: Upkip Administration -Edit machine -Select tags for base and result tag

Add a tag with type INT that will be used as Base Tag following the steps Search and add Tag

Add tag with type INT that will be used as Result Tag

Add Calculated Tag

Precondition: User is logged in Upkip Administration. Base and Result Tags are created. Select menu Calculated Tags.

Figure 54: Upkip Administration - Calculated Tags

Click the New button.

Figure 55: Upkip Administration - Add new calculated tag

Enter the following data in the form:

Search for Base and Result Tags

Figure 56: Upkip Administration - New Calculated tag - Select base and result tags

Figure 57: Upkip Administration - New calculated tag - select tag by display name

After adding the tag or display name they are filled read-only in the fields for Base tag and Result Tag

Figure 58: Upkip Administration - New calculated tag - Selected base and result tags

Add Expression

When creating a calculated tag is possible to create an expression that will be executed on the base tag. The result of execution will be written to Result Tag.

Figure 59: Upkip Administration - New calculated tag - Add expression

To create expression can be used:

Figure 60: Upkip Administration - New calculated tag - Add expression operators

Figure 61: Upkip Administration - New calculated tag - Add parameters

The expression parameter has Name, Type and Value. Use in expression with its name.

After filling the required fields – Name, Result, Base, and Expression, click Save

For example:

Figure 62: Upkip Administration - Saved calculated tag in the list

Built-in Functions

To add function in expression click on the button + Add Function.

When selecting some function on the right side appears Description and example.

Select function and click Add button.

Figure 63: Upkip Administration - New calculated tag - Add expression - Built-in functions