TM Forum Adapter for Order Management

TM Forum Order Management Adapter is an implementation for TMF622 API specification. It acts as a bridge between the TM Forum Specification and the TIBCO Order Management System.

Below mentioned service implementations on TM Forum adapter are mapped to the TIBCO Order Management Service.

Method TMF622 Service Order Management Service
POST /tmf-api/productOrdering/v4/productOrder /v1/SubmitOrder
DELETE /tmf-api/productOrdering/v4/productOrder/{productOrderId} /v1/WithdrawOrder
GET /tmf-api/productOrdering/v4/productOrder/{productOrderId} /v1/GetOrderDetails
PATCH /tmf-api/productOrdering/v4/productOrder/{productOrderId} Not supported
GET /tmf-api/productOrdering/v4/productOrder Not supported

The Product Order Resource of TM Forum is mapped with the SubmitOrder of Order Management Service. Below are the field to field mapping between these two:

TMF622 Order Management Service
id orderID
externalID externalBusinessTransactionID, orderRequest/orderRef
priority orderRequest/header/orderPriority
description orderRequest/header/description
note orderRequest/header/notes
requestedCompletionDate orderRequest/header/requiredOnDate
requestedStartDate orderRequest/header/requiredByDate
relatedParty/id [where relatedParty/role='customer'] (default value 'dummy customerID') orderRequest/header/customerID
relatedParty/id [where relatedParty/role='subscriber'] (default value 'dummy subscriberID') orderRequest/header/subscriberID
baseType orderRequest/header/udf/name=baseType,value=component json
billingAccount orderRequest/header/udf/name=billingAccount,value=component json
category orderRequest/header/udf/name=category,value=component json
channel orderRequest/header/udf/name=channel,value=component json
notificationContact orderRequest/header/udf/name=notificationContact,value=component json
orderTotalPrice orderRequest/header/udf/name=orderTotalPrice,value=component json
payment orderRequest/header/udf/name=payment,value=component json
relatedParty orderRequest/header/udf/name=relatedParty,value=component json
schemaLocation orderRequest/header/udf/name=schemaLocation,value=component json
orderItem orderRequest/line
orderItem/state orderResult/lines/status
orderItem/id orderRequest/line/lineNumber
orderItem/productOffering/name orderRequest/line/productID
orderItem/action/add orderRequest/line/action/PROVIDE
orderItem/action/modify orderRequest/line/action/UPDATE
orderItem/action/nochange orderRequest/line/action/PROVIDE
orderItem/action/delete orderRequest/line/action/CANCEL
orderItem/quantity orderRequest/line/quantity
orderItem/product/type [default '-'] orderRequest/line/UOM
orderItem/characteristic orderRequest/line/characteristic
appointment orderRequest/line/udf/name=appointment,value=component json
billingAccount orderRequest/line/udf/name=billingAccount,value=component json
itemPrice orderRequest/line/udf/name=itemPrice,value=component json
itemTerm orderRequest/line/udf/name=itemTerm,value=component json
itemTotalPrice orderRequest/line/udf/name=itemTotalPrice,value=component json
orderItemRelationship orderRequest/line/udf/name=orderItemRelationship,value=component json
payment orderRequest/line/udf/name=payment,value=component json
product orderRequest/line/udf/name=product,value=component json
productOffering orderRequest/line/udf/name=productOffering,value=component json
qualification orderRequest/line/udf/name=qualification,value=component json
schemaLocation orderRequest/line/udf/name=schemaLocation,value=component json
type orderRequest/line/udf/name=type,value=component json