0
Deploy     Requirements  Test         NIEM           Model    <Insert Picture Here> Data                                  ...
Disclaimer Notice   The following is intended to outline Oracle general   product direction. It is intended for informatio...
CAM Template Evaluation Report• The purpose of the CAM template evaluation report is  to provide a suite of checks against...
Contents• Evaluation Reporting• Comparison to NIEM NDR• Percentage component reuse scoring• Target Schema generation consi...
Understanding process detailsEVALUATIONREPORTING                     Copyright ©2011/12, Oracle. All rights reserved.     ...
Evaluation Report Specifics• The CAM template evaluation report serves multiple  purposes including:  • Basic logical erro...
Basic logical error checking on rules• These checks review the actual template rules themselves for  basic issues includin...
Naming and Design Rule (NDR)• The NDR checks are based on the Core Components Technical  Specification (CCTS) as interpret...
Further NDR checks provided• The NDR rules also require that written definitions be provided for  items so any item with a...
Content Type Consistency Checking• In addition to the NDR checks the template evaluator also  checks the consistency of th...
Schema syntax specific checks• The use of certain W3C schema techniques are flagged where  these can cause behaviours that...
More schema syntax considerations• The overall schema export process from a CAM template is  designed to simplify the sche...
Comparison to NIEM NDR evaluation• The NIEM NDR guidelines specify 150+ checks on various aspects  of schema syntax and us...
Dictionary comparison tool optionPERCENTAGE REUSESCORING                      Copyright ©2011/12, Oracle. All rights reser...
Compare to Dictionary processing• The Compare to Dictionary tool supports a special mode when  used with the NIEM-dictiona...
Considerations for Schema export toolsTARGET SCHEMAGENERATION                     Copyright ©2011/12, Oracle. All rights r...
Export Template to Schema • The Export Template to XSD schema supports several modes (that   are customizable through the ...
ConclusionSUMMARY AND REVIEW             Copyright ©2011/12, Oracle. All rights reserved.               Oracle Draft Mater...
Summary• The CAM template evaluation report supports a wide  range of quality control and interoperability checks• Specifi...
Resource Center link                                       http://www.oracle.com/goto/niem                        Q&ACAMed...
Upcoming SlideShare
Loading in...5
×

CAM editor NIEM Evaluation Report

1,077

Published on

Provides overview of the Naming and Design Rules and Exchange Quality evaluation reports provided by the CAM editor tools for NIEM.

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
1,077
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
15
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Transcript of "CAM editor NIEM Evaluation Report"

  1. 1. Deploy Requirements Test NIEM Model <Insert Picture Here> Data CAM Template Build Generate Evaluation Report Exchange Dictionary XML Exchange DevelopmentSynopsis of Evaluation PerformedOverview – Public Sector NIEM Team, March 2012
  2. 2. Disclaimer Notice The following is intended to outline Oracle general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle. Copyright ©2011/12, Oracle. All rights reserved. Slide 2 Oracle Draft Materials – Limited Circulation
  3. 3. CAM Template Evaluation Report• The purpose of the CAM template evaluation report is to provide a suite of checks against a template that are difficult, tedious or otherwise to determine by manual inspection of a template structure and its associated rules and annotation details• The report covers the following areas: • alerts users to potential issues with their template and provides suggestions for improving the functional details • addresses logical and conceptual issues that simple syntax checking alone does not flag • can be used as part of a formal review process to ensure a baseline for quality control Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  4. 4. Contents• Evaluation Reporting• Comparison to NIEM NDR• Percentage component reuse scoring• Target Schema generation considerations• Summary and Review Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  5. 5. Understanding process detailsEVALUATIONREPORTING Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  6. 6. Evaluation Report Specifics• The CAM template evaluation report serves multiple purposes including: • Basic logical error checking on rules used, e.g. duplicates, conflicted, erroneous • Naming and Design Rule (NDR) guidelines checking • Interoperability flagging of known problematic aspects of schema use in information exchange messaging • Support for spell checking of XML element and attribute names • Consistency checking (e.g. does the name representation term match the physical type definition) • Missing rules for code and other constrained content types Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  7. 7. Basic logical error checking on rules• These checks review the actual template rules themselves for basic issues including: • Duplicates of same rule type • Conflicted rules – optional and mandatory • Warning for setChoice rule where only one node applicable• These checks are designed to ensure the rules will not cause issues when evaluated by the CAMV validation engine Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  8. 8. Naming and Design Rule (NDR)• The NDR checks are based on the Core Components Technical Specification (CCTS) as interpreted by the NIEM NDR guidelines.• Consistency in use of upper and lowercase naming convention is checked• The naming representation terms are inspected for leaf element items and attributes• The naming convention is evaluated to look for use of these terms in the name itself (representation terms): Amount, Count, BinaryObject, Graphic, Picture, Sound, Video, Image, Code, Category, Currency, EMail, DateTime, Date, Time, Indicator, Format, Length, Width, Height, Weight, Level, Measure, Mode, Method, Numeric, Number, Price, State, Status, Rank, Flag, Frequency, Format, Size, Unit, Value, Version, Rate, Required, Percent, Quantity, Qty, Description, Comment, Reason, Location, Instructions, Text, Title, Type, Year, Month, Day, Name, URI, URL, or URN; or that ends with Days, Hours, Minutes, ID, Id, Identification or Identifier• A domain may use specialized terms that are not shown here and this can be configured accordingly. Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  9. 9. Further NDR checks provided• The NDR rules also require that written definitions be provided for items so any item with a missing annotation is flagged• Spell checking of element and attribute names is supported by providing an itemized list where the component name is broken out into the specific words – e.g. PersonBirthDate – Person Birth Date• An overall score is provided out of 10 maximum. Each rule category item that fails from the basic NDR checks results in a 0.5 deduction. The resulting score is merely indicative rather than definitive of the overall quality of the exchange structure.Note: not all existing NIEM dictionary components are NIEM conformant and may fail the NDR checks Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  10. 10. Content Type Consistency Checking• In addition to the NDR checks the template evaluator also checks the consistency of the content restriction rules used.• For items that use the reference terms date, time, number, value, amount and so on in their names then the associated content rule is compared• Mismatched or missing rules are flagged – e.g. date as integer• Items are named as specific content types such as Code or Type that could be evaluated with a code list are flagged when no associated code list is provided Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  11. 11. Schema syntax specific checks• The use of certain W3C schema techniques are flagged where these can cause behaviours that have know issues for consistent information exchange design and interpretation• xsd:any / xsd:anyAttribute – this allows a namespace to be created and any components then inserted at this point in the structure• xsd:nillable – interpretation and handling of empty elements varies widely across XML parsers and platforms• Interoperability concerns across systems include: • xsd:maxOccurs with explicit number – limiting occurrences to a specific value is not recommended • Length restrictions on string elements• In addition xsd:all is not supported• The xsd:group is imported, but then refactored Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  12. 12. More schema syntax considerations• The overall schema export process from a CAM template is designed to simplify the schema generated and rely only on basic constructs including complexType, simpleType and sequence mechanisms for element and reference type linkage.• The xsd:choice mechanism* is used along with basic type definitions for date, string, integer, decimal, and float then extended data types provided by xsd:datatype directly.• Namespaces are supported and schema imports created for each namespace declaration in the CAM template.• Extended schema constructs such as xsd:substitutionGroup, xsd:group, xsd:all, and so on are not utilized* xsd:choice is permitted in NIEM NDR for extension schema, but not reference schema Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  13. 13. Comparison to NIEM NDR evaluation• The NIEM NDR guidelines specify 150+ checks on various aspects of schema syntax and usage.• Using the CAM editor sidesteps these completely because the schema syntax generated is simple, consistent and complete and does not violate the 150+ items on the NIEM NDR checklist for schema syntax constructs and usage.• Simply put, any existing schema that can be ingested into a CAM template and then exported out again in the simplified schema syntax format will conform to the NIEM NDR. Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  14. 14. Dictionary comparison tool optionPERCENTAGE REUSESCORING Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  15. 15. Compare to Dictionary processing• The Compare to Dictionary tool supports a special mode when used with the NIEM-dictionary.xml file that ships in the program installation folder dictionaries directory• The NIEM-dictionary.xml file is a special file not to be confused with the regular dictionaries used by CAM for drag-and-drop designer collection purposes.• In this mode the processing produces the special NIEM wantlist.xml file for use with the NIEM SSGT and a cross-reference spreadsheet of matched and unmatched items• A HTML report is generated of the total percentage and number of leaf element and attributes reused from the NIEM component set• The Compare to Dictionary tool also works for any domain dictionaries (non-NIEM), but the wantlist.xml is not created Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  16. 16. Considerations for Schema export toolsTARGET SCHEMAGENERATION Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  17. 17. Export Template to Schema • The Export Template to XSD schema supports several modes (that are customizable through the XSLT provided) • The NIEM modes are designed to create a matching set of Exchange schema with Extension, Subset and External schema imports • Exported schema should always be checked with a schema validating tool – complexities of namespace use and design omissions may result in some schema syntax issues that need to be manually addressed • Additional tools are available for creating WSDL and JAXB binding* components • NIEM subset schema from the SSGT may be optionally manually substituted for generated subset schema* Will be available in the CAM editor v2.2 release Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  18. 18. ConclusionSUMMARY AND REVIEW Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  19. 19. Summary• The CAM template evaluation report supports a wide range of quality control and interoperability checks• Specific NIEM NDR items reporting are focused on the naming rules of the elements and attributes• Direct NIEM NDR schema checks are obviated by generation of simple NIEM-conforming schema syntax• This export schema tool supports NIEM compatible exchange, extension, subset schema collections• An additional dictionary reuse report, cross-reference spreadsheet and scoring is available• These three tools greatly improve the ability of information exchange designers to create NIEM- conforming information exchanges Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  20. 20. Resource Center link http://www.oracle.com/goto/niem Q&ACAMeditor download site:http://www.cameditor.org Copyright ©2011/12, Oracle. All rights reserved. Oracle Draft Materials – Limited Circulation
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×