Welcome!

Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Best Practices for Exchanging Valid Data Through Web Services

A model-based approach to semantic interoperability

Web services fit nicely into a service-oriented architecture (SOA) and appear to be one component of the ideal solution to business application integration. When exposing applications through Web services, the contract of each service is evident through its Web Services Description Language (WSDL) description.

The WSDL document describes the names of the operations, the names and types of each of the parameters, and the name and type of the return value. After you add reliable messaging support (to ensure delivery) and a business process management engine (to route based on high-level business logic), your integration problems are over.

Of course it's not so simple. Even when using the loose coupling afforded by Web services, you must marshal data into the correct format. Organizations that do not carefully plan their integration strategy usually end up with a multiplicity of point-to-point integrations, because the simplest way to expose a Web service is through a thin veneer on application data structures. A single point-to-point integration is manageable; dozens become a maintenance nightmare. Semantic inconsistency arises between disparate systems. Exposing application data as a Web service without considering the consumers of the data defeats the loose-coupling tenet of an SOA. Fortunately, a set of best practices is emerging to address these concerns. The essence of these practices is to separate data logic from business logic, capturing the data logic in a model with accompanying rules and transformations that are preserved as metadata. This model-based approach to integration promotes reuse, error management, and controlled change.

Use Data Models
The first step in improving integration is to use an application-agnostic data model. (See Jim Gabriel's Best Practices in Integrating Data Models for SOA.) The idea here is to transform data into a common, application-neutral format. (This format can be virtual - it may exist in the development environment only to be compiled away at run time.) Then each data type in the integration project should be mapped onto this format. Adding a new data type requires a single mapping to the neutral format rather than an unmanageably large number of mappings to all of the other types in the system. This can provide maximum flexibility in replacing individual systems without forcing you to rewrite the integration. When you take this approach, you commit to modeling the inputs and outputs of all of the components in the integration project along with the transformations between them. The tools you select will capture all of those relationships as metadata, preserving the intent for future generations of programmers who must maintain the software. Because schemas change over time, many tools provide capabilities for managing schema and interface evolution in a natural way.

Resolve Semantic Inconsistency
Adopting an application-agnostic data model is the starting point, but it's not sufficient. The next step is to ensure semantic interoperability. Enterprises often have multiple definitions for customer, product, or order, as well as business requirements to present data about these entities differently according to rules and roles within the business. To take a real-world example, consider the task of integrating billing and order-entry systems at a major telecommunications provider. The billing system has specific rules about what constitutes a valid request. For example, you aren't allowed to use the "residential" bill format for a commercial account. These rules aren't known to the order-entry system, and they're not expressible in the schema for an order. Simply exposing "order" as a parameter to a Web service does not obviate the underlying constraint. In fact, exposing this concept via a Web service increases the likelihood that inconsistent or incorrect data will be supplied, with little feedback provided to the suppliers of the bad data. A properly written integration project must take explicit steps to resolve these inconsistencies.

Separate Data Logic from Business Logic
These sorts of inconsistencies are all too often swept under the rug or addressed outside the scope of the integration project. A far-too-common approach is to change human processes to avoid entering "bad" data into the system in the first place. One customer concluded that it would be easier to train the data-entry staff to never enter a purchase order containing incompatible feature combinations than it would be to fix the integration to detect and correct this situation. These errors are typically addressed in one of two ways: by writing custom Java code in the individual service adapters or by adding decision nodes to the business process definition (in WebLogic, a Java Process Definition, or JPD). New business process decision nodes mean interspersing low-level data integration logic with the high-level application logic, resulting in a business process flow that is no longer understandable to the business user for whom it is intended. Custom Java code generally works well but results in a fragile integration. The Java code is tied to a specific version of the data schema - as soon as the schema changes, you must locate and revisit the Java code. Data logic should be tightly coupled with the data definition, not distributed throughout the integration project.

Use Model-Based Integration
An emerging best practice to address these concerns is to attach the rules relating to the data (validity constraints, logical calculations) directly to the model as metadata. In this case, the application-agnostic data model mentioned earlier includes not only the definitions of the data types of the various business applications, but also the custom reconciliation rules you must define to ensure semantic interoperability. This model-based approach results in comprehensive metadata for the entire integration project and helps you manage extensions to the models and rules over time. Model-based integration projects are self-documenting and significantly reduce maintenance costs. For example, you can develop validation rules and mapping transformations graphically in conjunction with application owners instead of using the commonly accepted but slow and error-prone practice of e-mailing spreadsheets across organization boundaries.

Reuse Common Computations
A model-based integration starts with definitions of the systems involved. Some organizations have these definitions defined in XML Schema, some in Unified Modeling Language (UML), some as object-relational mappings. In any case, these definitions are incorporated into a larger model that defines each of the payloads and the relationships between them. This model may be enriched with additional data that is not present in the original schemas but spans multiple systems. For example, an enterprise may have a well-defined delineation of "loan-to-value ratio," which is critical to its notion of mortgage data exchange. This calculation should be defined once and reused throughout the set of integration projects. Ideally this calculation would be attached directly to the model, resulting in what is often called an exchange model. (See Roy Schulte's Information Architecture for the Virtual Enterprise.)

More Stories By Andy Armstrong

Andy Armstrong is a software architect at Pantero Corporation. His responsibilities include the architecture and the overall user experience of Pantero software.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
SYS-CON Events announced today that TidalScale will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale is the leading provider of Software-Defined Servers that bring flexibility to modern data centers by right-sizing servers on the fly to fit any data set or workload. TidalScale’s award-winning inverse hypervisor technology combines multiple commodity servers (including their ass...
As hybrid cloud becomes the de-facto standard mode of operation for most enterprises, new challenges arise on how to efficiently and economically share data across environments. In his session at 21st Cloud Expo, Dr. Allon Cohen, VP of Product at Elastifile, will explore new techniques and best practices that help enterprise IT benefit from the advantages of hybrid cloud environments by enabling data availability for both legacy enterprise and cloud-native mission critical applications. By rev...
Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant tha...
As popularity of the smart home is growing and continues to go mainstream, technological factors play a greater role. The IoT protocol houses the interoperability battery consumption, security, and configuration of a smart home device, and it can be difficult for companies to choose the right kind for their product. For both DIY and professionally installed smart homes, developers need to consider each of these elements for their product to be successful in the market and current smart homes.
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, will lead you through the exciting evolution of the cloud. He'll look at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering ...
SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
In a recent survey, Sumo Logic surveyed 1,500 customers who employ cloud services such as Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). According to the survey, a quarter of the respondents have already deployed Docker containers and nearly as many (23 percent) are employing the AWS Lambda serverless computing framework. It’s clear: serverless is here to stay. The adoption does come with some needed changes, within both application development and operations. Tha...
SYS-CON Events announced today that Avere Systems, a leading provider of enterprise storage for the hybrid cloud, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere delivers a more modern architectural approach to storage that doesn't require the overprovisioning of storage capacity to achieve performance, overspending on expensive storage media for inactive data or the overbui...
With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
Digital transformation is changing the face of business. The IDC predicts that enterprises will commit to a massive new scale of digital transformation, to stake out leadership positions in the "digital transformation economy." Accordingly, attendees at the upcoming Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA, Oct 31-Nov 2, will find fresh new content in a new track called Enterprise Cloud & Digital Transformation.
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp emp...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
Amazon is pursuing new markets and disrupting industries at an incredible pace. Almost every industry seems to be in its crosshairs. Companies and industries that once thought they were safe are now worried about being “Amazoned.”. The new watch word should be “Be afraid. Be very afraid.” In his session 21st Cloud Expo, Chris Kocher, a co-founder of Grey Heron, will address questions such as: What new areas is Amazon disrupting? How are they doing this? Where are they likely to go? What are th...
Most technology leaders, contemporary and from the hardware era, are reshaping their businesses to do software. They hope to capture value from emerging technologies such as IoT, SDN, and AI. Ultimately, irrespective of the vertical, it is about deriving value from independent software applications participating in an ecosystem as one comprehensive solution. In his session at @ThingsExpo, Kausik Sridhar, founder and CTO of Pulzze Systems, will discuss how given the magnitude of today's applicati...
Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant th...
SYS-CON Events announced today that SkyScale will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. SkyScale is a world-class provider of cloud-based, ultra-fast multi-GPU hardware platforms for lease to customers desiring the fastest performance available as a service anywhere in the world. SkyScale builds, configures, and manages dedicated systems strategically located in maximum-security...
SYS-CON Events announced today that Avere Systems, a leading provider of hybrid cloud enablement solutions, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere Systems was created by file systems experts determined to reinvent storage by changing the way enterprises thought about and bought storage resources. With decades of experience behind the company’s founders, Avere got its ...
SYS-CON Events announced today that Taica will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. ANSeeN are the measurement electronics maker for X-ray and Gamma-ray and Neutron measurement equipment such as spectrometers, pulse shape analyzer, and CdTe-FPD. For more information, visit http://anseen.com/.
High-velocity engineering teams are applying not only continuous delivery processes, but also lessons in experimentation from established leaders like Amazon, Netflix, and Facebook. These companies have made experimentation a foundation for their release processes, allowing them to try out major feature releases and redesigns within smaller groups before making them broadly available. In his session at 21st Cloud Expo, Brian Lucas, Senior Staff Engineer at Optimizely, will discuss how by using...