1. OAGi Copyright OASIS, 2004 Resources: http://www.oasis-open.org/committees/cam http://www.jcam.org.uk Content Assembly Tutorial David RR Webber Chair OASIS CAM TC http://drrw.net david@drrw.net OAGi / NIST, Gaithersburg, April 2004.

2. Copyright OASIS, 2004 eBusiness XML parsing - mission profile Agile Interoperability Opening up business integration rules Handling local context drivers Validating content with semantics How does W3C XSD schema help? What does OASIS CAM provide? How does this work for OAGi BODs?

3. Copyright OASIS, 2004 OASIS CAM in a nutshell Assembly of XSD fragments into whole schema Provide payload structure and content definition – Local pre-deployment transaction checking – Industry Conformance and Compliance testing – Production validation and error handling Business Context Rules implementation – Simple business analyst friendly syntax and predicates Transaction Assembly and Integration / Formats Alignment of Vocabularies / Legacy Semantics

4. Copyright OASIS, 2004 $ Time / Maturity Semantic Interoperability Barrier Structuring Barrier $ $ Data Exchange Costs Data Quality Costs CAM – Providing Business Value

5. Copyright OASIS, 2004 Sampling of CAM interest Users – British Telecom – DFAS – Smartdraw.com – XML Center NY Technical Committee Individuals – Adobe – Amberpoint – NIST – Sun – Seeburger – US Navy – EPR-forum – CUNY XML Center - OAGi BODs IV&I transactions Purchase Order - UBL OP70 - FIXML - DFAS, IJI - xCBL Telcom CAM Templates Developed

6. Copyright OASIS, 2004 Information Maturity Capabilities

7. Copyright OASIS, 2004 Agenda Part 1 – Basic Feature Set / Uses – XSD Schema Assembly Techniques Part 2 – Content Structure Definition and Validation – XML Structure and Data Content Validation – Deployment / Business Context Mechanism – Using CAM template tools to create an OAGi BOD (IV&I) Part 3 – Advanced Features – Understanding Elements/Attributes/Data types/Namespace – Using Vocabularies / Legacy Semantics – Assembly of Business Content / Transactions Summary

8. OAGi Copyright OASIS, 2004 XSD Schema Assembly Techniques Part 1 – Basic Features

9. OAGi Copyright OASIS, 2004 XSD Schema Assembly Connecting standard pieces of XSD structure components together into coherent XSD schema Using a familiar construct to illustrate and introduce CAM features Compare and contrast with XSD alone

10. Copyright OASIS, 2004 Conceptual: Data Elements build Transactions Name AddressemailPhone #Company Phone # email Address NameParty Party ID Invoice PO #Line ItemCost CONTEXT

11. Copyright OASIS, 2004 Example #1 - Core Components Create Long Term Contract Forecast Component Requirements Send Planning Document Place Order Ship Materials Customer Arrange Payment Supplier Domain: Matl Mgmt Industry: Auto Ship Notice Regulatory: Safety Change Lvl Container Serialized ID ProdId Part Number Ship’d Qty Context Providing supply chain messaging using CCTS

12. Copyright OASIS, 2004 Example #2 - Context Affects “Person” depending on “Role”. CORE COMPONENT (PERSON) Police Officer knows he is a WITNESS FRENCH ENGLISH Police Investigator thinks He is a SUSPECT NPB calls him a PAROLEE Corrections call him a INMATE / CRIMINAL Judge calls him a DEFENDANT L'officier de police sait qu'il est un TÉMOIN L'investigateur de police pense qu'il est un SUSPECT NPB l'appelle un LIBÉRÉ SUR PAROLE Les corrections l'appellent un DÉTENU/CRIMINEL Le juge l'appelle un DÉFENDEUR

13. Copyright OASIS, 2004 How do you put this all together? ActionEvent Information Rule What Why HowWhen Where / Who ActionEvent Information Rule What Why HowWhen ActionEvent Information Rule What Why HowWhen

14. Copyright OASIS, 2004 Linking Person Scenario Details to Real World English or French Text Document HTML XML Schema PDF eForms CORE COMPONENT BUSINESS INFORMATION ENTITY SYNTAX BIE EXPRESSION USAGE CONTEXT Context Key:UID:RCMP023079:00 Geo-Political Context: English or French Legislative Context: Narcotics Legistation Industry Context: NAICS 9221 Process Context: HC 3515 Process Role Context: Police Chief Supporting Role Context: RCMP Investigator Product Context: Case Management System Systems Capabilities Context: XML Schema 1. Example: AGE Syntax Independent Syntax Bound 2. Becomes: PERSON.BIRTH.DATE of Suspect 3.Is expressed in an XML schema fragment

15. Copyright OASIS, 2004 Using CAM Template – XSD assembly Template consists of the following parts – Header Description, owner, version Context Declaration – Structure XSD component assembly details – Business Context use rules 1 2 3 Example

16. Copyright OASIS, 2004 Comparing XSD import to as:include XSD approach – Uses import mechanism to combine XSD syntax – Can name parent element blocks from import and build structure with them – Can rename parent element(s) with new name(s) CAM approach – Uses as:include predicate that retrieves XSD fragments – Can use predicates to control cardinality – Can exclude parts of tree, elements or attributes – Can use rules driven by context statements – Can include CAM sub-assembly structure(s)

17. Copyright OASIS, 2004 XSD selection factors – Works with XSD parser standalone – Good for well defined static structures – Tools available to help create syntax and visualize the result – Complex schema may not be supported by tools such as WSDL CAM as:include selection factors – Provides finer granularity of control on structure members – Can use context driven selection – Requires CAM processor – Output XSD results can be used at design time or runtime with tool that will consume the resultant simple resultant XSD – CAM V1.0 does not parse and interpret the XSD fragments Choosing which approach?

18. Copyright OASIS, 2004 XSD Schema Assembly Summary Provides one discreet use for CAM templates Useful for documenting business rules around selection of components of XSD structure Works best for relatively stable transactions with limited business permutations where XSD provides enough functionality Preferred if the deployment target is based around an XSD parser as the prime validator / consumer of the resultant schema. May solve XSD handling issues by providing fully resolved simple XSD for downstream processes / WSDL / SOAP environments

19. OAGi Copyright OASIS, 2004 XML Structure and Data Content Validation Deployment model + Business Context Mechanism Using CAM template tools to create an OAGi BOD Part 2 – Content Structure

20. OAGi Copyright OASIS, 2004 The most common need is to define a transaction structure - and to then test that a given piece of XML actually conforms correctly to those business rules (but I thought XSD does all that?) XML Structure + Validation

21. Copyright OASIS, 2004 How does CAM augment schema? Can have multiple structure instances selected by context Can include structure from sub-assembly of components Enhanced element semantics beyond simply datatyping Full code lists functionality beyond NMTOKEN Ability to leverage semantics at attribute level consistently with elements Ability to version content model components Link to industry dictionaries / registries Link to web service components for external checks Ability to assemble transaction instances Neutral approach - can handle non-XML / XSD formats

22. Copyright OASIS, 2004 Technology Foundation Simple XML V1.0 XPath Neutral approach to structure content Assertion predicates excludeAttribute() excludeElement() excludeTree() makeOptional(), makeMandatory() makeRepeatable(), setLimit() setRequired() setChoice() setId() setLength() setMask() setValue() restrictValues() restrictValuesByUID() useAttribute() useChoice() useElement() useTree() useAttributeByID() useChoiceByID() useElementByID() useTreeByID() lookup() startBlock(), endBlock()

23. Copyright OASIS, 2004 Example #3 – Sporting Goods Ordering This example illustrates the use of rule predicates both inline and in the business context section. The reference XML structure layout is directly inside the CAM template itself – (any associated XSD structure is used indirectly as a design reference only) Different XML structure components are selected based on context View Example

24. OAGi Copyright OASIS, 2004 An XSD schema structure definition provides a variety of permutations for its target XML structure. CAM provides the means to select the XML combination that matches the actual business context. Business Context Mechanism

25. Copyright OASIS, 2004 Context is the pervasive driver to effective engineering Drives dynamic process configuring and control Ensures accurate information capture, packaging and delivery Key to correct relationships between partners in a collaboration Lack of context control mechanisms is the most prominent reason why legacy e-Business systems are difficult and complex to extend and support Date: circa 1568 1 : the parts of a discourse that surround a word or passage and can throw light on its meaning 2 : the interrelated conditions in which something exists or occurs Understanding about Context

26. Copyright OASIS, 2004 Results for given context and action Context Statements How Context is applied CAM Template + CAM gets passed context from business use Generates actual XML instance definition to be used XML transaction content process and compare 1 2 3 4 5

27. Copyright OASIS, 2004 External Business Context Mechanism Link between messaging layer, business process layer and assembly layer. <ebContext UIDref='SDIR03400' interchangeID='123456789' BPMref='ABC123456:01‘ CPAref='ABC012345‘ xmlns:as="http://www.oasis-open.org/committees/cam"> An example context instance 1.0 CAM BPM <condition name="Catalogue" value="A2003-Q1" as:setLength="8" as:setMask="XNNNN-QN" as:UIDreference="SGIR:030451"/> <condition name="itemType" value="nonperishable" label="Item type:“ as:member="nonperishable,perishable,refridgerated,fragile"/> Context Variables Definition

28. Copyright OASIS, 2004 Content Assembly Template Configure the Business Exchange Rules XML instance structure(s) Business context rules + Content Reference rules + Data Validation rules + External Mapping rules Logical business transaction can have more than one structure layout can add inline rules directly into structure makeOptional() excludeTree() item type="noun" name="Agency/@AgencyID" UIDReference="ukt000910" <conditional expression="'//SupplierID' and lookup(value,'SGIRWSDL:supp lierID_check')" Simple Declarative Statements BPM Step transaction template

29. Copyright OASIS, 2004 Moving to deployment Business agreement Drives document exchanges

30. Copyright OASIS, 2004 Context Summary Context variables defined in CAM template header as needed Optional external XML context instance document can pass values to CAM processor from a business process step The external XML context instance can be shared with other process components that may require knowledge of context – e.g. messaging services, business process engine. Registry can provide storage for the artifacts involved – business process script, CAM template, XML context instance, CPA instance – in a catalogue entry.

31. OAGi Copyright OASIS, 2004 Worked example – creating an OAGIS BOD template Using CAM tools

32. Copyright OASIS, 2004 Summary of steps required Pick a target XML transaction instance – Tutorial example is IV&I SyncQuantityOnHand BOD Insert sample XML structure instance into the CAM template Build structure control predicate statements for use in Business Context control section Build content reference statements for each unique element within the XML transaction Optionally add data validation rules Complete template by testing against sample

33. Copyright OASIS, 2004 Example #4 - IV&I SyncQuantityOnHand Template consists of the following parts – Header Description, owner, version Context Declaration – Structure XML instance of BOD – Business Context use rules – Content Reference statements – Data Validation rules Example 1 2 3 4 5

34. Copyright OASIS, 2004 Using the CAM Wizard Tools Written in JavaScript Uses IE5.5+ with MS-XML4.0 parser Exploits the built-in XML DOM handler Easily extensible Writes examples to C: drive \temp directory Demonstration Select Sample XML (for use in Wizard) 2003-11-10T11:30:47-08:00 200311101130QOH442 SV Poller 4.1012 0 033987830 006927180 View Results

35. Copyright OASIS, 2004 Running the jCAM processor Available from : http://www.jCAM.org.ukhttp://www.jCAM.org.uk Test jCAM

36. Copyright OASIS, 2004 More CAM tools VisualScript Schema Designer Allows you to design an XML structure Automatically generates the XSD for the structure Automatically outputs the matching CAM template Creates two styles of documentation HTML XML – http://www.visualscript.com http://www.visualscript.com JAXE open source XML editor – http://jaxe.sourceforge.net http://jaxe.sourceforge.net – is configurable via the CAM.xsd

37. OAGi Copyright OASIS, 2004 Using elements / attributes / datatyping / namespaces Alignment of Vocabularies Multi-lingual support Assembly of Transaction Content Part 3 – Advanced Features

38. OAGi Copyright OASIS, 2004 Using Elements / Attributes / Data types / Namespace techniques and managing them Understanding XML parts

39. Copyright OASIS, 2004 Elements / Attributes / Data types While these are at the heart of XML syntax, they are also in many ways an odd-ball trio. If you ask ten people about these, you will get ten different views, or more! How do you get to consistency of use and sensible use standards? How do you apply versioning and reuse? CAM allows you to treat structure elements and attributes consistently and apply robust data typing and validations to them equally as nouns.

40. Copyright OASIS, 2004 Aligning Terminology and Usage XML allows for freeform naming of content tags CAM provides the means to link those tag names to standard industry terms and definitions within a formal vocabulary This also means that multi-lingual support is built-in You can also version those references Registry SCM team is defining noun semantics

41. Copyright OASIS, 2004 Capturing Noun Semantics Draft layout for storing noun details in registry See: OASIS Registry Semantic Content Management sub-committee work (SCM SC) Can use Designer Tools to automatically generate from XSD model

42. Copyright OASIS, 2004 Reference Nouns from CAM template Using the UID reference, and Registry alias mechanisms – associate content in the schema layout with noun semantic reference Define Registry Alias Associate structure items <registry name="OAGBOD" access="registry.oagi.net:1025" method="http-binding" description="OAGi BOD Element Dictionary Registry access"/> <item type="noun" name="//DataArea/oa:Sync@confirm" UIDReference="IVI070020" taxonomy="UID" registry=“OAGBODI" setValues="'Never','Always'" /> <item type="noun" name="//EffectivePeriod@inclusive" UIDReference="IVI070025" taxonomy="UID" registry=“OAGBOD" setValues="'True','False'" /> Noun semantics referencing

43. Copyright OASIS, 2004 Noun Semantics Summary CAM uses a simple unique identifier system (UID) tailored to the target domain – such as ISO11179, UDEF, RosettaNet, FIX, legacy EDI and more. With a neutral logical labelling system you decouple away from dependency on explicit human readable names – and can resolve possible collisions. Facilitates a system of nouns and constructing a vocabulary that provides consistent semantic use. Enables libraries of structure parts and foundation for automated crosswalks between transaction documents and application stores.

44. Copyright OASIS, 2004 Names and Namespaces Is this a solution looking for a problem? How much irresolvable collision of names really happens in a given XML instance? Local and global declarations – Can you just include a piece of XML into another XML structure and it always work? Can you work smart and build XML that is self- defining and always locally unambiguous? What we really need is a way of establishing logical identifiers that link consistent semantics – regardless of the tag name used!

45. Copyright OASIS, 2004 Namespaces – when to use them? CAM itself uses namespaces. The most coherent reason to use them is not to apply prefixes to every piece of content – that is wasteful, confusing and prevents easy content reuse! CAM uses namespaces to denote a stream of markup within markup. In other words – markup that is there only to direct how the main markup is to be used - e.g. inline predicates and assertion rules. This use of namespaces is simple and clear. A namespace prefix may also denote ownership organization location in a purely informational role.

46. Copyright OASIS, 2004 Elements / Attributes - Summary CAM facilitates the use of simple XML V1.0 based structure definitions that provide very stable interoperability and compatibility The CAM template provides the means to express the semantics around the content in the target XML structure The cardinality and logic statements in CAM provide the means to assemble together a clear structure instance schema Removes the need to use namespaces to avoid naming collisions. The next section looks at the techniques and examples

47. OAGi Copyright OASIS, 2004 Tools that support the development of industry vocabularies for noun semantics and legacy transaction integration. Aligning Industry Vocabularies

48. Copyright OASIS, 2004 Noun Semantics – common foundation Need consistent way of expressing noun definitions across industry domains Registry SCM provides path to that Existing industry domain vocabularies can be easily populated into Registry using the noun semantics layout Once loaded Registry provides powerful set of tools to aid alignment – associations, classification, ontologies, discovery Alignment is two steps – internal, then external

49. Copyright OASIS, 2004 Registry Roles “A semantic registry is the key foundation block upon which global electronic business exchanges will be built”. Business Analyst Web Interface Information Profiles Distribution Administration Program Level Semantics Information Engine Industry Business Standards Registry Protocol Standards ebXML, ISO11179, OASIS, OAGi, RosettaNet, UBL, UDEF XML Software Developers Interchange CAM

50. OAGi Copyright OASIS, 2004 In addition to the validation of content CAM provides the means to create transaction and information formats as an output. Assembly of Content

51. Copyright OASIS, 2004 Multiple Structure Layouts The AssemblyStructure section of the CAM template permits the definition of more than one structure Each structure can be labelled The ExternalMapping section of the CAM template can be directed to use a specific structure, or map between two structures There is an optional merge substitution feature that allows CAM to target any structured content layout

52. Copyright OASIS, 2004 Mapping to XML targets in CAM template OAG BOD target <MapRule output=“/OrderItem/Description" input="@trim(Sales/Company/Year/Qtr/Product/Item@name)"/> <MapRule output=“/OrderItem/ProductManufacturer" input="Sales/Company/Year/Qtr/Product/Item@manufacturer"/> <MapRule output=“/OrderItem/ShipmentValue" input="Sales/Company/Year/Qtr/Product/Item@value"/> <MapRule output=“/ReceivedQuantity" input="Sales/Company/Year/Qtr/Product/Item@sold"/> Interface to / from XML structures in template

53. Copyright OASIS, 2004 External Mapping to SQL targets Product List <MapRule output="name" input="@trim(Sales/Company/Year/Qtr/Product/Item@name)"/> <MapRule output="manufacturer" input="Sales/Company/Year/Qtr/Product/Item@manufacturer"/> <MapRule output="value" input="Sales/Company/Year/Qtr/Product/Item@value"/> <MapRule output="sold" input="Sales/Company/Year/Qtr/Product/Item@sold"/> Interface to / from SQL

54. Copyright OASIS, 2004 Example Merge Template to HTML <![CDATA[ Monthly Orders Report #as:REPEAT#; Month: #as:Month#; #as:REPEAT#; #as:name#; #as:type#; #as:manufacturer#; #as:sold#; #as:value#; #as:ENDREPEAT#; #as:IF (Sales/Company/Year/Qtr/Month < "12" )#; #as:ENDIF#; #as:ENDREPEAT#; ]]> CAM structure reference Inline merge commands Target HTML syntax Field substitution references

55. OAGi Copyright OASIS, 2004 Resources and Planning Summary

56. Copyright OASIS, 2004 Summary: The Holy Grail of e-Business Automatic information integration has been the Holy Grail of e-Business systems since before XML was conceived. Lesson learned - three needs are paramount: – the ability to design transactions consistently, – the ability to document their usage in a clear way and then – the ability to drive software that can apply rules and test information content to ensure correct compliance. CAM approach provides three critical abilities: – documentation of business interchange transactions, – design-time assembly support with verification, – and runtime checking of information content.

57. Copyright OASIS, 2004 Available Components / Resources jCAM component – http://jcam.org.uk http://jcam.org.uk VisualScript editor for CAM templates – http://www.visualscript.com http://www.visualscript.com JAXE editor with CAM XSD – http://www.jaxe.org http://www.jaxe.org OASIS CAM TC – http://www.oasis-open.org http://www.oasis-open.org

58. Copyright OASIS, 2004 Next Steps Work in progress: – Formal Publication of OASIS Specification – Continue development of jCAM processor – Library of CAM templates by industry – Integration with OASIS Registry assembly – Building of noun semantic dictionaries

59. Copyright OASIS, 2004 Get involved in OASIS CAM Download the specs from www.oasis-open.orgwww.oasis-open.org Open source resources www.jcam.org.ukwww.jcam.org.uk Encourage your industry group to adopt CAM templates for their standards Specify CAM-compliance from providers

60. OAGi Copyright OASIS, 2004 OASIS – Content Assembly Mechanism April 2004 http://www.oasis-open.org/committees/cam Thank You www.oasis-open.org xml.coverpages.org www.xml.org