David RR Webber Chair OASIS CAM TC (Content Assembly Mechanism) E-mail: drrwebber@acm

1. Open Standard Voting Localization with CAM- Localization Mechanisms- Publishing Localizations- Leveraging Open Standards - XSD ingesting David RR Webber Chair OASIS CAM TC (Content Assembly Mechanism) E-mail: drrwebber@acm.org http://wiki.oasis-open.org/cam

2. Overview • Goal is to promote the use of open public standards for voting systems • Develop in-country localizations from standard international base set • Provide common open public lexicon for elections management and verification • Leverage XML and open standards approach, including NIEM* • Provide developers with tools to aid delivery, documenting and testing of solutions *NIEM – National Information Exchange Model

3. Approach • Voting Localizations built from OASIS EML • EML has 29 pre-built components (schema) for voting processes • Use desktop visual editor to pick components • Trim and select only what you need from each standard schema • Desktop toolkit makes templates for the XML required • Generate localization details • Automatically build XML components to use • Build your own dictionary, compare to EML standard • Create readable documentation of details • Test, Package and Publish • The CAM desktop toolkit environment supports NIEM IEPD approach • Available as Open Source on SourceForge.net • Implementation of the public OASIS CAM standard for schema templates (camprocessor)

4. Localization Mechanisms Creating a Country Voting Localization Package

5. XML Schema Localization Key Components 1  EML Schema XSD aligns voting information model, processes and domain dictionary  Documentation Readable information use details (HTML), EML cross-reference Spreadsheet 2 Key components (aka IEPD*)  XML artifacts The localized schema and picklist.xml 3  Examples & Test Cases Realistic test XML instances for conformance and interoperability testing 4 *IEPD – Information Exchange Package Documentation

6. Localization Approach Steps EML Steps: • OASIS develops standard international XSD schema • Implements the voting process, management and information exchange needs • Ingest the standard XSD into base CAM template • Apply localizations to CAM template • Exclude unwanted optional components • Align local exchange needs to standard • Extend for local needs • Generate new localized XSD schema that conform to EML standard • Build dictionary cross-reference of localization usage • Publish documentation and examples 4 Local XML XSD Generate Voting XML XSD Revised CAM Template Base CAM Template 1 2 3 localize develop ingest Exchange 5 Compare EML Dictionary Manage 6 Publish Documentation + Examples

7. Creating a Package for Localization • Step 1 - Ingest EML XSD – rules, structure, annotations • Step 2 - Select & mark out your use model in visual editor - Save your “pick list” selections - Compress template to desired structure • Step 3 - Generate your localized use XSD schema subset • Step 4 - Generate and test rich concrete data examples (complete with content hints / pass / fail / random options) - Run rules engine - Verify operation and outcomes • Step 5 - Build localization documentation of structure elements, usage, rules and cross-reference map • Step 6 – Package, Publish and Share (IEPD)

8. Challenge: XSD schema has limitations! • The schema contains the superset of voting exchange component variations for every country • XSD syntax does not have direct context mechanisms • Hence people make everything in schema optional • Dependencies are not clear • It is difficult to understand the constructs and to document the rules clearly for election authorities to verify • It is hard to create test cases and instances (the “pick list” tough to visualize) • These are all limitations inherent in W3C Schema language itself

9. Completing Localization Picture: • Base EML XSD schema structure model • CAM template + rules / refinements • Documentation of use patterns (aka “pick list” + subset XSD) • Test cases and examples • Content hinting (localization use data) • Validation engine for unit and regression testing • Open standard, open platform and open source allows consistent agreements between participants

10. Localization Package Use Scenario XML Publish Developer Uses & Creates Templates Test Cases Structure Rules Context Examples Documentation 2 Package 3 1 Validate XML Test Localization Content Hints Testing, Agreement / Alignment. Results Report XML 4 html Verify Result Outcomes Pass / Fail

11. Tutorial • Base CAM templates – (ingesting XSD schema ) • step by step example • Documenting the Localization Patterns • Creating “pick list” selections • Compressing template structure • Subset XSD generation • Publishing Localization package • Cross-reference spreadsheet • Documentation reporting options • Generate use dictionary • Testing and Conformance • Creating Test Case examples • Content Hinting • Running Test Cases • Advanced Techniques

12. Base CAM Templates(ingesting XSD Schema) Using jCAM editor Wizard (http://www.jcam.org.uk)

13. EML V6.0 provides base CAM templates • Templates come pre-packaged in the EML V6 download • However, for completeness we show how to generate one…

14. XML Schema Components CIQ xsd Namespace Common xsd Localization EML xsd EML xml Ingesting XSD to CAM template format Structure OASIS EML XSD Collection XSLT tools process entire EML XSD collection Rules INGEST Documentation CAM = Content Assembly Mechanism

15. Step 1 & 2 – Pick the XSD schema to ingest Choose File / New Template Specify XSD Location root directory 1 2 Pick XSD First location is the root folder for the XSD collection. Typically this is the same as the location for the XSD schema you want to ingest. (Complex XSD can have this in separate folder; hence need for option)

16. Step 3 – Choose the XSD parent element From the dropdown list pick the correct root element you wish to use (EML). XSD’s may have more than one collection in them (as shown here) or may not have the parent node element cleanly defined. The Wizard shows you the list of all possible ones it finds – so you can select and confirm the right one. 3 Choose XSD parent element Confirm and start the XSD ingesting

17. Step 4 – Ingesting complete – Save Results Completed template is loaded and save dialogue appears Processing usually takes a few seconds, some larger EML XSD can take a few minutes to process. Tip: jCAM runs the ingesting as a background task – so you can continue to use the computer while such long ingesting is proceeding. 4 4

18. Step 5 – Review ingested structure Completed template is shown in the structure navigator panel for review and editing Template contains all the default content model and structure rules ingested from the XSD. All annotations and documentation from XSD also ingested (show as “paperclip” symbol). Code lists and typical content values inserted for easy visual reference. 5

19. Documenting the Localization Patterns “Pick lists”, documentation and XSD subset generation

20. Building a pick list Make pick list Structure EML structure is all inclusive!!! Rules MARK WHAT IS NOT NEEDED Documentation excluded items DESIRED RESULTS

21. Marking Items for exclude - pick list • Can exclude at all levels within the structure • excludeTree() • excludeElement() • excludeAttribute() • Use XPath operators to control scope: • Specific node • Group of nodes • Anywhere occurs in structure • Contextually based on condition • Can add new domain elements with own namespace to EML template

22. Using Editor to mark Exclude items Structure Editor Tools Select focus on item Invoke action menu (right mouse click) Pick action Tip: exclude rule display is context sensitive and only available on optional items Tip: use “Add New Rule” mode to specify different XPath for exclude (quick mode assumes “current path”)

23. Export and Save completed pick list File Menu Option Select Export / Pick List and then specify filename of destination. Excluded items are designated with red “dot” in structure editor and italics font with no bold highlight

24. Pick List Details Pick lists provide a handy way to catalogue the localization model and can be re-used later by importing into other templates EXCLUDE FLAG VALUE Exported Example

25. Compress Operation File Menu Option Select option and specify filename for new copy of your template. Compress process removes all rules and structure items marked with an exclude statement. Note: ignores excludes that have a conditional context expression (advanced section technique). Note: You can retain both original and new compressed templates

26. Extending the base EML schema • In addition to excluding existing optional components you may need to add new pieces • New pieces should be assigned their own extension namespace prefix – to identify them from the base EML components • Typically the OASIS EML committee will review new pieces as candidates for adding to future versions of the standard • Send comments and suggestions to election-comment@lists.oasis-open.org

27. Adding New Domain Elements 1 Select root element node in structure; right mouse click for context menu; select “Add Namespace”; then enter prefix and URI Select element node in structure; right mouse click for context menu; select “Add Child Attribute / Element”; then enter prefix and name 2

28. Generating your EML use schema • Once your localization details are completed you are ready to complete the remainder of the process • This starts with generating your own new subset schema • Then once schema details are OK – creating test cases, cross-reference spreadsheet and documentation

29. Generating subset use schema File Menu Option Select Export CAM as XSD menu option Confirm the location and filename, and namespace mode. 1 Select ‘default’ for Mode to write a regular import set of XSD schema for each namespace 2

30. Schema subset generated Set of XSD files with filename and namespace suffix Each namespace file is import for those specific type definitions Reviewing XSD results in a schema visual editor tool

31. Information Restriction Considerations • The CAM template allows full use of XPath conditional expressions and a rich set of over 30 functions including: • setNumberRange(), setLength(), setLimit(), setDateMask(), setNumberMask(), restrictValues(), lookup() • Those that are compatible with XSD constraints will cause constraint schema assertions to be written out when exporting to schema • In the advanced topics section we will look at cross field validations using XPath conditional rules

32. Generating Testing and Conformance Examples Generating base examples Customizing content with Hints Selecting valid and invalid modes Running rules validation check

33. Test Case Generation Quick Start Default directory to write examples into File Menu Option Name to be used for the examples How many examples to create Repeating elements count for Quick Test – just click “OK” to use default settings

34. Test Case Results Active links to view the generated examples

35. Advanced Generation Options Optional schema file validation link; use this to have example validate with EML schema or local subset schema Use content type or item name (name is useful for checking backend transform processing) How to handle optional items: all | random | none If you want deliberate errors for fail testing; (will give variety of data and structure errors) Use namespaces or not; if ‘false’ is selected – then XML instances are created with minimized namespace usage. Use slider to pick a specific seed value – or leave blank for random seed Optional content hints (explained next )

36. Test Case Generator Feature Summary • Make both Pass / Fail testing examples • Content hinting so examples use real not fake data • Test optional item logic with: all / random / none • Uses exclude() assertions so does not include those items – makes realistic examples of your use pattern • Can pass in seed value – use when adding and testing hints (each test case is labelled with its seed value) • Make hundreds of test cases without manual editing • Can link test case to XSD schema for structure tests • You can modify XSLT tool for own testing needs

37. Run CAM Rules Check on Examples Run Menu Option 1 Pick Test Case Example to VALIDATE; click Finish to run validation rules Review validation results 2 3

38. Content Hinting Mechanisms • Designed to create realistic data examples • Hints can be provided in two ways • Firstly - using ‘Value’ notes in annotations on specific items in the structure editor • Second – create your own Hints XML file and add matching rules to globally apply across your template(s) – e.g. FirstName, LastName, Address, BirthDate, etc. • Can export from one template, import into another

39. First Approach: annotation Value Hints Select focus on structure item Invoke action menu (right mouse click) Choose “Edit Annotations”

40. Then add Value annotation item 3 Select “Value” tab 2 4 Enter values terminated with “|” character 1 Click on “Add New”, then enter “Value” as Type and confirm “OK” 5 Re-run Example export to see results

41. Second: Hints File Mechanism (XML file) 1 like / with partial name matching use for component match on items – e.g. first with name matches <nxnl:first_name> key matching on tag name 2 use for exact match of items key / parent path matching 3 use when same name occurs within different parents – e.g. Country and Person / NameElement with different content and context Note: matching is case sensitive but ignores namespaces TIP: can use Export Hints to create initial XML file for editing

42. A- Using Examples Generator with Hints Select XML hints file to be used here

43. B- Import Hints into Annotations (merge) set and select as needed Option to auto-reload new anno file into current template

44. Documentation Cross-Reference Spreadsheet Default reporting options

45. Generating Cross-Reference Spreadsheet • Use Compare to Dictionary tool • Compare to default EML-V6-dictionary • Drag and Drop XML file into Microsoft Excel • Review and save spreadsheet workbook

46. Dictionary Compare Tool Select compare tool menu option Browse and choose EML dictionary

47. Drag and Drop to Excel Spreadsheet Click OK

48. Documentation Layouts • Five options • Source XML • Component details (XML) • Tabular format (HTML) • Interactive web page (wiki) • Code list • Tabular format page layout for data analyst use and designed to make rules and use patterns clear • Each documentation layout XSLT script can be customized as desired

49. Tabular Documentation Documentation Menu Option Select Format, resulting HTML opens in browser viewer

50. Tabular HTML Content Details Clear use pattern Extended Code list handling Annotations XPath references and functions Enhanced Data type Logic