User Story: Facility Management

Total Facilities

Value (5): A distinct count of all facilities registered in the system, regardless of their status. <br> Formula: COUNT(DISTINCT Facility_ID)

The master Facility Registry table.

Title: Total Facilities <br> Description: "The total number of facilities, including active and inactive, that are registered in the system."

Operational

Value (4): A count of all facilities with a status of 'Active' or 'Operational'. <br> Formula: COUNT(Facilities) WHERE Status = 'Operational'

The Status field in the Facility Registry table.

Title: Operational Facilities <br> Description: "The number of facilities that are currently active and in service."

Avg Condition Score

Value (78): The weighted average of the condition scores of all operational facilities. <br> Formula: SUM(Facility_Condition_Score * Facility_Weight) / SUM(Facility_Weight) <br> Business Rule: The score is categorized (e.g., 0-40=Poor, 41-75=Fair, 76-100=Good). The color of the card (yellow for 'Fair') should reflect this category.

Aggregated from the Condition_Score of each individual facility in the registry.

Title: Average Condition Score <br> Description: "The weighted average health score across all operational facilities. This score is derived from the aggregated condition of its underlying systems and assets."

Total Capacity

Value (280): The sum of the design capacity for all operational facilities. <br> Formula: SUM(Design_Capacity) for all operational facilities. <br> Unit: MLD (Megaliters per Day).

The Design_Capacity field in the Facility Registry table.

Title: Total Capacity <br> Description: "The combined total design capacity (in Megaliters per Day) of all currently operational facilities."

Search Facilities...

Functionality: A free-text search box. <br> Business Rule: As the user types, the "Facilities Registry" list below will dynamically filter to show only facilities where the Facility ID, Name, Type, or Zone/Division matches the search term. The search should be case-insensitive.

Filters

Functionality: Opens a dropdown or modal with advanced filtering options. <br> Filter Options: <br> • Type: Multi-select checklist of all available facility types (e.g., Water Treatment Plant, Pumping Station). <br> • Zone/Division: Multi-select checklist of all defined zones. <br> • Condition: Multi-select checklist of condition statuses (Good, Fair, Poor). <br> • Status: Multi-select checklist of operational statuses (Operational, Inactive, Under Construction). <br> Business Rule: Applying a filter updates the registry list and recalculates the KPIs at the top to reflect the filtered data set.

Export

Functionality: Exports the currently displayed list of facilities. <br> Business Rule: Clicking this button will generate and download a CSV or Excel file. The exported file must respect any active search or filter criteria. The columns in the export should match the columns in the registry table.

Bulk Add

Functionality: Opens a modal for importing multiple facilities from a file. <br> Business Rule: The user can download a template (CSV/Excel), fill it out, and upload it. The system must validate the uploaded data against the business rules for each field before importing. A summary of successful and failed imports must be shown to the user.

Add New Facility

Functionality: Navigates the user to the first screen of the multi-step "Create New Facility" wizard. <br> Business Rule: This button is the primary entry point for manually onboarding a single new facility.

Facility ID

A unique, system-generated, or user-defined identifier for the facility (e.g., FAC-001). This is the primary key. Clicking the ID navigates to the detailed view of that facility.

Facility Registry table.

Title: Facility ID <br> Description: "The unique identifier for the facility. Click to view the facility's detailed profile."

Name

The common name of the facility (e.g., Water Treatment Plant A).

Facility Registry table.

Title: Facility Name <br> Description: "The common name of the facility."

Type

The classification of the facility. This must be a value from a pre-defined list managed in Settings.

Facility Registry table.

Title: Facility Type <br> Description: "The primary function or classification of the facility."

Zone / Division

The geographical or administrative zone the facility belongs to. This must be a value from a pre-defined list.

Facility Registry table.

Title: Zone / Division <br> Description: "The operational or geographical district this facility belongs to."

Systems

The total number of child "Systems" associated with this facility in the asset hierarchy. <br> Formula: COUNT(Systems) WHERE Parent_Facility_ID = [This Facility_ID]

A live count from the Systems table, linked by Facility_ID.

Title: Systems Count <br> Description: "The total number of distinct operational systems contained within this facility."

Assets

The total number of individual "Assets" associated with this facility. <br> Formula: COUNT(Assets) WHERE Parent_Facility_ID = [This Facility_ID]

A live count from the Assets table, linked by Facility_ID.

Title: Assets Count <br> Description: "The total number of individual assets registered to this facility."

Condition Score

The calculated health score for the specific facility, from 0-100. <br> Business Rule: The score is displayed with a color-coded tag (e.g., 85 = Good, 72 = Fair) based on pre-defined thresholds in Settings. This score is an aggregation of the conditions of its child systems and assets.

Facility Registry table. The value is calculated by a separate condition assessment engine.

Title: Condition Score <br> Description: "The overall health score of this facility, aggregated from the condition of its systems and assets. (Good: 76-100, Fair: 41-75, Poor: 0-40)."

Design / Current Capacity (MLD)

Design (e.g., 50): The maximum capacity the facility was designed to handle. This is a static value. <br> Current (e.g., 45.2): The actual, real-time operational capacity, which may be lower due to asset condition or operational issues. <br> Unit: MLD (Megaliters per Day).

Design_Capacity is from the Facility Registry. Current_Capacity is a calculated value based on the real-time status of its critical assets.

Title: Design / Current Capacity <br> Description: "The facility's original design capacity versus its current operational capacity, which can be affected by asset condition and performance."

Actions

A "kebab" menu (...) that opens a dropdown of actions for that specific row. <br> Options: <br> • View Details: Navigates to the facility's detailed profile page. <br> • Edit: Opens the "Edit Facility" wizard. <br> • Deactivate/Activate: Toggles the operational status of the facility. <br> • Delete: Permanently removes the facility (requires confirmation and is only possible if no child assets are linked).

N/A

Title: Actions <br> Description: "Perform an action on this facility record."

Pagination

Controls for navigating through a large list of facilities. <br> Show per page: A dropdown to select the number of rows to display (e.g., 10, 25, 50, 100).

N/A

N/A

Breadcrumbs (Dashboard > add-facility)

Shows the user's current location. "add-facility" indicates they are in a creation workflow.

Back to Facilities Button

Functionality: Navigates the user back to the main "Facilities Registry" screen. <br> Business Rule: If the user has entered any data, a confirmation modal must appear before navigating away, warning them that "Unsaved changes will be lost. Are you sure you want to continue?".

Page Title (Add New Facility)

A clear title indicating the purpose of the screen.

Subtitle

"Create a new facility in the utility system."

Facility ID*

Functionality: A unique identifier for the facility. <br> Business Rules: <br> • The system automatically suggests a unique ID (e.g., FAC-YYYY-NNN). The format is FAC-[Current Year]-[Sequential Number]. <br> • This field must be editable by the user, but the system must perform a real-time check to ensure the entered ID does not already exist in the database. If it does, an error message "Facility ID already exists" must be shown. <br> • Validation: Must not be empty.

System-generated, with user override capability.

Title: Facility ID <br> Description: "A unique system identifier for the facility. It is auto-generated but can be overridden. Must be unique across all facilities."

Facility Name*

Functionality: The common, human-readable name for the facility. <br> Placeholder: "e.g., Northwood Regional Water Treatment Plant" <br> Validation: Must not be empty. Maximum length of 255 characters.

User input.

Title: Facility Name <br> Description: "The full, descriptive name of the facility."

Facility Type*

Functionality: A dropdown menu to classify the facility. <br> Business Rules: <br> • The user must select one type from the list. <br> • The list of options is dynamic and managed under Settings > Asset Classification. <br> Options Shown: Water Treatment Plant, Wastewater Treatment Plant, Water Pumping Station, etc.

Master data from Settings > Asset Classification.

Title: Facility Type <br> Description: "Select the primary function of this facility. This classification determines available parameters and reporting categories."

Operating Status*

Functionality: A dropdown to set the current operational status. <br> Business Rules: <br> • The list of options is managed in Settings. <br> • Standard Options: Operational, Inactive, Under Construction, Decommissioned. <br> • The selection here will determine if the facility is included in KPIs like "Operational Facilities" and "Total Capacity".

Master data from a Status configuration table.

Title: Operating Status <br> Description: "The current operational status of the facility. This affects its inclusion in performance calculations."

Operational Hours*

Functionality: A dropdown to define the facility's standard operating schedule. <br> Business Rules: <br> • The list of options is dynamic and managed in Settings. <br> • Options Shown: 24/7 - Continuous Operations, 16/5 - 16 hours/day, 5 days/week, On-Demand, Seasonal. <br> • This information can be used by the O&M and Energy modules to schedule maintenance or analyze off-peak energy usage.

Master data from an Operational_Schedules configuration table.

Title: Operational Hours <br> Description: "The standard operating schedule for this facility. This helps in planning maintenance and analyzing performance."

Address / Site Label

Functionality: A text field for a descriptive location label or address. <br> Business Rules: <br> • This field can be auto-populated based on the location pinned on the map using a reverse geocoding service. <br> • The user can manually edit or override the auto-populated value. <br> Validation: Optional, but recommended.

User input or auto-filled via GIS reverse geocoding.

Title: Address / Site Label <br> Description: "The physical street address or a descriptive site label for the facility's location."

Map Pin Location

Functionality: An interactive map for setting the precise geographic coordinates. <br> Business Rules: <br> • This is an embedded map interface (e.g., Leaflet, ArcGIS, Google Maps). <br> • The user can click on the map to place a pin. <br> • Placing the pin automatically populates the Latitude and Longitude fields below. <br> • The user can also search for an address within the map to move the view.

GIS Integration.

Title: Map Pin Location <br> Description: "Click on the map to set the precise geographic location of the facility. This will auto-populate the latitude and longitude."

Latitude*

Functionality: The geographic latitude of the facility. <br> Business Rules: <br> • This field is auto-populated when the user clicks on the map. <br> • It can also be manually entered. If entered manually, the pin on the map must move to the corresponding location. <br> Validation: Must be a valid numerical latitude value (between -90 and 90).

Auto-populated from map or manual user input.

Title: Latitude <br> Description: "The geographic latitude of the facility. Auto-filled from the map or can be entered manually."

Longitude*

Functionality: The geographic longitude of the facility. <br> Business Rules: <br> • This field is auto-populated when the user clicks on the map. <br> • It can also be manually entered. If entered manually, the pin on the map must move to the corresponding location. <br> Validation: Must be a valid numerical longitude value (between -180 and 180).

Auto-populated from map or manual user input.

Title: Longitude <br> Description: "The geographic longitude of the facility. Auto-filled from the map or can be entered manually."

Area*

Functionality: A dropdown to assign the facility to a predefined geographical or administrative area. <br> Business Rules: <br> • The list of options (e.g., North District, Central District) is managed in Settings. <br> • This is used for regional filtering and reporting.

Master data from a Zones/Areas configuration table.

Title: Area <br> Description: "Assign this facility to a predefined operational area or district for reporting and management."

Facility Manager / Lead Contact*

Functionality: A searchable dropdown to assign a primary point of contact. <br> Business Rules: <br> • This dropdown searches the system's user directory. <br> • When a user is selected, their contact details (Phone, Email) are automatically populated in the read-only fields below.

The system's User Directory.

Title: Facility Manager / Lead Contact <br> Description: "The primary point of contact responsible for this facility. Their contact details will be auto-populated."

Contact Details

Functionality: Read-only fields displaying the selected manager's contact info. <br> Business Rule: These fields are not editable and update automatically when the "Facility Manager" selection changes.

Pulled from the selected user's profile in the User Directory.

N/A

High-Level Operational Parameters

Overall Design Capacity (MLD)*

Functionality: The maximum capacity the facility was designed for. <br> Placeholder: "e.g., 30.5" <br> Validation: Must be a positive numerical value.

User input.

Title: Overall Design Capacity <br> Description: "The maximum design capacity of the facility in Megaliters per Day (MLD)."

Service Zone / Division*

Functionality: A dropdown to assign the facility to a service zone. <br> Business Rule: This may be the same as or a sub-category of the "Area" field, used for more granular operational management. The list is managed in Settings.

Master data from a Service_Zones configuration table.

Title: Service Zone / Division <br> Description: "The specific service zone this facility supports. Used for operational and customer impact analysis."

Financial & Lifecycle

Commissioned Date*

Functionality: The date the facility officially went into service. <br> Business Rule: A date picker interface must be used. The selected date cannot be in the future. This date is the starting point for calculating the asset's age.

User input via date picker.

Title: Commissioned Date <br> Description: "The date the facility was officially placed into service. This is used as the start date for its operational life."

Design Useful Life (Years)*

Functionality: The expected operational lifespan of the facility in years. <br> Placeholder: "e.g., 50" <br> Validation: Must be a positive integer.

User input.

Title: Design Useful Life <br> Description: "The expected number of years this facility is designed to operate before requiring major overhaul or replacement."

Annual Facility O&M Budget ($)*

Functionality: The budgeted annual cost for operating and maintaining the facility. <br> Placeholder: "e.g., 2500000" <br> Validation: Must be a positive numerical value.

User input.

Title: Annual O&M Budget <br> Description: "The budgeted annual cost for all operations and maintenance activities for this facility."

Documentation

Facility-Wide Documents

Functionality: A drag-and-drop area for uploading relevant documents. <br> Business Rules: <br> • Supports multiple file uploads. <br> • Allowed file types: PDF, DOCX, XLSX, JPG, PNG. <br> • A progress bar should be shown during upload. <br> • Uploaded files will be associated with this facility record and accessible from its profile. <br> Examples: Site Plans, Environmental Permits, Geotechnical Reports, Major As-Built Drawings.

User file uploads.

Title: Facility-Wide Documents <br> Description: "Upload important documents that apply to the entire facility, such as permits, site plans, or warranties."

Cancel

Functionality: Discards all entered information and returns the user to the "Facilities Registry" screen. <br> Business Rule: This action is identical to the "Back to Facilities" button and must trigger the same "Unsaved changes" confirmation modal if data has been entered.

Create Facility

Functionality: Submits the form to create the new facility record. <br> Business Rules: <br> • This button is disabled until all mandatory fields (*) are filled with valid data. <br> • On click, the system performs a final validation of all data. <br> • If successful, the facility record is created in the database, and the user is navigated to the next step in the wizard (e.g., "Asset Discovery" or the newly created facility's detailed profile page). <br> • If validation fails, the button remains disabled, and error messages are displayed next to the invalid fields.

Breadcrumbs (Dashboard > Facilities > Water Treatment Plant A)

Functionality: Shows the user's current location in the hierarchy. <br> Business Rule: "Dashboard" and "Facilities" are clickable links that navigate to their respective pages. "Water Treatment Plant A" is the current page and is not clickable.

Page Title (FAC-001)

The main title is the unique Facility ID, reinforcing its identity.

Subtitle

"Comprehensive facility information and operational details."

Facility ID

The unique identifier for the facility. This is a read-only display of the primary key.

The Facility_ID field from the Facility Registry.

Title: Facility ID <br> Description: "The unique identifier for this facility."

Facility Name

The common name of the facility. Read-only display.

The Name field from the Facility Registry.

Title: Facility Name <br> Description: "The common name of this facility."

Facility Type

The classification of the facility. Read-only display.

The Type field from the Facility Registry.

Title: Facility Type <br> Description: "The primary function or classification of this facility."

Commission Date

The date the facility was placed into service. Read-only display.

The Commissioned_Date field from the Facility Registry.

Title: Commissioned Date <br> Description: "The date this facility was officially placed into service."

Contact Person

The primary point of contact for this facility. Read-only display.

The Lead_Contact field from the Facility Registry, linked to the User Directory.

Title: Contact Person <br> Description: "The primary point of contact responsible for this facility."

Contact

The phone number of the contact person. Read-only display.

The Phone field from the selected user's profile.

Title: Contact Information <br> Description: "The primary phone number for the lead contact."

Location

The general district or location of the facility. <br> View on map: A clickable link that opens a modal or navigates to a GIS view, showing the facility's precise location on a map.

The Location or District field from the Facility Registry.

Title: Location <br> Description: "The general district where this facility is located. Click 'View on map' for the precise geographic location."

Area

The specific administrative or operational area. Read-only display.

The Area field from the Facility Registry.

Title: Area <br> Description: "The specific operational area this facility belongs to."

Zones / Divisions Served

A list of specific service zones this facility supports. <br> Business Rule: These are displayed as tags. If there are more than 3-4 zones, the list should be truncated with a "+X more" indicator.

A list of linked Service_Zones from the Facility Registry.

Title: Zones / Divisions Served <br> Description: "A list of all the specific service zones that receive service from this facility."

Description

A brief, human-readable description of the facility's purpose and function. Read-only display.

The Description field from the Facility Registry.

Title: Description <br> Description: "A summary of the facility's function and key characteristics."

Current Capacity (MLD)

Value (45.2 / 50): The current operational capacity versus the total design capacity. <br> Formula (Current): Calculated based on the operational status and performance of critical child assets. <br> Formula (Design): Static value from the Design_Capacity field. <br> Percentage (90%): (Current Capacity / Design Capacity) * 100. The progress bar visualizes this percentage.

Design_Capacity is from the Facility Registry. Current_Capacity is a real-time calculation from underlying asset performance data.

Title: Current Capacity <br> Description: "The current operational capacity versus the original design capacity. A reduction can indicate performance issues or assets being out of service."

Systems

Value (3): A distinct count of all active systems that are children of this facility. <br> Formula: COUNT(Systems) WHERE Parent_Facility_ID = 'FAC-001' AND Status = 'Active'

A live count from the Systems table.

Title: Active Systems <br> Description: "The number of active operational systems contained within this facility. Click to view the list of systems."

Networks

Value (2): A distinct count of all networks connected to this facility. <br> Formula: COUNT(Networks) WHERE Connected_Facility_ID = 'FAC-001'

A live count from the Networks table.

Title: Connected Networks <br> Description: "The number of distribution or collection networks connected to this facility. Click to view the list of networks."

Assets

Value (12): A distinct count of all individual assets that belong to this facility. <br> Formula: COUNT(Assets) WHERE Parent_Facility_ID = 'FAC-001'

A live count from the Assets table.

Title: Total Assets <br> Description: "The total number of individual assets registered to this facility. Click to view the list of assets."

Age

Value (7 years): The calculated age of the facility. <br> Formula: Current_Date - Commissioned_Date (displayed in years, rounded to the nearest whole year or one decimal place).

Calculated from the Commissioned_Date in the Facility Registry.

Title: Facility Age <br> Description: "The operational age of the facility, calculated from its commissioned date."

Condition

Value (85): The current condition score of the facility. <br> Business Rule: The score is an aggregation of the condition of its child systems and assets. It is displayed with a color-coded tag (Good) based on pre-defined thresholds.

The Condition_Score field from the Facility Registry.

Title: Condition Score <br> Description: "The overall health score of this facility, aggregated from its underlying components. (Good: 76-100, Fair: 41-75, Poor: 0-40)."

Risk Score

Value (82): The current risk score of the facility. <br> Business Rule: This score is a calculated value combining the probability of failure (derived from condition) and the consequence of failure (criticality). It is also displayed with a color-coded tag (Good suggests low risk).

The Risk_Score field from the Facility Registry.

Title: Risk Score <br> Description: "A score representing the overall risk posed by this facility, combining the likelihood of failure with the consequence of that failure."

Efficiency

Value (90%): A composite score representing the operational efficiency of the facility. <br> Formula: This could be a weighted average of metrics like (Current Capacity / Design Capacity), energy efficiency, and chemical usage efficiency.

A calculated value from various operational data sources (SCADA, Energy meters, etc.).

Title: Operational Efficiency <br> Description: "A composite score measuring the overall operational efficiency of the facility, including factors like capacity utilization and energy performance."

Edit Facility

Navigates the user to the "Edit Facility" wizard, which would be pre-populated with this facility's data.

Duplicate Facility

Functionality: Initiates a workflow to create a new facility using this one as a template. <br> Business Rule: Opens the "Add New Facility" screen, pre-populated with all the data from FAC-001 (except for the Facility ID, which would be new). This is useful for creating similar facilities quickly.

Create Service Order

Functionality: Creates a new work order (service order) associated with this facility. <br> Business Rule: Opens the "Create Service Order" form, with the "Facility" field already pre-populated with "FAC-001 - Water Treatment Plant A".

Delete Facility

Functionality: Permanently deletes the facility record. <br> Business Rule: This action must be protected by a confirmation modal that clearly states "This action is irreversible and will permanently delete the facility. Are you sure?". Deletion should be blocked if the facility has any child Systems or Assets associated with it. The user must first reassign or delete all child objects. The button may be disabled with a tooltip explaining this rule if child objects exist.

Performance

This is the currently active tab. It displays the "Key Metrics" and other performance-related information shown on the screen.

Alerts

Displays a filtered list of all active and historical operational alerts (e.g., from SCADA, field alerts) that are associated with this facility or any of its child assets.

Finance

Displays financial information specific to this facility, such as YTD O&M spend vs. budget, depreciation, and the total value of its assets.

Compliance

Displays compliance-related information, such as active violations, upcoming inspections, and water quality sample results associated with this facility.

Systems

Displays a detailed, filterable list of all the "Systems" that are children of this facility.

Networks

Displays a detailed, filterable list of all the "Networks" connected to this facility.

Assets

Displays a detailed, filterable list of all the individual "Assets" that belong to this facility.

Conditions & Risks

Provides a more detailed breakdown of the condition and risk assessments, including historical trends, assessment history, and details on what factors are contributing to the scores.

Schedules

Displays all maintenance schedules (PMs, inspections) associated with this facility and its child assets.

O&M

Displays a detailed history of all Operations & Maintenance activities, including a full list of past and present service orders for this facility.

Facility Health Index

Value (87.3): A composite score representing the overall health of this specific facility. <br> Formula: A weighted average of the facility's Condition Score, Risk Score, and key performance metrics (e.g., Asset Availability). <br> Trend (↑2.1% from last month): Compares the current index to the value from the previous month.

Aggregated from this facility's condition, risk, and performance data.

Title: Facility Health Index <br> Description: "A consolidated score from 0-100 indicating the overall health of this facility, combining asset condition, risk, and operational performance."

Asset Availability

Value (94.2%): The percentage of time the assets within this facility were operational. <br> Formula: (SUM(Scheduled Operating Time) - SUM(Unplanned Downtime)) / SUM(Scheduled Operating Time) * 100 for all assets in this facility. <br> Trend (↑1.3% from last month): Compares to the previous month.

Maintenance and operational logs (CMMS) for all assets within this facility.

Title: Asset Availability <br> Description: "The percentage of time assets within this facility were available to perform their required function during the selected period."

Out of Service

Value (8 (5.8%)): The count and percentage of assets within this facility that are currently inactive. <br> Formula (Count): COUNT(Assets) WHERE Parent_Facility_ID = [This Facility] AND Status = 'Out of Service' <br> Formula (%): (Out of Service Count / Total Assets in Facility) * 100 <br> Trend (↑2 from last month): Shows the change in the absolute number of out-of-service assets.

The master Asset Repository, filtered for this facility.

Title: Out of Service Assets <br> Description: "The total number and percentage of assets within this facility that are currently inactive or not operational."

Avg Remaining Life

Value (12.4 yrs): The average remaining useful life (RUL) of all assets within this facility. <br> Formula: SUM(Asset RUL) / COUNT(Assets) for all assets in this facility. <br> Trend (↓0.8 yrs from last quarter): Compares to the previous quarter's average RUL.

The RUL or Expected_Lifespan and Commissioned_Date fields from all assets within this facility.

Title: Average Remaining Life <br> Description: "The average number of years remaining before the assets in this facility are expected to reach the end of their service life."

Inspection Compliance

Value (91.7%): The percentage of scheduled regulatory and preventive maintenance inspections for this facility that were completed on time. <br> Formula: (COUNT(Completed Inspections) / COUNT(Scheduled Inspections)) * 100 for this facility. <br> Visual: The line graph shows the trend over the last few periods.

The Inspection/Maintenance module (CMMS).

Title: Inspection Compliance <br> Description: "The percentage of required inspections for this facility and its assets that were completed by their due date."

Overall Risk Score

Value (23): The aggregated risk score for this facility. <br> Formula: A criticality-weighted average of the risk scores of all assets within the facility. <br> Subtitle (Low risk): A qualitative assessment based on the score (e.g., 0-30=Low, 31-70=Medium, 71-100=High).

The Risk Register or Risk_Score field on asset records for this facility.

Title: Overall Risk Score <br> Description: "The aggregated risk score for this facility, combining the probability and consequence of failure for all its assets. A lower score is better."

Service Level Achievement

Value (96.8%): The percentage of time this facility met its defined service level targets (e.g., water pressure, quality parameters). <br> Formula: (Time Met Service Level / Total Time) * 100 <br> Visual: The line graph shows the trend over time.

SCADA systems, sensors, and operational data logs specific to this facility's output.

Title: Service Level Achievement <br> Description: "The percentage of time that this facility's operational service levels (e.g., pressure, flow, quality) were met."

Energy Efficiency

Value (285 kWh/ML): A measure of how much energy is used to produce one unit of output. <br> Formula: Total kWh Consumed / Total Megaliters (ML) Produced <br> Trend (↓12 kWh/ML vs last month): A downward trend is positive, indicating better efficiency.

Energy meters (for kWh) and production meters (for ML).

Title: Energy Efficiency <br> Description: "Measures the energy consumed (in kWh) to produce one megaliter (ML) of water. A lower number indicates better efficiency."

Monthly Energy Cost

Value ($18,650): The total energy cost for this facility for the current period. <br> Formula: SUM(kWh Consumed * Cost per kWh) <br> Trend (↓8.2% vs budget): Compares the actual cost to the budgeted amount for the period. A negative value (under budget) is positive.

Utility billing data and the internal budgeting system for this facility.

Title: Monthly Energy Cost <br> Description: "The total cost of energy for this facility during the current period, and its variance against the planned budget."

Energy Consumption by System

Functionality: A ranked list of the top energy-consuming systems within this facility. <br> Business Rules: <br> • The list is sorted descending by energy consumption (kWh). <br> • Each row displays: System Name, System ID, a progress bar showing its percentage of the facility's total consumption, and the absolute kWh value. <br> • Clicking on a system (e.g., "Aeration System") should navigate to a detailed performance view for that specific system.

Energy sub-metering data, aggregated by system.

Title: Energy Consumption by System <br> Description: "A breakdown of energy usage by the major operational systems within this facility. This helps identify the largest consumers for efficiency efforts."

Turbidity, Chlorine, pH, etc.

Functionality: A series of cards for key water quality parameters. <br> Business Rules: <br> • Each card shows the Parameter Name, the latest reading, the target/required range, and a status tag. <br> • Status Tag: The tag color and text are rule-based: Within Limits (Green) if the value is within the target range, Approaching Limit (Yellow) if it's near a boundary, and Exceeded (Red) if it's outside the range. Normal or Compliant are also used for pass/fail tests.

Laboratory Information Management System (LIMS) and real-time SCADA sensors.

Title: [Parameter Name] <br> Description: "The latest reading for [Parameter Name]. The target is [Target Range]. The current status is [Status]."

Asset Health Status Distribution

Functionality: A breakdown of all assets in this facility by their condition. <br> Business Rules: <br> • Shows the count and percentage of assets in 'Good', 'Fair', and 'Poor' condition. <br> • Formula: COUNT(Assets) WHERE Condition = '[Status]' and (Status Count / Total Assets) * 100. <br> • The color legend must be consistent across the application.

The Condition field from all asset records within this facility.

Title: Asset Health Status Distribution <br> Description: "A breakdown of all assets in this facility by their assessed condition. This helps visualize the overall health of the asset base."

Asset Age Profile

Functionality: A breakdown of all assets in this facility by age. <br> Business Rules: <br> • Shows the count of assets in predefined age bands (e.g., 0-5 years, 5-10 years). <br> • The progress bar provides a quick visual comparison of the number of assets in each band.

The Commissioned_Date field from all asset records within this facility.

Title: Asset Age Profile <br> Description: "A breakdown of all assets in this facility by age. This helps in long-term capital planning and understanding replacement cycles."

Financial Overview

Functionality: A set of KPIs summarizing the financial aspects of this facility. <br> Business Rules: <br> • Total Asset Value: SUM(Current Book Value) of all assets in the facility. <br> • Maintenance Spend: SUM(Maintenance Costs) for the current period for this facility. <br> • Budget Variance: ((Budgeted Spend - Actual Spend) / Budgeted Spend) * 100 for this facility. <br> • Emergency Repairs: SUM(Costs) from 'Emergency' work orders for this facility.

Financial/Accounting system and CMMS, filtered for this facility.

Title: [Metric Name] <br> Description: Provides a detailed definition for each financial metric as it applies to this facility.

Assets Approaching Replacement

Functionality: A watchlist of assets within this facility that are nearing their end-of-life. <br> Business Rules: <br> • Lists assets with a low Remaining Useful Life (e.g., < 2 years). <br> • Displays Asset Name, ID, Estimated Cost, and Expected Replacement Quarter. <br> • A priority tag (high, medium, low) is assigned based on the asset's criticality and risk. <br> • The "Schedule" button should initiate a capital planning or project creation workflow for that asset.

Master Asset Repository and Risk Register.

Title: Assets Approaching Replacement <br> Description: "A prioritized list of assets in this facility that will soon require replacement. Click 'Schedule' to begin the capital planning process."

Frequent Failure Assets

Functionality: A watchlist of the most unreliable assets in this facility. <br> Business Rules: <br> • Lists assets with the highest number of failure-related work orders in the last 6-12 months. <br> • Displays Asset Name, ID, Failure Count, and Last Failure Date. <br> • The "Inspect" button should create a high-priority inspection work order. <br> • The "Review" button should navigate to the asset's detailed performance and maintenance history page.

CMMS work order history, filtered for this facility.

Title: Frequent Failure Assets <br> Description: "A list of the most unreliable assets in this facility. These may be candidates for proactive overhaul or replacement."

Emergency Work Orders

Value (7): A count of all open work orders for this facility with a priority of 'Emergency' or 'Critical'. <br> Formula: COUNT(WOs) WHERE Facility_ID = [This Facility] AND Priority IN ('Emergency', 'Critical') AND Status = 'Open' <br> Assign Resources Button: Opens the resource scheduler, pre-filtered to show available technicians suitable for emergency work for this facility.

CMMS Work Order module.

Title: Emergency Work Orders <br> Description: "The number of open, high-priority work orders for this facility requiring immediate assignment. Click to dispatch a team."

SLA Breaches

Value (3): A count of events in the period where a Service Level Agreement linked to this facility was breached. <br> Formula: COUNT(SLA_Breach_Events) WHERE Facility_ID = [This Facility] <br> Escalate Button: Triggers a pre-defined escalation workflow, notifying senior management and creating a high-priority incident report for this facility's performance.

SLA monitoring system; CMMS.

Title: SLA Breaches <br> Description: "The number of times a Service Level Agreement for this facility has been breached. Click 'Escalate' to initiate a formal review."

Overdue Tasks

Value (12): A count of all work orders for this facility where the current date is past the Due_Date and the status is not 'Completed'. <br> Formula: COUNT(WOs) WHERE Facility_ID = [This Facility] AND Due_Date < Current_Date AND Status != 'Completed' <br> View Details Button: Navigates to a pre-filtered list of these 12 overdue work orders.

CMMS Work Order module.

Title: Overdue Tasks <br> Description: "The total number of work orders for this facility that have passed their scheduled due date. Click 'View Details' to take action."

Work Order Backlog

Value (24 / Est. 156 hours): The number of open work orders and the total estimated labor hours required to complete them for this facility. <br> Formula (Count): COUNT(WOs) WHERE Facility_ID = [This Facility] AND Status IN ('Open', 'Scheduled') <br> Formula (Hours): SUM(Estimated_Duration) for those work orders. <br> Optimize Schedule Button: Launches an intelligent scheduling tool for this facility's backlog, suggesting an optimal work plan based on priority, resource availability, and asset location.

CMMS Work Order module.

Title: Work Order Backlog <br> Description: "A summary of all pending work for this facility. Click 'Optimize Schedule' to use the intelligent scheduling assistant."

High Maintenance Cost Assets

Functionality: A ranked list of assets within this facility that are the most expensive to maintain. <br> Business Rules: <br> • The list is sorted descending by the calculated monthly maintenance cost. <br> • Each item displays Asset Name, ID, and the calculated average monthly cost (shown in red to indicate a negative financial impact). <br> • Review Button: Navigates to the detailed financial and maintenance history page for that specific asset, allowing the manager to analyze the root cause of the high costs.

CMMS, by summing all maintenance costs (labor, parts) per asset over a rolling period (e.g., 6 months) and averaging it.

Title: High Maintenance Cost Assets <br> Description: "These assets are the largest drivers of maintenance spending for this facility. Click 'Review' to analyze their cost history."

Predictive Maintenance Alerts

Functionality: A list of assets that a predictive model has identified as needing future maintenance. <br> Business Rules: <br> • This is different from "Anomalies" as it's based on long-term degradation models, not immediate deviations. <br> • Each item displays Asset Name, ID, the specific maintenance needed (e.g., "Bearing replacement needed"), the model's confidence level (e.g., "87% confidence"), and the recommended timeframe ("within 2 weeks"). <br> • Schedule Button: Opens the "Create Service Order" form, pre-populated with the asset details, the recommended task, and a suggested due date based on the timeframe.

Predictive Maintenance analytics engine.

Title: Predictive Maintenance Alerts <br> Description: "The system predicts these assets will require maintenance within the specified timeframe to prevent failure. Click 'Schedule' to create a proactive work order."

Active Violations

Functionality: A list of current, unresolved compliance violations specific to this facility. <br> Business Rules: <br> • Each item displays the Violation Type, its current status (e.g., PENDING, MONITOR, INVEST), and the due date for resolution. <br> • View Details Button: Navigates to the detailed record for that specific violation in the Compliance module.

Compliance Violation tracking module.

Title: Active Violations <br> Description: "A list of current, unresolved compliance violations for this facility. Click 'View Details' for the full response plan."

Overdue Inspections

Functionality: A list of mandatory inspections for assets within this facility that are past their due date. <br> Business Rules: <br> • The list is sorted by priority, then by how long it's overdue. <br> • Each item displays the Asset Name, ID, a priority tag (high, medium, low), and how many days it is overdue. <br> • Schedule Button: Opens the "Create Service Order" form, pre-populated as a high-priority inspection task for that asset.

CMMS or a dedicated Inspections module.

Title: Overdue Inspections <br> Description: "These mandatory inspections for assets in this facility are past due. Click 'Schedule' to create a work order immediately."

Current Book Value

Value ($12,500,000): The net value of the facility on the company's books. <br> Formula: Initial Capital Cost - Accumulated Depreciation

Calculated from the other fields in this section.

Title: Current Book Value <br> Description: "The current accounting value of the facility. This is calculated as the initial cost minus all depreciation to date."

Initial Capital Cost

Value ($25,000,000): The total cost to acquire or build the facility. <br> Business Rule: This is a static value, typically entered when the facility is first registered. It can only be changed by a "Capital Improvement" event.

The Initial_Capital_Cost field from the Facility Registry.

Title: Initial Capital Cost <br> Description: "The total original cost to acquire or construct the facility, including all initial setup expenses."

Accumulated Depreciation

Value (($12,500,000)): The sum of all depreciation expenses recorded for this facility since it was commissioned. <br> Business Rule: Displayed as a negative number in red to indicate it's a reduction in value. This value increases over time.

A sum of all "Annual Depreciation" events from the Facility Financial History Ledger.

Title: Accumulated Depreciation <br> Description: "The total amount of depreciation that has been charged against this facility since it was placed into service."

Salvage Value

Value ($0): The estimated residual value of the facility at the end of its useful life. <br> Business Rule: This is typically a static value entered during registration.

The Salvage_Value field from the Facility Registry.

Title: Salvage Value <br> Description: "The estimated resale value of the facility at the end of its useful life. This amount is not depreciated."

Calculate Finance Button

Functionality: A manual trigger to run the next period's financial calculations. <br> Business Rules: <br> 1. When clicked, the system calculates the next depreciation event (e.g., for the current year if not already calculated). <br> 2. It updates the "Accumulated Depreciation" and "Current Book Value" fields. <br> 3. Crucially, it creates a new entry in the "Facility Financial History Ledger" (visible on the History sub-tab) with an "Event Type" of "Annual Depreciation" and the calculated Value Change. <br> 4. The button may be disabled if the calculation for the current period has already been run, with a tooltip explaining "Depreciation for the current period has already been calculated."

N/A

Title: Calculate Finance <br> Description: "Manually triggers the financial calculation for the next period (e.g., annual depreciation). This will update the facility's book value and create a new entry in the financial history ledger."

Annual Depreciation (Current Year):

Value ($500,000): The amount of depreciation expense for the current fiscal year. <br> Formula: (Initial Capital Cost - Salvage Value) / Design Useful Life (Years)

Calculated field.

Title: Annual Depreciation <br> Description: "The calculated amount of depreciation expense for this facility for the current fiscal year."

Depreciation To Date (Current Year):

Value ($250,000): The portion of the current year's depreciation that has been recognized so far. <br> Formula: Annual Depreciation * (Number of Months Passed in Fiscal Year / 12)

Calculated field.

Title: Depreciation To Date <br> Description: "The portion of this year's annual depreciation that has been accounted for as of today's date."

Remaining Depreciation:

Value ($12,500,000): The total amount of depreciation that has yet to be charged over the rest of the facility's life. <br> Formula: Current Book Value - Salvage Value

Calculated field.

Title: Remaining Depreciation <br> Description: "The total amount of value that is yet to be depreciated over the remaining useful life of the facility."

Next Depreciation Date:

Value (Dec 31, 2025): The date of the next scheduled major depreciation event. <br> Business Rule: This is typically the end of the fiscal year.

Calculated based on the last depreciation event date.

Title: Next Depreciation Date <br> Description: "The date the next annual depreciation expense will be officially recorded."

View:

A dropdown to filter the ledger by time. Options: "All Years," "Last 5 Years," "Last 12 Months," or a specific year (e.g., "2024," "2023"). Default is "All Years."

Event Type:

A multi-select dropdown to filter by the type of financial event. Options: "All Events," "Annual Depreciation," "Capital Improvement," "Revaluation," "Impairment." Default is "All Events."

Compliance Status

Overall Status: "On Schedule"

A calculated status. If Next Sample Due is not past and all previous samples were taken, status is "On Schedule." If a due date is missed, it becomes "Overdue" (Red).

LIMS/Sampling Schedule

Title: Compliance Status <br> Description: "Indicates if the facility is on track with its mandatory sampling schedule."

Samples Taken (This Month): 10

COUNT(Samples) where Sample_Date is in the current month for this facility.

LIMS

Title: Samples Taken <br> Description: "The total number of regulatory samples collected and analyzed for this facility so far this month."

Next Sample Due: July 15, 2025

The earliest Due_Date for any upcoming scheduled sample for this facility.

Sampling Schedule Module

Title: Next Sample Due <br> Description: "The due date for the next required regulatory sample."

View Full Schedule Button

Navigates to a dedicated, detailed page showing the complete annual sampling schedule for this facility.

N/A

N/A

Water Quality Compliance

Overall Status: "In Compliance"

A calculated status. If Exceedances (Last 30 Days) is 0, status is "In Compliance." If > 0, status is "Violation Detected" (Red).

LIMS

Title: Water Quality Compliance <br> Description: "Indicates if all water quality parameters are currently within their regulatory limits."

Parameters Monitored: 0

This seems to be an error in the screenshot data. It should be a COUNT(DISTINCT Parameter) for all monitored parameters for this facility.

LIMS/Sampling Schedule

Title: Parameters Monitored <br> Description: "The total number of distinct water quality parameters being monitored for this facility."

Exceedances (Last 30 Days): 0

COUNT(Samples) where Result is outside the regulatory limit and Sample_Date is within the last 30 days.

LIMS

Title: Recent Exceedances <br> Description: "The number of times a sample has tested outside of its regulatory limits in the last 30 days."

View Recent Results Button

Navigates to a detailed log of all recent sample results for this facility.

N/A

N/A

Title (Systems Management)

A clear title for the section.

Subtitle

"Manage and monitor all systems within this facility."

Add System Button

Functionality: This is the primary call-to-action to associate a new system with this facility. <br> Business Rule: Clicking this button opens the "System Suggestions" modal as the first step. This intelligent feature helps the user quickly find and connect relevant systems.

Search systems...

Functionality: A free-text search box. <br> Business Rule: As the user types, the list of systems below will dynamically filter to show only systems where the System ID or Name matches the search term. The search is case-insensitive.

Filter Button

Functionality: Opens a dropdown or modal with advanced filtering options for the list. <br> Filter Options: <br> • Location: Multi-select checklist of locations within the facility. <br> • Condition Score: A slider or range input to filter by condition (e.g., 70-90). <br> • Risk Score: A slider or range input to filter by risk. <br> Business Rule: Applying filters updates the list of systems shown.

Export Button

Functionality: Exports the currently displayed list of systems. <br> Business Rule: Generates a CSV/Excel file of the systems list, respecting any active search or filter criteria.

Title (Networks Management)

A clear title for the section.

Subtitle

"Monitor and manage distribution networks and transmission lines."

Add Network Button

Functionality: This is the primary call-to-action to associate a new network with this facility. <br> Business Rule: Clicking this button opens the "Network Suggestions" modal as the first step, providing an intelligent way to find and connect relevant networks.

Search networks...

Functionality: A free-text search box. <br> Business Rule: As the user types, the list of networks below will dynamically filter to show only networks where the Network ID or Name matches the search term. The search is case-insensitive.

Filter Button

Functionality: Opens a dropdown or modal with advanced filtering options for the list. <br> Filter Options: <br> • Parent System: Multi-select checklist of all systems within this facility to see which networks they feed. <br> • Condition Score: A slider or range input to filter by condition (e.g., 70-90). <br> • Network Length: A range input to filter by length (e.g., 5-10 km). <br> Business Rule: Applying filters updates the list of networks shown.

Export Button

Functionality: Exports the currently displayed list of networks. <br> Business Rule: Generates a CSV/Excel file of the networks list, respecting any active search or filter criteria.

Facility Condition

Score (82): The current, official condition score for the facility. <br> Status Tag (Good): A color-coded, qualitative assessment based on the score (e.g., 0-40=Poor, 41-75=Fair, 76-100=Good).

The most recent "Condition" assessment from the Assessment History ledger.

Title: Facility Condition Score <br> Description: "The overall health score of this facility, aggregated from the condition of its systems and assets."

Last Assessed: June 15, 2025

The date of the most recent condition assessment.

Assessment History ledger.

Title: Last Assessed Date <br> Description: "The date the current condition score was officially recorded."

Assessed By: Jane Smith (Operations)

The name and department of the user who performed the last assessment.

Assessment History ledger.

Title: Assessed By <br> Description: "The user or team that performed the most recent condition assessment."

Assess Condition Button

Functionality: Initiates a new condition assessment workflow for the facility. <br> Business Rule: Clicking this would open a new screen or a comprehensive modal where an authorized user can input new data points to calculate a new condition score. Upon completion, a new entry is created in the "Assessment History" ledger.

N/A

N/A

Facility Risk

Score (65): The current, official risk score for the facility. <br> Status Tag (Medium): A color-coded, qualitative assessment based on the score (e.g., 0-30=Low, 31-70=Medium, 71-100=High).

The most recent "Risk" assessment from the Assessment History ledger.

Title: Facility Risk Score <br> Description: "A score representing the overall risk posed by this facility, combining the likelihood of failure (from condition) with the consequence of that failure."

Last Assessed: May 30, 2025

The date of the most recent risk assessment.

Assessment History ledger.

Title: Last Assessed Date <br> Description: "The date the current risk score was officially recorded."

Assessed By: Jane Doe (Engineering)

The name and department of the user who performed the last assessment.

Assessment History ledger.

Title: Assessed By <br> Description: "The user or team that performed the most recent risk assessment."

Assess Risk Button

Functionality: Initiates a new risk assessment workflow. <br> Business Rule: Similar to the condition assessment, this opens a workflow for an authorized user to calculate a new risk score, which then creates a new entry in the history ledger.

N/A

N/A

Systems with Lowest Condition

Filter: All Systems belonging to this facility. <br> Sort: By Condition Score in ascending order (worst first).

The Systems table, filtered for this facility.

Systems with Highest Risk

Filter: All Systems belonging to this facility. <br> Sort: By Risk Score in descending order (riskiest first).

The Systems table, filtered for this facility.

Assets in Poor Condition

Filter: All Assets belonging to this facility where Condition_Status is 'Poor'. <br> Sort: By Condition Score in ascending order (worst first).

The Assets table, filtered for this facility.

Assets with Highest Risk

Filter: All Assets belonging to this facility where Risk_Status is 'High'. <br> Sort: By Risk Score in descending order (riskiest first).

The Assets table, filtered for this facility.

Score Type:

A dropdown to filter the ledger by the type of assessment. Options: "All Assessments," "Condition," "Risk." Default is "All Assessments."

Assessed By:

A searchable dropdown to filter by the user who performed the assessment. The list is populated with all users who have ever assessed this facility. Default is "All Users."

Start Date / End Date:

Two date picker fields that allow the user to filter the history ledger to a specific date range.

Title (PM Schedules)

A clear title for the section.

Subtitle

"Preventive maintenance and inspection schedules for this facility."

Create Schedule Button

Functionality: This is the primary call-to-action to create a new recurring maintenance schedule. <br> Business Rule: Clicking this button would open a multi-step wizard where the user defines the schedule's name, type, frequency, the assets it applies to, and the specific tasks to be performed.

Manage Schedules Button

Functionality: This button likely navigates to a more advanced management interface. <br> Business Rule: This could lead to a screen with a calendar view of all schedules, tools for bulk-deactivating/activating schedules, or advanced configuration options for the work order generation engine.

Schedule ID

A unique identifier for the master schedule (e.g., PM-PUMP-001). This is the primary key for the schedule itself.

The master Schedule table.

Title: Schedule ID <br> Description: "The unique identifier for this recurring maintenance schedule."

Schedule Name

A human-readable name describing the purpose of the schedule (e.g., "Monthly Pump Inspection - Station 3").

The master Schedule table.

Title: Schedule Name <br> Description: "A descriptive name for this maintenance plan."

Type

A classification of the schedule. <br> Business Rule: Displayed as a color-coded tag. The options ("Preventive Maintenance," "Inspection") must come from a pre-defined list in Settings.

The master Schedule table.

Title: Schedule Type <br> Description: "The classification of this schedule, which determines the type of work orders it generates."

Frequency

The trigger that determines when the next work order should be generated. <br> Business Rule: This can be time-based (Monthly, Quarterly, Annually) or usage-based (Every 500 Hrs). Usage-based frequencies require integration with asset telemetry (SCADA/IoT) to track runtime.

The master Schedule table.

Title: Frequency <br> Description: "The trigger for generating the next work order. This can be based on time or asset usage."

Runs

The total number of times this scheduled activity has been performed (i.e., the number of completed work orders generated from this schedule).

A COUNT of completed work orders linked to this Schedule_ID.

Title: Runs <br> Description: "The total number of times this scheduled maintenance has been successfully completed to date."

Assets

The number of individual assets that are included in this maintenance schedule. <br> Business Rule: A single schedule can apply to a group of similar assets (e.g., all 5 pumps in a station).

A COUNT of assets linked to this Schedule_ID.

Title: Assets Covered <br> Description: "The number of individual assets included in this recurring schedule."

Next Due Date

The date when the next work order for this schedule is due to be completed. <br> Formula: This is calculated based on the Last Completed date and the Frequency. For example, Last Completed (June 15) + Frequency (Monthly) = Next Due Date (July 15).

A calculated field based on the schedule's frequency and last completion date.

Title: Next Due Date <br> Description: "The date the next work order generated by this schedule is due."

Last Completed

The completion date of the most recent work order generated by this schedule.

The Completion_Date from the last completed work order linked to this Schedule_ID.

Title: Last Completed Date <br> Description: "The date the most recent maintenance cycle for this schedule was completed."

Progress

A summary of the completion status for the current active cycle. <br> Formula: (Number of Assets Completed / Total Assets in Schedule) <br> Business Rule: This shows progress for schedules that involve multiple assets. For a schedule with 5 assets, if 3 have had their work orders completed, the progress is "3/5 Completed."

A real-time calculation based on the status of the currently open work orders generated by this schedule.

Title: Progress <br> Description: "The completion progress for the current maintenance cycle, especially for schedules covering multiple assets."

Status

The overall status of the master schedule itself. <br> Business Rule: Displayed as a color-coded tag. <br> • Active (Green): The schedule is running normally. <br> • Overdue (Red): The Next Due Date is in the past, and the work order is not yet complete. <br> • Inactive/Paused (Gray): The schedule has been manually paused and is not generating new work orders.

A calculated field based on the schedule's settings and the status of its latest work order.

Title: Schedule Status <br> Description: "The current status of the master schedule. 'Overdue' indicates that the most recent work order has passed its due date."

Actions

A "kebab" menu (...) that opens a dropdown of actions for that specific schedule. <br> Business Rule: <br> • View Details: Navigates to the detailed profile page for this master schedule. <br> • Edit Schedule: Opens the wizard to edit the schedule's parameters. <br> • Run Now: Manually generates a new work order from this schedule immediately, regardless of the due date. <br> • View History: Navigates to a page showing all past work orders generated by this schedule. <br> • Deactivate/Activate: Pauses or resumes the automatic generation of work orders from this schedule.

N/A

Title: Actions <br> Description: "Perform an action on this master schedule."

Search service orders...

Functionality: A free-text search box. <br> Business Rule: As the user types, the list of service orders below will dynamically filter to show only orders where the SO ID, SO Name, or Asset Name / ID matches the search term. The search is case-insensitive.

Filter Button

Functionality: Opens a dropdown or modal with advanced filtering options. <br> Filter Options: <br> • Type: Multi-select checklist of SO types (Preventive, Corrective, Inspection, Emergency). <br> • Priority: Multi-select checklist of priorities (High, Medium, Low, Critical). <br> • Status: Multi-select checklist of statuses (In Progress, Completed, Scheduled, Active, On Hold). <br> • Date Range: A start and end date picker to filter by creation date or due date. <br> Business Rule: Applying filters updates the list of service orders shown.

Export Button

Functionality: Exports the currently displayed list of service orders. <br> Business Rule: Generates a CSV/Excel file of the service orders list, respecting any active search or filter criteria.

SO ID

A unique, system-generated identifier for the service order (e.g., SO-001). This is the primary key.

Service Order table.

Title: Service Order ID <br> Description: "The unique identifier for this work order."

SO Name

A human-readable name describing the main task of the service order (e.g., "Pump Maintenance," "Filter Replacement").

Service Order table.

Title: Service Order Name <br> Description: "A brief description of the work to be performed."

Asset Name / ID

The specific asset that the work is being performed on. Both the common name and the unique ID are displayed.

A link to the Asset Registry.

Title: Target Asset <br> Description: "The specific asset that is the subject of this service order."

System / Network

The parent System or Network that the asset belongs to. This provides hierarchical context.

A link to the System/Network Registry.

Title: Parent System/Network <br> Description: "The parent system or network that this asset belongs to, providing operational context."

Location

The physical location where the work needs to be performed (e.g., "Building A-1," "Treatment Plant").

Pulled from the Asset's location attribute.

Title: Location <br> Description: "The physical location of the asset where the work will take place."

Type

The classification of the work order. <br> Business Rule: The options ("Preventive," "Corrective," "Inspection") must come from a pre-defined list in Settings.

Service Order table.

Title: Service Order Type <br> Description: "The classification of this work (e.g., planned preventive work vs. unplanned corrective work)."

Priority

The urgency of the service order. <br> Business Rule: Displayed as a color-coded tag (High=Red, Medium=Yellow, Low=Green). The priority levels are managed in Settings.

Service Order table.

Title: Priority <br> Description: "The urgency of this work order, which dictates scheduling and resource allocation."

Status

The current stage of the service order in its lifecycle. <br> Business Rule: Displayed as a color-coded tag. The status options ("In Progress," "Completed," "Scheduled," "Active") are managed in a workflow engine. "Active" might mean it's open but not yet started.

Service Order table.

Title: Status <br> Description: "The current stage of this service order in its lifecycle."

Actions

A set of actions for that specific service order. <br> Business Rule: The primary action is "View." Clicking this navigates to the full, detailed service order page, where a user could see assigned technicians, parts used, notes, and completion details. Other actions like "Edit" or "Cancel" might appear in a dropdown menu (...) depending on user permissions and the SO status.

N/A

Title: Actions <br> Description: "View the full details of this service order."

Title (Files & Documents)

A clear title for the section.

Subtitle

"Manage facility-related documents, media files, and attachments."

Upload Files Button

Functionality: This is the primary call-to-action to add new files to the facility's library. <br> Business Rule: Clicking this button must open the operating system's file selection dialog, allowing the user to select one or more files to upload. After selection, a progress indicator should appear for each file being uploaded. The system must enforce file size and type restrictions.

File Name

The name of the uploaded file, including its extension (e.g., facility_overview.jpg). <br> Business Rule: Clicking the file name should initiate a download of the file or open it in a new browser tab if the file type is supported for in-browser viewing (like PDF or JPG).

File metadata table.

Title: File Name <br> Description: "Click to open or download the file."

File Size

The size of the file, displayed in appropriate units (KB, MB, GB). <br> Formula: The raw file size in bytes is converted to the most readable unit.

File metadata table.

Title: File Size <br> Description: "The storage size of this file."

Uploaded By

The name of the user who uploaded the file.

File metadata table, linked to the User Directory.

Title: Uploaded By <br> Description: "The user who originally uploaded this file to the system."

Upload Date

The date the file was uploaded to the system.

File metadata table.

Title: Upload Date <br> Description: "The date this file was added to the facility's document library."

Download Icon (↓)

Functionality: An explicit button to download the file. <br> Business Rule: Clicking this icon must initiate a direct download of the file to the user's computer.

N/A

Title: Download File <br> Description: "Click to download this file to your device."

Preview Icon (👁️)

Functionality: An explicit button to preview the file without downloading. <br> Business Rule: <br> • Clicking this icon opens the file in a modal window or a new browser tab. <br> • This functionality is only enabled for file types that can be rendered by a web browser (e.g., images, PDFs, plain text, some videos). <br> • For unsupported file types (like .xlsx or .dwg), this icon should be disabled or hidden, with a tooltip explaining "Preview not available for this file type."

N/A

Title: Preview File <br> Description: "Click to open a preview of this file without downloading."

More Actions (...)

Functionality: A kebab menu that opens a dropdown of additional actions. <br> Business Rule: <br> • Edit Details: Opens a modal allowing the user to rename the file or add a description. <br> • Move: Allows the user to re-associate the file with a different entity (e.g., a specific asset within the facility). <br> • View History: Shows a log of when the file was accessed or if new versions were uploaded. <br> • Delete: Permanently removes the file. This action must be protected by a confirmation modal: "Are you sure you want to permanently delete this file? This action cannot be undone."

N/A

Title: More Actions <br> Description: "View more options for this file."

Title (Notes & Comments)

A clear title for the section.

Subtitle

"Add and view notes related to this facility."

Export Button

Functionality: Exports the currently displayed list of notes. <br> Business Rule: Clicking this button will generate and download a CSV or TXT file. The exported file must respect any active search or filter criteria. The export should include the note content, creator, and timestamps.

Text Area (Add a new note...)

Functionality: A multi-line text input field for composing the note. <br> Business Rules: <br> • It should support a reasonable character limit (e.g., 1000 characters). <br> • The field may support basic markdown for formatting (e.g., bold, italics, lists), which would be rendered in the display view.

Add Note Button

Functionality: Submits the text in the text area as a new note. <br> Business Rules: <br> • The button is disabled if the text area is empty. <br> • When clicked, a new record is created in the Notes table with the following attributes: <br> - Note_Content: The text from the text area. <br> - Facility_ID: The ID of the current facility. <br> - Created_By: The ID of the currently logged-in user. <br> - Created_At: The current server timestamp. <br> • After successful submission, the text area must be cleared, and the new note should appear at the top of the notes list below.

Search notes...

Functionality: A free-text search box. <br> Business Rule: As the user types, the list of notes below will dynamically filter to show only notes where the content or the creator's name matches the search term.

Filter Button

Functionality: Opens a dropdown or modal with advanced filtering options. <br> Filter Options: <br> • Created By: A searchable dropdown of all users who have ever created a note for this facility. <br> • Date Range: A start and end date picker to filter notes by their creation date. <br> Business Rule: Applying filters updates the list of notes shown.

Title (Activity Log)

A clear title for the section.

Subtitle

"Timeline of all activities and changes for this facility."

Export Button

Functionality: Exports the currently displayed activity log. <br> Business Rule: Generates a CSV or plain text file of the activity log, respecting any active search or filter criteria. The export must include the event type, timestamp, description, and associated user/system.

Search activities...

Functionality: A free-text search box. <br> Business Rule: As the user types, the list below dynamically filters to show only log entries where the description or associated user/system name matches the search term.

Filter Button

Functionality: Opens a dropdown or modal with advanced filtering options. <br> Filter Options: <br> • Activity Type: A multi-select checklist of all possible event types (e.g., Service Order, Inspection, Failure, Maintenance, Compliance, Note Added, Asset Created). <br> • User / Source: A searchable dropdown of all users and system sources (e.g., "John Smith," "System Alert," "Compliance Engine"). <br> • Date Range: A start and end date picker to filter log entries by their timestamp. <br> Business Rule: Applying filters updates the activity log shown.

Activity Type Tag

A color-coded tag that categorizes the event at a glance. <br> Business Rule: The tag's text and color are determined by the source of the event. <br> • Service Order (Blue) <br> • Inspection (Green) <br> • Failure (Red) <br> • Maintenance (Purple) <br> • Compliance (Orange) <br> • Note (Gray)

The event_type field in the master Activity Log table.

Title: Activity Type <br> Description: "The category of this log entry, based on where the event originated in the system."

Timestamp

The precise date and time the event occurred. <br> Format: YYYY-MM-DD HH:MM

The created_at timestamp from the source event record.

Title: Event Timestamp <br> Description: "The exact date and time this activity was recorded in the system."

Primary Description

A bolded, concise summary of the event. <br> Formula: This is a system-generated string based on the event type and its key data. <br> • Example (Service Order): "Created service order SO-001 for pump maintenance" <br> • Example (Failure Alert): "Reported failure in control valve C3"

A formatted string generated by the system when the event occurs.

Title: Activity Summary <br> Description: "A high-level summary of the event that occurred."

Secondary Description

An optional, non-bolded line providing additional context or details. <br> Formula: This pulls secondary information from the source event. <br> • Example (Service Order): "Scheduled preventive maintenance for main pump unit" <br> • Example (Inspection): "All parameters within acceptable ranges"

Additional details from the source event record.

Title: Additional Details <br> Description: "More specific details about this activity."

User / Source

The user, system, or process responsible for the event. <br> Business Rule: <br> • If the action was performed by a user, their full name is displayed (e.g., "John Smith"). <br> • If the action was automated, the system source is displayed (e.g., "System Alert," "Compliance Engine").

The user_id or source_system field from the source event record.

Title: Event Source <br> Description: "The user or system process that generated this activity log entry."

Clickable Entry

Functionality: The entire log entry should be clickable. <br> Business Rule: Clicking on a log entry must navigate the user directly to the source of that event. <br> • Clicking the "Created service order SO-001" entry navigates to the detailed page for SO-001. <br> • Clicking a "Reported failure" entry navigates to the specific alert in the Alerts tab. <br> • Clicking a "Completed routine inspection" entry navigates to the detailed inspection report.

A dynamic link constructed from the event_type and the source_record_id.

Title: View Source <br> Description: "Click to navigate to the original item (e.g., the service order, alert, or report) that this log entry refers to."