oasis cam – technology introduction business rules exchange workgroup call october 30 th, 2007

OASIS CAM – Technology Introduction

Business Rules Exchange Workgroup Call October 30th, 2007

http://www.mismo.org/

OASIS CAM – Technology Introduction

David Webber

Chair OASIS CAM TC

October, 2007

[email protected]

MISMO Presentation 2007 - Webinar 3

Agenda

Today’s information integration needs

CAM technology approach

Demonstration

Illustrative examples

Summary / Next Steps


Agenda



Demonstration




Defining Information Services

Create Samples

RulesEditor

XML

AnalystTemplates

Samples

Develop

Verify

StructureRulesContextVocabulary

3

2

Rules

html

XML

Resultshtml

Publish

1

Detail Use Rules

Test Rules on Samples

4

Share Results

EnablingAgile Information Exchanges

Structure + Vocabulary

Rules + Context Templates

Verify Template Outcomes


Partner Conformance

Test andCertification

Validate

Templates

Report

PartnerCreatesXMLResults

Test

Pass / Fail

Templates

XMLhtml

StructureRulesContext

4

5

6

Publish


What makes something Agile?

• Re-usable methods that can be applied to many areas– Based on open standards and approach; not proprietary

• Context and role driven and aware– This allows tailoring to specific profiles and use pattern templates dynamically

• Self-adaptive– When requirements change can be adjusted on-the-fly in real time

• Fault tolerant and not brittle– Ability to ignore non-critical interchange items and especially not to fail for trivial

reasons or slight version nuances

– Leveraging XML capabilities to make self-describing transactions possible rather

than static fixed legacy exchanges

• Able to support new uses without extensive re-programming– Usage patterns set via external configuration allowing broad but controlled uses


Facilitation Needs

• For business communities:– Ability to create sharable templates for communities

of practice that need consistent XML transaction handling definitions that are open and public.

• For business data analysts:– Printable rule documentation support and features. – Example domain templates within communities of

practice – Genericode codelists implementation.

• For programmers:– XML content manipulation support and rules ( xslt,

XPath …)– Web services and SOA support


Select your technology set

• Many technologies are available, including application servers, distributed objects, and integration servers. Agile use of XML a prerequisite.

• The choice of technology will likely be a mix of components that together meet your SOA needs.

– Avoid vendor lock-in

– Prefer Open Standards and Open Source solutions

– Ensure proper use of layers to separate and manage complexity

– Select simple components that integrate easily


Summary - Solution Metrics

• Can I create a standard simple open format to

describe my message structures and data content

rules?

• Can my partners validate their transactions in test

BEFORE they send them?

• How do people know what I will send them?

• I want something that’s simple and standards based –

leverages existing XML components

• Can I generate HTML documentation that is readable

by business analysts?


Agenda



Demonstration




History and Status of CAM work

• OASIS technical committee• Five years of combined development in UN/CEFACT

and OASIS• OASIS v1.1 public standard and specification • jCAM open source implementation in Java• Creating simple XML-scripted open standard

mechanisms for XML transaction assembly and processing

• Re-use: leverages XPath and xslt, and extends schematron approach

• Developing templates for common industry formats


Why not use XSD?

• Today’s XML schemas have complex structures with no context

awareness + no cross field association rules + no dynamic

lookups

• The XSD provides a model of ALL possible structure instances –

not the particular instance

• Generating valid sparse transaction layout is tough

• Documentation diagrams hard to read

• Excessive use of namespaces make for fragile XML transaction

handling

• How to create simple re-usable templates?


XSD – PESC model example

EVERYTHINGis optional! So what do I REALLY sendto you?


What about these needs?

• Versioning• Content consistency• Use rules• Codelists• Associations (what uses which?)• Guidelines• Providing local contextual validation services


Versioning Challenges

• If the schema version changes – how to ensure it does not break our in place validations?

• How to rapidly adapt to rule changes in a production environment?

• How to develop user context driven deep version control and re-use of sub-components?

• Enhance and automate Test release cycle by improving transparency for bug fix process and expose change deltas to speed testing process? Support for regression testing?


CAM Process Architecture

CAMCAMCAMCAM

XML ParserXML Parser/ DOM/ DOM


Built-in Built-in FunctionsFunctionsBuilt-in Built-in

FunctionsFunctions

XPathXPathhandlerhandlerXPathXPath

handlerhandler

SQL SQL persistencepersistence

SQL SQL persistencepersistence TermsTerms

RegistryRegistryTermsTerms

RegistryRegistryRule EngineRule EngineRule EngineRule Engine Post-Post-ProcessingProcessing

/ Errors/ Errors

Post-Post-ProcessingProcessing

/ Errors/ Errors

XML-awareXML-awareXML-awareXML-aware

EXTENSIONS


jCAM Functional Components

CAMCAMCAMCAM



Built-in Built-in FunctionsFunctionsBuilt-in Built-in

FunctionsFunctions

XPathXPathhandlerhandlerXPathXPath

handlerhandler

SQL SQL persistencepersistence

SQL SQL persistencepersistence TermsTerms

RegistryRegistryTermsTerms

RegistryRegistryRule EngineRule EngineRule EngineRule Engine

EXTENSIONS

jaxenxerces

e.g. JRules,Others…

Saxon - xslt

planned using AJAX / ebXML


/ Errors/ Errors


/ Errors/ Errors

XML Data Mapping

XML-awareXML-awareXML-awareXML-aware

cam

XXXX


Deployment Options

B2B Web services

jCAMenginejCAM

engine

XML

Templates

XML

MessageSystemXMLJava

APIReceive

Process

Validate Server

TemplatesRequest

XML

htmlResponseJavaAPIProcess

StructureRulesContext

1

2

3

1

2

3

Standalone

EDITOR

Template

XMLhtml

Report


Agenda

MISMO information integration needs


Demonstration




How does CAM work?

• CAM uses WYSIWYG approach to XML

• Starting with your XML sample – creates structure template from

that + default data content model

• Next – add your structure use rules – optional / repeatable, date

fields, allowed values, lookups

• Then make context business rules – cross field use rules, exclude,

include, variables

• Save template – run against samples

• Eclipse editor tool makes this all easy to do!

• Deploy to production using jCAM processor


Eclipse CAM Editor

1

2

3

4

5

Available structures

Structure Rule Viewer

Rule Details

Results Viewer

ValidationProcess


Using jCAM :

• Start with sample XML

• Use Eclipse template editor

• Load XML, generate CAM

• Enhance base template

• Test, refine and deploy

• Generate documentation

• Deliver business solution

Build SimpleBuild SimpleTemplateTemplateBuild SimpleBuild SimpleTemplateTemplate

ExtendingExtendingTemplateTemplateExtendingExtendingTemplateTemplate

Verify ResultsVerify ResultsVerify ResultsVerify Results

SimpleSimpleXML instanceXML instance

SimpleSimpleXML instanceXML instance

Document Document Rule DetailsRule DetailsDocument Document Rule DetailsRule Details

1

2

3

4

5


Summary of CAM template features

• Ability to use <as:include> to modularize complex content

• Use of XPath references enables agile rule handling

• Full contextual support including variables, rules and context

sections

• Code lists can be externally built and then referenced

• Extensions section provides customization options

• Integration with xslt provides extended results handling and

error reporting capabilities

• Template representation model and XML enables extended

post-processing and documentation options


CAM Functions Summary

excludeAttribute() startBlock() useElementByID() useAttribute()

excludeElement() endBlock() useTreeByID() useChoice()

excludeTree() checkCondition() setDefault() useElement()

makeOptional() makeRecursive() restrictValuesByUID() useTree()

makeMandatory() setUID() orderChildren() useAttributeByID()

makeRepeatable() restrictValues() setRequired() useChoiceByID()

setChoice()

setId()

setLength()

setNumberRange()

setLimit()

setValue()

setDateMask()

setStringMask()

setNumberMask()

allowNulls()

datatype() or setDataType()

<as:BusinessUseContext> <as:Rules> <as:default> <as:context> <as:constraint action="makeRepeatable(//Items/Item)"/> <as:constraint action="makeOptional(//Item/comment)"/> <as:constraint action="setLength(//shipTo/state,2)"/> <as:constraint action="setDateMask(//PurchaseOrder/shipDate,YYYY-MM-DD)"/> <as:constraint action="makeOptional(//PurchaseOrder/comment)"/> <as:constraint action="restrictValues(//shipTo/@type,'US'| 'CA'| 'MX', 'US')"/> <as:constraint action="setDateMask(//PurchaseOrder/@orderDate,YYYY-MM-DD)"/> <as:constraint action="setNumberMask(//Item/@pno,###-###)"/> <as:constraint action="setNumberMask(//Item/quantity,###)"/> <as:constraint action="setNumberMask(//Item/price,####.##)"/> <as:constraint condition="//Item/@pno = 123-678“ action="restrictValues(//shipTo/state,'WA')"><as:annotation> <as:documentation type="documentation">Can only ship item 123-678 to Washington State </as:documentation></as:annotation> </as:constraint> <as:constraint condition="$QuickBooks = true“ action="excludeElement(//Item/comment)" /> </as:context> </as:default> </as:Rules> </as:BusinessUseContext>

Example of Rules Use


Interactive Documentation (iDoc)

CAM Template

XSLT

iDocwiki

HTML


Agenda



Demonstration




Conceptual View of MISMO transactions

Transaction

Templates

StructureRulesContext3

2

Use Rules

html

XML

Reportshtml

Publish

1

Common Details

Rules

4

Share Details

Case Data

Asset

Interviewer

Loan Product

Terms

Purpose

Transaction

Content Rules

Lookup Values

Context

VersioningBorrower


MISMOCAMEclipseEditorSample


Illustrative MISMO requirements

• When Loan Amount > 700,000– Require LTV <= 90

• When Loan Amount > 1,000,000– Require LTV <= 80– AND CLTV <= 90

• When Documentation Type = Full AND Loan Purpose = Purchase AND Occupancy = Primary Residence– Require LTV <= 95– AND CLTV <= 95

• Require Property State = CA


CAM rules syntax

<as:BusinessUseContext> <as:Rules> <as:default> <as:context>

<as:constraint condition="//Loan/Amount > 700000 and( //Loan/LTV > 90)" action="restrictValues(//Loan/LTV, ‘LTV must be less than or equal 90 for 700,000 loans') "/>

<as:constraint action="restrictValues(//Property/State, 'CA')"/>

</as:context> </as:default> </as:Rules> </as:BusinessUseContext>


Lookup Rule Tables (example #1)


Lookup Rule Tables (example #2)


Other Domain Examples

DOJNIEM/LEX

Fannie MaeEDI-esque

XML

PESCDictionary

andschema

UBL schema

and CCTS

-Universal Business Language (UBL)

-OASIS standard

-Uses UML models and CCTS approach

-Derived from xCBL and simplEDI approach

-Supply chain schema with joint initiative EU / Asia / US

-Developed by GTRI for DOJ community

-Vocabulary based

-LEXS schema built using NIEM vocabulary

-Law enforcement and court applications

-Developed for Education Department

-form-style XML

-Older XSD techniques for simple flat schema model

-No re-use of common structures

-Student loans and transcripts

-Developed by BAH and NG for form-based application submissions

-Translate previous paper form into multiple schema sections

-Massive schema with extended namespaces

-Set of functional transactions and configuration templates for managing and processing elections

-Common set of components and vocabulary

-Widely differing use patterns and items by country localization

OASISEML

Grants.govform based

schema

-Transactions replacing EDI

-Overloaded reuse of structure components

-Financial reporting data

-Financial transaction data

-Extended use of code sets to label transaction content / purpose


Agenda



Demonstration




Value Proposition

• Making XML transaction handling simpler and predictable

• Extends and clarifies your existing XSD schema structures

• Quick and easy rule building from sample XML transaction

• Enabling more robust fault tolerant processing + versioning

• Providing open sharable templates and documentation

• Re-use easier through support for includable components

• Ability to integrate to business processes and context

• Open source, open public standard toolkit – editor + engine


What’s Next / Call to Action

• Develop template sets for your business domain

• Integrate into your messaging exchanges

– OrionSMG supports jCAM

– Web service test-bed

• Publish to registry to facilitate adoption

– Create document templates to generate registry

content / guidelines

• Use Wiki / SourceForge to facilitate sharing


Questions?


www.jcam.org.uk

camprocessor.sourceforge.net

www.drools.org (JRules)

www.oasis-open.org/committees/cam

docs.oasis-open.org/cam

Resources:


A special mention for our contributors to the CAM and jCAM work:

UK - Martin Roberts and team from BTplcUS - Sidhartha Nagolu from AC-Tech / NIH

Credits:

oasis cam – technology introduction business rules exchange workgroup call october 30 th, 2007

Documents

stepsmismo presentation

easilymismo presentation

soa supportmismo presentation

agile use of xml

choice of technology

integration servers

business analysts

standard simple open