Blog

Java in Telecommunications – Order Management API

14 May, 2007

In the previous two episodes in this series we described the position of Java in the Telecommunications industry, Telemanagement Forum and the basics of OSS/J. This episode focuses on the Order Management API (JSR 264), this is one of the OSS/J APIs being developed using the JCP process (proposed final draft 2 will be released May/June ’07). It is also the API we covered during last weeks session at JavaOne.

Order management is a common process and virtually every organization does some sort of order management to ensure that it can process requests from it’s customers and deliver the requested product (for example book, car, drivers license) or service (for example telephony, health insurance, TV). The Order Management API is (as far as we know) the only open and standards based API available for order management and therefore is relevant for many organizations developing an order management solution (not telecommunications only). By using this API as a basis for your order management solution you can reuse the knowledge of others (not reinventing the wheel) and reduce your integration costs.

The key features are:

  • Supports both simple and complex use cases

  • Supports long running transactions

  • Defines the managed entities on which the Order Management operations work (Order, OrderItems, etc). These are extended from the Telemanagement Forums Shared Information/Data Model, the items used from the TMF SID are the non Telecommunications specific ones.

  • Defines the (extendible) state model for Orders.

  • Support for creation, starting, updating and removing Orders.

  • Support for bulk operations to create, update, remove orders. These are available in an atomic (all must succeed) or best effort (failing ones will be reported back) flavor.

  • Support for notification to keep clients informed of progress of an Order (not only clients that submitted an order but also other interested clients).

  • Notifications that requests the client for validation of certain aspects of the order (before it continues processing).

  • Notifications that requests the client for additional input (before it continues processing).

  • Extensibility. The types of orders (and all contents) and the order states can be extended for your specific needs.

  • Flexible query possibilities like query by key, query based on a template and defining named queries (comparable to JDBC Prepared Statements).

  • Support for static and dynamic typing of attributes of an Order.

  • Support meta-operations that (for example) enable a client to discover at runtime what orders are available.

The Order Management API is not bound to telecommunications specific orders. The API allows for definition of your own order types and and thus can be customized to the specific needs of other industries. To ensure that the operations exposed by the Order Management API are not bound to any specific industry, a generic type ‘Request’ is defined. This Request type is the supertype of all Orders and all Order Management API operations operate on Requests. It is possible to define your own Order types as subtype of Request, or as subtype of one of the four predefined Request subtypes: ProductOrder, ServiceOrder, ResourceOrder, WorkOrder (the latter requires human intervention).

“All nice and dandy”, I hear you think, “but can’t I achieve the same with BPEL?”. From a functional perspective you could realize the same functionality with BPEL (or many other technologies), however you would be inventing you own API instead of building on a standards based one. For example, BPEL will not give the standardized information model, state model or set of operations. You would need to define them yourself and thus you’re creating a proprietary solution. The advantage of reduction in integration costs is lost.

<!-- @page { size: 8.5in 11in; margin: 0.79in } P { margin-bottom: 0.08in } --></p><p style="margin-bottom: 0in">The Order Management API does not attempt to boil the ocean, the following items are out-of-scope and not defined in the API:</p><ul><li><p style="margin-bottom: 0in">Workforce management: Management of staff, schedules etc. is not part of Order Management.</p></li><li><p style="margin-bottom: 0in">Inventory Management: There is a separate Inventory API defining this (JSR 142). Because the will often be a close relation between Order Management and Inventory it can make sense to implement both APIs in one product. Both APIs build on the same OSS/J concepts and interaction is smooth.</p></li><li><p style="margin-bottom: 0in">Order decomposition: This is implementation specific and cannot be defined in the API.</p></li></ul><p style="margin-bottom: 0in">This blog entry roughly covers the first part of the <a href="https://www28.cplan.com/cc158/session_details.jsp?isid=286860&ilocation_id=158-1&ilanguage=english">presentation </a>we did at JavaOne, the second part was answering the question “How does the Order Management API fit into a Service Oriented Architecture?”. Guess what the subject of the next entry in this series will be…</p></div> <!-- Author bio --><div class=" max-w-5xl mx-auto"><div class="w-full mt-lg"><div class="rounded-lg bg-grey-100 mb-sm p-sm md:flex"> <img class="blog-author-pic w-20 h-20 rounded-full flex-grow-0 lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4AQAAAAARHwt/AAAAAnRSTlMAAHaTzTgAAAAXSURBVDjLY2AYBaNgFIyCUTAKRgG9AQAHgAABOufK1AAAAABJRU5ErkJggg==" data-src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-120x120.png" decoding="async"><noscript><img class="blog-author-pic w-20 h-20 rounded-full flex-grow-0" src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-120x120.png" data-eio="l"></noscript><div class="pt-4 md:pt-0 md:pl-sm flex-1 text-left"><div class=""><div class="block font-semibold">by <a class="text-black" href="https://xebia.com/blog/author/gvermaas/">Gero Vermaas</a></div> <span class="text-grey-500 block pt-2"></span></div><div class="pt-6"></div></div></div></div></div></div></section></main> <!-- Related posts --><section class="w-full pb-lg pt-md"><div class="container pb-md"><div class="md:flex justify-between items-center pb-md data-appear-group"><h3 class="text-3xl text-black antialiased mb-4 md:mb-0">Explore related posts</h3></div><div class="grid md:gap-10 grid-cols-1 md:grid-cols-3 data-appear-group-sm"> <!-- Item --><article class="has-img-zoom box case-post bg-white shadow-lg rounded-md flex flex-col"> <a href="https://xebia.com/blog/java-in-telecommunications-introduction/" class="img-wide block rounded-md overflow-hidden relative"><div class="img-zoom h-full w-full absolute lazyload" style="background: no-repeat center; background-size: cover;" data-back="https://xebia.com/wp-content/themes/xebia-theme/images/thumb01.jpg"></div> </a><div class="p-6 md:p-sm flex flex-col justify-between h-full"><div><div class="text-sm text-purple font-bold pb-1 block cat-list"> <span class="cat-list-item">Uncategorized</span></div> <a href="https://xebia.com/blog/java-in-telecommunications-introduction/" class="text-xl text-black my-0 font-semibold link-underline block leading-tight">Java in Telecommunications – Introduction</a></div><div class="md:flex items-center text-grey-700 pt-4 leading-tight"> <img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2 lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAAAnRSTlMAAHaTzTgAAAAeSURBVGje7cEBAQAAAIIg/69uSEABAAAAAAAAAL8GIDoAAeprBV8AAAAASUVORK5CYII=" data-src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-250x250.png" decoding="async"><noscript><img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2" src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-250x250.png" data-eio="l"></noscript><div class="flex-auto"> <a class="text-grey-500 border-none " href="https://xebia.com/blog/author/gvermaas/">Gero Vermaas </a> <span class="text-sm md:text-base block text-grey-300">30 Mar, 2007</span></div></div></div></article> <!-- End item --><!-- Item --><article class="has-img-zoom box case-post bg-white shadow-lg rounded-md flex flex-col"> <a href="https://xebia.com/blog/java-in-telecommunications-order-management-api-in-a-service-oriented-architecture/" class="img-wide block rounded-md overflow-hidden relative"><div class="img-zoom h-full w-full absolute lazyload" style="background: no-repeat center; background-size: cover;" data-back="https://xebia.com/wp-content/themes/xebia-theme/images/thumb01.jpg"></div> </a><div class="p-6 md:p-sm flex flex-col justify-between h-full"><div><div class="text-sm text-purple font-bold pb-1 block cat-list"> <span class="cat-list-item">Uncategorized</span></div> <a href="https://xebia.com/blog/java-in-telecommunications-order-management-api-in-a-service-oriented-architecture/" class="text-xl text-black my-0 font-semibold link-underline block leading-tight">Java in Telecommunications – Order Management API in a Service Oriented Architecture</a></div><div class="md:flex items-center text-grey-700 pt-4 leading-tight"> <img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2 lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAAAnRSTlMAAHaTzTgAAAAeSURBVGje7cEBAQAAAIIg/69uSEABAAAAAAAAAL8GIDoAAeprBV8AAAAASUVORK5CYII=" data-src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-250x250.png" decoding="async"><noscript><img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2" src="https://xebia.com/wp-content/uploads/2022/01/avatar_user_136_1641225371-250x250.png" data-eio="l"></noscript><div class="flex-auto"> <a class="text-grey-500 border-none " href="https://xebia.com/blog/author/gvermaas/">Gero Vermaas </a> <span class="text-sm md:text-base block text-grey-300">06 Jun, 2007</span></div></div></div></article> <!-- End item --><!-- Item --><article class="has-img-zoom box case-post bg-white shadow-lg rounded-md flex flex-col"> <a href="https://xebia.com/blog/standarize-on-java-platform-rather-than-java-language/" class="img-wide block rounded-md overflow-hidden relative"><div class="img-zoom h-full w-full absolute lazyload" style="background: no-repeat center; background-size: cover;" data-back="https://xebia.com/wp-content/themes/xebia-theme/images/thumb01.jpg"></div> </a><div class="p-6 md:p-sm flex flex-col justify-between h-full"><div><div class="text-sm text-purple font-bold pb-1 block cat-list"> <span class="cat-list-item">Uncategorized</span></div> <a href="https://xebia.com/blog/standarize-on-java-platform-rather-than-java-language/" class="text-xl text-black my-0 font-semibold link-underline block leading-tight">Standarize on Java platform rather than Java language</a></div><div class="md:flex items-center text-grey-700 pt-4 leading-tight"> <img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2 lazyload" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" data-src="https://secure.gravatar.com/avatar/5fb955df9063eb3c990c0b60bf7a8e38?s=250&d=mm&r=g" decoding="async"><noscript><img class="flex-none blog-author-pic w-10 h-10 rounded-full border border-grey-200 mr-2" src="https://secure.gravatar.com/avatar/5fb955df9063eb3c990c0b60bf7a8e38?s=250&d=mm&r=g" data-eio="l"></noscript><div class="flex-auto"> <a class="text-grey-500 border-none " href="https://xebia.com/blog/author/lvonk/">Lars Vonk </a> <span class="text-sm md:text-base block text-grey-300">06 Dec, 2007</span></div></div></div></article> <!-- End item --></div></div></section> <!-- footer --><footer class="w-full bg-black pb-sm pt-4 text-white footer-main relative z-20"><div class="footer-wave"> <img class="w-full lazyload" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" alt="" data-src="https://xebia.com/wp-content/themes/xebia-theme/images/footer.svg" decoding="async"><noscript><img class="w-full" src="https://xebia.com/wp-content/themes/xebia-theme/images/footer.svg" alt="" data-eio="l"></noscript></div><div class="container md:flex justify-between"><div class=""><div class="pb-6 pt-2"> <svg class="fill-current text-white w-24 h-10 mx-auto md:mx-0"><title>Xebia Creating Digital Leaders