Skip to content

Latest commit

 

History

History
287 lines (189 loc) · 11.4 KB

codelists.md

File metadata and controls

287 lines (189 loc) · 11.4 KB

Codelists reference

Welcome to the Open Fibre Data Standard 0.1.0-beta release.

We want to hear your feedback on the standard and its documentation. For general feedback, questions and suggestions, you can comment on an existing [discussion](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/discussions) or start a new one. For bug reports or feedback on specific elements of the data model and documentation, you can comment on the issues linked in the documentation or you can [create a new issue](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/issues/new/choose).

To comment on or create discussions and issues, you need to [sign up for a free GitHub account](https://github.com/signup). If you prefer to provide feedback privately, you can email [info@opentelecomdata.net](mailto:info@opentelecomdata.net).

Some schema fields refer to codelists, to limit and standardise the possible values of the fields, in order to promote data interoperability.

Codelists can either be open or closed. Closed codelists are intended to be comprehensive; for example, the currency codelist covers all currencies in the world. Open codelists are intended to be representative, but not comprehensive.

Publishers must use the codes in the codelists, unless no code is appropriate. If no code is appropriate and the codelist is open, then a publisher may use a new code outside those in the codelist. If no code is appropriate and the codelist is closed, then a publisher should instead create an issue in the OFDS GitHub repository.

:class: Tip

If you use new codes outside those in an open codelist, please create an issue in the [OFDS GitHub repository](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/issues), so that the codes can be considered for inclusion in the codelist.

The schema has a codelist property to indicate the CSV file that defines the codes in the codelist (shown as tables below). It also has an openCodelist property, to indicate whether the codelist is open or closed.

Codes are case-sensitive, and are generally provided as English language camelCase. Codes must not be translated.

Open codelists

contractType

The contract type codelist is used to categorise contracts based on the World Bank PPPLRC's types of PPP arrangement.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/contractType.csv

language

The language codelist is used to provide the default language used in text fields and the language of linked documents, using two-letter codes from ISO639-1.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/language.csv

linkRelationType

The link relation type codelist consists of extensions to the IANA Link Relationship Types constructed according to the tag URI scheme.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/linkRelationType.csv

mediaType

The mediaType codelist is based on the IANA Media Types list. The media type codelist adds an exceptional code for printed documents ('offline/print'), and omits any media type that is marked as deprecated or obsolete by IANA.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/mediaType.csv

nodeTechnologies

The node technologies codelist is used to indicate the technologies used in a node.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/nodeTechnologies.csv

nodeType

The node type codelist is used to categorise the nodes in a network.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/nodeType.csv

organisationIdentifierScheme

The organisation identifier scheme codelist uses the codes from org-id.guide to identify the register from which an organisation's identifier is drawn. You can search for codes by browsing the website or you can download the latest version of the codelist as a CSV file.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/organisationIdentifierScheme.csv

organisationRole

The organisation role codelist is used to identify an organisation's roles in a network. An organisation can have one or more roles.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/organisationRole.csv

spanTechnologies

The span technologies codelist is used to indicate the technologies used on a span.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/open/spanTechnologies.csv

Closed codelists

country

The country codelist uses uppercase two-letter codes from ISO3166-1. The country codelist adds a user-assigned code for Kosovo ('XK').

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/country.csv

currency

The currency codelist uses uppercase 3-letter codes from ISO4217.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/currency.csv

deployment

The deployment codelist is used to categorise the deployment of spans.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/deployment.csv

fibreType

The fibre type codelist is a subset of ITU-T recommendations that describe characteristics of optical fibre and cables. It is used to categorise the type of fibre used in a span.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/fibreType.csv

geometryType

The geometry type codelist is used to categorise the type of geometry represented by the geometry object.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/geometryType.csv

nodeStatus

The node status codelist is used to identify the operational status of a node.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/nodeStatus.csv

spanStatus

The span status codelist is used to indicate the operational status of a span.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/spanStatus.csv

transmissionMedium

The transmission medium codelist is used to categorise the physical media of a span.

This codelist is referenced by the following properties:

This codelist has the following codes:

:header-rows: 1
:widths: auto
:file: ../../codelists/closed/transmissionMedium.csv