Informational KCIs
These KCIs are for information only and do not necessarily require an action from the tenant. However, the KCIs are categorised to identify any changes and aid tenant's business rules/logic to take appropriate action. KCIs will always include the latest version of the order.
| Type | Description | Likely effect on order |
|---|---|---|
| CREATED | Supplier has created the order - unsolicited cease orders only | Order status is RECEIVED_BY_GATEWAY |
| ACKNOWLEDGED | Supplier has acknowledged receipt of the order (KCI1) | Order status change to ACKNOWLEDGED |
| COMMITTED | Supplier has committed to the order (KCI2) | Order committedDate/targetDate updated |
| DELAY | There is a problem causing a delay | Order status change to HELD |
| RESUMED | The problem causing the delay has been resolved without impact on target date | Order status change to IN_PROGRESS |
| REAPPOINTED | Supplier has re-appointed the order (if not suitable then treat as a REAPPOINT) | Order has updated appointment details/target date, possible status change |
| ADDITIONAL | Supplier has updated the order with additional information | Order fields may be updated - refer to KCI text |
| WARNING | Supplier has updated the order and flagged a warning | Order fields may be updated - refer to KCI code/text for warning details |
| UPDATE | Supplier has updated the order | Order fields may be updated |
| AMENDED | Supplier has accepted/applied the requested order amendment | Order fields updated, status change |
| CANCELLED | Supplier has accepted the requested cancellation and cancelled the order | Order status change to CANCELLED |
| TERMINATED | Supplier has ended the order without fulfilling it | Order status change to CANCELLED, REJECTED or FAILED |
| COMPLETED | Supplier has successfully completed the order (KCI3) | Order status change to COMPLETED or PARTIAL |
Created KCI
Orders are usually created by the tenant so this KCI will not be sent. However, a supplier can create an Unsolicited Cease which will result in this KCI being sent to the tenant. This will be a new order and hence a new order id that the tenant must handle. These orders will then receive further KCIs as appropriate below.
Acknowledged KCI
Once the supplier has received the order and performed initial checks, they will send an acknowledged KCI. Where suppliers acknowledge orders synchronously, this KCI will be sent by the Fibre Gateway to ensure consistency.
This KCI is also known as KCI1 by some tenants/suppliers.
Committed KCI
Once the supplier has committed to fulfilment of the order, they will send a KCI with the order delivery confirmed for the date as specified on the order - this will be returned in the committedDate/targetDate fields (where the expected delivery needs to change from this point, targetDate will be used to reflect the new date).
This KCI is also known as KCI2 by some tenants/suppliers.
Delayed KCI
Where there is a delay in delivery of the order, the supplier may send a KCI to inform the tenant. This will include a standard Fibre Gateway code representing the problem/reason for delay along with optional text and supplier code.
Refer to Order KCIs for more information on problem codes.
Note: a delayed order by itself is informational and does not require the tenant/end user to reappoint. Further KCIs will be sent once the problem is resolved or the order could be cancelled in some cases.
Resumed KCI
Once the problem causing a delay has been resolved, a REAPPOINT KCI will usually be sent and the tenant must re-appoint the order. However, in scenarios where a new appointment is not required, the supplier can send a KCI to resume the order without change. For un-appointed orders, this KCI means the delay is resolved without impact on the target date.
Reappointed KCI
Some suppliers may automatically re-appoint orders or liaise directly with the end customer to (re)book appointments. In these cases, the supplier will send a KCI to inform the tenant of the new appointment details. If the new appointment is not suitable then this KCI can be handled in the same way as a re-appoint.
Additional Information KCI
Additional service characteristics are sent during the order lifecycle - at a minimum this includes the service identifier and VLAN information. Where the supplier indicates or the Fibre Gateway detects that new information is available on the order, this KCI will be sent instead of the generic updated KCI. Context may be available in the KCI text.
Warning KCI
Where the supplier supports it, a KCI may carry a warning message. These are different from delays as they are for information and no action is required - the order remains in progress. However, there is a chance that the warning could progress to a delay or action required. These KCIs are accompanied by a problem code and/or text.
This KCI will be sent where an appointment was booked but is not required - the appointment will have been removed from the order and the KCI will include the problem code:
- APPOINTMENT_NOT_REQUIREDUpdated KCI
Any other information updates to the order will be sent as generic update KCIs. Some suppliers send multiple KCIs that may appear as duplicates or with only minor changes - tenants can generally disregard these KCIs in their workflows but should always use the latest order from them.
Amended KCI
Where the tenant has requested an amendment to an order, it will be confirmed as a KCI including the latest version of the updated order and the amendment request.
Cancelled KCI
Where the tenant has requested a cancellation to an order or the supplier has cancelled the order, it will be confirmed as a KCI including the latest version of the cancelled order and the cancellation request if relevant.
Note: this differs from terminated KCI below as it follows a tenant cancellation request.
Terminated KCI
Where the supplier has cancelled an order, the KCI will include a standard Fibre Gateway code (see below) representing the problem/reason for cancellation along with optional text and supplier code.
Note: this differs from cancelled KCI above as it originates from the supplier and not a tenant cancellation request.
Refer to Order KCIs for more information on problem codes.
Completed KCI
Once the supplier has fulfilled the order, this KCI will be sent. In some cases it may not have been possible to complete everything on the order (i.e. all engineer tasks) - the PARTIAL order state is used to indicate this and should come with appropriate KCI text.
This KCI is also known as KCI3 by some tenants/suppliers.