Java in Telecommunications – Order Management API

Gero Vermaas


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.

<meta name="GENERATOR" content="OpenOffice.org 2.0 (Linux)" /><meta name="AUTHOR" content="Gero Vermaas" /><meta name="CREATED" content="20070329;13524000" /><meta name="CHANGEDBY" content="Gero Vermaas" /><meta name="CHANGED" content="20070514;14401000" /><br /> <style type="text/css"> <!-- @page { size: 8.5in 11in; margin: 0.79in } P { margin-bottom: 0.08in } --> </style> <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="http://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> </div> <!--end post--> <!-- Comments --> <div id="comments"> <h4>Comments (1)</h4> <ol class="comments-list"> <li class="pingback even thread-even depth-1" id="comment-18100"> <!--comment body--> <div id="div-comment-18100"> <div class="comment-meta"> <h5 class="author"> <a href='http://blog.xebia.com/2007/09/25/jsr264-order-management-api-released/' rel='external nofollow' class='url'>Xebia Blog</a> - <a rel='nofollow' class='reply comment-reply-link' href='http://blog.xebia.com/java-in-telecommunications-%e2%80%93-order-management-api/?replytocom=18100#respond' onclick='return addComment.moveForm( "div-comment-18100", "18100", "respond", "228" )' aria-label='Reply to Xebia Blog'>Reply</a> </h5> <p class="date">September 25, 2007 at 9:03 am</p> </div> <div class="comment-entry"> <p>[...] The Order Management API 1.0 has been released. The Order Management API is (as far as we in the JSR264 Expert Group (EG) know) the only open and standards based API available for order management and is relevant for any organization developing an order management solution. By using this API as a basis for your Order Management solution you can reuse the knowledge of others (not reinventing the wheel), reduce your integration costs and create a flexible Order Management solution. In a previous blog post I already described the features of the API in detail, so I’ll just repeat the most important features: [...]</p> </div> </div> </li><!-- #comment-## --> </ol> <div id="respond"> <h4>Add a Comment <a class="reply comment-reply-link" rel="nofollow" id="cancel-comment-reply-link" href="/java-in-telecommunications-%E2%80%93-order-management-api/#respond" style="display:none;"> - Cancel Reply</a></h4> <form method="post" action="http://blog.xebia.com/wp-comments-post.php" id="comments-form"> <input type="text" value="Name" id="author" name="author" default-value="Name" /> <input type="text" value="Email" id="email" name="email" default-value="Email" /> <textarea cols="88" rows="6" id="comment" name="comment" default-value="Message">Message</textarea> <input type="submit" value="Add Comment" class="red" /> <input type='hidden' name='comment_post_ID' value='228' id='comment_post_ID' /> <input type='hidden' name='comment_parent' id='comment_parent' value='0' /> </form> </div> </div> <!-- /Comments --> </div> <!-- /Main Content --> <!-- Sidebar --> <div id="sidebar"> <!-- Sidebar --> <div id="sidebar"> </div> <!-- /Sidebar --> </div> <!-- /Sidebar --> </div> <!-- /Content --> <!-- Footer --> <div id="footer"> <div class="container clearfix"> <div class="one-fourth footer"><div class="widget widget_links"><h3>Xebia Sites</h3> <ul class='xoxo blogroll'> <li><a href="http://www.xebia.fr" rel="me">Xebia France</a></li> <li><a href="http://training.xebia.com" title="www.xebiatraining.com">Xebia Training</a></li> <li><a href="https://www.xebia.com" rel="me">Xebia.com</a></li> </ul> </div></div> <div class="one-fourth footer"><div class="widget widget_meta"><h3>Login</h3> <ul> <li><a href="http://blog.xebia.com/wp-login.php?action=register">Register</a></li> <li><a href="http://blog.xebia.com/wp-login.php">Log in</a></li> <li><a href="http://blog.xebia.com/feed/">Entries <abbr title="Really Simple Syndication">RSS</abbr></a></li> <li><a href="http://blog.xebia.com/comments/feed/">Comments <abbr title="Really Simple Syndication">RSS</abbr></a></li> <li><a href="https://wordpress.org/" title="Powered by WordPress, state-of-the-art semantic personal publishing platform.">WordPress.org</a></li> </ul> </div></div> </div> <div class="clear"></div> <div class="info container clearfix"> <!-- Copyright --> <ul class="copyright"> <li>© 2013 Xebia. All rights reserved</li> </ul> <!-- /Copyright --> <!-- Social Links --> <ul class="social-links"> <li class="Xebia"><a href="Xebia.com">Xebia</a></li> </ul> <!-- /Social Links --> </div> </div> <!-- /Footer --> </div> <!-- /Main Container --> <!-- Back to Top --> <div id="back-top"><a href="#top"></a></div> <!-- /Back to Top --> <!-- Start of Async HubSpot Analytics Code for WordPress v1.1.0 --> <script type="text/javascript"> var _hsq = _hsq || []; _hsq.push(["setContentType", "blog-post"]); (function(d,s,i,r) { if (d.getElementById(i)){return;} var n = d.createElement(s),e = document.getElementsByTagName(s)[0]; n.id=i;n.src = '//js.hs-analytics.net/analytics/'+(Math.ceil(new Date()/r)*r)+'/697348.js'; e.parentNode.insertBefore(n, e); })(document, "script", "hs-analytics", 300000); </script> <!-- End of Async HubSpot Analytics Code --> <script type='text/javascript' src='http://blog.xebia.com/wp-includes/js/comment-reply.min.js?ver=4.6.1'></script> <script type='text/javascript' src='http://blog.xebia.com/wp-includes/js/wp-embed.min.js?ver=4.6.1'></script> <script type="text/javascript"> var cdJsHost = (("https:" == document.location.protocol) ? "https://" : "http://"); document.write(unescape("%3Cscript src='" + cdJsHost + "analytics-eu.clickdimensions.com/ts.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var cdAnalytics = new clickdimensions.Analytics('analytics-eu.clickdimensions.com'); cdAnalytics.setAccountKey('a3PdFXuvqc0qk3dIzpmOq0'); cdAnalytics.setDomain('xebia.com'); cdAnalytics.trackPage(); </script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-9457407-3', 'auto'); ga('require', 'displayfeatures'); ga('send', 'pageview'); </script> </body> </html>