CodingBox Documentation

Documentation, labelling and records

Fibre is invisible inside the cable, and a cable is invisible inside the ground: without records, nobody knows which of 144 fibres carries the hospital's link, where closure 14 is buried or which port on the panel goes to which building. Restoration time, change safety and the value of the plant as an asset depend on documentation more than on any component. This page lists the record set a fibre plant needs, the identifier and labelling rules that keep it usable, the standards that define them, the tools that hold the records and the process that keeps them true.

The record set

RecordContentWho needs it
Route drawings / GIScable routes with coordinates, depth, offsets from landmarks, duct and microduct occupancy, manholes, poles, closures, slack loops; as-built, not as-designedrestoration crews, other utilities, planners
Cable schedulecable ID, type, fibre count and type, manufacturer, reel and fibre data sheets, installation date, length by metre marks at both endsbudget checks, ageing decisions (Cable construction)
Splice schedules and diagramsper closure: incoming and outgoing cables, tube and fibre colours, tray and position, fibre-to-fibre mapping, splice loss, express (uncut) tubesthe person opening the closure at 3 a.m.
Panel and port mapsrack, panel, port → cable, fibre number, far end; connector type and polish (UPC/APC), MPO polaritypatching, troubleshooting
Fibre assignment matrixcircuit or service → fibre numbers end to end through every panel and closurechange control, capacity planning
Test recordsOTDR traces (.sor, both directions, all wavelengths) and insertion-loss results per fibre at commissioning, plus the instrument, launch cord and index used; the DDM link passportbaselines for every future comparison (Testing & measurement)
Connectivity (patching) recordswhich patch cord connects which ports, with datesthe sad reality of patch fields
Spare inventoryspare fibres per cable, spare ports, spare cable on reels, closures, cordsrestoration kit (Maintenance & restoration)
Change logwho changed what, when, with which ticket; links to the updated recordsaudits, root-cause analysis
Safety filehazard-level labels per site, APR procedures, emergency contactsanyone opening an amplified site (Safety & handling)

Identifier scheme

RuleExample / reasoning
Hierarchical and uniquesite – building – room – rack – panel – port: DC1-B2-R07-PP03-P12; readable by a human, parsable by a script
Cables named by both endsCBL-0042 DC1/PP03 ↔ POP7/ODF02, plus fibre count and type in the record, not in the name
Fibres numbered, not only colouredfibre 37 = tube 4 (brown), fibre 1 (blue) under TIA-598; write the number and the colour scheme, because schemes differ between cables
Closures with coordinatesSC-014 with WGS-84 coordinates, depth and marker post; a fibre length from the OTDR is not a location (Reading an OTDR trace)
Circuits separate from fibresa service ID maps to fibre numbers; when fibres are re-spliced the service keeps its ID
No meaning overloaddo not encode speed, customer or vendor in the identifier — they change; keep them as attributes
Stable over the liferenaming a plant is a project; pick the scheme before the first cable is pulled

Labelling

ItemWhere and howMaterial
Outdoor cablesat every manhole, closure entry and building entrance; both sides of a closure; every 100–200 m in ducts where accessibleembossed stainless, brass or UV-stable engraved plastic tags on cable ties
Closuresclosure ID outside; splice schedule copy inside in a sealed pocketengraved plate, laminated paper inside
Indoor cablesboth ends and at every pass-through; within 300 mm of the terminationself-laminating vinyl wrap labels, printed
Patch panels and portspanel ID on the front; port numbers printed by the manufacturer; far-end ID per port or per groupprinted label strips
Patch cordsboth ends, identical text: from and toself-laminating wrap or flag labels; never handwritten on tape
Racks and roomsat eye level, both sides of the rowrigid plates
Hazard and laser labelsat every ODF, closure and amplifier site with accessible power above Class 1standardised laser warning labels (IEC 60825)
Colour coding (optional, TIA-606)e.g., orange for demarcation, green for network connections, blue for horizontallabel background colour, not cable jacket

Labels must stay legible for the life of the plant: UV, temperature, moisture and the cleaning solvent used on panels all destroy cheap labels within a year. Print, do not write.

Standards

StandardScope
ANSI/TIA-606-Cadministration of telecommunications infrastructure: identifier classes 1–4 (single room to multi-campus), label durability (UL 969), record requirements
ISO/IEC 14763-2 and TR 14763-2-1planning and installation of cabling, including documentation and identifiers; European equivalent EN 50174-1
ANSI/TIA-568.3-D, ISO/IEC 14763-3what a test record for optical cabling must contain (Fibre characterization)
ANSI/TIA-598-D, IEC 60304fibre and tube colour codes
Telcordia SR-4731the .sor OTDR trace file format — keep native files, not only PDFs
GOST R 53246-2008, GOST R 53245-2008Russian structured cabling standards: design and administration; installation and testing
RD 45.156-2000Russian industry document on the composition of as-built documentation for fibre-optic lines
Full listStandards map

Tools

ToolFitsNotes
Spreadsheetsone building, a few cablesbreaks at the first many-to-many relation (a fibre through five closures)
Fibre management / GIS-based OSP systemsoutside plant of any sizecable, fibre, splice, closure and coordinate model; restoration search "which services are on cable 42 between km 3 and 4"
DCIM with fibre modellingdata centresrack, panel, port, trunk and polarity model; integration with tickets
Network inventory / NMSoperatorsservices on fibres, alarms per fibre
Trace archiveevery plant.sor files named by cable-fibre-direction-wavelength-date; baseline flagged
Photo archiveclosures, panels, manholesa photograph of the opened closure is worth a page of diagram
Offline copyevery restoration truckthe network may be down while you need the records

Process

StepRule
Before constructionidentifier scheme, label specification and record templates written into the contract; handover package defined
During constructiondaily as-built updates; splice schedules filled at the closure, not later from memory
Handover packagedrawings (native + PDF), cable schedule with data sheets, splice schedules, port maps, OTDR .sor both directions at 2–3 wavelengths, insertion-loss results, endface inspection images, label list, warranty and contact list
Every changeticket → work → update records → re-test affected fibres → new baseline → close ticket; no "temporary" patch without a record
Restorationthe incident report includes the new splice schedules and traces; the "temporary" fix gets a date to be replaced
Auditannual sample of closures and panels against records; full audit every 3–5 years
Accessrecords readable by the night crew without a specialist; versioned; backed up off-site

Common failures

FailureConsequenceFix
Labels on one end onlywrong fibre cut, wrong port patchedboth ends, always
Records not updated after restorationthe next fault is located on the old drawingrestoration ticket cannot close without records
Buried closures without coordinatesan OTDR distance and a shovelGPS every closure and marker post; metre marks at both ends
Different colour or numbering conventions per contractorfibre 7 is not fibre 7scheme in the contract; state the scheme in each splice schedule
OTDR traces saved as PDF only, without launch cord and index datano re-analysis possiblekeep .sor files with settings
Patch cords labelled by hand on tapeunreadable in a yearprinted self-laminating labels
Records in one person's headleaves with the personthe process above

In CodingBox

The module is part of the record: its vendor, part number and serial number identify what sits in each port, and its commissioning DDM values are the baseline of the link passport. CodingBox reads the identity and the DDM on the bench and keeps notes and photographs per part number in the code database, so the port map can say which module, not just which fibre (Check transceiver, Code database, DDM in the app).