Simplified profile for Webel Parsing Analysis for SysML1.6+ in MagicDraw/Cameo (adapt as required)

Gallery

Tutorial

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

Section

Tags and keywords

Topic level

ESSENTIAL

UML keywords

Package

Model

Dependency

Keywords

Slide kind

UML Profile Diagram

This Profile Diagram shows a simplified slice through a typical profile for the Webel Parsing Analysis recipe for SysMLv1.6 (which should be fine also for SysMLv1.7):

Click on the image to view it full size

The UML Artifact and its UML standard profile extensions such as «document» Document and «file» File are NOT included in UML4SysML.

But the Webel Parsing Analysis recipe for SysML^® uses it anyway because it works fine in the MagicDraw SysML Plugin and Magic Cyber-Systems Engineer ^® (Cameo Systems Modeler^®) and is evocative of "documents":

Webel Parsing Analysis: A custom Document stereotype (keyword «document») extends the UML standard profile Document that extends Artifact (which is NOT in the UML4SysML intersection). Such a Document may act as the 'source' of a «snippet».

The most important policies of all are:

Webel Parsing Analysis: A Snippet (keyword «snippet») MUST always have exactly one domain 'source' Document (keyword «document»).

Webel Parsing Analysis: A 'source' Document must have one (only) of a URL or a URN (includes ISBN or other unique identifier) for use as a URI

Don't leave home without this tip:

Webel Parsing Analysis: If you have a unique URL for a domain source «document» you MAY additionally set it as an external hyperlink in the MagicDraw/Cameo tool (as well as setting it as the unique 'url' tagged value that acts as the '/uri').

One or more author:Person and/or org:Organisation items may also optionally be provided as tagged values.

The DocumentKind is just a typical example only, and may be adapted to suit the needs of any organisation. It's actually not of great consequence to the Webel Parsing Analysis recipe what kind of domain document is processed as long it contains some juicy text describing a system.

The Copyright stereotype - which also cheekily extends Artifact - could, for example, be linked in the tool to an external statement of copyright conditions.

There are some other stereotypes used in the Webel Parsing Analysis recipe for SysML^® that we'll be examining as we work through the trail slides. There's also a summary of these "auxiliary" stereotypes later here:

Visit also (later): REFERENCE CARD: Webel Parsing Analysis for SysML1.x: Auxiliary stereotypes

Up next

«pa:term»: Dealing with synonyms, alternative names, and identifiers

Notes

[ASSERTION, CAVEAT]{INFORMATIVE} The UML Artifact and its UML standard profile extensions such as «document» Document and «file» File are NOT included in UML4SysML.

[POLICY]{STRICT} Webel Parsing Analysis: A custom Document stereotype (keyword «document») extends the UML standard profile Document that extends Artifact (which is NOT in the UML4SysML intersection). Such a Document may act as the 'source' of a «snippet».

[POLICY]{STRICT} Webel Parsing Analysis: A 'source' Document must have one (only) of a URL or a URN (includes ISBN or other unique identifier) for use as a URI

[POLICY]{STRICT} Webel Parsing Analysis: A Snippet (keyword «snippet») MUST always have exactly one domain 'source' Document (keyword «document»).

[PROPOSAL]{STRONG} Dr Darren of Webel has always opposed the exclusion of the obviously useful UML Artifact from SysML (but in MagicDraw and Cameo you can sneak it in anyway). After all, systems engineers do use documents quite a bit.

[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.

[CAPABILITY, FEATURE, NAVIGATION, TIP, TOOL]{RECOMMENDED} Webel Parsing Analysis: If you have a unique URL for a domain source «document» you MAY additionally set it as an external hyperlink in the MagicDraw/Cameo tool (as well as setting it as the unique 'url' tagged value that acts as the '/uri').

Snippets (quotes/extracts)