National Institute of Standards and Technology 1 Testing and Validating OAGi NDRs Puja Goyal Salifou Sidi Presented to OAGi April 30 th, 2008

National Institute of Standards and Technology 2 Outline Naming and Design Rules Quality of Design Tool (QOD) OAGi NDR v9.0 Encoding –Testability –Observations –Demo NDR Authoring/Sharing What’s Next

National Institute of Standards and Technology 3 NDR: Naming and Design Rules Rules applied when creating standards for the exchange of information –Any of a series of rules documents since 2003 that restrict XML Schema flexibility –Indicate features which should, may, may not, should not, must, or must not be used.

National Institute of Standards and Technology 4 What’s in an NDR? Naming Rules: –Names (or tags) represent information to be exchanged –Subject names to consistent naming practices for clarity and consistency in an XML schema. Design Rules –Address how information is structured Superstructures: namespaces Microstructures: global vs. local elements

National Institute of Standards and Technology 5 Benefits of Encoding Rules NDRs written in English –Easy to misinterpret –Schema testing and validation not automated Encoded NDRs –Result in better rules Verifies rule is clear Validates rule is being used as intended –Can be computationally enforced –Cycle time from requirements for a schema to production XML is reduced

National Institute of Standards and Technology 6 QOD – Apply rules directly Interface to write Test Requirements (rules) and associate with Test Cases (encoded rules) –Schematron –Java-Expert System Shell (JESS) Automate testing and validation against schema(s) –Displays and stores results from execution against Schematron/JESS Repository to store rules –Easy to reuse –Group rules to create Test Profile

7 QOD – Testing Environment Common Rule Database Schema Compliance Report Schema to Check Rule Input & Test GUI

National Institute of Standards and Technology 8 QOD Tool Overview Test Requirements Page Test Case Page Test Profile Page * Results Page (Updated) * Import an NDR profile (New) * Export a QOD test profile (New)

National Institute of Standards and Technology 9 OAGi NDR v9.0 Encoding Rule Testability Additional observations Demo

National Institute of Standards and Technology 10 Rule Testability Fully Testable –Rule can be encoded without any assumptions Partially Testable –Some assumptions are needed Not Testable –unable to encode the rule

National Institute of Standards and Technology 11 Testability of OAGi Rules

National Institute of Standards and Technology 12 Not Testable Rules – From Our Perspective QOD Limitations –Related to XML instance Lack of clarity Nondeterministic –Lack of information in the OAGi schemas Documentation or Guidance –Supplementary information

National Institute of Standards and Technology 13 Examples: OAGi-76, OAGi-70 - Ambiguous : OAGi-76 : “xsd:notation MUST NOT be used.” –Which notation must not be used? xsd:notation element or xsd:NOTATION type ? - Nondeterministic: OAGi-70 “ Minor version schema MUST incorporate all XML constructs from the immediately preceding major or minor version schema” - No minor version information in OAGi schemas

National Institute of Standards and Technology 14 Additional Observations Overlaps –“Fully Overlapped” Generalization vs. Restriction Generic rule may be removed for same results –“Partially Overlapped” Occasionally can combine rules if same type of schema Links (one rule refers to another) –For testing purposes, all referenced rules have to be included A B Rule A Rule B

National Institute of Standards and Technology 15 Overlaps between rules Example : OAGi-11 “XML element, attribute and type names constructed from dictionary entry names MUST NOT include periods, spaces, or other separators; or characters not allowed by W3C XML 1.0 for XML names.” OAGi-10 “Element, attribute and type names MUST be drawn from the following set: a – z and A – Z.” OAGi-10 is restriction of OAGi-11 OAGi-11 can be deleted from the NDR without affecting the original intention

National Institute of Standards and Technology 16 OAGi Profiles in QOD General Profile –Rules that can be applied to all OAGi schemas BOD Profile –Rules specific to BOD schemas

National Institute of Standards and Technology 17 Demo Overview of the QOD main functionalities (Public vs Private) Demo Test Profile : - Rules related to the BOD - Rules related to the usage of annotation and documentation elements Schema to be tested: - OAGi Developer BOD version 9.0 Full Test Results of the execution of OAGi Developer BOD schemas version 9.0, 9.1 and 9.2 against the rules that we have encoded.

National Institute of Standards and Technology 18 OAGi Developer BOD Testing : Materials Schemas tested - Developer BOD schemas version 9.0 : 434 files - Developer BOD schemas version 9.1 : 434 files - Developer BOD schemas version 9.2 : 494 files Profiles tested - General Profile : 25 rules - BOD Profile : 5 rules

National Institute of Standards and Technology 19 General Profile BOD Profile Total Developer BOD v9.0 errors Developer BOD v9.1 errors Developer BOD v9.2 errors Rule OAGi 90 : 1 error found - GetReceiveItem.xsd Rule OAGi 98 : 6 errors found - ShowCustomerPartyMaster.xsd - ShowPartyMaster.xsd - ShowPayable.xsd - ShowSupplierPartyMaster.xsd - SyncCatalog.xsd - SyncSupplierPartyMaster.xsd Rule OAGi 100 : 6 errors found - GetLocationService.xsd - ShowLocationService.xsd Error details Rule OAGi 98 : 6 errors found - ShowCustomerPartyMaster.xsd - ShowPartyMaster.xsd - ShowPayable.xsd - ShowSupplierPartyMaster.xsd - SyncCatalog.xsd - SyncSupplierPartyMaster.xsd Error details Rule OAGi 31 : 2 errors found - GetReceiveItem.xsd - GetRouting.xsd Rule OAGi 31 : 1 error found - GetRouting.xsd OAGi Developer BOD Testing : Results

National Institute of Standards and Technology 20 NDR Sharing Environment Facilitate reuse of rules –Different groups have different requirements but some overlap –Group relevant tests to create customized test profile –Upload new tests to share with others

National Institute of Standards and Technology 21 NDR Authoring Environment Capability to export/import rules –Edit rules offline –Display in multiple ways HTML, XML, PDF, Spreadsheet, DocBook, etc –Customize NDR to fit your needs –Based on NDR Profile Schema Standard structured vocabulary for describing NDR rules Available:

National Institute of Standards and Technology 22 QOD – Authoring and Sharing Common Rule Database Schema Compliance Report Schema to Check Rule Selection Custom NDRs Sharing GUI Rule Input & Test GUI

National Institute of Standards and Technology 23 OAGi NDR Sharing Based on UN/CEFACT 26 totally reusable from UN/CEFACT 59 modifications of UN/CEFACT rules and can be partially reuse 17 rules are unique

National Institute of Standards and Technology 24 NDR Profile Schema Purpose of NDR Schema –Standard set of rules for describing NDR rules –Use of open standards when developing NDRs –Standard structured vocabulary for describing NDR rules Benefits of NDR Schema –Enables exchange of NDR profiles between parties. –Facilitates import/export of NDR rules with QOD. –Can be developed using standard-based tools –Is machine (computer) readable –Multiple presentation methods for human visualization of rules HTML/PDF/Excel, etc.

National Institute of Standards and Technology 25 NDR Profile Authoring Ways to create NDR Profile XML Exchange Documents conforming to the NDR Profile Schema –Export from QOD –XForms creation –Excel Spreadsheet Template XSLT transform from Excel to NDR Profile –Any Validating XML Editor

National Institute of Standards and Technology 26 What’s next Create stand alone system Enhance support for rule sharing by including rule traceability Pursue similar support for developing tests for constraints on instance data Incorporate feedback into our tools!

National Institute of Standards and Technology 27 Discussion Points Authoring/Sharing Environment –Do OAGi members see it useful for their needs? Instance testing Stand alone vs. web based system

National Institute of Standards and Technology 28 Contacts KC Morris, NIST – Simon Frechette, NIST – Josh Lubell, NIST – Puja Goyal, NIST Salifou Sidi, NIST – Betty Harvey, ECC, Inc. -- Websites QOD online Developer’s site for QOD tool and executable rules: XML Tools available from MSID: DAS XSI Working Group:

National Institute of Standards and Technology 29 Welcome page

National Institute of Standards and Technology 30 Testing as Guest

National Institute of Standards and Technology 31 My account

National Institute of Standards and Technology 32 OAGi demo profile

National Institute of Standards and Technology 33 TP results

National Institute of Standards and Technology 34 OAGi 31 results with schema

National Institute of Standards and Technology 35 NDR Authoring Environment Based on XML Schema – NDR ProfileNDR Profile User’s Guide Prototype Authoring and Rendering tools Display NDR Document Edit NDR Profile The Bridge to Testing: QOD Import/ExportQOD Import/Export

National Institute of Standards and Technology 36 Mark-Up of Guidance Check the usage of empty elements Fully-Testable Empty elements MUST NOT be used. [OAGi 90] Error : Empty elements MUST NOT be used. [OAGi 90] Error : Empty elements MUST NOT be used. ]]>

National Institute of Standards and Technology 37 Demonstration of Editing

National Institute of Standards and Technology 38 Editing (cont.)

National Institute of Standards and Technology 39 Demonstration of Rendering: NDR in PDF

National Institute of Standards and Technology 40 NDR in HTML with links to Profile Data and QOD

National Institute of Standards and Technology 41 Profile Depicted as HTML