System Administration
User creation, project setup, worksite management, and system configuration for the Digital Lock On platform.
Purpose
System administration provides the foundational data and configuration required for all operational domains. This domain covers the creation and lifecycle management of users, projects, worksites, plant equipment, and system entities through a dedicated administrative interface.
Primary Users: System Administrators, KiwiRail IT Staff
Business Value: Proper system setup and data foundation enabling all operational activities with appropriate user access controls
Core Concepts & Context
Administrative Scope
System administration covers the setup and configuration phase of entity lifecycles:
- User Creation: Both authenticated (Protectors, RPOs) and unauthenticated (Workers, Visitors) users
- Project Setup: Project creation and initial configuration
- Worksite Management: Worksite creation and updates within projects
- Plant Creation: Plant and equipment registration with type classification (V, MP, HRV)
- System Configuration: Platform-wide settings and integrations
Note: Active operational use of these entities is handled in the respective operational domains.
User Types & Authentication Models
- Authenticated Users: Protectors and RPOs with Clerk integration for email/password access
- Unauthenticated Users: Workers, Visitors, and plant operators who use QR codes for operational access
- Admin Users: System administrators with full platform management access
Platform Architecture
- Admin Platform: Separate administrative interface for managing system entities (fully online)
- Digital Lock On Platform: Main operational platform where protection and work activities occur
- Integration Points: Clerk authentication service and external KiwiRail systems
Jobs to be Done (JTBD)
| Actor | JTBD | Success Metric |
|---|---|---|
| System Administrator | Set up new projects and worksites efficiently | Projects and worksites available for operational use with proper configuration |
| System Administrator | Create and manage user accounts across all types | Users can access appropriate platforms with correct permissions and roles |
| System Administrator | Register plant and equipment with proper classification | Plant records available for operational lock-on/off and tracking |
| System Administrator | Maintain system data integrity and lifecycle | Clean, accurate data supporting reliable operational activities |
| KiwiRail IT Staff | Integrate with existing KiwiRail systems | Seamless data flow between Digital Lock On and enterprise systems |
Key Interactions & Dependencies
- Enables: Access Control by providing user data and role assignments
- Enables: Protection Management by providing project and worksite definitions
- Enables: Worker Operations by providing worker data and competency records
- Enables: Plant Operations by providing plant and equipment registrations
- Integrates With: Clerk authentication service for user credential management
- Integrates With: KiwiRail central systems for bulk data import and synchronisation
Assumptions & Out of Scope
Assumptions
- Administrative users have appropriate access and training for system management
- Network connectivity is available for administrative operations (admin platform is fully online)
- Integration with KiwiRail central systems is available for bulk data operations
- Clerk authentication service is operational and accessible
Out of Scope
- Day-to-day operational use of created entities (handled in operational domains)
- Real-time operational monitoring and alerts
- Financial or billing management
- Detailed audit trail and compliance reporting (handled in Reporting & Analytics)
Requirements Index
User Management
- REQ-ADMIN-001: Creating Authenticated Users - Protectors and RPOs with Clerk integration
- REQ-ADMIN-002: Creating Unauthenticated Users - Workers, Visitors, and plant operators
- REQ-ADMIN-003: Managing User Lifecycle - Updates and deletion
Project & Worksite Management
- REQ-ADMIN-004: Creating Projects - Project creation and configuration
- REQ-ADMIN-005: Managing Worksites - Worksite creation and updates within projects
Plant & Equipment Management
- REQ-ADMIN-006: Creating Plant - Plant and equipment registration with type classification
Domain-Specific Decisions
No domain-specific ADRs currently documented
Access Control Model
For the initial implementation, anyone with admin platform access can manage:
- All user types (authenticated and unauthenticated)
- Plant and equipment
- Projects and worksites
Future Considerations
- Enhanced role-based access control for administrative functions
- Comprehensive audit trail implementation
- Automated bulk import processes from KiwiRail central systems
- Self-service user management capabilities for appropriate user types