Stop Codes
Stop Codes is the catalog of reasons why a piece of equipment or fixed asset stops working (a breakdown, scheduled maintenance, no operator, out of fuel, etc.). Each code is later selected when logging an actual equipment stoppage, so you can measure how much time is lost and why, inside the Industrial Maintenance module.
What is it and what is it for?
Each record in this catalog is simply a Name and optional internal notes. You'll find this same information under different names depending on which screen you're on: the menu and the list call it "Stop Codes", the create/edit form calls it a "Downtime Code", and when you pick it from another screen the field is labeled "Failure Code". They all point to the same catalog.
This catalog doesn't log stoppages by itself: it only defines the possible causes. The actual stoppage of a piece of equipment (with its start date, end date, hours lost and the affected equipment) is recorded on the Failure Records screen, where you pick one of these codes to indicate the cause. A well-thought-out catalog of codes then lets you build maintenance reports that show how much time you lost, by cause, by equipment, by equipment class or by day.
Screens in this area
| Screen | What it does |
|---|---|
| List | All the registered stop codes, sorted by name. From here you open each one to view or edit it, or create a new one. |
| Create / Edit | A simple form with the code's name and its internal notes. |
| Details | A read-only view of the code's data with a shortcut to edit it if you have the corresponding permission. |
How to create a stop code step by step
- Open the list and click New. You need the "add" level of the "Stop Codes" permission.
- Enter the name. It's the only required field, for example "Mechanical Failure", "Scheduled Maintenance", "Out of Fuel" or "No Operator". It must be different from any other code already registered (200 characters maximum).
- Add notes (optional) if you want to clarify for your team when this specific code should be used.
- Save. The code is immediately available for selection on any equipment's Failure Record.
Where it's used
- In the Failure Code field of equipment Failure Records, to indicate why a piece of equipment was down.
- As a filter and grouping criterion in maintenance reports: Failures by Equipment, Failures by Equipment Class, Failures by Reason and Failures by Day.
Key fields
| Field | What it's for |
|---|---|
| Name | A description of the stoppage cause (for example, "Mechanical Failure" or "Scheduled Maintenance"). It's the only required field and cannot repeat with another code already registered. |
| Notes | Free text to clarify the internal use of this code, visible only within this screen. |
Validations when saving
- Name is required.
- Name must be unique: it cannot repeat with another code already registered.
- You cannot delete a code if it's already been used on a Failure Record; the system shows you the document type and number of the affected transactions so you know what to review first.
Availability, plan and modules
- This screen is only available on the Enterprise plan, and only when your company has the Industrial Maintenance module active. If the module isn't active, neither the menu nor the screen will be visible.
- Access is controlled by the "Stop Codes" permission of the user group, with separate levels to view, add, edit and delete.
Tips and common pitfalls
Think about your reports first. Define codes specific enough to be useful when analyzing maintenance reports (for example, separating "Electrical Failure" from "Mechanical Failure"), but not so many that your team ends up unsure which one to pick when logging a stoppage.
Don't get confused by the different names. "Stop Code", "Downtime Code" and "Failure Code" are the same thing seen from different screens in the product; they're not separate catalogs.
Can't delete a code? That's because it's already been used on a Failure Record. Review those transactions before trying to delete it again; if the code no longer applies but has history, it's safer to just stop using it than to delete it.