Tenant Updates (KCIs)

Once a request has been placed and accepted by the gateway, updates on the progress with the supplier will be delivered to the tenant. These requests include:

  • Orders
  • Service Tests
  • Service Problems

These notifications are sent asynchronously from the supplier to the tenant via the Fibre Gateway as the state changes and at key milestones/events. The Fibre Gateway may send some of the KCIs to ensure consistent behaviour between suppliers and workflows.

Reasons for KCI

Order Updates

  • Informational i.e.
    • CREATED : A new order has been created ( unsolicited cease )
    • ACKNOWLEDGED : Supplier has acknowledged receipt of the order (KCI1)
    • COMMITTED : Supplier has committed to fulfillment of the order (KCI2)
    • DELAY : There is a problem causing a delay (usually accompanied by a status change to HELD)
    • RESUMED : The problem causing the delay has been resolved without impact on target date
    • REAPPOINTED : Supplier has re-appointed the order (if not suitable then treat as a REAPPOINT)
    • ADDITIONAL : Supplier has updated the order and flagged that additional information is available
    • WARNING : Supplier has updated the order and flagged a warning
    • UPDATE : Supplier has updated the order
    • AMENDED : Supplier has accepted and applied the requested order amendment
    • CANCELLED : Supplier has accepted and applied the requested order cancellation
    • TERMINATED : Supplier has ended the order without fulfilling it
    • COMPLETED : Supplier has completed the order (KCI3)
  • Action needed i.e.
    • REAPPOINT : The order needs to be reappointed with the customer
    • INFORMATION_REQUIRED : Supplier needs additional information to continue the order
    • RESUBMIT : The previous request was rejected and must be corrected and resubmitted
  • Error e.g.
    • FAILED _ TO_SEND : Request to supplier failed or the supplier returned an error

Service Test Updates

  • Informational i.e.
    • SENT _ TO_SUPPLIER : Request has been successfully sent to the supplier
    • IN_PROGRESS : Supplier has accepted the service test request
    • REJECTED : Supplier has rejected the request due to validation issue
    • COMPLETED : Supplier has completed the service test. This KCI contains the test results
  • Error e.g.
    • FAILED _ TO_SEND : Request to supplier failed or the supplier returned an error

Service Problem Updates

  • Informational i.e.
    • SENT _ TO_SUPPLIER : Request has been successfully sent to the supplier
    • ACKNOWLEDGED : Supplier has acknowledged receipt of the service problem
    • REJECTED : Supplier has rejected the request due to validation issue
    • IN_PROGRESS : Supplier has accepted the service problem
    • ADDITIONAL : Supplier has updated the service problem and flagged that additional information is available
    • UPDATE : Supplier has updated the service problem
    • AMENDED : Supplier has accepted and applied the requested service problem amendment
    • CANCELLED : Supplier has accepted and applied the requested service problem cancellation
    • COMPLETED : The resolution has been accepted by the tenant or the time period to accept has elapsed
  • Action needed i.e.
    • REAPPOINT : The service problem needs to be (re)appointed with the customer
    • INFORMATION_REQUIRED : Supplier needs additional information to continue the service problem
    • RESUBMIT : The previous request was rejected and must be corrected and resubmitted
    • CONFIRM : The tenant must confirm acceptance or otherwise reject the resolution
  • Error e.g.
    • FAILED _ TO_SEND : Request to supplier failed or the supplier returned an error

Metadata

KCIs contain a consistent set of metadata across Orders, Service Tests and Service Problems:

Field Description Example
id Unique identifier for this KCI (UUID) af14d243-dd62-4e75-8b02-4b5f822e3001
supplier Supplier of this KCI (Fibre Gateway identifier) SUPPLIER1
sequenceNumber Sequence number of KCI for ordering KCIs 1
issuedOn When the supplier issued this KCI
(optional - not set when KCI originated from the Fibre Gateway)		 2022-01-10T09:19:00.000Z
receivedOn When the Fibre Gateway received the KCI from the supplier
(optional - not set when KCI originated from the Fibre Gateway)		 2022-01-10T09:19:00.000Z
deliveredOn When the Fibre Gateway delivered the KCI 2022-01-10T09:19:00.000Z
updateType Type of KCI (see Types of KCIs) INFORMATIONAL

Entity

The KCI will always include the related entity for the update - this could be a provide, cease or modify for a service order or it could be for service test or a service problem

The entityType field will specify which entity type is provided in the KCI.

When reporting the result of an amendment or cancellation request to an existing order, service test or service problem, then the entity will include the appropriate request.