Delete this link at the end of the specification process:
The LinkIdIntoLtpWriter is part of the HighPerformanceNetworkInterface.
Planning data (includes content of legacy databases like x:akta or APT) is identified by IDs generated by Telefonica (e.g. network element ID or link ID). Actual configuration data, which has been retrieved from the network, is identified by IDs (e.g. LTP UUID) that have been generated by devices. Joining planning and configuration data is required for use cases like data reconciliation, configuration verification, live network view and many more.
The LinkIdIntoLtpWriter matches the planned links with the AirInterfaces operating in the network. By sequentially performing a series of independent and unrelated tests, it identifies ONF LTP UUIDs that correspond to the Telefónica LinkIds, with the critical objective of striving for the highest possible accuracy in this association. The application then writes the Telefónica Link ID into the appropriate Logical Termination Point.
The LinkIdIntoLtpWriter operates on a priority-based hygiene queue, which contains entries of the link ID to be written, the respective mountNames of both link ends, a reliability score and supporting planning data (such as modem card slot, access port, txFrequency, etc.) to facilitate the identification of the corresponding LTP.
Checks and Reliability Scoring:
A set of independent checks are sequentially performed on each entry in the hygiene queue to assign the link ID to the right LTP in the list of potential candidates on the device. Each check contributes to a reliability score associated with the queue entry. The score reflects the confidence in the accuracy of the Link ID assignment.
- Threshold-based Assignment: The Link ID will only be written to the LTP if the associated reliability score reaches a predefined minimum value.
- Dynamic Priority Adjustment: Based on the reliability score, each entry in the queue will be reassigned a priority for future evaluation cycles. Entries with lower reliability scores will be given higher priority in the next run for re-evaluation.
The tests executed for each entry of the HygieneQueue can be divided into two types:
-
Plan-Data Tests at link end: These checks focus on matching the planned data with information retrieved from the devices at one link end, and thus identifying the correct LTP.
-
Cross-Link Tests: These checks involve performing a configuration activity at one end, and querying the opposite link end to evaluate whether the expected reaction occurs.
The proccess of assesment of the appropriate LTP is uniform and idempotent:
- The same checks are performed at every (re)assesment, regarless of the previous reliability value, or whether a linkId is already written into the LTP. If the opposite link end is not reachable, cross-link tests will be skipped, reflecting in a poorer reliability score.
- In case some configuration activity is done on the link as part of a test, the changes shall be reverted by the end of it.
See Processing of entries in the Hygiene Queue
See Tests for identifying the correct AirInterface LTP
See Hygiene Queue definition
Services Provided by the LinkIdIntoLtpWriter:
The LILW offers the following exposed services:
/v1/add-link-to-queue: (>>>Other possibility "/v1/add-links-to-queue" and accept a list of links)
Adds a new link to the hygiene queue, giving it the highest priority for immediate evaluation.
It returns a response with the outcome of the first evaluation:
*200 (Success): If the Link ID was successfully written to an LTP, the response includes the UUID of the LTP and the reliability score.
*409 (Conflict): In case an entry in the hygiene queue already exists for this LinkId, but with different mountNames. Or alternatively, in case the linkId is already written in an LTP of the device (different to the best candidate determined after the checks and evaluation), and this LTP has an interface status type UP.
*470? (Ressource does not exist within the connected device): Within the device(s), no appropriate LTP(s) could be found for the linkId to be written into. In other words, the required threshold was not met for any LTP at one or both link-ends.
/v1/remove-link-from-queue-and-ltps: Removes the entire link entry from the hygiene queue and deletes the link ID from the LTPs, in case it has already been written.
/v1/promote-link-in-queue: Promotes an existing entry in the queue, giving it the highest priority for re-evaluation.
/v1/get-logged-errors: Provides access to the log of errors or issues that have occurred during the Link ID assignment process. (?)
If the LinkIdIntoLtpWriter would write wrong LinkIDs into devices, other applications will write correct data into wrong devices.