The right sidebar allows you to navigate Alarms, Insights (reports), some Company configuration items, and allows you to view and edit the Schedule for a department or piece of equipment. In some cases it will allow you to view and configure the device(s) attached to a piece of equipment.

By default, the right sidebar will be collapsed when starting up the web application.

Right sidebar collapsed
Figure 4.1.1 – Right Sidebar Collapsed

Clicking on the arrow at the bottom will cause the sidebar to expand, so that the full labels can be read.

Figure 4.1.2 – Right Sidebar Expanded

Clicking on the arrow again will collapse the sidebar.

The Alarms section holds any alarms which are currently active. If no alarms are active, the alarm area will display text telling you so.

No alarms tripped for equipment
Figure 4.2.1 – Right Sidebar Showing No Alarms

There are two buttons that you will encounter in the Alarms area as well.

  • View all – Clicking this will take you to the Alarm configuration page, where you can view, edit and subscribe to all alarms.
  • New alarm – When at the equipment level in the Company Tree, this button will appear. It allows you to configure a new alarm for that equipment.

Three settings are displayed with each alarm, and those are Threshold, Threshold Unit, and Restrict To Schedule. The length of time that an alarm has been active is also displayed.

Example alarm
Figure 4.2.2 – Alarm Example
  • Threshold – Value at which the alarm is triggered. In the case of a Temperature alarm, the alarm can be triggered when a value goes either above or below a value. All other alarms are triggered only when the current value goes above the threshold.
  • Threshold Unit – The unit of measure that the Threshold is defined in. This can be a unit of time (seconds, minutes, hours) or temperature in degrees. No unit is specified for an impact alarm.
  • Restrict To Schedule – Whether or not the alarm is only enabled during scheduled time for a piece of equipment. If this option is checked, the alarm will be disabled when the equipment is not scheduled to be running. This prevents employees from getting text and email alerts for the alarm during times when the equipment is not scheduled to be running, such as during a weekend shutdown.

The Insights section provides access to reports and additional features like data export. The items in this section can vary depending on what level of the Company Tree you are at. When at the department or company level, two options will be available: Excessive downtimes and Summary report.

Company and department level Insights
Figure 4.3.1 – Company & Department Insights
  • Excessive downtimes – Displays a report of excessive downtime entries in tabular format, with drop downs that allow setting a reason for each of the excessive downtime entries.
  • Summary report – Only shown when at a level above equipment. Displays a report showing a summary of the utilization for all equipment within the department, equipment that has not cycled for an extended period of time, the number of hours of excessive downtime associated with each sub-department, and the distribution of reasons for excessive downtime occurrences.

When at the equipment level, the list retains the Excessive downtimes option, but adds Raw cycle data. The Raw cycle data option displays the cycle data for that piece of equipment in tabular form. The data included in the table is set by the time filter just below the navigation bar. An Export button is also provided that allows downloading the data in either JSON or CSV format.

Equipment level Insights
Figure 4.3.2 – Equipment Insights

The Configuration section of the right sidebar will display different items depending on whether you are at the company, department or equipment level in the Company Tree. When at the company (top) level, the address and main contact of the company administrator are displayed, along with a drop-down menu to set the time zone of the company.

Company level configuration
Figure 4.4.1 – Company Level Configuration

When at the department level, a text box is displayed allowing you to change the name of the department. A drop down menu is also available to allow setting the time zone in case it differs from the company’s time zone. This is helpful when multiple sites within a company are spread across different time zones. If the time zone is inherited from a parent, that will be indicated by an Inherited marker. The Save button must be clicked after changing any of the department settings for the changes to take effect.

Figure 4.4.2 – Department Level Configuration

At the equipment level, several items are listed that influence the operation of the user interface elements and reporting for that piece of equipment. Those items are listed with descriptions below.

Figure 4.4.3 – Equipment Level Configuration
  • Name – The equipment name that will be displayed in the Company Tree in the left sidebar.
  • Category – A drop down list which allows specifying the type of equipment. If a category for your equipment does not exist in the list, please contact LCM2M support to have it added.
  • Manufacturer – A drop down list which allows specifying the manufacturer of the equipment. If the manufacturer of your equipment does not exist in the list, please contact LCM2M support to have it added.
  • Model – A drop down list to set the manufacturer’s model designation for the equipment. If the model of your equipment does not exist in the list, please contact LCM2M support to have it added.
  • Potential revenue / hour ($) – The revenue per hour that a piece of equipment is capable of generating. If this is filled in, a metric showing revenue made versus revenue lost for the time span set via the time filter will be displayed on the equipment detail page.
  • Maximum allowed cycle time (seconds) – The number of seconds before a piece of equipment is considered down. This does not apply if the equipment is configured so that a single signal controls both running and down states. This should be set to the shortest amount of time the machine should be allowed to sit idle before it is considered down. This effects many aspects of reporting, such as utilization and revenue reporting.
  • Exclude from utilization – When checked, the equipment will not be included in the utilization calculation for any of its parents in the company tree. This is useful for equipment such as pumps that are supposed to be running continuously, and are only being monitored to alert when they are not running. They would otherwise skew the utilization value for the rest of the company.
  • Excessive downtime enabled – When checked, the system will keep track of when the equipment crosses the excessive downtime threshold, including triggering alerts. When unchecked, the equipment will be ignored with regard to excessive downtimes.
  • Excessive downtime threshold (seconds) – The number of seconds before downtime becomes “excessive”. What excessive means in this context is that a machine has been down longer than it should be during normal operation. Excessive downtime goes beyond things like product change-over and routine preventative maintenance during operation. Excessive downtime usually indicates a problem that needs to be addressed by a supervisor. This value should be set high enough above the maximum allowed cycle time to avoid false triggers, but low enough that a problem is caught early. Excessive downtime occurrences can have reasons associated with them, and are used for reporting.
  • Do not consider downtime less than threshold in utilization calculation – Limits the utilization calculation to only use excessive downtime occurrences as part of the equipment utilization calculations, and ignores any downtime that may be considered normal (stock reload, mold cleaning, etc) that is below the excessive downtime threshold.

The schedule section displays the current operations schedule for a company, department or piece of equipment. It also displays whether or not the current schedule is inherited from an ancestor further up the Company Tree. If text similar to Schedule is inherited from… is displayed, the schedule is inherited from an ancestor. If the schedule is not inherited, this text will say Schedule is not inherited from an ancestor. Clicking the Edit button will take you to the schedule editor, which allows schedule sections to be added, removed, and resized to cover different amounts of time. The configuration section provides more details on changing the schedule.

Example schedule
Figure 4.5.1 – Example Department Schedule

4.6 Preventive Maintenance

The Preventative Maintenance section is represented by a clock face icon, and displays user-defined preventative maintenance (PM) alarms and their current conditions.

Preventative maintenance icon

Figure 4.6.1 – Preventative Maintenance Icon

There are two panes that show information about the PM alarms on the right and left. The left-hand pane displays the currently defined PM alarms, and if an entry is outlined in red, it means that a PM operation is due for that alarm. The right-hand pane displays two different sets of information, depending on whether an alarm is selected in the left-hand pane. With no PM alarms selected, the right-hand pane will show the history of all the PM operations that have been performed.

Figure 4.6.2 – Preventive Maintenance Panes

4.6.1 PM Alarm Types

There are 3 types of PM alarms:

  1. Cycle Count – Triggered once the cycle count on a machine meets or exceeds a user-defined threshold.
  2. Runtime – Triggered once the amount of time that a machine has been actively running meets or exceeds a user-defined threshold of hours.
  3. Stopwatch – Triggers after a user-defined amount of time, regardless of a machine’s status. This is useful if the machine does not have an attached device.

4.6.2 PM Alarm Entry

A PM alarm that has not been triggered will have a normal border. Each PM alarm entry can have up to 4 sections in it. The description (#2) may be blank if it is omitted by the user.

Figure 4.6.3 – Example PM Alarm Entry
  1. Title – Created based on the equipment name and alarm type.
  2. Description – This is entered by the user who created the alarm.
  3. Notification Indicator – This bell icon hows whether or not your user is set up to receive notifications for the PM alarm. A slash through the bell indicates that your user will not receive notifications when the alarm is triggered.
  4. Progress – Shows an X/Y indication the difference between the current amount (X) and the alarm trigger threshold (Y). Once the progress meets or exceeds the threshold, the outline of the alarm entry will turn red and alarm notifications will be sent.

4.6.3 PM Alarm Detail View

The PM alarm detail view shows extra information and allows editing of a PM alarm.

Figure 4.6.4 – Example PM Alarm Detail View

The sections are as follows.

  1. Equipment Name – Based on the equipment the PM alarm was created for.
  2. Alarm Type – Shows which type of PM alarm the entry is (see subsection 4.6.1).
  3. Notes – A description of the process that needs to be completed to complete the PM. If this information was not entered by the user, this section may not be visible.
  4. Active since – Shows and indication of when the PM alarm was created, and provides an edit button (pencil icon) and delete button (trash can) for the PM alarm entry. When the edit button is clicked, an Edit alarm dialog will appear, and the entries are the same as those specified in section 4.6.5.
  5. My alerts – Any subscription that your individual user has to this PM alarm. Can be either SMS or Email. A user can subscribe by using the Subscribe button (#6).
  6. Subscribe – When mousing over the button, the user is presented with a small popup that allows them to subscribe to the PM alarm via SMS, Email, or both. The green Subscribe button at the bottom of the popup must be clicked to save the subscription settings.
  7. Other alerts – This entry will be visible when viewed by an administrator, and shows any users who have been subscribed to the PM alarm. It also shows whether they are subscribed via SMS or Email. The Edit other subscriptions button (#8) will allow an administrator to edit these subscriptions.
  8. Edit other subscriptions – Button that allows an administrator to subscribe other users to the current PM alarm, via both SMS and email. Clicking this button will bring up the advanced user selection dialog.
  9. Progress – Shows an X/Y indication of the difference between the current amount (X) and the alarm trigger threshold (Y). Once the progress meets or exceeds the threshold, alarm notifications will be sent.
  10. Complete Maintenance (Early) – Button that when clicked, displays a simple dialog allowing a user to enter a note about what was done to address the PM need, and then click Complete to reset the PM alarm.
  11. Maintenance History – Shows each entry where the alarm was marked as completed, which resets the alarm so that it can track new progress to the threshold. Each entry shows when the maintenance was completed, and user comments about what work was done can be viewed by mousing over the speech bubble icon.

4.6.4 PM History Item

Each Equipment Maintenance History item has multiple pieces of information, which are outlined below.

Figure 4.6.5 – Example PM Alarm History Item
  1. Title – Created automatically by combining the equipment name and the alarm type.
  2. Description – Explains the process that needs to be completed to address the PM alarm.
  3. Completion information – Provides the date and time that the PM alarm was addressed, along with the number of cycles or hours, depending on the type of alarm. Clicking on the speech bubble icon at the end displays any notes that the user entered when marking the PM task as complete.
  4. User – Displays the user who completed the PM task.

4.6.5 Adding a New PM Alarm

New PM alarms can be added by clicking the Add New button at the top of the Current PM Alarms column.

Figure 4.6.6 – Add PM Alarm Button

This will display the Add alarm dialog, which contains the following items.

Figure 4.6.7 – Add PM Alarm Dialog

1. Equipment – The piece of equipment that this alarm is being added for.
2. Alarm Type – One of the alarm types outlined in section 4.6.1.

Selecting an alarm type after selecting the equipment will display additional options. These options are different for each type of alarm. The next sections outline the options available for each type. Cycle Count

Cycle Count PM alarms are based on the number of cycles an equipment has seen since the alarm was last Completed (reset).

Figure 4.6.8 – Add PM Alarm Dialog – Cycle Count
  1. Cycle Count – Number of cycles that occur before the alarm is triggered.
  2. Notes – The description of what process should be followed to address the alarm.
  3. Subscribe? – Allows the user creating the PM alarm to set whether they want to be subscribed via Text message, Email, both or neither. Runtime

Runtime PM alarms are based on the number of hours of runtime on a piece of equipment has seen since the alarm was last completed (reset).

Figure 4.6.9 – Add PM Alarm Dialog – Runtime
  1. Runtime Hours – Number of hours that the machine can run without this PM being performed before the alarm is triggered.
  2. Notes – The description of what process should be followed to address the alarm.
  3. Subscribe? – Allows the user creating the PM alarm to set whether they want to be subscribed via Text message, Email or neither. Stopwatch

Stopwatch PM alarms are based on a simple timer that triggers the alarm when it expires.

Figure 4.6.10 – Add PM Alarm Stopwatch – Runtime
  1. Duration – Amount of time that has to elapse before the alarm is triggered. This is a simple timer, and its units are set by the next item.
  2. Duration unit – Unit of time for the timer, can be Minute(s), Hour(s), Day(s), Week(s), and Month(s).
  3. Notes – The description of what process should be followed to address the alarm.
  4. Subscribe? – Allows the user creating the PM alarm to set whether they want to be subscribed via Text message, Email, or neither.

4.7 Devices

The Devices section of the right sidebar will only appear when at the equipment level of the Company Tree. At least one device must be attached to a piece of equipment in order for data to be collected. If no device is attached, the text in the Devices section will be No attached devices. The Add device button can be used to attach a device to a piece of equipment.

Equipment with no devices attached
Figure 4.7.1 – No Devices Present on Equipment

If the equipment does have one or more devices attached, they will be listed below the Add device button. Each device has a unique identifier, and a portion of that ID will be displayed for each device, followed by an ellipsis. Two other device attributes which may be displayed are Primary and active. Each piece of equipment must have a primary device, and if only one device is present it will be Primary be default. Devices can be disabled so that they do not collect data, and this is reflected via the active setting. If there is only one device, it should show both Primary and active so that data will be collected. Clicking on the blue wrench next to a device entry will open the configuration screen for that device.

Equipment with a device attached
Figure 4.7.2 – Device Present on Equipment

Contents | Next