Versions Compared

Version Old Version 3 New Version Current
Changes made by

Jim Wilson

Jim Wilson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Background

W3C XML Schema expression patterns

There are four well-knows known W3C XML Schema design expression patterns. They are:

  • Russian Doll

  • Garden of Eden

  • Salami Slice

  • Venetian Blind

These The names of these patterns are referenced used in this document. Useful resources for understanding them the patterns include:

...

OAGi manually maintained OAGIS versions through version 10.6. last manually-maintained version. Version 10.6 was a result of Mike Rowell, OAGi’s former Chief Architect, manually updating XSD files on his file system, running scripts locally, zipping content, etc.

OAGIS 10.6 was/is offered in four release packages (“editions”):

  • Enterprise (included all below)

  • Platform

    Status
    colourRed
    titlepattern

  • Standalone-

    Status
    colourRed
    titlepattern

  • Standalone- StatuscolourRedtitlepattern(included all below)

  • Standalone Global

  • Standalone Local

  • Standalone Local Groups

OAGIS 10.7 and later

Beginning with OAGIS 10.7, OAGi began maintaining OAGIS with Score for version 10.7. OAGi ceased to advertise availability of any XML Schema expressions of OAGIS while quietly making the Platform and Standalone-

Status
colourRed
titlepattern
platform model (Garden of Eden) and Standalone (pattern (question)) editions available to members on request.

Miscellaneous

JSON schema

...

patterns

What XML Schema design patterns are possible with JSON schema?

...

Note regarding naming specific organizations

In the spirit of meeting needs across the OAGi community, we avoid indicating in writing organization names in the use cases. Satisfying any set of use cases is for the benefit of the community, not just one member of it.

Use

...

Case #

Expression Type

Pattern

Model subset

File system structure

Notes

0

...

W3C XML Schema

Garden of Eden (question)

All CCs

Organized like the OAGIS 10.6

...

platform model

Score supports this today

1

JSON schema

...

Venetian Blind (question)

All CCs

One file

2

JSON schema

...

Venetian Blind (question)

All CCs

One file per component with the set of files zipped

...

3

XMI

N/A

All CCs

One file

4

...

W3C XML Schema

Venetian Blind (question)

Each component tagged noun

...

One file for each specified component with the set of files zipped

...

...

5

XML schema file of entire model.

Use case 6

Entire model expressed as Hugo-formatted documentation.

Use case 7

W3C XML Schema

Venetian Blind (question)

One CC or set of CCs

One file (for one CC) unzipped or one file for each specified component (for set of CCs) with the set of files zipped

Score 3.0+ test instance supports this today

6

Markdown

N/A

All CCs

Organized as applicable subset of a Hugo project

7

Mermaid script

N/A

One CC or set of CCs

One file (for one CC) unzipped or one file for each specified component (for set of CCs) with the set of files zipped

Score support for CC expression

...

Available in Score 3.0 (and some earlier versions)

Module-based expression in W3C XML Schema according to the Venetian Blind pattern.

Available in Score 3.0+ test instance

Choose component or components (e.g., based on noun tag) and express each selected component as W3C XML Schema according to the Venetian Blind pattern. In the case of multiple components, the XSD files will be zipped.

API design

API parameters

  1. Model subset: What part of the model needs to be expressed?

    1. All

    2. All except… (e.g., all except supplementary components)

    3. A root component (e.g., BOM)

    4. A set of root components (e.g., BOM, ProcessPurchaseOrder, NotifyShipment)

    5. All components with a specified tag (e.g., noun)

  2. Expression type: What is the expression type? (Is there a better name for this other than “expression type”?)

    1. W3C XML Schema

    2. JSON Schema

    3. XMI

    4. Documentation

    5. OAS? (Jim doesn’t think this makes sense)

    6. XMI

    7. Documentation

    8. OWL?

    9. RDF Schema?

  3. Pattern: For some expression types, what is the pattern (e.g., Garden of Eden)expression pattern?

  4. File system structure: For some expression types, what is the file/folder naming conventions and structure?

  5. Internal file organization: For some expression types, how content is organized within files. ? (eE.g., Within within W3C XML schemas Schemas list element declarations first in alphabetical order followed by type definitions in alphabetical order.)

CC Meta Model Type

Component

File Structure

Expression Type

Pattern

Other Score options

ASCCP

This should be query mimicking the filters in the View/Edit CC page (by default ASCCP is selected). Release keyword should also be supported.

Keywords:

  • One ASCCP per file (note this could be all low level and high-level ASCCP or just high-level ASCCPs like Nouns or BODs depending on the what are returned in the Component parameter.

  • All ASCCPs in one file

  • Use Module Set Release

XML Schema

Garden of Eden

N/A

JSON Schema

Venetian Blind

N/A

Top-level BIE

This should be query mimicking the filters in the View/Edit BIE page

  • One BIE per file

  • Schema package

XML Schema

Russian Doll

Follow options on the Score’s BIE expression page

JSON Schema

OAS