User Story: Network Management
Network Management - Complete User Story & Business Rules
1. Problem Statement
User Roles Identified:
- Network Operations Manager: Responsible for managing water distribution network infrastructure and operational efficiency
- Utility Administrator: Manages network type configurations and maintains standardized network classifications
Pain Points by User Role:
Network Operations Manager:
- Fragmented system for categorizing different types of water distribution networks (transmission, distribution, DMA)
- Inconsistent network classification leading to poor operational planning and maintenance strategies
- Difficulty in tracking network types and their operational characteristics for system optimization
- Limited visibility into network classifications needed for hydraulic modeling and pressure management
- Manual processes for organizing different network segments without standardized descriptions
Utility Administrator:
- Time-consuming manual setup of network type definitions without standardized templates
- Lack of centralized management for network type descriptions and operational characteristics
- Difficulty maintaining consistency in network data structure across different operational areas
- Complex process to add new network types and update existing network descriptions
- Limited ability to customize network classifications based on specific utility infrastructure requirements
Core Problem:
Water utilities lack a standardized system for managing network type definitions and descriptions, leading to inconsistent network classification, poor hydraulic management, and inefficient operational oversight across transmission, distribution, and district metered areas.
2. Who Are the Users Facing the Problem?
Network Operations Manager
- Oversees water distribution network operations and hydraulic management
- Requires standardized network types for effective network management and optimization
- Needs consistent network classifications for operational planning and maintenance strategies
Utility Administrator
- Manages system configuration and master data for network types
- Responsible for setting up and maintaining network type definitions and descriptions
- Ensures data consistency across all network management systems
Both roles should have access to this feature with appropriate permission levels based on their network management responsibilities.
3. Jobs To Be Done
For Network Operations Manager: When I need to organize and manage different types of water distribution networks for operational planning and hydraulic optimization, But I lack standardized network type definitions with proper operational descriptions that makes it difficult to categorize networks and plan system operations effectively, Help me access a comprehensive network type management system with standardized classifications and detailed operational descriptions, So that I can develop effective network management strategies, optimize hydraulic performance, and maintain consistent network organization.
For Utility Administrator: When I need to set up and maintain consistent network type definitions across the utility, But I face time-consuming manual processes and lack of standardized templates for network classification that create organizational inconsistencies, Help me configure network types with easy customization options and centralized description management, So that I can ensure network classification consistency, reduce setup time for new network types, and maintain standardized network organization.
4. Solution
The Network Management system provides a comprehensive platform for organizing water distribution networks with the following capability areas:
4.1 Network Type Definition and Management
- Pre-configured network types for water utility infrastructure (Transmission, Distribution, DMA)
- Custom network type creation with detailed operational descriptions
- Centralized management of network classifications and operational characteristics
4.2 Network Description Management
- Detailed description fields for each network type explaining operational purpose and characteristics
- Standardized description templates for common water distribution network types
- Custom description creation with comprehensive operational and technical details
4.3 Network Classification Organization
- Organized list of network types with network icons and creation dates
- Detailed display of network information with operational descriptions
- Easy access to network type details and management functions
4.4 Search and Management Capabilities
- Advanced search across network types and descriptions
- Quick access to network type information and editing functions
- Streamlined network type creation and modification workflows
4.5 Standardization and Templates
- Industry-standard network type templates for water utilities
- Standardized naming conventions and description formats
- Best practice guidance for network organization and hydraulic classification
4.6 Integration and Data Management
- Seamless integration with GIS, hydraulic modeling, and asset management systems
- Export capabilities for reporting and network planning
- Data validation and consistency checks across network definitions
5. Major Steps Involved
Network Operations Manager Flow:
- Access Network Management Dashboard
- Navigate to Settings > Network Management
- View existing network type definitions and descriptions
- Review network type organization and classification structure
- Review Network Classifications
- Review network types and their operational descriptions
- Assess current network type coverage and organization
- Identify gaps in network classification structure
- Analyze Network Organization
- Review network type descriptions for operational clarity
- Assess network classification effectiveness for hydraulic management
- Identify optimization opportunities in network organization
- Request Network Type Modifications
- Identify needs for new network types or description updates
- Submit requests for network classification enhancements
- Provide operational requirements for network type improvements
- Validate Network Management Effectiveness
- Review network type utilization across the utility
- Assess network classification effectiveness for operational planning
- Recommend improvements for network organization
Utility Administrator Flow:
- System Configuration Access
- Log into SMART360 administrative interface
- Navigate to Settings > Network Management
- Access network type management dashboard
- Create New Network Type
- Click "Add Network Type" button
- Enter network type name and operational description
- Configure network type settings and classifications
- Manage Network Descriptions
- Edit existing network type descriptions
- Update network type information as operational requirements change
- Ensure description accuracy and operational relevance
- Configure Network Classifications
- Set up network type names with descriptive information
- Define network operational characteristics and purposes
- Configure network type organization and hierarchy
- Validate and Test Configuration
- Review complete network type structure
- Test network type creation and modification workflows
- Validate integration with network management systems
6. Flow Diagram
7. Business Rules
Field-wise Business Rules
13. Network Management Main Page
Page Header
- Title: "Network Management"
- Subtitle: "Manage network types and their descriptions for your water utility system."
- Breadcrumb: Dashboard > Settings > network-management
Search Field
- Field Name: Search
- Placeholder: "Search network types..."
- Rules:
- Minimum 2 characters required to trigger search
- Search is case-insensitive
- Searches across network type names and descriptions
- Real-time search with 300ms debounce
- Maximum 100 characters allowed
- Special characters allowed: hyphen (-), underscore (_), space
- Search results highlight matching terms
- Empty search displays all network types
- No search filters or advanced options
Add Network Type Button
14. Network Types List Display
Network Type Items
- Display Requirements:
- Network type name displayed as main header
- Network icon displayed on the left (network/connection icon)
- Creation date displayed below network type name
- Description displayed below creation date
- Edit icon (pencil) on hover for authorized users on the right
- Delete icon (trash) on hover for authorized users on the right
- Clean card layout with consistent spacing and borders
Network Type Name Display
- Rules:
- Displayed as bold text header
- Font weight: bold/semi-bold
- Color: dark gray/black for readability
- Truncated with ellipsis if exceeds container width
- Cannot be clicked for expansion (unlike facility types)
- Always visible with description
Network Icon
- Rules:
- Consistent network/connection icon for all network types
- Blue color (#3b82f6) to match theme
- Positioned on the left side of each network type card
- Size: Medium (24x24 or 32x32 pixels)
- Always visible and non-interactive
Creation Date Display
- Rules:
- Format: "21/7/2025" (DD/M/YYYY)
- Displayed in gray text below network type name
- Automatically populated when network type is created
- Non-editable field
- Always visible below network type name
Description Display
- Rules:
- Always visible (no expand/collapse functionality)
- Description text in gray color (#6b7280)
- Auto-wraps text content within card boundaries
- Preserves line breaks from description field
- Full description always displayed
- No truncation or "read more" functionality
Action Icons
- Edit Icon (Pencil):
- Only visible on hover
- Positioned on the right side of each network type card
- Opens inline editing mode or modal for the network type
- Disabled if user lacks edit permissions
- Tooltip: "Edit network type"
- Delete Icon (Trash):
- Only visible on hover
- Positioned next to edit icon
- Triggers confirmation dialog before deletion
- Disabled if network type has associated networks
- Tooltip: "Delete network type"
16. Add New Network Type Modal
Modal Structure
- Modal Title: "Add New Network Type"
- Modal Size: Medium (approximately 500px width)
- Modal Position: Centered on screen
- Background Overlay: Semi-transparent dark overlay
- Close Button: X icon in top-right corner
Network Type Name Field
- Field Label: "Name"
- Placeholder: "Enter network type name"
- Field Type: Text input
- Rules:
- Required field (no visual asterisk shown in screenshot)
- Minimum 3 characters, maximum 50 characters
- Must be unique across all network types (case-insensitive)
- Allowed characters: letters, numbers, spaces, hyphens, parentheses ()
- Cannot start or end with spaces
- Cannot contain consecutive spaces
- Cannot be only numbers
- Cannot contain special characters: @, #, $, %, ^, *, <, >, ?, |, , [, ]
- Real-time validation with error display below field
- Auto-focus when modal opens
Network Type Description Field
- Field Label: "Description"
- Placeholder: "Enter network type description"
- Field Type: Textarea
- Rules:
- Required field (no visual asterisk shown in screenshot)
- Minimum 10 characters, maximum 500 characters
- Must provide meaningful description of network type purpose
- Cannot be only spaces or special characters
- HTML tags not allowed
- Auto-resize textarea based on content (minimum 4 rows)
- Character count indicator showing remaining characters
- Line breaks preserved in storage and display
- Real-time validation with error display below field
Modal Action Buttons
Add Network Type Button
Cancel Button
Modal Close Button (X)
- Rules:
- Always visible in top-right corner
- Same behavior as Cancel button
- Confirmation dialog if unsaved changes exist
- No confirmation needed if no changes made
Modal Validation
Real-time Validation Rules:
- Name field validation:
- "Network type name is required"
- "Network type name must be at least 3 characters"
- "Network type name cannot exceed 50 characters"
- "Network type name already exists"
- "Network type name contains invalid characters"
- Description field validation:
- "Description is required"
- "Description must be at least 10 characters"
- "Description cannot exceed 500 characters"
- "Description cannot contain only whitespace"
Form Submission Validation:
- Both fields must pass individual validation
- Check for duplicate network type names across system
- Validate against reserved network type names (if any)
- Network connectivity check before submission
Modal Behavior
- Opening: Smooth fade-in animation (200ms)
- Closing: Smooth fade-out animation (200ms)
- Keyboard Navigation: Tab between fields and buttons
- Focus Management: Auto-focus on name field when opened
- Accessibility: Proper ARIA labels and screen reader support
17. Inline Editing Mode (if applicable)
Edit Network Type Name
- Trigger: Click edit icon (pencil) next to network type
- Display: Network type name becomes editable text input
- Rules:
- Same validation rules as new network type creation
- Original name displayed as initial value
- Auto-focus on the input field
- Save on Enter key or blur event
- Cancel on Escape key
- Cannot edit if network type has associated networks (in some cases)
Edit Network Type Description
- Trigger: Edit mode also enables description editing
- Display: Description becomes editable textarea
- Rules:
- Same validation rules as new network type creation
- Original description displayed as initial value
- Auto-resize based on content
- Save/cancel applies to both name and description changes
- Preserves formatting and line breaks
Edit Mode Actions
- Save Changes: Validates and saves both name and description
- Cancel Changes: Reverts to original values without saving
- Keyboard Navigation: Tab between name and description fields
18. Delete Network Type
Delete Confirmation Dialog
- Trigger: Click delete icon (trash) next to network type
- Dialog Title: "Delete Network Type"
- Dialog Message: "Are you sure you want to delete '[Network Type Name]'? This action cannot be undone."
- Buttons: "Delete" (red/danger) and "Cancel" (gray)
Delete Validation Rules
- Cannot delete if:
- Network type has associated networks in the system
- Network type is referenced in GIS or hydraulic modeling systems
- User lacks delete permissions
Delete Error Messages
- With dependencies: "Cannot delete network type - it is currently used by X networks"
- Permission error: "You do not have permission to delete network types"
- System error: "Unable to delete network type. Please try again."
Delete Success
- Success message: "Network type '[Name]' deleted successfully"
- UI update: Network type removed from list immediately
- Undo option: 5-second undo option before permanent deletion (optional)
19. Global Business Rules
Data Validation
- All text inputs trim whitespace before validation
- Case-insensitive uniqueness checks across the system
- HTML encoding applied to prevent XSS attacks
- SQL injection prevention on all database queries
- Maximum total network types: 50 per system
Permissions
- Network types view: All authenticated users
- Network type creation: Utility Administrator role
- Network type editing: Utility Administrator role
- Network type deletion: System Administrator role only
- Audit trail access: System Administrator role only
Performance Rules
- Search results limited to 50 items (max network types)
- Auto-save functionality for long descriptions (every 30 seconds)
- Page loading: Maximum 2 seconds for network types list
- Search response time: Maximum 500ms
- Modal opening: Maximum 300ms
8. Sample Data
Network Types and Descriptions:
Transmission
├── Created: 21/7/2025
├── Description: Large-scale distribution networks that carry water over long distances from source to treatment facilities or major distribution points.
Distribution
├── Created: 21/7/2025
├── Description: Networks that distribute treated water from storage or treatment facilities to end users including residential, commercial, and industrial customers.
DMA (District Metered Areas)
├── Created: 21/7/2025
├── Description: District Metered Areas - isolated sections of the distribution network with defined boundaries and flow measurement points for water loss management.
Additional Network Type Examples:
Collection
├── Description: Networks that collect wastewater from customer connections and transport it to treatment facilities through gravity and pumped systems.
Reclaimed Water
├── Description: Networks that distribute treated reclaimed water for non-potable uses including irrigation, industrial processes, and groundwater recharge.
Fire Protection
├── Description: Dedicated networks or network sections designed specifically for fire protection services with enhanced pressure and flow requirements.
Industrial Supply
├── Description: Specialized networks serving large industrial customers with specific pressure, quality, and reliability requirements.
Raw Water Transmission
├── Description: Networks that transport untreated water from sources to treatment facilities through large-diameter pipelines and pumping systems.
9. Acceptance Criteria
- The system must display a list of network types with their descriptions and creation dates
- The system must allow creation of new network types with name and description fields via modal dialog
- The system must provide editing capabilities for existing network type names and descriptions
- The system must support deletion of network types with proper validation
- The system must validate that network type names are unique across the system
- The system must prevent deletion of network types that have associated network assets
- The system must provide search functionality across network type names and descriptions
- The system must display network type descriptions in an organized format
- The system must show creation dates for each network type (21/7/2025 format)
- The system must validate network type name length (3-50 characters)
- The system must validate network type description length (10-500 characters)
- The system must provide modal dialog for network type creation
- The system must show save and cancel options in creation modal
- The system must maintain audit trails for all network type changes
- The system must support export of network type data for reporting
- The system must integrate with GIS and hydraulic modeling systems
- The system must provide role-based access control for network type management
- The system must display clear error messages for validation failures
- The system must prevent creation of network types with invalid characters
- The system must support network type icons and visual identification
10. Process Changes
Process Area | From | To | Impact |
---|---|---|---|
Network Classification | Manual categorization of networks without standardized types | Standardized network type definitions with detailed operational descriptions | 75% improvement in network organization consistency, 55% reduction in classification time |
Network Planning | Ad-hoc network planning without standardized classifications | Systematic network planning using standardized network type definitions | 60% improvement in planning efficiency, 80% better hydraulic modeling accuracy |
Network Documentation | Inconsistent network documentation across service areas | Standardized network descriptions and operational characteristic documentation | 85% improvement in documentation consistency, 90% better operational clarity |
Network Operations | Limited network categorization for operational decisions | Comprehensive network type organization enabling targeted operational strategies | 70% improvement in operational efficiency, 65% better resource optimization |
Hydraulic Modeling | Manual network segmentation for modeling purposes | Automated network type classification for hydraulic model development | 50% reduction in modeling setup time, 90% improvement in model accuracy |
Network Maintenance | Generic maintenance approaches across all network types | Network type-specific maintenance strategies and protocols | 60% improvement in maintenance effectiveness, 75% better resource allocation |
Cross-Department Coordination | Different network naming across operational areas | Unified network type definitions with consistent terminology | 85% reduction in communication errors, 95% improvement in operational coordination |
Network Performance Analysis | Limited ability to analyze performance by network type | Comprehensive network type-based performance analysis and benchmarking | 70% improvement in performance insights, 60% better operational decision-making |
11. Impact from Solving This Problem
Impact Category | Metric | Improvement |
---|---|---|
Operational Efficiency | Network classification time | 75% reduction through standardized network type templates and definitions |
Data Quality | Network information consistency | 85% improvement through enforced standardization and validation rules |
Network Planning | Planning accuracy and efficiency | 60% improvement through standardized network type organization |
Hydraulic Management | Modeling accuracy | 90% improvement through consistent network type classification |
Resource Utilization | Administrative workload | 65% reduction in network type configuration and maintenance efforts |
Documentation Quality | Network description completeness | 90% improvement through required description fields and templates |
Operational Coordination | Cross-department communication | 85% improvement through unified network type terminology |
Maintenance Planning | Planning effectiveness | 60% improvement through network type-specific maintenance strategies |
Performance Analysis | Analysis capability | 70% improvement through standardized network type benchmarking |
Strategic Planning | Network organization effectiveness | 75% improvement through comprehensive network type management |
12. User Behavior Tracking
Network Operations Manager Tracking:
Event | Properties | Insights Goal |
---|---|---|
network_types_viewed | network_types_accessed, time_spent, descriptions_reviewed | Understanding which network types require the most operational attention |
network_planning_performed | network_types_analyzed, planning_duration, decisions_made | Identifying network types most critical for operational planning |
network_organization_accessed | network_types_reviewed, organization_patterns, efficiency_metrics | Tracking network organization effectiveness and optimization opportunities |
network_reports_generated | network_types_included, report_format, use_case | Understanding reporting needs and most valuable network type data |
Questions Answered:
- Which network types require the most operational management?
- How effectively are network types organized for planning purposes?
- What network type information is most valuable for operational decisions?
- Are network type definitions comprehensive for hydraulic management needs?
Utility Administrator Tracking:
Event | Properties | Metrics | Insights Goal |
---|---|---|---|
network_type_created | type_name, creation_time, description_length, user_id | Number of new network types per month | Measuring system expansion and network type evolution |
network_description_updated | network_type, description_changes, update_frequency | Description maintenance and quality | Understanding maintenance patterns and optimization opportunities |
network_type_search_performed | search_term, results_found, action_taken | Search effectiveness and user behavior | Improving search functionality and information architecture |
network_management_session | network_types_modified, session_duration, changes_made | Time spent on network type configuration | Identifying areas where templates or automation could improve efficiency |
validation_errors_encountered | error_type, field_name, resolution_time | Data quality and user experience | Identifying common configuration issues and improving user guidance |
network_integration_tested | network_types_tested, integration_success, issues_found | Integration effectiveness and reliability | Ensuring seamless connection with GIS and hydraulic modeling systems |
Questions Answered:
- How effectively are administrators configuring new network types?
- Where do users encounter the most difficulty in setup processes?
- What are the most common network type configuration patterns?
- How can we streamline the administrative workflow?
- Are network type definitions comprehensive for operational needs?
- What templates or automation would provide the most value?