Maintenance

    Maintenance


    Article summary

    Maintenance refers to the process of keeping something in good working condition by regularly checking, repairing, or updating it. Maintenance performed in a job shop can be recorded in Steelhead. A careful Maintenance program can eliminate costly breakdowns and lost production, and ensure compliance with safety and quality regulations.

    Maintenance can be reached by clicking the Maintenance Tile.
    Screenshot 2025-03-11 at 12.40.51 PM.png

    A red bubble may appear on the tile, displaying how many recurring plans are due for maintenance.

    This article includes instructions for:

    Maintenance Dashboard

    The Maintenance Dashboard is the default page to open when the Maintenance Tile is clicked. It allows for planning, scheduling, assigning, tracking, and reviewing of Maintenance Events.

    Screenshot 2025-04-23 at 8.54.41 AM.png

    The Maintenance Dashboard displays the following:

    • Recurring Maintenance Plans - See related section for more information.
      • (a) NEW RECURRING PLAN button
      • (b) Equipment Due for Recurring Maintenance table - Easy access to view or perform recurring maintenance.
    • Maintenance Events - See related article for more information.
      • (c) NEW MAINTENANCE EVENT button
      • (d) Active Maintenance Events table - Easy access to view, open, edit, and archive active maintenance events.
      • (e) Completed Maintenance Events table - Easy access to view, open, edit, and archive completed maintenance events.
    • (f) Filters and paging for each table
    • (g) Switches to hide (toggle-off) or display (toggle-on) each table
    • Alert banner that displays how many plans are due for maintenance

    Recurring Maintenance Plans

    A Recurring Maintenance Plan is a scheduled task where maintenance for equipment is performed at regular intervals of time. Recurring plans in Steelhead can serve as reminders to perform maintenance. They are created on the Maintenance Dashboard and can be edited from the Recurring Maintenance Plans page.

    Create a Recurring Maintenance Plan

    To create a new recurring maintenance plan:

    1. Click the NEW RECURRING PLAN button on the Maintenance Dashboard.
      Screenshot 2025-03-11 at 1.02.43 PM.png

    2. Enter a Name for the plan.

    3. Select the Type - Either Maintenance Plan or Maintenance Node.

      1. Then, select a node or plan from the dropdown, based on the selection made above.
    4. Select the Equipment Type or the specific Equipment that will be receiving maintenance.

    5. Optionally, select the Default Assignee, who will perform the regular maintenance.

    6. Select the Frequency Mode: Daily, Weekly, Monthly, or Yearly.

      1. Set the Interval of the Frequency Mode.
      2. If weekly, select the Weekday that applies, or multiple.
    7. Select the Recurrence Mode:

      • Fixed Schedule - Maintenance will be requested to be performed on set date and times, with no fluctuation. Select the Occurrence Times to specify the time(s).
      • From Last Maintenance - Maintenance will be requested based on when the last related Maintenance Event was performed.
    8. Select the Limit Mode:

      • End Date - The plan will stop being recurring after the selected End Date.
      • Count - The plan will stop being recurring after the set Count of times.
      • Forever - The plan will recur forever, until it is ended (archived or adjusted to end).
    9. Select the Start date.

    10. Review the Recurrence Rule and verify that it is correct. If incorrect, adjust any recurrence rule details (steps 6-9).

    11. If all information looks correct, and there are no alerts, click SAVE. Information can be edited after saving.
      a. Alerts will display which pieces of information must be filled out to successfully save. Click the refresh button to update the warnings that still apply.
      Screenshot 2025-04-21 at 11.41.20 AM.png

    Example:
    The changing of forklift tires is to be performed every three months at 2:00PM. This is what the creation of the plan may look like.
    Screenshot 2025-03-11 at 1.20.03 PM.png

    Perform Recurring Maintenance

    To use a recurring maintenance plan:

    1. Click one of the icons on the "Equipment Due for Recurring Maintenance" section of the Maintenance Dashboard.
      Screenshot 2025-04-23 at 9.30.47 AM.png

      • (a) Create a new maintenance event for this plan icon - When clicked, the Create Maintenance Event dialog will auto-fill, which can be saved and completed now or later.
      • (b) Quickly adjust last event completion icon - When clicked, the Update Maintenance will open, displaying related active and completed maintenance events that can be adjusted.
      • (c) Quick-complete a new maintenance event icon - When clicked, the Quick Complete Maintenance Event dialog will open, allowing for a completion date and comment to be entered and saved.
    2. If a new maintenance event is being created, see the Create a Maintenance Event section for more instructions.

    Edit/Archive/Unarchive a Recurring Maintenance Plan

    Once a Recurring Maintenance Plan exists, it can be edited or archived/unarchived.

    To edit or archive/unarchive a recurring maintenance plan:

    1. Navigate to the Recurring Maintenance Plans page.
      a. Click the Edit pencil icon to make any adjustments to the plan.
      b. Click the Archive icon to archive the plan. Plans can be unarchived.

    Screenshot 2025-04-21 at 12.09.18 PM.png

    1. If edits were made, click SAVE.
    2. If a plan needs to be unarchived - Toggle the "View Archived" switch on, and click the Unarchive icon.
      Screenshot 2025-04-23 at 9.36.47 AM.png

    Maintenance Plans

    Maintenance Plans are collections of maintenance nodes that are organized and customized. They have code that is set up to alter how nodes are displayed in a maintenance event.

    Create a Maintenance Plan

    To create a Maintenance Plan:

    1. Click the NEW MAINTENANCE PLAN button.
    2. Enter a Name. This name will appear as an option if creating a Recurring Maintenance Plan or a Maintenance Event using a Maintenance Plan.
    3. Optionally add an associated Equipment Type. Then, SAVE.
    4. Open the plan by clicking on name link.
    5. Next to Source Code, click EDIT. Code should only be edited by those who know TypeScript.
      1. Insert the Boilerplate from any Maintenance Nodes that should be included.
      2. Insert any customization.
    6. Once code is ready, run a test, and then SAVE AND CLOSE.

    Example:

    • The "Change Air Filters" node only displays when the "Check Air Filters" node is set as True.
      Apr-22-2025 09-49-20.gif

    • This is because the maintenance plan code is customized to do so.
      Screenshot 2025-04-22 at 9.55.26 AM.png

    Use Maintenance Plans

    Visit the Create a Maintenance Event section for more information on how to perform maintenance using Maintenance Plans.

    Edit/Archive/Unarchive a Maintenance Plan

    Once a Maintenance Plan exists, it can be edited or archived/unarchived.

    To edit or archive/unarchive a maintenance plan:

    1. Navigate to the Maintenance Plans page.
      a. Click the Edit pencil icon to make any adjustments to the plan.
      b. Click the Archive icon to archive the plan. Plans can be unarchived.

    Screenshot 2025-04-23 at 12.32.36 PM.png

    1. If edits were made, click SAVE.
    2. If a plan needs to be unarchived - Toggle the "View Archived" switch on, and click the Unarchive icon.
      Screenshot 2025-04-23 at 12.35.25 PM.png

    Maintenance Nodes

    Maintenance Nodes are steps configured to resemble the steps of a maintenance procedure. They are used in Maintenance Plans and Maintenance Events.

    Navigate to the Maintenance Nodes page through the sidebar of the Maintenance Dashboard.

    Create a Maintenance Node

    To create a Maintenance Node:

    1. Click the New Maintenance Node button if a new procedure is being created. Name the node. This name will appear as an option if creating a Recurring Maintenance Plan or a Maintenance Event using a Maintenance Node.

      1. Move to step 2 if a child node needs to be added.
    2. Open the node by clicking the linked name on the Maintenance Nodes table.

    3. Determine if the node should be displayed during maintenance event completion.

      1. Check the "Skip Execution" box if the step does not need to be displayed.
    4. Add child nodes by clicking + NEW CHILD NODE.

    5. Nodes can be (a) moved, (b) edited, (c) deleted, (d) restored.
      Screenshot 2025-04-23 at 12.58.35 PM.png

    6. Nodes can be configured to display a variety of things when the step is open on a maintenance event. To configure a node:​

    • Click the Edit pencil icon to change the Name of the node.
    • Click the Edit button add Operator Instructions. ​
    • Click the + Add File button to add Files.​
    • Click the Add Sensor button to select Sensors that will be available to measure.
    • Click the Add Inventory Item button to select Inventory Items that will be available to deplete.

    Example:
    The operator should know exactly what to do for checking the forklift brakes when performing forklift inspection.

    • Instructions and a picture are attached to the Node:
      Screenshot 2025-04-23 at 11.03.12 AM.png

    • This is how it appears at time of completion:
      Screenshot 2025-04-23 at 11.01.39 AM.png

    Use Maintenance Nodes

    Visit the Create a Maintenance Event section for more information on how to perform maintenance using Maintenance Nodes.

    Edit/Archive/Unarchive a Maintenance Node

    Once a Maintenance Node exists, it can be edited or archived/unarchived.

    To edit or archive/unarchive a maintenance node:

    1. Navigate to the Maintenance Nodes page.
      a. Click the Edit pencil icon to make any adjustments to the plan.
      b. Click the Archive icon to archive the plan. Plans can be unarchived (step 3).

    Screenshot 2025-04-23 at 2.18.18 PM.png

    1. If edits were made, click SAVE.
    2. If a plan needs to be unarchived - Toggle the "View Archived" switch on, and click the Unarchive icon.
      Screenshot 2025-04-23 at 2.18.35 PM.png

    Maintenance Events

    Once Maintenance Nodes and Plans are created, they can be implemented as Maintenance Events. A Maintenance Event is record of a maintenance task or procedure performed.

    Navigate to the Maintenance Events page through the sidebar of the Maintenance Dashboard. Active and completed events are also displayed on the main Maintenance Dashboard page.

    Create a Maintenance Event

    To create a Maintenance Event:

    1. Click the New Maintenance Event button OR an icon related to a Recurring Maintenance Plan.
      a. If the event is being created from a Recurring Maintenance Plan, verify the information on the "Create Maintenance Event" dialog is correct, and SAVE. Then, skip step 2.
    2. Fill out the necessary details for creating the event.
      1. Select Node or Plan, then select from the drop-down, based on that selection.
      2. Optionally select the Assignee. This is who will perform the maintenance.
      3. Optionally select the Equipment that is receiving maintenance.
        1. Any related Equipment Labels will appear, for reference.
    3. Click SAVE & BEGIN if the event information is correct and ready to begin. This will open the event. Click SAVE if the event information is correct, but does not need to be opened immediately.

    Example:
    Forklift Inspection for Forklift #2 needs to be performed and recorded. On creation of the Maintenance Event, the following were chosen:

    • Plan: Forklift Daily Inspection
    • Equipment: Forklift #2
      Screenshot 2025-04-23 at 2.25.49 PM.png

    Perform a Maintenance Event

    Once a Maintenance Event is created and active, it can be performed and completed.

    To do so:

    1. Open the Maintenance Event.

      1. On the Maintenance Dashboard, click the Complete Maintenance Steps icon or the link to the event.
        Screenshot 2025-04-23 at 2.38.00 PM.png

      2. On the Maintenance Events page, click the link to the event Number.
        Screenshot 2025-04-23 at 2.42.03 PM.png

    2. Start the timer for the Maintenance Event if applicable (or do this at step 4). Maintenance timers contribute to labor costing.
      Screenshot 2025-04-23 at 3.05.14 PM.png

    3. Navigate to the Next Nodes section.

    4. Complete the steps as they are performed by the operator. Enter any Sensor or Inventory Item depletions as they appear.

    • Click COMPLETE MULTIPLE NODES to view all steps at once.
      a. Click COMPLETE as each step is performed.
      b. Click COMPLETE ALL to complete all steps at once.
      c. Click UNDO to undo the completion of a step.
      d. Click SAVE if to save all completed steps.

    OR

    • Click COMPLETE STEP to view the particular step
      a. Click SAVE when the open step has been performed.
    1. Once all steps are complete, and if the event didn't automatically complete, click the COMPLETE MAINTENANCE EVENT button in the Next Nodes section.
      1. To un-complete an event, click the UN-COMPLETE MAINTENANCE EVENT button in the Next Nodes section.
    2. All completed steps will appear in the Node Events section.
      1. To delete a completed step, click the delete icon in the associated row. Only the last completed step can be deleted.
    3. Any timers associated with the event will appear in the Billed Labor section. Timers can be edited or deleted here.
    4. Click the UPLOAD FILE button to add any necessary files to the Maintenance Event.
      1. File upload can also be done from the main Maintenance Events table. Click the Attach a file to this event icon on the event row.
    5. Enter any comments necessary near the top of the page in the Comments section.

    Edit/Archive/Unarchive a Maintenance Event

    An active Maintenance Event can be edited or archived/unarchived. A complete Maintenance Event cannot be edited, but it can be archived/unarchived.

    To edit or archive/unarchive a maintenance event:

    1. Navigate to the Maintenance Nodes page.
      a. Select "View Active" or "View Complete" depending on the status of the event.
      b. Click the Edit pencil icon to make any adjustments to the event. Open the event if any other details need to be adjusted.
      c. Click the Archive icon to archive the event. Events can be unarchived (step 3).

    Screenshot 2025-04-23 at 3.19.48 PM.png

    1. If edits were made, click SAVE.
    2. If an event needs to be unarchived - Toggle the "View Archived" switch on, and click the Unarchive icon.
      Screenshot 2025-04-23 at 3.23.50 PM.png

    --


    Was this article helpful?

    What's Next