Data model

The OFDS data model is a logical model that sets out the entities, attributes and relationships needed to describe a fibre network, without specifying how to represent them in a particular data format. This page provides an overview of the data model and reference tables for each entity.

See also

OFDS also defines standardised representations of the data model in different data formats, which can be used to store, publish or exchange OFDS data.

Overview

The following diagram provides an overview of the key entities and relationships in the OFDS data model.

        ---
config:
  layout: elk
---
erDiagram
    Network {
    }
    
    Contract {
    }

    Node {
    }

    Organisation {
    }

    Phase {
    }

    Span {
    }

    Wayleave {
    }

    Network ||--o{ Node : "Consists of"
    Network ||--o{ Span : "Consists of"
    Network ||--o{ Phase : "Deployed in"
    Node }o--|| Organisation : "Transmission medium owned by"
    Node }o--|| Organisation : "Supporting infrastructure owned by"
    Node }o--|| Organisation : "Active infrastructure operated by"
    Node }o--|| Phase : "Deployed in"
    Span }o--|| Node : "Starts at"
    Span }o--|| Node : "Ends at"
    Span }o--|| Organisation : "Transmission medium owned by"
    Span }o--|| Organisation : "Supporting infrastructure owned by"
    Span }o--|| Organisation : "Active infrastructure operated by"    
    Span }o--|| Organisation : "Installed by"
    Span }o--|| Phase : "Deployed in"
    Contract }o--|| Phase: "Agreement to develop"
    Phase }o--|| Organisation: "Financed by"
    Wayleave }o--o{ Span: "Grants rights for installation, operation and maintenance of"
    Wayleave }o--|| Organisation: "Rights granted by"

    classDef spatial fill:#f3ffa6ff,stroke:#bbd034
    classDef non-spatial fill:#cec7ffff,stroke:#110e27

    class Node,Span spatial
    class Network,Organisation,Phase,Contract,Wayleave non-spatial
    direction LR

    

See also

For an introduction to key concepts and relationships covered in the OFDS data model, read the scope, focus and key concepts primer.

Entities

This section provides a definition for each entity in the data model, including a description, relationships to other entities, and attributes.

Some attributes refer to codelists to limit and standardise the possible values of the attribute. In such cases, a link to the codelist is provided in the attribute’s description.

Network

Description

A telecommunication network. A network consists of a set of nodes interconnected by spans.

Relationships

Entity

Cardinality

Description

Node

1:N

The nodes that belong to this network.

Span

1:N

The spans that belong to this network.

Phase

1:N

The phases in which this network was, or will be, deployed.

Attributes

Title

Description

Type

Format

Required

id

string

uuid

Required

UUID

A universally unique identifier for this network, as defined by RFC 4122. For more information, see the identifier reference.

identifier

string

Identifier

A local identifier for this network in an internal system.

name

string

Network name

A name for this network.

website

string

iri

Website

The URL of the website for this network.

language

string

Language

The default language used in text attributes,from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

Phase

Description

name: phase-description

A set of nodes and/or spans deployed as a group.

Relationships

Entity

Cardinality

Description

Network

N:1

Node

1:N

Span

1:N

Organisation

1:N

The organisations that provide financing for the development or operation of this phase, also known as investors or financers.

Contract

N:1

Attributes

Title

Description

Type

Format

Required

id

string

Required

Identifier

A locally-unique identifier for this phase.

name

string

Name

A name for this phase. The name should be unique amongst the phases belonging to a network.

description

string

Description

A description for this phase.

Node

Description

A point within a network. A node may be an access point or may reflect a geographic point at which a span splits, aggregates or crosses a border. Nodes can allow for interconnections to other networks or connections to end users.

Relationships

Entity

Cardinality

Description

Network

N:1

Phase

N:1

The phase to which this node belongs.

Span

M:N

Organisation (Transmission medium owner)

N:1

The organisation that owns the transmission media for this node, i.e. the passive network equipment such as splitters, combiners and fibre distribution panels.

Organisation (Supporting infrastructure owner)

N:1

The organisation that owns the supporting infrastructure.

Organisation (Network provider)

N:M

The organisations that operate the active network infrastructure for this node, i.e. the electrical elements, such as optical transceivers, switches and routers. In open business models, network providers provide wholesale access to service providers such as retail internet service providers. Network providers can own or lease the active network infrastructure.

Attributes

Title

Description

Type

Format

Required

id

string

Required

Identifier

A locally-unique identifier for this node.

name

string

Name

A name for this node. The name should be unique amongst the nodes belonging to a network.

status

string

Status

The status of this node, from the closed nodeStatus codelist.

location

object

Location

The physical location of this node.

address/streetAddress

string

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

address/locality

string

Locality

The locality. For example, Mountain View.

address/region

string

Region

The region. For example, CA.

address/postalCode

string

Postal code

The postal code. For example, 94043.

address/country

string

Country

The country in which the address is physically located, from the closed country codelist.

type

array[[string]]

Type

This node’s function, from the open [nodeType codelist]https://standard.ofds.info/en/latest/reference/codelists#nodetype). For nodes with multiple network providers, the union of the node types for each provider. If a node’s only function is to serve as a junction between spans, this attribute should be omitted. Junction nodes are identified by the existence of more than two spans that begin or end at the node.

supportingInfrastructure/type

string

Type

The type of supporting infrastructure, from the open nodeSupportingInfrastructure codelist.

supportingInfrastructure/description

string

Description

A description of the supporting infrastructure for this node.

supportingInfrastructure/spareCapacity

boolean

Spare capacity

Whether the supporting infrastructure has spare capacity for the installation of additional network equipment.

accessPoint

boolean

Access point

Whether active or passive transmission equipment is installed at this node which is capable of providing access to the network.

internationalConnections

array[Address]

International connections

The international connections available at this node. For all connections, .country is required.

power

boolean

Power availability

Whether power for active network equipment is available at this node.

technologies

array[[string]]

Technologies

The active technologies used at this node, from the open nodeTechnologies codelist. For nodes with multiple network providers, the union of the active technologies used by each provider.

Span

Description

A physical connection between two nodes.

Relationships

Entity

Cardinality

Description

Network

N:1

Phase

N:1

The phase to which this span belongs.

Node (start)

N:1

The identifier of one of two nodes that this span connects. If the span is directed, it represents the starting point of the span.

Node (end)

N:1

The identifier of one of two nodes that this span connects. If the span is directed, it represents the end point of the span.

Organisation (Transmission medium owner)

N:1

The organisation that owns the transmission media for this span, i.e. the fibre cables.

Organisation (Supporting infrastructure owner)

N:1

The organisation that owns the supporting infrastructure.

Organisation (Network provider)

N:M

The organisations that operate the active network infrastructure for this span, i.e. the electrical elements, such as optical transceivers, switches and routers. In open business models, network providers provide wholesale access to service providers such as retail internet service providers. Network providers can own or lease the active network infrastructure.

Organisation (Supplier)

N:1

The organisation responsible for installing the cable for this span.

Wayleave

M:N

The identifiers of the formal agreements that grant network operators rights to install, maintain or operate this span’s infrastructure on, over, or under grantors’ property or assets.

Attributes

Title

Description

Type

Format

Required

id

string

Required

Identifier

A locally-unique identifier for this span.

name

string

Name

A name for this span. The name should be unique amongst the spans belonging to a network.

status

string

Status

The status of the network infrastructure for this span, from the closed spanStatus codelist.

readyForServiceDate

string

date

Ready for service date

The date this span was ready to carry traffic. For spans with multiple network providers, the earliest of the dates at which each provider’s network was ready to carry traffic on this span.

directed

boolean

Directed

Whether this span is directed. If the span is directed, the span begins at the node referenced in .start and ends at the node referenced in .end. Otherwise, the span connects the nodes referenced in .start and .end with no direction implied.

route

object

Route

The physical route that this span takes between the nodes that it connects.

transmissionMedium

array[[string]]

Transmission medium

The physical media of this span, from the closed transmissionMedium codelist.

deployment

array[[string]]

Deployment

The physical deployment of this span, from the closed deployment codelist. Further details of this span’s deployment can be provided in .supportingInfrastructure.

supportingInfrastructure/type

string

Type

The type of supporting infrastructure, from the open spanSupportingInfrastructure codelist.

supportingInfrastructure/description

string

Description

A description of the supporting infrastructure for this span.

supportingInfrastructure/spareCapacity

boolean

Spare capacity

Whether the supporting infrastructure has spare capacity for the installation of additional fibre cables.

codeployment

string

Codeployment

The type of utility or transport infrastrucutre with which this span is codeployed.

cableType

string

Cable type

The type of cable used in this span.

darkFibre

boolean

Dark fibre availability

Whether access to dark fibre is available on this span.

fibreType

string

Fibre type

The type of fibre used in this span, from the closed fibreType codelist. Further details of the span’s fibre type can be provided in .fibreTypeDetails.

fibreTypeDetails/fibreSubtype

string

Subtype

The sub-category of this span’s fibre type. For example, G.652.B.

fibreTypeDetails/description

string

Description

A description of this span’s fibre type.

fibreCount

integer

Fibre count

The number of individual optical fibres in this span.

fibreLength

number

Fibre length

The physical length in kilometres, of fibre optic cable used in this span.

technologies

array[[string]]

Technologies

The active technologies used on this span, from the open spanTechnologies codelist. For spans with multiple network providers, the union of the active technologies used by each provider.

capacity

number

Equipped capacity

The transmission rate, or throughput, of this span, expressed in Gbit/sec (Gbps). The equipped capacity is the total capacity of the circuits (e.g. E1, DS3, STM-1 etc.) which have been activated in the network transmission equipment of the span. For spans with multiple network providers, the sum of the capacity of each provider’s network on this span. Further details of this span’s capacity can be provided in .capacityDetails. For more information, see equipped capacity.

capacityDetails/description

string

Description

A description of this span’s capacity.

countries

array[[string]]

Countries

The countries in which this span is physically located, from the closed country codelist.

Additional information

Equipped capacity

Span.capacity is defined as the equipped capacity of a span:

The transmission rate, or throughput, of this span, expressed in Gbit/sec (Gbps). The equipped capacity is the total capacity of the circuits (e.g. E1, DS3, STM-1 etc.) which have been activated in the network transmission equipment of the span. For spans with multiple network providers, the sum of the capacity of each provider’s network on this span. Further details of this span’s capacity can be provided in .capacityDetails. For more information, see equipped capacity.

There are several measures of capacity in fibre networks[1]:

  • Potential capacity refers to the total theoretical bandwidth that is available, including lit (turned on) and unlit (dark fibre) capacity.

  • Equipped capacity, also known as lit capacity, refers to bandwith that is turned on and ready for use.

  • Purchased capacity, also known as contracted capacity, covers bandwidth put into service, but not all of which is used; some is held in reserve for restoration or redundancy

  • Used capacity covers bandwidth that is available to carry traffic.

Capacity diagram

Organisation

Description

An organisation.

Relationships

Entity

Cardinality

Description

Phase

N:1

Node (Transmission medium owner)

1:N

Node (Supporting infrastructure owner)

1:N

Node (Network provider)

M:N

Span (Transmission medium owner)

1:N

Span (Supporting infrastructure owner)

1:N

Span (Network provider)

M:N

Span (Supplier)

1:N

Attributes

Title

Description

Type

Format

Required

id

string

Required

Local identifier

A locally-unique identifier for this organisation.

name

string

Name

A name for this organisation. The name should be unique amongst the organisations belonging to a network.

identifier/id

string

Identifier

The identifier assigned to the organisation in the register identified in .scheme.

identifier/scheme

string

Scheme

The register from which the identifier in .id is drawn, from the open organisationIdentifierScheme codelist.

identifier/legalName

string

Legal name

The legally registered name of the organisation

identifier/uri

string

iri

URI

A canonical URI for this identifier, such as those provided by Open Corporates. Do not use this field to provide the website of the organisation: instead, use Organisation.website.

country

string

Country

The country in which this organisation is legally registered, from the closed country codelist.

roles

array[[string]]

Roles

This organisation’s roles in this network, from the open organisationRole codelist. Further details about this organisation’s roles can be provided in .roleDetails.

roleDetails

string

Role details

Further details about this organisation’s roles in the network

website

string

iri

Website

The URL of the website for this organisation.

string

iri

Logo

The URL of the logo for this organisation.

Contract

Description

An agreement between the public and private sectors to develop a network.

Relationships

Entity

Cardinality

Description

Phase

1:N

The phases to which this contract relates.

Attributes

Title

Description

Type

Format

Required

id

string

Required

Identifier

A locally-unique identifier for this contract.

title

string

Title

A title for this contract.

description

string

Description

A description for this contract.

type

string

Type

The type of this contract, from the open contractType codelist.

value/amount

number

Amount

The amount of this value.

value/currency

string

Currency

The currency of this value, from the closed currency codelist.

dateSigned

string

date

Date signed

The date this contract was signed.

Wayleave

Description

A formal agreement that grants a network operator rights to install, maintain or operate telecommunications infrastructure on, over, or under the grantor’s property or asset.

Relationships

Entity

Cardinality

Description

Span

M:N

The identifiers of the formal agreements that grant network operators rights to install, maintain or operate this span’s infrastructure on, over, or under grantors’ property or assets.

Attributes

Title

Description

Type

Format

Required

id

string

Required

Identifier

A locally-unique identifier for this wayleave.

grantor

object

Grantor

The entity that grants a network operator the legal right to install, maintain, or operate telecommunications infrastructure on, over, or under property or assets.

grantor/id

string

Required

Local identifier

The local identifier of the organisation being referenced.

grantor/name

string

Name

The name of the organisation being referenced. This must match the name of the organisation referenced in .id.

yearSigned

integer

Year signed

The year in which this wayleave was signed.

term

object

Term

Information about the duration of the wayleave.

term/indefinite

boolean

Indefinite

Whether the term of wayleave is indefinite, i.e. without an end date.

term/years

integer

Years

If the wayleave’s term is definite, its duration in years.

cost

object

Cost

Information about the cost of the wayleave.

cost/recurring

boolean

Recurring

Whether this is a recurring cost.

cost/perMetre

object

Cost per metre

The average cost per metre for this wayleave. Wayleave costs can include a mix of per length and per item fees, e.g. a fee per metre of cable and a fee per pole. The average cost per metre should be calculated by dividing the total cost of all fees by the total length in metres of cable covered by the wayleave. For recurring fees, the average cost per metre should be annualised.

cost/perMetre/amount

number

Amount

The amount of this value.

cost/perMetre/currency

string

Currency

The currency of this value, from the closed currency codelist.

Document

Description

A piece of electronic or physical matter that provides information or evidence or that serves as an official record.

Relationships

Entity

Cardinality

Description

Contract

N:1

Attributes

Title

Description

Type

Format

Required

title

string

Title

A title for this document.

description

string

Description

A description of this document. Descriptions should not exceed 250 words. If the document is not accessible online, the description should describe how to access a copy of the document.

url

string

iri

URL

A web address for accessing this document.

format

string

Format

The format of this document, from the open mediaType codelist.