Top-level Package/Model organisation for the Source Input Zone

Gallery

Tutorial

TRAIL: Theory and best practices for the Webel Parsing Analysis recipe for SysMLv1.6+

Section

Tags and keywords

Topic level

ESSENTIAL

Keywords

The Webel Parsing Analysis recipe for SysML1.x does not use the ElementGroup directly, it extends it as a user-defined Snippet stereotype with keyword «snippet» and with MagicDraw Customization.

Rather than looking yet at a typical underlying Stereotype profile for the Webel Parsing Analysis recipe for SysML, we're going to see first how it is applied to a simple tutorial-friendly text extract from a unique domain 'source' Document (represented by a Wikipedia page) captured in a Webel «snippet» extension of the SysML1.x ElementGroup:

Wikipedia: '"The quick brown fox jumps over the lazy dog" is an English-language pangram — a sentence that contains all of the letters of the English alphabet. '

Before we elicit any model elements, we're going to see first how the Source Input Zone - where every Parsing Analysis Diagram (PAD), domain source Document, and Snippet lives - is organised:

Click on the image to view it full size

The very top-level index Package Diagram is not shown yet, we'll see that later once we've elicited some model elements. But notice we can navigate to it:

Webel Best Practice: Webel: UML/SysML: Navigation: ALWAYS offer a way out of a diagram (usually up a hierarchy, but possibly across) using a navigable symbol (linked to a diagram) and/or a diagram symbol. Avoid "cul-de-sacs"! [But beware of shared package cross-dependencies]

We start here with a Model package called 0-source with the keyword «pa» applied. This defines the Source Input Zone:

Webel Parsing Analysis: Create a top-level 'source' or '0-source' Package/Model SEPARATE from your project model. All source «document» elements and «snippet» extracts and «pa» diagrams MUST be ultimately owned by that top-level Package/Model as ancestor!

Webel Parsing Analysis: Acronym: PAD = Parsing Analysis Diagram (may be nearly any diagram type, except those types that must be owned by an elicited model element)

In this case the 0-source just has an overview Package Diagram showing a sub-Model wikipedia with the keyword «pa» applied.

The «pa» wikipedia Model in turn has an overview Package Diagram featuring a «document» FoxDogPangram with a URL as identifier and an «organisation» Wikipedia.

Next down is a Package Diagram of some Snippets treated for the FoxDogPangram. This is known informally as an index PAD, it serves as an entry point to the focus PADs that each feature one or more Snippets:

Webel Parsing Analysis: A "focus" Parsing Analysis Diagram (PAD) for one or more Snippets SHOULD always show the /member tagged value of every Snippet.

There's nothing special here about the choice of Model packages over Packages:

Webel Parsing Analysis: It does not matter whether you use a Package or a Model package. (The informal Webel convention is that Models are used for systems engineering analysis with SysML and Packages are reserved for code-related software engineering.)

You can't see the Snippets listed within the Package or Model package symbols:

Webel Parsing Analysis: MagicDraw/Cameo: SysML1.6+: ElementGroup-based Snippets do not list in the compartment of Package/Model symbols because ElementGroup is based on the UML Comment, which does not list in Package/Model symbols.

Okay, it's time to perform some model element elicitation. To make things easier we're actually going to use a partial Snippet first just for this part:

Wikipedia: '"The quick brown fox jumps over the lazy dog" ...'

Up next

Focus PAD for the Snippet 'The quick brown fox jumps over the lazy dog'

Notes

[TIP]{EDITORIAL} In Webel Parsing Analysis every Package, Model, or Diagram used to perform Parsing Analysis MUST have the stereotype keyword «pa» applied, and MUST live under a top-level Model or Package 'source' separate from the rest of the project model.

[POLICY]{STRICT} Webel Parsing Analysis: Create a top-level 'source' or '0-source' Package/Model SEPARATE from your project model. All source «document» elements and «snippet» extracts and «pa» diagrams MUST be ultimately owned by that top-level Package/Model as ancestor!

[POLICY, STYLE]{STRICT} Webel «pa» Parsing Analysis Diagrams (PADs) are "scratchpads" used to elicit model elements traceably from text Snippets (extracts from source Documents). While BDDs are a good initial choice, most types of SysML diagram can be used as a «pa» diagram.

[MODELLING, NAMING, POLICY]{STRICT} Webel Parsing Analysis: Acronym: PAD = Parsing Analysis Diagram (may be nearly any diagram type, except those types that must be owned by an elicited model element)

[DISPLAY, MODELLING, OPTION]{INFORMATIVE} Webel Parsing Analysis: An "index" Parsing Analysis Diagram (PAD) showing a collection of Snippets may optionally (but need not always) show the /member tagged value of each Snippet.

[MODELLING, NAVIGATION, PATTERN, TIP, TOOL]{STRONG} Webel: UML/SysML: Navigation: ALWAYS offer a way out of a diagram (usually up a hierarchy, but possibly across) using a navigable symbol (linked to a diagram) and/or a diagram symbol. Avoid "cul-de-sacs"! [But beware of shared package cross-dependencies]

[TIP]{INFORMATIVE} The Webel Parsing Analysis recipe for SysML1.x does not use the ElementGroup directly, it extends it as a user-defined Snippet stereotype with keyword «snippet» and with MagicDraw Customization.

[CONVENTION, MODELLING, TIP]{RECOMMENDED} Webel Parsing Analysis: It does not matter whether you use a Package or a Model package. (The informal Webel convention is that Models are used for systems engineering analysis with SysML and Packages are reserved for code-related software engineering.)