Tenant Order Updates (KCIs)

Once an order has been placed and accepted by the gateway, updates on the order as it progresses with the supplier will be delivered to the tenant.

These notifications are sent asynchronously from the supplier to the tenant via the Fibre Gateway as the state of the order 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

  • 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.
    • Request to supplier failed or the supplier sent an error

Metadata

KCIs contain a consistent set of metadata:

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 service order.

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 then the order entity will include the appropriate request.