Introduction
These notes aim to guide the specification, design, and building of an interface between NetCo and ServCo. A NetCo is primarily responsible for managing physical infrastructure, such as Fibre Optic cables. Consequently, the Physical Network Inventory (PNI) system and application must accurately represent physical network elements (which are mostly passive) both logically and spatially. THe SerCo on the other hand centres around customer services and product offerings, enabling mobile and Internet product and service access to end users.
A PNI application and system must integrate with GIS (Geographic Information System) Systems and with Production systems (in the TMForum ODA sense) that are part of the ServCo. While GIS systems gather, manage, and analyze spatial and geographic data, TMForum ODA Production systems are responsible for fulfilling Telecommunication Services.
A key challenge in fibre network management is the lack of open standards for inventory data exchange. This necessitates that Communication Service Providers (CSPs) and Digital Service Providers (DSPs) specify and develop custom integrations between the PNI system and the Production System, specifically the Logical Network Inventory (LNI) system and the Service Fulfillment system. Some level of decoupling between systems, particularly when provided by different vendors, can be achieved using a REST architecture or SOAP interface.
Constrains on specifying, designing and building the interface
The specification, design, and building of this interface are subject to specific constraints, particularly concerning communication, coordination, and consistency. These concepts, as covered in “Fundamentals of Software Architecture” by Mark Richards and Neal Ford, are critical to understanding the design choices made.
- Communication: The chosen communication method had to be synchronous. Implementing and productionising queuing and messaging frameworks or mediations between existing systems was not feasible within the project’s scope.
- Coordination: The LNI and Service Fulfillment components already orchestrate the provisioning of Resource Facing Services for various transport technologies (e.g., DWDM, MPLS) and enterprise services (e.g., Carrier Ethernet, SD-WAN). This existing orchestration relies on APIs for synchronous request-response interactions, rather than the choreography seen in Intent-Based Networking where autonomous systems communicate collaboratively to fulfill an order.
- Consistency: Given the synchronous communication and the coordinated nature of orders between the two systems, it is important for transactions to operate atomically. This ensures near real-time consistency in the lifecycles and operational states of Optical Fibres and the services they transport.
Fulfillment and Orchestration Logic, wherever possible, requires automated decisions for path-finding in both the physical and logical networks, along with corresponding resource allocations in PNI and LNI. This highlights the complex handoffs between the NetCo and ServCo domains. Visualizing the flow within the interface contract is essential to surface the intricate dependencies for completing specific flows that consume dedicated API endpoints to achieve the above.
Data and Information Modelling
This section outlines the critical aspects of data and information modeling required for effective interface specification within the ServCo-NetCo domain. These elements are essential for enabling effective system interactions.
- Physical and Resource Logical Relationship Mapping: This involves defining and mapping the relationships between physical network assets and their logical representations. A clear understanding of these relationships is fundamental for network planning, provisioning, and fault management.
- Location and Cost Modeling for Path-Finding: Accurate location and cost models are vital for efficient path-finding algorithms. These models facilitate the identification of optimal routes for services, considering factors such as latency, bandwidth, and cost to route.
- Data Master-ship: A clear definition of data master-ship is essential. This specifies which system is the authoritative source for each shared entity, preventing data inconsistencies and conflicts across the integrated environment.
Fulfilment and Orchestration Logic
Fulfillment and Orchestration Logic requires, where possible, automated decisions for path-finding in the physical network and correspondingly in the logical network, and related resource allocations in PNI and LNI.
Error and Fallout Handling
Designing comprehensive error handling strategies, including specific retries, circuit breaking, and backpressure expectations, is essential for managing unexpected failures.
1. Communication Errors: These can arise from network issues or misconfigured endpoints. Handling involves implementing retries, timeouts, and backoff strategies to manage transient failures.
2. Data Consistency Errors: Inconsistent data between systems can lead to incorrect operations. Ensuring atomic transactions and using techniques like idempotency can help maintain consistency.
3. Authorization and Authentication Errors: Incorrect handling of security tokens or permissions can prevent access. Implementing robust authentication mechanisms like OAuth2 and ensuring proper scope management can mitigate these issues.
4. Resource Allocation Errors: Failures in finding or reserving resources can occur. Implementing fallback mechanisms and pre-order planning can help manage resource-related errors.
5. Orchestration and Coordination Errors: Errors in the sequence of operations can disrupt service fulfillment. Using sequence diagrams and ensuring proper orchestration logic can help prevent these errors.
6 Observability and Operability: Implementing correlation IDs, audit events, and metrics can help in diagnosing and resolving errors quickly by providing insights into system operations.
Key Considerations for Robust Interface Design
Beyond the core logic, several other critical aspects contribute to a robust and maintainable interface:
- Diverse Fibred Paths: This refers to having multiple routes for data to travel through the network. The idea is to ensure that if one path fails (due to damage or congestion), others are available to maintain communication. Paths can be physical, as in Optical Fibres, and logical, as in service circuits that carry Ethernet and IP traffic.
- Security and Compliance: This includes defining authentication and authorization (e.g., OAuth2/bearer tokens), scopes, token handling, and considerations for Personally Identifiable Information (PII).
- Observability and Operability: This covers correlation IDs, audit events, metrics, logs, and traces aligned to Service Level Indicators (SLIs) and Service Level Objectives (SLOs), along with documented dashboards and alerts.
- Lifecycle and Governance: This encompasses change management and history, ensuring proper control and tracking of interface evolution.
In the end the integration option selected depends on multiple factors existing and emerging with clarifying and implementing requirements. Some points to consider when designing and building such an interface are provided here.


