Service Characteristics
As part of an order or during order fulfilment, service characteristics are used to define the service details required by both parties. The Fibre Gateway uses the following enumerated set - not all service characteristics are supported by all suppliers.
| Name | Description | Notes |
|---|---|---|
| LINE_PROFILE | Standardises line characteristics - see line profiles | Numeric identifier supplied by tenant on provide order creation - values vary by supplier |
| AUTHENTICATION_AGENT | Authentication agent, possible values: DHCPRelayAgent, PPPIntermediateAgent, None | Supplied by tenant on provide order creation - not used by all suppliers |
| REMOTE_ID | Remote identifier for authentication | Supplied by tenant on provide order creation - not used by all suppliers |
| RETAILER_ID | Unique identifier for the retailer provided by the OFCOM | Supplied by tenant on order creation - not used by all suppliers |
| MINIMUM_SPEED | Requested guaranteed minimum speed | Optionally supplied by tenant on order creation - not used by all suppliers |
| END_USER_TYPE | Type of end user - Business or Residential | Supplied by tenant on order creation - not used by all suppliers |
| CONTRACT_TERM | Contract term in months | Supplied by tenant on order creation - not used by all suppliers |
| ECC_CHARGEBAND | Excess construction charges - see chargebands | Numeric identifier supplied by tenant on order creation - values vary by supplier, not used by all suppliers |
| TRC_CHARGEBAND | Time related charges - see chargebands | Numeric identifier supplied by tenant on order creation - values vary by supplier, not used by all suppliers |
| CARE_LEVEL | Chosen service level - see care levels | Numeric identifier supplied by tenant on order creation - value(s) as agreed with supplier, not used by all suppliers |
| STATIC_IP_REQUESTED | Where static IP(s) are requested, contains the number of static IPs required | Supplied by tenant on order creation - not supported by all suppliers |
| DN_PORT_NUMBER | Where number porting is required, contains the donor number | Supplied by tenant on order creation - not supported by all suppliers |
| DN_PORT_DATETIME | Where number porting is required, contains the date/time to port the number | Supplied by tenant on order creation - not supported by all suppliers |
| LINE_ID | Unique identifier for the line (SOGEA) | Provided by supplier via KCI - mandatory for FTTP before order is completed |
| SERVICE_ID | Unique identifier for the fibre service | Provided by supplier via KCI - mandatory for FTTP before order is completed |
| ENNI_ID | ENNI identifier linking service traffic between tenant and supplier | Provided by supplier via KCI - mandatory for most FTTP suppliers to provide |
| SERVICE_VLAN_ID | Service VLAN between tenant and supplier | Provided by supplier via KCI - mandatory for most FTTP suppliers to provide |
| CUSTOMER_VLAN_ID | Customer VLAN between tenant and supplier | Optionally provided by supplier via KCI |
| CABLE_LINK_ID | External cable link reference for connection to exchange | Optionally provided by supplier via KCI |
| CIRCUIT_REFERENCE | Circuit reference | Provided by supplier where multiple circuits are aggregated |
| SITE_NAME | Unique reference for handover point/point of presence | Optionally provided by supplier via KCI |
| SITE_LOCATION | Site address details of the cabinet/handover point/point of presence | Optionally provided by supplier via KCI |
| ONT_REFERENCE | Supplier identifier for the installed ONT | Provided by supplier via KCI - mandatory where ONT is present |
| ONT_SERIAL_NUMBER | Serial number for the installed ONT | Optionally provided by supplier via KCI |
| ONT_PORT | Port identifier on the ONT providing service | Optionally provided by supplier via KCI |
| ONT_MANUFACTURER | Manufacturer of installed ONT (if available) | Optionally provided by supplier via KCI |
| ONT_FLOOR | ONT location attribute - floor | Optionally provided by supplier via KCI |
| ONT_ROOM | ONT location attribute - room | Optionally provided by supplier via KCI |
| ONT_POSITION | ONT location attribute - position | Optionally provided by supplier via KCI |
Note
When integrating with an existing supplier API or where a supplier cannot send these values as specified, the Fibre Gateway can map between these and custom supplier values to ensure a consistent set for tenants.