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.
In the section is described:
- Create new event
- Create events and warnings from tag limits
- Delete events and warnings from tag limits
Create new event
Precondition: The user with the role Administrator is logged in to the Upkip Administration.
Select the menu Data/Events.
- The list of all events in the system is shown
Figure 1: Events list
Click the New button to create a new event.
Figure 2: Events - New event
Fill in the data:
- Name of the event (1)
- Expression of the event (4). Expressions are defined by using Function from +Add Function(2) and Tags by +Add Tag(3)
- To create an expression used some operators:
- Math operations: -, +, *, /, ^, sqr
- Logical operations: Use & or |
- Comparison operators: <, >, <=, >=, =, !=
- User parentheses () to set the order of operations;
- Expression parameters (5) are possible to define with Name, Type (Number, Boolean, String, DateTime), and Value.
To save the event click the Add button.
- The created event appears in the list of events by (Name and Expression)
Add function in expression
Precondition: The New event form is opened. Click the button +Add Function to select a function for expression from the Built-in functions list:
Figure 3: New event - Add function - built-in functions
Select a function from the list and click the Add button
- The function is added in the expression field in a New event form.
The following list of built-in functions are developed:
- Abs
- AlarmSeverity
- Ceiling
- Contains
- CountTagValues
- CountValues
- Date
- DisplayNameToTag
- Floor
- GetMetadata
- GetStatusNames
- GetTagNameByTagType
- GoOverLimit
- GoOverOrEqualToLimit
- GoUnderLimit
- GoUnderOrEqualToLimit
- IF
- IndexOf
- LastValue
- Len
- Log10
- MachineProperty
- MAX
- MaxForPeriod
- MIN
- MinForPeriod
- now
- nowUTC
- Pow
- PreviousValue
- PreviousValueTime
- SPEED
- Sqrt
- Substring
- SubstringLen
- SUM
- TimePerValue
- TimePerValueExtra
- TimePerValueMultiple
- Trim
- TypeNameToTag
- ValueOf()
Add tag in expression
Precondition: The New event form is opened. Click the button +Add Tag to search and add tag in the expression field when creating an event.
Figure 4: New event - add tag in expression
Click on Add Tag button.
- The Select tag form is opened.
Select a tag from all tags
Precondition: The Select tag form is opened.
There is possible to search for and select a tag between all tags.
Figure 5: New event - search tag from all
- Filter tags by Name or Display Name and click Search. The tags are filtered.
- Select a tag from the list. The Select Tag button is enabled.
- Click the Select Tag button.
- The selected tag appears in the expression field.
Select a tag from organization tree
Precondition: The Select tag form is opened.
There is possible to search for and select a tag thourgh organization tree with departments and machines.
Figure 6: New event - search tag from organization tree
- Click on the tab Organization (1).
- The organization tree with departments and machines is shown.
- Expand the organization tree with departments, and select some machine (2).
- The list of tags for the selected machine is listed on the right side.
- Filter the tags by typing in the Filter (3) field.
- Select the tag from the list. The Select Tag button is enabled.
- Click the Select Tag
- The selected tag appears in events expression field.
Add parameters in expression
Precondition: The New event form is opened.
There is possible to define parameters for the expression field.
Figure 7: New event - define parameters for expression
- The defined parameters can be used in the event expression field.
Create events and warnings from tag limits
Precondition: The machine is selected in the organization tree. The tab TAGS is selected. The New tag form is opened.
Purpose: When adding a Tag of type INT is possible to specify Min or Max values of the tag.
To configure the tag limits follow the steps below:
- Select the menu Organization.
- Select the machine in the organization tree.
- Click the tab Tags. Filter the tags. Click the button Update to edit the tag.
Figure 8: Machine - Select machine tag
- The Edit tag form is opened.
Figure 9: Machine- Edit tag - create warnings from tag limits
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.
- Check both and click Save.
- Automatically are created a relevant Events and Warnings which can be seen in the Events and Warnings lists.
Select menu Events and search in the list – e.g. Temp - Pump1
Figure 10: Events - аutomatically created events from tag limits
- The events are created automatically for the MIN and/or MAX limits of the tag.
Select menu Warnings and search in the list – e.g. Temp-Pump1
Figure 11: Warnings - automatically created warnings from tag limits
- The warnings are created automatically with created events for the MIN and/or MAX limits of the tag.
Delete events and warnings from tag limits
Precondition: There are created events and warnings from tag limits.
It is possible to delete events and warnings from the Edit tag form.
Select the tag with created events and warnings from tag limits. Click the Update button.
- The Edit tag form is opened.
- In the form are visible checkboxes Delete warning.
Figure 12: Edit tag - checked Delete warning
Select checkboxes Delete warning and click the Save button.
- All events and warnings automatically created from tag limits will be deleted.
Warnings
Precondition: Log in to the Upkip Administration. Select menu Warnings.
Purpose:
- The warnings are created with different severity: Information, Warning, or Alarms.
- Warnings have start and stop events .
- Warnings could be created automatically when entering Tag limits. Create events and warnings from tag limits.
- Warnings could be visualized on the dashboard to indicate that some tags values are not within the limits.
Figure 13: Warnings list
In the section are described:
Create Warning
Precondition: The menu Warnings is selected. The warnings page is opened. The events are created. Click on the New button.
- The NEW Warning form is opened.
Figure 14: Warnings - create new warning
Enter in the form the following data:
- Name (1) of the warning.
- Severity(2) – select the severity of the warning from the dropdown list - Information, Warning, Alarm.
- Select the start event (3) from the list of events.
- Select the stop event (4) from the list of events.
- Click Add.
- The created warning appears in the warnings list with its Severity and Name.
Figure 15: Warnings with different severity
Edit Warning
Precondition: The menu Warnings is selected. The warnings page is opened.
Select some warning from the list and lick the Update button.
- The Edit Warning form is opened.
The warning can be edited by changing the Name, Severity, Start and Stop event. The warning severity is selected from the dropdown list: Alarm, Warning, Information.
Click the Save button.
- The warning is updated.
Figure 16: Edit Warning
The Severity of the warning could be edited by selecting a value from the dropdown - Information, Warning or Alarm.
Figure 17: Edit warning - change severity
Delete Warning
Precondition: The menu Warnings is selected. The warnings page is opened.
Select some warning from the list and click the Delete button.
- The confirmation warning is shown. Confirm with the Delete button.
Figure 18: Upkip Administration - Delete warning
- The warning is removed from the warnings list.
Warnings from Tag Limits
Purpose: Create automatic warnings when entering tag limits.
Warnings could be created automatically by entering the tag limits min and/or max values with selected checkboxes Create Warning.
- On saving the tag are created automatically events and warnings.
Follow the steps Events/Create events and warnings from tag limits.
Figure 19: Warnings from tag limits
Deleting warnings created from tag limits is possible automatically following the steps Event/Delete warnings from tag limits
Notifications
Purpose:
- The notifications are used to notify users about some events.
- The event should be created before using it in a notification. To Create New Events
- Nonfictions are possible to be by email, SMS, Viber messages, or Teams messages.
- In the notification message text is possible to use placeholders that extract different system information.
Precondition: Log in to the Upkip Administration. Select menu Data/Notifications.
- The page Notifications is opened.
Figure 20: Notifications list
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 buttons for New, Update or Delete notifications.
There are the following types of notifications:
Notifications from machine alarms
Purpose: To create automatic email notifications from the machine alarms list.
Precondition: The user with the role Administrator is logged in to the Upkip Administration
Select the menu ORGANIZATION. In the organization tree select the machine. Click on the tab ALARMS.
- The list with machine alarms is shown.
Figure 21: Create notification by selecting machine alarms
Find by the filter some alarms, and select them by the checkboxes.
Click on the button Create Notification.
- Automatically is created Event for the selected alarms.
- The form Edit Notification is opened with the filled Name and created an event in the Events list.
Figure 22: Upkip Administration - Edit notification automatically opened
The created automatic notification that is prefilled could be edited and saved.
- Name: Sensor ID Alarm Notification
. - Message Subject: Sensor ID Alarm Occurred.
- Message Text: Filled with place holders {EVENTTIME}: "{TAGVALUE}". There is possible to add additional text or insert placeholders from predefined.
- To insert placeholders click the Placeholders button
Figure 23: Notifications - placeholders list
After selecting from the list and clicking the Add button, the placeholder is inserted in the notification message text.
- Events: Automatically is selected created Event for selected alarm.
- Addresses: Automatically are added Media Type=Email, Address Type=User, and Address=email of the user. The email of the user can be changed by selecting from the list.
If an alarm message is sent to the machine tag of type Alarm, the event is triggered.
Notification email configured with it also is sent to the 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 a 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 a role System Administrator in to the 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 a phone number with the 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.
- The list of notifications for the organization is shown with name, subject, and text. Click the New button to create a new notification
Figure 25: Upkip Administration - Create notification with media type email
Enter the Name, Message Subject, and Message text.
- Message Subject will appear as Email Subject
- Message text will be shown as the email text of the message.
- There is possible to select some predefined placeholders by clicking on the +Placeholders and selecting from the list.
- Click the Add button to add an event. Select from the list the created event. Create event manually
- Click the the New to enter Address, Media Type, and Address Type.
- For Media Type select Email
- For Address Type select User.
- For Address, click and select user from the list with users
- Click Save to save the notification.
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.
A notification email with this event will be sent to user's email.
The email will be with:
- Email Subject equal to Notification Message Subject
- Email message text equal to Notification Message Text
Figure 26: Notification email with configured message 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 the events. In the event are defined expressions on some machine or sensor tag. If the event has occurred then the notification has been triggered and the defined message in the notification is submitted to the Viber Upkip Notifier.
Precondition: Setup Viber account
- Configure user in Upkip Administration
- Configure event and notification to Viber
- Subscribe to Upkip Viber Notifier
- Submit Viber notification
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 to the 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.
- In the user's details has entered a phone number with the area code.
Figure 27: Upkip Administration - User configuration with phone number
Configure Event and Notification to Viber
Precondition: The user logged in to the 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.
- A form for creating notifications is opened.
Fill in the Notification form:
- Notification name
- Message subject
- Message text. There is possible to use Placeholders from the list by clicking on +Placeholders.
- Event – select an event from the events list
- Addresses:
- Media Type – select Viber
- Address Type – select User
- Address - double click and select our configured user with the phone for Viber notifications. The selected user appears in the address field.
Figure 28: Upkip Administration - Create notification with a message to Viber phone number
Click Save.
- Notification with Media Type Viber is created.
- Viber Invitation email is sent to the user email.
Figure 29: Upkip Viber invitation email
Subscribe to Upkip Viber Notifier
Precondition: The user has received a 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.
- The Upkip Notifier is opened on the mobile device.
Figure 30: Upkip Viber Notifier
Till a minute user will receive a message to the Viber Upkip Notifier.
Figure 31: Upkip Viber Notifier prompt for subscribe message
Type on the chat and submit a message with text
.subscribe [email_address@example.net]
- There appears a response from the Viber bot :“A verification email has been sent to your email address.”
- The verification email is sent to the user email with the subject: Viber Verification and text.
Figure 32: Upkip Viber verification email
Open the received email and click on the link Verify to make email verification.
- The confirmation email for successful verification has been sent.
Figure 33: Upkip Viber Verification confirmation page
- In Viber is received a message from Viber Bot :
- You are successfully subscribed with email email_address@example.net
Figure 34: Upkip Viber successful subscription
Submit Viber Notification
Preconditions:
- The user is subscribed successfully for the Viber Upkip Notifier account.
- The notification to user is configured Configure event and notification to Viber
If the event configured in the notification has triggered, a notification with Media Type=Viber and Destination=User has to submit a message to the user Upkip Notifier Viber account.
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 user's mobile phone as SMS.
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.
- The list of notifications for the organization is shown with name, subject, and text.
- Click the New button to create a new notification
Figure 35: Upkip Administration - Create notification with media type SMS
To create a notification enter:
- Name, Message Subject, Message text.
- Message text will be shown as SMS text.
- There is possible to select some predefined placeholders by clicking on +Placeholders and selecting from the list.
- Click to Add an event. Select from the list of created events. Create event manually.
- Click The New to enter an Address, Media Type, and Address Type.
- For Media Type select SMS.
- For Address Type select User.
- For Address, click and select a user from the list of users.
- Click Save to save the notification.
The Notification will be saved in the Notification list.
Submit Notification by SMS
Preconditions:
- The user is configured in the Upkip Adminitration.
- The notification to user as SMS is configured Configure notification by SMS
If the event configured in the notification has triggered, a notification as SMS will be sent to user's phone. Message Text from Notification will come as SMS text.
Notifications to Microsoft Teams
Purpose: Notifications could be configured to submit messages to Microsoft Teams channel where invited Team peoples can read them and reply. Notifications are triggered by the event. If the event has occurred then the notification is triggered and the defined message in the notification is submitted to configured teams channel. To work notifications to Teams, the member <Upkip Notifier has to be added to the Team.
- Microsoft Teams Configuration
- Configure event and notification to Teams
- Submit messages to Microsoft Teams
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 been 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
- Manage Team page is opened with the selected menu Members
Figure 38: Microsoft Teams Configuration - Manage Team
Type in the member search field – Upkip Notifier and add to the team.
- Upkip Notifier must be added to the Team (This member is used only for system purposes)
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
- The link to the channel is copied to the clipboard and will be used to configure Notification in the Upkip Administration.
Configure Event and Notification to Teams
Precondition: Log in to the Upkip Administration.
-
Configure the event following the steps Create new event
-
Configure the notification with created Event.
Select the menu Notifications.
- The list of notifications for the organization is shown with name, subject and text.
Figure 42: Upkip Administration - Create notification with destination Teams
- Click the New button to create new notification
To create notification enter:
- Name, Message Subject, Message text. Message text will be shown in the Microsoft team channel.
- There is possible to select some predefined placeholders by clicking on +Placeholders and selecting from the list.
- Click to Add an event. Select from the list created event.
- Click New to enter Address, Media Type, and Address Type
- In the address, paste the copied channel link
- For Media Type select MicrosoftTeams
- For Address Type select Destination.
- Click Save to save the notification.
The created Notification will appear in the Notifications list.
Submit messages to Microsoft Teams
Open Microsoft Teams and select created channel for notifications.
Figure 43: 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 44: 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 45: Upkip Administration - Open users list
From the users' list select the user and click Edit.
- Form for editing user is opened
Figure 46: Upkip Administration - Configure user with an allowed time interval for notifications
- Enter user email for receiving email notifications. Enter user phone number with area code for receiving SMS or Viber messages.
- Select time zone – e.g. (UTC+02:00)E.EUROPE STANDARD TIME
- Select from the dropdown EMAIL, SMS, or Viber
- Specify for each selected notification channel time From-To for the allowed time interval
- Click OK to save the user
- The user data are saved with entered times for each notification channel.
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.
- The notification is sent.
Trigger the event and notification for each notification channel outside the specified time interval.
- The notification is not sent.
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.
Figure 47: 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.
- The page for configuring calculated tags is opened. There is possible to create, edit or delete calculated tags.
Figure 48: Upkip Administration - Calculated Tags
Click the New button.
- Form for creating calculated tag is opened.
Figure 49: Upkip Administration - Add new calculated tag
Enter the following data in the form:
- Name - Enter the calculated tag name
- Base – select base tag by searching between tags (button Tag) or search by Display Name or Payload.
- Result – select result tag by searching between tags (button Tag) or search by Display Name or Payload.
- Add expression to execute over the base tag. There is possible to add functions from the built-in functions, use math, logic or operators for comparison, parentheses if necessary. In expression is possible to add additional tags.
- Expression Parameters - There is possible to define expression parameters, that are used in the expression.
- Click Add
- The calculated tag is created.
Search for Base and Result Tags
- When searching to add Base and Result tags there is possible to search tag from all tags or from the organization tree following the steps Search and Add Tag
Figure 50: Upkip Administration - New Calculated tag - Select base and result tags
- When adding Base or Result Tags is possible to select not real tags but Display name with specific Type ID.
Figure 51: 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 52: 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 53: Upkip Administration - New calculated tag - Add expression
To create expression can be used:
- Built-in Functions – implemented functions that can be selected from the list.
- Add Tag – it is possible to select the tag from all tags or from the organization tree to add in expression
- Add Display name – it is possible to search and select the display name of some Type and add in expression.
- Use mathematical or logical operations, operators for comparison, or parentheses to create expression.
Figure 54: Upkip Administration - New calculated tag - Add expression operators
- There is possible to define expression parameters and use them in expression.
Figure 55: 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
- The calculated tag is saved and appears in the list of Calculated tags.
For example:
Figure 56: Upkip Administration - Saved calculated tag in the list
Built-in Functions
To add function in expression click on the button + Add Function.
- The list with predefined functions is listed.
When selecting some function on the right side appears Description and example.
Select function and click Add button.
- The selected function appears in the expression section.
Figure 57: Upkip Administration - New calculated tag - Add expression - Built-in functions
Lists
Lists is a special section which provides the possibility:
- for delivering generic and flexible functionalities within the platform
- for users to freely be able to define hierarchical data structures for various purposes
Figure 58: Lists menu
Working with Lists is fairly simple:
- Lists are organized in a hierarchical way
- A single List can contain multiple child lists
- A single List can contain multiple child list items
- A single List can contain a mix of child lists or list items
In the common case Lists are made to organize specific list items (data items). Each list item has an accosiated Label (text value) and Color provided in hex format e.g. #A1B2E3.
Figure 59: Lists menu
By clicking on the Add button a new List or List Item can be added. Available options are limited based on the currently selected element in the structure. To add a List Item a List must be selected.
Properties to fill are as follows:
- Lists
- Name - a name for internal (system usage) which will be hidden in UI
- Label - a user friendly name acting as display name for the list. Name and Label can be the same
- Parent - Parent list, if this is a child list
- Type - a specific predefined internal type of list. Set Unassigned for non-specific lists
Figure 60: Add List
- List Items
- Name - a name for internal (system usage) which will be hidden in UI
- Label - a user friendly name acting as display name for the list. Name and Label can be the same
- Color - a color code provided in hex format e.g. #A1B2E3
Figure 61: Add List Item
Downtime Tagging
Introduction
- Downtime tagging configuration applies to the downtime tagging instrument/dashboard in Visualization portal.
- Downtime tagging utilizes different downtime tagging reasons grouped in categories.
- Each organization in Upkip is provided with a default set of downtime reasons under the list name Default Downtime. Reasons are grouped under standard categories Man, Machine, Method, Material
- Organizations can customize these or create additional machine-specific lists of downtime tagging reasons
Default Downtime Reasons
Figure 62: Default downtime reasons
Figure 63: Default downtime reasons as seen from the Downtime Tagging panel
- Each organization is absolutely free to customize the default downtime tagging list, categories and items according to its needs
- New Downtime list can be created and set As Default for the organization
- Multiple Downtime lists can be created and then used accross the organization as machine-specific and/or organization default
Click here for more details on how to create and manage Lists.
Create New
Creating a new downtime list follows the rules of Lists with the following requrements:
- The Type of the new list should be Downtime
- Each top-level list of type Downtime is considered a different set of Downtime Reasons
- Only one set of Downtime Reasons can be set as Default
- The top-list should have only one level of child lists below it. These represent the Categories of the Downtime list
- List Items added under these Categories represent the actual downtime reasons
Figure 64: Create new downtime reasons list
Steps to create new downtime list (Figure 65):
- Click Add > List
- Set Name and Label
- Choose None for Parent
- Choose Downtime for Type
- Select Default is this is to be the default downtime list for the organization
Existing downtime list can be edited when its element is selected in the list structure
Figure 65: Create new downtime reasons list
Steps to create a new category under a downtime list (Figure 66):
- Click Add > List
- Set Name and Label
- Choose the target downtime list as Parent. The category will be created below it
- Choose Downtime for Type
- Select Default is this is to be the default downtime list for the organization
Existing category can be edited when its element is selected in the list structure
Figure 66: Create new downtime category
Steps to create a new downtime reason under some category (Figure 67):
- Select the target category element in the list structure
- Click Add > List Item
- Set Name and Label
- Set a hex color code of the reason. This will be the color of the reason on the downtime chart in Visualization Portal
Existing downtime reason can be edited when its element is selected in the list structure e.g.#a1e3b5
Figure 67: Create new downtime reason
Here is an example of a simple downtime list:
Figure 68: Example of a downtime list
Machine Specific Downtime Reasons
The platform provides the possibility to change the default downtime reasons for a specific machine. This is available via the Properties tab of the selecte machine in the Organization structure (Figure 69). For each machine there is a Downtime List property available.
- By default machines use the organization default downtime reasons. No matter if it is explicitly selected in the property dropdown
- The Downtime List property presents a list of all Lists marked with Type Downtime
Figure 69: Change default machine dowtime reasons
In the cases when a downtime list different from the organization default is selected, then in the downtime tagging panel two options for downtime list are available:
- The machine default, which is also initially selected
- The organization default list
Figure 70: Multiple dowtime reason lists for tagging