SOA Pattern of the Week (#6): Canonical Schema

thomas erl ( soaschool.com) and herbjorn wilhelmsen , ( objectware ), bring you the fourth soa pattern of the week, a series comprised of original content and insights provided to you courtesy of the authors and contributors of the soapatterns.org community site and the book “soa design patterns."

the canonical schema pattern ensures that services are built with contracts capable of sharing business documents based on standardized data models (schemas). the application potential of canonical schema can become one of the fundamental influential factors that determine the scope and complexion of a service inventory architecture.

of all the patterns in the soa design patterns catalog there is perhaps no other as simple to understand yet as difficult to apply in practice as canonical schema . there are also few patterns that spark as much debate. in fact, that application potential of canonical schema can become one of the fundamental influential factors that determine the scope and complexion of a service inventory architecture.

it all comes down to establishing baseline interoperability. the canonical schema pattern ensures that services are built with contracts capable of sharing business documents based on standardized data models (schemas). unlike the well-known pattern canonical data model (hohpe, woolf) which advocates that disparate applications be integrated to share data based on common data models, canonical schema requires that we build these common data models into our service contracts in advance. hence, the successful application of this pattern almost always requires that we establish and consistently enforce design standards.

but before we discuss the standardization of data models and all of the enjoyable things that come with trying to make this happen, let’s first take a step back and describe what we mean by “baseline interoperability.”

when services and service consumer programs interact, data is transmitted (usually in the form of messages) organized according to some structure and a set of rules. this structure and the associated rules constitute a formal representation (or model) of the data.

when different services are designed with different data models representing the same type of data, then they will have a problem sharing this data because the data models are simply incompatible. to address this problem, a technique called data model transformation is applied whereby data model mapping logic is developed so that data exchanged by such services is dynamically converted at runtime from compliance with one data model to another. so successful has this technique been that a corresponding data model transformation pattern was developed.

however, with data model transformation comes consequences. and with the overuse of data model transformation comes real problems pertaining to architectural complexity, increased development effort, and runtime performance demands that can impact larger service compositions to such an extent that if you press your ear close enough to your middleware you can actually hear the churning and grinding of this extra runtime latency.

these and other details and issues will be discussed separately during an upcoming series article dedicated to the data model transformation pattern. what’s important for us to understand for now is that the primary goal of applying canonical schema is for us to avoid having to apply data model transformation .

this brings us back to design standards and the scope of their application. establishing canonical schemas as part of services delivered by different project teams at different times requires that each project team agrees to use the same pre-defined data models for common business documents. this may sound like a simple requirement but something simple is not always easy. many organizations have historically struggled with the enforcement and governance of standardized data models – so much so that it has led to organizational power struggles, resentment of individuals at being “enforced”, and technical difficulties with large-scale compliance and change management (of the data models).

these are all reasons as to why the canonical schema pattern is very commonly applied together with domain inventory . limiting the application, enforcement, and governance of standardized data models to the confines of a manageably sized service inventory dramatically increases the potential to successfully realize the full potential of this pattern.

canonical schema epitomizes the transition from silo-based, integrated enterprises to service-orientation. it is a pattern that solves a big problem but asks in return that we make an equally big commitment to its on-going application.