OnTakt: Maintenance: Difference between revisions

From Knowledge Base
m (Andy moved page OnTakt Maintenance to OnTakt: Maintenance without leaving a redirect)
(NC alarm due date)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
Part of the [[OnTakt User Guide]].
Part of the [[OnTakt User Guide]].


== Maintenance Items ==
<onlyinclude>
Maintenance items are regular tasks that are performed for the shop as a whole or on a single machine. They can be scheduled to show up as alerts in OnTakt on an interval measured in hours, days, or weeks, with instructions for completing the maintenance item.
Maintenance items are regular tasks that are performed for the shop as a whole or on a single machine. They can be scheduled to show up as alerts in OnTakt on an interval measured in hours, days, or weeks, with instructions for completing the maintenance item.


=== Creating maintenance items ===
Maintenance issues are occasional maintenance items that can optionally be scheduled.
</onlyinclude>
 
<html>
<div style="position: relative; padding-bottom: 64.86486486486486%; height: 0;"><iframe src="https://www.loom.com/embed/06899d28d21049a3a3a69d57b55c1f7a?sid=2ef1ef50-c467-4571-bf92-8e9fe9ab5061" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
</html>
 
== Types of maintenance items ==
 
=== Maintenance Tasks ===
Maintenance tasks are maintenance items that record the date and time last performed, whether the task was successful, and user-supplied notes.
 
=== Maintenance Measurements ===
Maintenance measurements are numeric measurements that are taken on an interval and can be charted over time. They can define an acceptable range and notify when a value falls outside this range.
 
== Creating maintenance items ==
Only administrators and planners can create maintenance items
Only administrators and planners can create maintenance items
#Navigate to the Maintenance page
#Navigate to the Maintenance page
Line 14: Line 29:
#To send reminders when regular maintenance items must be completed, switch to the Reminders tab at the top of the editor window and enter an interval. Once an interval is set (zero disables reminders), another option will appear that offers a list of notification channels to send messages to when the reminder comes up. Regardless of this option, an in-app alert will appear in the alerts pane.
#To send reminders when regular maintenance items must be completed, switch to the Reminders tab at the top of the editor window and enter an interval. Once an interval is set (zero disables reminders), another option will appear that offers a list of notification channels to send messages to when the reminder comes up. Regardless of this option, an in-app alert will appear in the alerts pane.
For '''measurements''', the following additional fields are available in the Info tab:
For '''measurements''', the following additional fields are available in the Info tab:
#Enter the measurement unit to guide entry and analysis. For example, "%" or "mm".
#Enter the measurement unit to guide entry and analysis. For example, "%", "pH", or "mm".
#Enter the acceptable range of the measured values. One or both ends of the range can be specified. If either or both ends is entered, another option will appear that offers a list of notification channels to send messages to when a measurement exceeds the range. Regardless of this option, an in-app alert will appear in the alerts pane.
#Enter the acceptable range of the measured values. One or both ends of the range can be specified. If either or both ends is entered, another option will appear that offers a list of notification channels to send messages to when a measurement exceeds the range. Regardless of this option, an in-app alert will appear in the alerts pane.


=== Completing maintenance items ===
<html>
<div style="position: relative; padding-bottom: 64.86486486486486%; height: 0;"><iframe src="https://www.loom.com/embed/f4bee4d838df4df6951d233d1db96957?sid=e2428e9b-4feb-4a0a-8678-141441d25b8b" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
</html>
 
=== Scheduling ===
Maintenance items can be scheduled in several ways:
 
==== Clock time ====
This is the default way to schedule a maintenance item. Enter a timer interval and the item will be due that far out from the last entry.
 
If the maintenance was performed before creating an item in OnTakt, set the initial entry date so that it becomes due at the correct time.
 
==== Run time ====
''Before OnTakt client version 2.3.15, this option was available as a "cycle time only" checkbox.''
 
This mode functions just like the clock time mode, but only time spent producing parts is counted. Each time the associated machine finishes a part, the process's cycle time is added to the maintenance item's counter. The item becomes due once the counter reaches the defined timer interval.
 
This mode is only available for maintenance items that are associated with a machine.
 
==== Calendar ====
''Only available with OnTakt Server 4.12.14 or newer.''
 
In calendar mode, maintenance issues can be scheduled for a specific time on days that meet certain conditions, just like a recurring calendar event. As you edit the schedule options, the next few due dates will appear in the schedule preview at the top.
{| class="wikitable"
|+Example schedules
!'''Description'''
!'''Interval'''
!'''Frequency'''
!'''Time'''
!'''Indices'''
!'''Weekdays'''
!'''Months'''
|-
|Every other Thursday at 6:15 PM
|2
|week
|6:15 PM
|
|
* Thursday
|All
|-
|Every Monday, Wednesday, and Friday at 12:30 PM
|1
|week
|12:30 PM
|
|
* Monday
* Wednesday
* Friday
|All
|-
|The last day of every month at 5:00 PM
|1
|month
|5:00 PM
|
* -1
|All
|All
|-
|6:00 AM on the 1st and 3rd Monday of the first month of each quarter
|1
|month
|6:00 AM
|
* 1
* 3
|
* Monday
|
* January
* April
* July
* October
|}
''In the table above, "Indices" refers to the "Days of the month" setting that is only displayed when the selected frequency is "month".''
 
==== NC alarms ====
''Requires OnTakt server version 4.13.5 or newer.''
 
Any maintenance item can also be triggered when its associated machine (or the machine associated with its equipment) reports specific alarms. This is useful in cases where a maintenance task can prevent and/or resolve the alarm condition.
 
To configure this, first assign the maintenance item to a machine or to equipment that belongs to a machine, then click the "Machine Alarms" button in the Info tab of the maintenance item editor and enter a list of NC alarms that will trigger this maintenance item. Machine alarms entered here are case-sensitive and must exactly match the alarm type or code reported by the machine.
[[File:Maintenance item due from NC alarm.png|thumb]]
When a matching alarm is reported, the maintenance item's due date will be set to match the timestamp of the alarm. This state and the alarm message will be shown in the maintenance item table:
 
Once a maintenance entry is created for the affected item, this due date override will be cleared and it will resume the configured schedule.
 
== Completing maintenance items ==
#Click the green plus button in the Actions column of an item.
#Click the green plus button in the Actions column of an item.
#Follow the item's instructions (if shown). For tasks, check whether the task was completed successfully. For measurements, enter the measured value.
#Follow the item's instructions (if shown). For tasks, check whether the task was completed successfully. For measurements, enter the measured value.
Line 23: Line 128:
This window can also be accessed from the entry viewer (described below) by clicking "New entry" at the top.
This window can also be accessed from the entry viewer (described below) by clicking "New entry" at the top.


=== Viewing collected data ===
== Viewing collected data ==
Click the table row of a measurement item. A new column appears that contains the log of entries.
Click the table row of a measurement item. A new column appears that contains the log of entries.


For measurements, a chart will be displayed above the table.
For measurements, a chart will be displayed above the table.


=== Maintenance Tasks ===
<html>
Maintenance tasks are maintenance items that record the date and time last performed, whether the task was successful, and user-supplied notes.
<div style="position: relative; padding-bottom: 64.86486486486486%; height: 0;"><iframe src="https://www.loom.com/embed/5f70327cc6cf4ae58ebd62add4b27f45?sid=2e365ee6-b430-4e83-959c-12ca35ba11b8" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
 
</html>
=== Maintenance Measurements ===
Maintenance measurements are numeric measurements that are taken on an interval and can be charted over time. They can define an acceptable range and notify when a value falls outside this range.


== Maintenance Issues ==
== Maintenance Issues ==
Maintenance issues are occasional maintenance items that can optionally be scheduled.
Issues were separated from the maintenance module in [[OnTakt Changelog#Server 4.12.10, Client 2.3.10, Proxy 2.7.13|OnTakt client version 2.3.10]]. See [[OnTakt: Issues]] for more information.
 
[[Category:OnTakt User Guide]]
'''One-time''' maintenance issues are instantaneous, for example, machine crashes.
{{DEFAULTSORT:Maintenance}}
 
'''Ongoing''' maintenance issues define a start and optionally an end date, such as scheduled downtime.
 
=== Creating maintenance issues ===
#Navigate to the Maintenance page
#At the top right of the Issues table, click the "New issue" button.
#Select a type (one-time or ongoing). The available form fields change based on the type.
#Enter an identifiable name for the item. As you type, names of previous issues will be suggested to make it easier to link recurring issues. Most browsers will allow you to press the down arrow on the keyboard from the empty name field to show all previous names.
#For one-time issues, the current timestamp will be recorded. For ongoing issues, enter the start and/or end times. If left empty, the start time will be set to the current time, and the end time will stay empty. An issue with an empty end time is considered "unresolved".
#Enter a helpful, detailed description.
[[Category:OnTakt]]

Latest revision as of 16:24, 10 September 2024

Part of the OnTakt User Guide.


Maintenance items are regular tasks that are performed for the shop as a whole or on a single machine. They can be scheduled to show up as alerts in OnTakt on an interval measured in hours, days, or weeks, with instructions for completing the maintenance item.

Maintenance issues are occasional maintenance items that can optionally be scheduled.


Types of maintenance items

Maintenance Tasks

Maintenance tasks are maintenance items that record the date and time last performed, whether the task was successful, and user-supplied notes.

Maintenance Measurements

Maintenance measurements are numeric measurements that are taken on an interval and can be charted over time. They can define an acceptable range and notify when a value falls outside this range.

Creating maintenance items

Only administrators and planners can create maintenance items

  1. Navigate to the Maintenance page
  2. At the top right of the Items table, click the "New item" button.
  3. Select a type (task or measurement). The available form fields change based on the type.
  4. Enter an identifiable name for the item.
  5. Machine selection is optional. If no machine is selected, the item is considered to be "shop-wide".
  6. Enter instructions to display when completing the item
  7. To send reminders when regular maintenance items must be completed, switch to the Reminders tab at the top of the editor window and enter an interval. Once an interval is set (zero disables reminders), another option will appear that offers a list of notification channels to send messages to when the reminder comes up. Regardless of this option, an in-app alert will appear in the alerts pane.

For measurements, the following additional fields are available in the Info tab:

  1. Enter the measurement unit to guide entry and analysis. For example, "%", "pH", or "mm".
  2. Enter the acceptable range of the measured values. One or both ends of the range can be specified. If either or both ends is entered, another option will appear that offers a list of notification channels to send messages to when a measurement exceeds the range. Regardless of this option, an in-app alert will appear in the alerts pane.

Scheduling

Maintenance items can be scheduled in several ways:

Clock time

This is the default way to schedule a maintenance item. Enter a timer interval and the item will be due that far out from the last entry.

If the maintenance was performed before creating an item in OnTakt, set the initial entry date so that it becomes due at the correct time.

Run time

Before OnTakt client version 2.3.15, this option was available as a "cycle time only" checkbox.

This mode functions just like the clock time mode, but only time spent producing parts is counted. Each time the associated machine finishes a part, the process's cycle time is added to the maintenance item's counter. The item becomes due once the counter reaches the defined timer interval.

This mode is only available for maintenance items that are associated with a machine.

Calendar

Only available with OnTakt Server 4.12.14 or newer.

In calendar mode, maintenance issues can be scheduled for a specific time on days that meet certain conditions, just like a recurring calendar event. As you edit the schedule options, the next few due dates will appear in the schedule preview at the top.

Example schedules
Description Interval Frequency Time Indices Weekdays Months
Every other Thursday at 6:15 PM 2 week 6:15 PM
  • Thursday
All
Every Monday, Wednesday, and Friday at 12:30 PM 1 week 12:30 PM
  • Monday
  • Wednesday
  • Friday
All
The last day of every month at 5:00 PM 1 month 5:00 PM
  • -1
All All
6:00 AM on the 1st and 3rd Monday of the first month of each quarter 1 month 6:00 AM
  • 1
  • 3
  • Monday
  • January
  • April
  • July
  • October

In the table above, "Indices" refers to the "Days of the month" setting that is only displayed when the selected frequency is "month".

NC alarms

Requires OnTakt server version 4.13.5 or newer.

Any maintenance item can also be triggered when its associated machine (or the machine associated with its equipment) reports specific alarms. This is useful in cases where a maintenance task can prevent and/or resolve the alarm condition.

To configure this, first assign the maintenance item to a machine or to equipment that belongs to a machine, then click the "Machine Alarms" button in the Info tab of the maintenance item editor and enter a list of NC alarms that will trigger this maintenance item. Machine alarms entered here are case-sensitive and must exactly match the alarm type or code reported by the machine.

Maintenance item due from NC alarm.png

When a matching alarm is reported, the maintenance item's due date will be set to match the timestamp of the alarm. This state and the alarm message will be shown in the maintenance item table:

Once a maintenance entry is created for the affected item, this due date override will be cleared and it will resume the configured schedule.

Completing maintenance items

  1. Click the green plus button in the Actions column of an item.
  2. Follow the item's instructions (if shown). For tasks, check whether the task was completed successfully. For measurements, enter the measured value.
  3. Enter any relevant notes

This window can also be accessed from the entry viewer (described below) by clicking "New entry" at the top.

Viewing collected data

Click the table row of a measurement item. A new column appears that contains the log of entries.

For measurements, a chart will be displayed above the table.

Maintenance Issues

Issues were separated from the maintenance module in OnTakt client version 2.3.10. See OnTakt: Issues for more information.