Webel's "super-relational" Note pages!

A Note is a short categorised statement, claim, policy, tip, or issue tracker Throughout this site, content is often related to supporting Notes, and each Note page links back to the content pages that reference it! The Note and Snippet concepts are very closely related and they support each other.
Look for "super-relational" Note page links at the bottom of most content pages!
Note kind Note Spec tag UML keywords SysML keywords Keywords
CAPABILITY, FEATURE, TOOL MagicDraw/Cameo can parse the 'text' field of some mathematical Requirements and populate the constraint (and also then the constraint parameters) of a ConstraintBlock that refines a Requirement (your mileage varies). Constraint Requirement, ConstraintBlock, constraint parameter, Refine mathematics, equation
ISSUE, TOOL MagicDraw/Cameo 19SP3: Validation of required and provided Interfaces proxied between a ProxyPort and a part with a compatible contract fails SysML-1.6 required Interface, provided Interface, InterfaceRealization, Usage, part ProxyPort, part property contract, Cameo Systems Modeler, MagicDraw SysML
ISSUE MagicDraw/Cameo 19SP3: uses PascalCase instead of lowerCamelCase on some SysML compartment names MagicDraw SysML, Cameo Systems Modeler
ISSUE, TOOL MagicDraw/Cameo 19SP3: The property path in callout does always correspond to the SysML spec examples. callout pathname dot notation MagicDraw SysML, Cameo Systems Modeler
ISSUE MagicDraw/Cameo 19SP3: Stakeholder: Has 'concern' NOT derived and /concernList derived; SysML-1.6 has /concern derived and concernList NOT derived. SysML-1.6 Stakeholder::/concern, Stakeholder::concernList MagicDraw SysML, Cameo Systems Modeler
CAVEAT, DISPLAY, ISSUE, TOOL MagicDraw/Cameo 19SP3: If Continuous or Discrete are applied to the underlying Parameter of an InputPin or an OutputPin the keywords «continuous» or «discrete» can't be displayed Parameter, Pin, InputPin, OutputPin Continuous, «continuous», Rate, «rate», Discrete, «discrete» MagicDraw SysML, Cameo Systems Modeler
DISPLAY, FEATURE, TIP, TOOL MagicDraw/Cameo 19SP3: if Continuous or Discrete are applied to the Parameter of an ActivityParameterNode the keywords «continuous» or «discrete» can be optionally displayed on the ActivityParameterNode symbol ActivityParameterNode, Parameter Continuous, «continuous», Rate, «rate», Discrete, «discrete» MagicDraw SysML, Cameo Systems Modeler
ISSUE, TOOL MagicDraw/Cameo 19SP3: enumeration 'FeatureDirection' should be 'FeatureDirectionKind' (reflects known error in older SysML specification versions) FlowDirectionKind Cameo Systems Modeler, MagicDraw SysML
MagicDraw/Cameo 19SP3: Does not yet support AddFlowPropertyValueOnNestedPortAction AddStructuralFeatureValueAction AddFlowPropertyValueOnNestedPortAction Cameo Systems Modeler, MagicDraw SysML
ISSUE, TOOL MagicDraw/Cameo 19SP3: Does not yet handle Property-wise Type compatibility validation of FlowProperty contracts (it only handles them at the level of entire Block types). Webel asserts the spec is inconsistent w.r.t. ProxyPort connection compatibility. provided Feature, required Feature, DirectedFeature MagicDraw SysML, Cameo Systems Modeler
ISSUE, TOOL MagicDraw/Cameo 19SP3: Does not yet handle Feature-wise validation of provided/required DirectedFeature contracts (it only handles them at the level of entire Block types). Webel asserts the spec is inconsistent w.r.t. ProxyPort connection compatibility. Feature, BehavioralFeature, Reception, Operation, StructuralFeature, Property provided Feature, required Feature, DirectedFeature MagicDraw SysML, Cameo Systems Modeler
CAVEAT, ISSUE, TIP, TOOL MagicDraw/Cameo 19SP3: Does not seem to directly support compartment for decomposition of Views as properties of Views (but one can create properties in an IBD and they will show in the 'attributes compartment') Property View MagicDraw SysML, Cameo Systems Modeler
ISSUE MagicDraw/Cameo 19SP3: Continuous and Discrete have metaclass [ActivityEdge, ObjectNode, Parameter] not just [ActivityEdge, Parameter] (via Rate), so may be applied directly to Pin and ActivityParameterNode ActivityEdge, Parameter, CallBehaviorAction, CallOperationAction, InputPin, OutputPin, Pin Continuous, «continuous», Rate, «rate» MagicDraw SysML, Cameo Systems Modeler
ISSUE MagicDraw/Cameo 19SP3: Can't seem to show {control} notation on control Pin Pin::isControl, ObjectNode::isControlType, control Pin MagicDraw SysML, Cameo Systems Modeler, MagicDraw UML
ISSUE, TOOL MagicDraw/Cameo 19SP3: Can't callout from ItemFlow on Connector, the Note handle pulls from the Connector not the ItemFlow Connector, callout, Note, handle ItemFlow MagicDraw SysML, Cameo Systems Modeler
ISSUE MagicDraw/Cameo 19SP3: can't assign Statemachine submachine as principal of AdjunctProperty via validation warning dialog (confirmed bug). WORKAROUND: Set principal using the specification dialog. AdjunctProperty, AdjunctProperty::principal MagicDraw SysML, Cameo Systems Modeler
COMPLICATION, DISPLAY, FEATURE, ISSUE, MODELLING, STYLE, TOOL, WARNING, WORKAROUND MagicDraw/Cameo 19SP3/v2022xGolden: [FIXED in v2022xRefresh1]: Activity Diagrams: Pin display mode 'Position of Labels' does not work correctly for 'Name And Type Labels Inside', only shows the Name inside (not the Label) [and WORKAROUND] SysML-1.6, SysML-1.7, UML-2.5.1 Activity, Pin, Activity Diagram, ObjectFlow SysML Activity Diagram MagicDraw, UML, MagicDraw UML, Unified Modeling Language, Systems Modeling Language, SysML, MD SysML, Cameo Systems Modeler, CATIA Magic, Mathematica, Webel:MathematicaSysML, CATIA Magic:v2022xGolden
TOOL, WARNING MagicDraw/Cameo 19SP3 still supports the DEPRECATED UML Port conjugation (but it is recommended here that you DO NOT use it, even though there might be future migration for such directly conjugated Ports). Port, Port::isConjugated InterfaceBlock, ~InterfaceBlock, conjugation MagicDraw SysML, Cameo Systems Modeler
TIP MagicDraw, Cameo Systems Modeler, and Cameo Simulation Toolkit use the name 'English' for a "default" vendor-specific action scripting language MagicDraw SysML, MagicDraw UML, Magic Model Analyst [Cameo Simulation Toolkit], Cameo Systems Modeler
ISSUE, TOOL MagicDraw UML/SysML/Cameo 19SP3: Sometimes on application of a named Association as the Type of a Connector that already has an InformationFlow (or ItemFlow) applied, the direction of the InformationFlow (or ItemFlow) indicator swaps. InformationFlow, InformationFlow::conveyed, Connector Association, ItemFlow MagicDraw SysML, Cameo Systems Modeler, MD SysML
COMPLICATION, DISPLAY, FEATURE, GOTCHA, ISSUE, MODELLING, WARNING, WORKAROUND MagicDraw SysML: [v2022xGolden,v2022xRefresh1]: ISSUE: Automatic assignment of the Type of the 'result' of a ReadStructuralFeatureAction not working with drag & drop. CallBehaviorAction, OutputPin, Pin, ReadStructuralFeatureAction, Action MagicDraw SysML, Systems Modeling Language, CATIA Magic:v2022xGolden, CATIA Magic:v2022xRefresh1
TIP MagicDraw SysML/Cameo: You do not always need to load the entire SysPhS ModelLibrary for simpler black box exports to Modelica or Simulink/Simscape/Stateflow (sometimes the sysphs_profile within the MD Customization for SysML is enough) SysML-1.6, SysPhS-1.1 Profile SysPhS, Modelica, Stateflow, Simulink, Simscape, MD SysML, SysML, Systems Modeling Language, Cameo Systems Modeler, simulation, execution, MagicDraw SysML
CAPABILITY, TIP, TOOL MagicDraw SysML/Cameo: You can customise the generic query table diagram kind to check that the context Blocks of your Parametric Diagrams only contain BindingConnectors (not Connectors) SysML-1.6, SysML-1.7 Connector BindingConnector, constraint parameter MagicDraw SysML, Cameo Systems Modeler, SysML, Systems Modeling Language
TIP, TOOL MagicDraw SysML/Cameo: SysPhS: Export to Modelica: It does not seem to matter whether you give the language of Constraints as 'Modelica' or 'sysphs' (although SysPhS specifies a restricted SysPhS expression grammar) SysML-1.6, SysML-1.7, SysPhS-1.1 MD SysML, MagicDraw SysML, Systems Modeling Language, SysML, SysPhS, Modelica
FEATURE, GOTCHA, MODELLING, TIP, TOOL MagicDraw SysML/Cameo: If you have a SINGLE Allocate from an Activity to a Block it will set that Block to be the Behavior::/context for that Activity. SysML-1.6, SysML-1.7 Behavior::/context, Behavior, Activity Allocate, Block functional allocation, SysML, Systems Modeling Language, systems engineering, MagicDraw SysML, Cameo Systems Modeler
COMPLICATION, TIP, WARNING MagicDraw SysML/Cameo: GOTCHA: Export to Modelica only includes owned Constraints (not just applied Constraints) under the 'equation' export SysML-1.6, SysML-1.7, SysPhS-1.1 Modelica, Modelica::equation, SysPhS, MagicDraw SysML, MD SysML, Cameo Systems Modeler, SysML, Systems Modeling Language
COMPLICATION, FEATURE, MODELLING, TIP, TOOL, WARNING MagicDraw SysML/Cameo: GOTCHA: A Constraint created and applied to a ConstraintBlock via the sidebar menu is NOT owned by the ConstraintBlock! SysML-1.6, SysML-1.7 Constraint ConstraintBlock MagicDraw SysML, Cameo Systems Modeler, Systems Modeling Language, MD SysML, SysML
TIP MagicDraw SysML/Cameo: For export of more complex physical interaction and flow cases to Modelica or Simulink/Simscape/Stateflow load the SysPhS ModelLibrary using SysPhSLibrary.mdzip as a shared project. SysML-1.6, SysPhS-1.1 SysPhS, Modelica, Stateflow, Simulink, Simscape, MD SysML, SysML, Systems Modeling Language, Cameo Systems Modeler, simulation, execution, MagicDraw SysML
ISSUE, TOOL MagicDraw SysML/Cameo: 19SP3: Export to Modelica from TestBed (for SignalProcessor) sample does not validate in Wolfram SystemModeler SysML-1.6, SysML-1.7, SysPhS-1.1 Wolfram SystemModeler, MagicDraw SysML, MD SysML, Cameo Systems Modeler, Modelica, SysPhS
ISSUE, TOOL MagicDraw SysML/Cameo: 19SP3: Export to Modelica from SysPhS sample for HumidifierSystem does not execute in Wolfram SystemModeler Simulation Centre SysML-1.6, SysML-1.7, SysPhS-1.1 Wolfram SystemModeler, MagicDraw SysML, MD SysML, Cameo Systems Modeler, Modelica, SysPhS
CAVEAT, ISSUE, TOOL MagicDraw SysML/Cameo: 19SP3: Does not seem to support export to Modelica from a Package [use a SysML Block as root instead] SysML-1.6, SysML-1.7, SysPhS-1.1 Package Block MagicDraw SysML, MD SysML, Cameo Systems Modeler, Modelica, SysPhS, Modelica::model
MODELLING, STYLE, TIP, TOOL MagicDraw SysML/Cameo has a nice feature 'Tools > Delegate Port(s)' accessible from the context menu for splitting Connectors that cross block boundaries into multiple Connectors with "exporting" Ports. SysML, Systems Modeling Language, Cameo Systems Modeler, MagicDraw SysML, MD SysML
ISSUE, TOOL MagicDraw SysML/Cameo 19SP3: Sometimes on application of an ItemFlow to a Connector with Ports typed by Blocks or InterfaceBlocks that have a FlowProperty of the same type (but different direction) it shows two ItemFlow arrows InformationFlow, InformationFlow::conveyed, Connector ItemFlow MagicDraw SysML, Cameo Systems Modeler
GOTCHA, MODELLING, TIP, WARNING MagicDraw SysML/Cameo 19SP3: GOTCHA: If you drag a Behavior from the model browser onto the 'entry', 'doActivity', or 'exit' field in a specification dialog of a State it WILL BECOME OWNED by the State (which "steals ownership")! SysML-1.6, SysML-1.7, SysPhS-1.1, UML-2.5.1 State, State::entry, State::doActivity, State::exit, Behavior Modelica, MD SysML, MagicDraw SysML, Cameo Systems Modeler, drag-n-drop
CAPABILITY, GOTCHA, LIMITATION, TIP, TOOL Mac: Compressor: HOWTO render H.264 and H.265 at higher than 50Mbps Mac:Compressor, Mac, video, H.264 H.265, HEVC, bps, bitrate, Final Cut Pro, FCP, 4K
TIP List of some formal systems engineering methodologies, standards, and guides [EXTERNAL LINKS] Model-Based Systems Engineering, systems engineering, Unified Architecture Framework, UAF, DoDAF, MODAF, NATO Architecture Framework, NAF, The Open Group Architecture Framework, TOGAF, INCOSE, INCOSE Systems Engineering Handbook, SeBOK, NASA
TOOL LINKS: Wolfram Workbench for Mathematica (or just use the far superior IntelliJ IDEA Plugin) Wolfram, Wolfram Workbench, Wolfram Language, Mathematica, coding, code formatting, documentation
ISSUE It's not clear that the «domain» block 'AutomotiveDomain' is the best choice of owner for BDD Figure D.16, the «system» block 'Hybrid SUV' might be better.
ASSERTION, WARNING It is NOT true in SysML1.6+ that you "should" always use a SysML FullPort or a SysML ProxyPort instead of a "standard" Port, and it's not even always a good idea (and the spec states this very clearly in multiple places)! Port FullPort, ProxyPort, "standard" Port
ISSUE, TOOL ISSUE: MagicDraw/Cameo: v2022x Golden, v2022xRefresh1: Comment can't connect anchor to another Comment as annotatedElement SysML-1.6, SysML-1.7, UML-2.5.1 Comment, Comment::annotatedElement Systems Modeling Language, SysML, MagicDraw, CATIA Magic:v2022xGolden, MagicDraw SysML, MagicDraw UML, Cameo Systems Modeler, CATIA Magic:v2022xRefresh1
ISSUE, MODELLING, TOOL ISSUE: Cameo Simulation Toolkit: v2024x: Does not show argument Pins corresponding to inherited attributes of Signal on SendSignalAction or un-marshalling AcceptEventAction. No known UML2.5.1 or fUML-1.4 constraint; no obvious tool display option. fUML-1.3, fUML-1.4, SysML-1.6, SysML-1.7, UML-2.5.1 InputPin, Signal, SendSignalAction, AcceptEventAction, AcceptEventAction::isUnmarshall SysML, Systems Modeling Language, SysMLv1, MBSE, Model-Based Systems Engineering, Cameo Systems Modeler, MagicDraw SysML, CATIA Magic, Magic Model Analyst [Cameo Simulation Toolkit], UML, fUML
CAVEAT, COMPLICATION, GOTCHA, ISSUE, MODELLING, NAMING, TOOL ISSUE/GOTCHA: MagicDraw/Cameo v2022x: UML/SysML: If you "rename" an ActivityParameterNode symbol on the frame of an Activity Diagram it actually renames the underlying Parameter (only) NOT the name of the ActivityParameterNode element! Activity, ActivityParameterNode, Activity Diagram, Pin, Parameter, CallBehaviorAction, CallOperationAction SysML Activity Diagram Unified Modeling Language, UML, SysML, Systems Modeling Language, SysMLv1.x, MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler, MagicDraw:validation
TIP In Webel Parsing Analysis tutorials, Wikipedia pages are often used as a placeholder sources to represent authoritative domain source documents from which text extract "snippets" are sourced, and from which SysML model elements are traceably elicited. Webel Parsing Analysis, Wikipedia
OPTION In Webel Parsing Analysis if you want to track elicited model elements that have not been explicitly mentioned in source text you can introduce Element-level custom tracking Stereotypes with the keywords «pa:implied» or «pa:assumed». Stereotype, custom Stereotype, «keyword», user defined Stereotype parsing analysis, Webel Parsing Analysis, WPA:«pa:implied», WPA:«pa:assumed»
TIP 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. Webel Parsing Analysis, WPA:«pa»
ASSERTION In Webel Parsing Analysis elicited model elements MUST eventually be moved out of the 'source' (or '0-source') Package/Model zone and under a main project Package/Model area. (Use the owner display option to check.) Webel Parsing Analysis, WPA:«pa», WPA:TargetModelZone, WPA:SourceInputZone
In UML/SysMLv1.x Lifelines do not have specific information about the times or time ordering of events (such as Message arrival/sending) of other Lifelines Lifeline, Sequence Diagram, Interaction, interaction diagram, Message SysML Sequence Diagram UML, Unified Modeling Language, SysML, Systems Modeling Language, SysMLv1.x
TIP In UML and SysML a '/' forward slash prefix before a Property name indicates that it is derived from other elements in the model. SysML-1.6, UML-2.5.1 Property::isDerivedUnion, Property::isDerived
ISSUE, STYLE In the Webel trail versions of the SysML-1.6 spec sample Figure D.38, the alignment of ObjectNode symbols over the ActivityParameterNode boundaries is completely contrived, please DO NOT mimic it; please use explicit Pins instead! SysML-1.6 elided Pin notation, ObjectNode HSUV sample problem, AllocateActivityPartition MagicDraw SysML, Cameo Systems Modeler
NAMING, PATTERN, TIP In the Webel terminology for a basic control loop there is an 'aim' value (controlled via an actuator) and a 'got' value (a value read from a sensor). The 'got' value is NOT necessarily exactly the same as the actual physical value. SysML-1.6, SysML-1.7, SysMLv2, SysPhS-1.1, UML-2.5.1 got value, aim value, control loop, Webel Best Practice
PATTERN In the Webel recipe for UML/SysML, the pattern of progressive redefinition of end Properties of Associations between progressively more specialised pairs of Blocks at the same level of abstraction is informally called a "redefinition ladder" Generalization, Association, Property::redefinedProperty, Association::memberEnd Block, block property Webel Best Practice
ASSERTION, TIP In the Webel recipe for SysML, DO use a "standard" Port until you have a truly compelling reason to commit to a FullPort or ProxyPort Port FullPort, ProxyPort, "standard" Port Cameo Systems Modeler, MagicDraw SysML, MD SysML
POLICY In the Webel Parsing Analysis recipe you are not obliged to map every single part of a Snippet's text extract to a UML or SysML model, just traceably elicit model elements of immediate or anticipated interest to your task or goal. Webel Parsing Analysis
ASSERTION, GOTCHA, WARNING In the course PDF for 'CED Engineering: Air Conditioning Psychrometrics (A.Bhatia)' the term "enthalpy (h)" usually refers to the mass-specific enthalpy per dry air (in CoolProp notation 'Hda') enthalpy, specific enthalpy, Psychrometrics, CoolProp
TIP In SysML, unless you MUST use a DataType or PrimitiveType from an existing ModelLibrary or Profile, you SHOULD probably be using a ValueType, Enumeration ValueType, or SysML PrimitiveValueType instead so that it integrates with the value system of SysML. DataType, PrimitiveType ValueType, PrimitiveValueType Webel Best Practice
ISSUE, WARNING In SysML the NOW DEPRECATED (since SysML-1.6) direct UML Port conjugation does not work consistently with SysML DirectedFeature and SysML FlowProperty on nested ports! SysML-1.6 Port::isConjugated, Port
COMPLICATION In SysML more than one NamedElement can help Satisfy a single Requirement (which presents challenges for verifying satisfaction of Requirements). This is a conceptual challenge for requirements engineering in general, not just SysML! SysML-1.6 NamedElement Satisfy, Satisfy::getSatisfies(in ref), AbstractRequirement::/satisfiedBy, AbstractRequirement, Requirement requirements engineering, test engineering
DISPLAY, STYLE In SysML diagrams, showing the context name and type in the diagram frame can lead to clutter and is not always clear to non-SysML stakeholders (although that is the style used in the specification samples) SysML, Systems Modeling Language, Webel Best Practice
In some slides some Comments in UML/SysML diagrams are verbosely marked with the stereotype keyword «webel» to distinguish them from «snippet» domain source document text extracts. Webel Parsing Analysis, WPA:«snippet», WPA:«webel»
TIP In professional applications of the Webel Parsing Analysis recipe for SysML, a robust reusable profile for «part»/«assembly»/«leaf» components is used, along with stereotypes keywords like «assembles» for indicating physical composition hierarchies. AggregationKind Block, block property Webel Best Practice, WPA:«assembles», WPA:«part», WPA:«leaf», WPA:«assembly», composition hierarchy
DISPLAY, STYLE, TOOL In Package Diagrams and Block Definition Diagrams use the owner indicator display option for Classifier symbol headers to indicate the owner (except where a containment operator suffices). The mode 'Below Element Name' is preferred. Element::owner, owner path display SysML Block Definition Diagram, SysML Package Diagram Webel Best Practice, Cameo Systems Modeler, MagicDraw SysML
CONVENTION, STYLE In most Webel examples, the default is chosen to be 'out' if there is a single FlowProperty, so a Port with the type applied will act as a source. If an InterfaceBlock is used, then a Port typed by the conjugating ~InterfaceBlock will act as a sink. Webel Best Practice
CAVEAT, TOOL, WARNING In MagicDraw/Cameo the ProfileApplication relationship is only available in Profile Diagram menus ProfileApplication MagicDraw SysML, Cameo Systems Modeler
CAPABILITY, DISPLAY, STYLE In MagicDraw/Cameo the name and any stereotype keywords of a Classifier subject of a UseCase may be shown in the top-middle (not just top-left) UseCase::subject MagicDraw SysML, MagicDraw UML
TOOL In MagicDraw/Cameo the dashed line symbol from a UML Comment or SysMLv1.x ElementGroup to an annotatedElement is called an 'anchor'. Comment, Comment::annotatedElement, MD:anchor
CAPABILITY, FEATURE, TIP In MagicDraw/Cameo one can just drag the IBD or BDD of a Block from the model browser onto parts that are typed by that Block to make them the default hyperlink target for that part (so one can just "open the parts up" recursively to navigate the system). Diagram, Property, symbol part property MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler
CAPABILITY, TOOL In MagicDraw/Cameo one can display many element properties (and metamodel properties) directly in compartments on most element symbols Note MagicDraw SysML, MagicDraw UML, Cameo Systems Modeler
CAPABILITY, TOOL In MagicDraw/Cameo one can "call-out" many element properties (and metamodel properties) into a Note using the Edit Compartments context menu item Note MagicDraw SysML, MagicDraw UML, Cameo Systems Modeler
CAPABILITY, FEATURE, TIP In MagicDraw/Cameo if the Type of a Property has a Composite Structure Diagram or Internal Block Diagram defined it will act as the default hyperlink target for the Property Diagram, Property, symbol part property MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler
CAPABILITY, FEATURE, TIP, TOOL In MagicDraw/Cameo an assigned stereotype of a Classifier that types an instance-like element (such as a part Property) "shines through" unless it has an instance-level stereotype assigned. This is sometimes called a "secondary stereotype". Diagram, Property, symbol, Stereotype part property MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler, translucency, secondary stereotype, SysML, Systems Modeling Language, UML, Unified Modeling Language
TOOL In MagicDraw SysML or Cameo Systems Modeler if you drag a Classifier onto an Association or Connector, it will in fact create a SysML ItemFlow not a UML InformationFlow InformationFlow, InformationFlow::conveyed ItemFlow MagicDraw SysML, Cameo Systems Modeler
TIP In general, the SysML DirectedFeature approach is more powerful and the notation is cleaner than UML provided/required Interfaces. Prefer SysML DirectedFeatures unless you have a really good reason to use Interfaces! SysML-1.6 provided Interface, required Interface, ball-and-socket, lollipop DirectedFeature, FeatureDirectionKind::provided, FeatureDirectionKind::required, FeatureDirectionKind::providedrequired Webel Best Practice
DISPLAY, TIP In a SysML Activity Diagram a control flow may be notated with a dashed line and stick arrowhead; this helps distinguish a ControlFlow from an ObjectFlow symbol. SysML-1.6 ControlFlow SysML control flow notation, SysML Activity Diagram
ASSERTION In a control loop, the 'got' (sensed) value is not in necessarily exactly the same as the actual, physical value being controlled! Typically it will be limited to a certain performance accuracy (and an intrinsic accuracy limit due to the number of bits). control loop, aim value, got value
TIP If you are using Blocks (not InterfaceBlocks) to Type your Ports just use "manual" feature-by feature direction inversion to achieve type conjugation (and you can even use a ~ tilde prefix) Port, TypedElement, TypedElement::type conjugation, Block
CONVENTION, NAMING If using "French style" post-adjective naming in English use a trailing underscore after the noun and before the adjective or qualifier: Vin_rouge, Cable_digital. Can be combined with TLA acronyms: Player_DVD. NamedElement::name, Class Block Webel Best Practice
TIP If instances of Blocks “communicate” with each other use an Association between them. Association Block Webel Best Practice
ASSERTION, TIP If an abstract Block or Class in a domain model has Associations to Blocks or Classes that are not also abstract, it's often a hint that you have not identified a correct abstraction layer. Association, Class, Classifier::isAbstract Block Webel Best Practice
ASSERTION Humans work well with natural language: Many stakeholders – including those who are not necessarily familiar with UML or SysML modelling symbols and diagrams - benefit enormously from having plain text in diagrams side-by-side with graphics. Requirement Webel Parsing Analysis, parsing analysis, WPA:«document», WPA:«snippet»
CAVEAT, DISPLAY, TOOL HSUV trail slide: Figure D.4: IBD: Could not show Connector typed by an anonymous Association as 'connectorName:' with trailing colon Association, Connector, Type HSUV sample problem Cameo Systems Modeler, MagicDraw SysML, MagicDraw UML, anonymous
TIP, TOOL HOWTO: MagicDraw/Cameo: v2022Refresh1: JDK 11 download compatible with the modelling tools AND Apple Silicon (ARM) machines (such as M1 Max) Constraint ConstraintBlock, SysML Parametric Diagram MagicDraw SysML, CATIA Magic, Magic Model Analyst [Cameo Simulation Toolkit], CATIA Magic:v2021x, CATIA Magic:v2021xR1, JDK, Java Development Kit, Java, ARM Architecture, M1 Max, Apple Silicon, CATIA Magic:v2022xGolden, CATIA Magic:v2022xRefresh1
TIP, TOOL HOWTO use Mathematica v12.3.2 as an external maths engine for SysML Parametrics (ConstraintBlocks) in Magic Model Analyst (Cameo Simulation Toolkit) versions 2021x, 2021xR1, 2022xR1 Constraint ConstraintBlock, SysML Parametric Diagram Wolfram, JLink, Mathematica, MagicDraw SysML, SysML, MD SysML, SysML Parametrics, mathematics, CATIA Magic, Magic Model Analyst [Cameo Simulation Toolkit], CATIA Magic:v2021x, CATIA Magic:v2021xR1, JDK, Java Development Kit, Java
TIP HOWTO set a ValueSpecificationAction to use the * LiteralUnlimitedNatural to drive an 'insertAt' InputPin on an AddStructuralFeatureValueAction in Cameo Simulation Toolkit and Cameo Systems Modeler UML-2.5.1 InputPin, AddStructuralFeatureValueAction, AddStructuralFeatureValueAction::insertAt, ValueSpecification, ValueSpecificationAction, LiteralUnlimitedNatural Cameo Systems Modeler, Magic Model Analyst [Cameo Simulation Toolkit]
TIP HOWTO get at and display "standard" Ports that have been unnecessarily hidden and suppressed in MD SysML 19SP3 and Cameo 19SP3 SysML-1.6 Port "standard" Port MD SysML, Cameo Systems Modeler, Systems Modeling Language, SysML
QUESTION, TIP, TOOL HOWTO access custom (user-defined) Mathematica functions using Mathematica v13.2 as an external maths engine for SysML Parametrics (ConstraintBlocks) in Magic Model Analyst (Cameo Simulation Toolkit) versions 2021x, 2021xR1, 2022xR1 Constraint ConstraintBlock, SysML Parametric Diagram Wolfram, JLink, Mathematica, MagicDraw SysML, SysML, MD SysML, SysML Parametrics, mathematics, CATIA Magic, Magic Model Analyst [Cameo Simulation Toolkit], CATIA Magic:v2021x, CATIA Magic:v2021xR1, JDK, Java Development Kit, Java, CATIA Magic:v2022xGolden, CATIA Magic:v2022xRefresh1
EXPLANATION, GOTCHA, MODELLING HOWTO "cheat" with two-level white-boxing and tracking stereotypes because you just don't want that darn "extra" logical subsystem (conceptual subsystem) Block the systems engineers reckon you are supposed to use (and why it's easier to actually use one) SysML-1.6, SysML-1.7 Activity SysML Activity Diagram SysML, Systems Modeling Language, MBSE, SysMLv1, Webel::SE:«blackbox», Webel::SE:«whitebox», Webel::«whitebox:logical», functional analysis, Webel::logical handler, logical subsystem
TIP How to prounce Guillemet, those French-looking sideways double chevron quote thingies UML and SysML use to indicate a stereotype «keyword» (amongst other things). Stereotype, «keyword» Systems Modeling Language, SysML, Unified Modeling Language, UML, Guillemet, language, English, American English, British English, pronunciation
GOTCHA, TOOL GOTCHA: UML/SysML: Cameo Simulation Toolkit 19SP3: A [true] or [false] guard on an ActivityEdge MUST be a LiteralBoolean, not just characters typed in, or the evaluation may give unexpected or ill-defined results fUML-1.3, fUML-1.4, SysML-1.6, SysML-1.7, UML-2.5.1 ActivityEdge, ActivityEdge::guard, LiteralBoolean, LiteralBoolean::true, LiteralBoolean::false UML, SysML, Cameo Systems Modeler, Unified Modeling Language, Systems Modeling Language, Alf, fUML, Foundational UML
COMPLICATION, TIP, WARNING GOTCHA: MD SysML/Cameo 19SP3 vs SysPhS-1.1: Export to Modelica does not see a 'doActivity' on a State (does not write it to a Modelica algorithm), you MUST use an 'entry'! SysML-1.6, SysML-1.7, SysPhS-1.1 State::doActivity, State::entry, State SysML, SysPhS, Systems Modeling Language, Cameo Systems Modeler, MD SysML, MagicDraw SysML
COMPLICATION, GOTCHA, TIP GOTCHA: Mathematica: Specific enthalpy conversion J/kg to Btu/lb: Does not consider a possible "total" enthalpy reference offset vs 0 °C or 0 °F respectively enthalpy, specific enthalpy, unit conversion, SI unit, Imperial unit, Btu, British Thermal Unit, Mathematica, Wolfram, HVAC&R, water condensation, humid air, air, air conditioner, Psychrometrics, US customary measurement system
CAVEAT, GOTCHA, TIP, WARNING GOTCHA: Mathematica v13.2+: Operations on "DegreesFahrenheit" °F and "DegreesCelsius" °C are now performed using Kelvins (K). CASE: Naive percentage operation gives answer relative to Kelvins. Use "DegreesCelsiusDifference"/"DegreesFahrenheitDifference"! Wolfram, Wolfram Language, Mathematica, temperature, celsius, Fahrenheit, kelvin, Kelvins, units, unit conversion
GOTCHA, TOOL, WARNING GOTCHA: MagicDraw/Cameo: SysMLv1/UML: The argument context required to see results in Evaluation Mode for custom OpaqueBehavior scripts might not be the same as required for use in an Operation From Model for a Derived Property on a table column SysML-1.6, SysML-1.7 OpaqueBehavior MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler, CATIA, MagicDraw derived property
GOTCHA, TOOL, WARNING GOTCHA: MagicDraw/Cameo: SysMLv1/UML: The 'name' of a Derived Property is parsed and sometimes displayed quite differently in column names. Be careful when mixing lower case and UPPER CASE in the middle of Derived Property names. SysML-1.6, SysML-1.7 MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler, CATIA, MagicDraw derived property
GOTCHA, TOOL, WARNING GOTCHA: MagicDraw/Cameo: SysMLv1/UML: If you can extract model info using an OpaqueBehavior and you can see that in the Evaluation Mode in the Expression Editor it might not appear in a column in the Generic Table Diagram because the final Type is not set SysML-1.6, SysML-1.7 OpaqueBehavior MagicDraw UML, MagicDraw SysML, Cameo Systems Modeler, CATIA, MagicDraw derived property
GOTCHA, ISSUE, MODELLING, TIP, WARNING GOTCHA: MagicDraw SysML/Cameo 19SP3: Export to Modelica: The name of a redefining Property must be exactly the same as the Property it redefines or it will not export properly! SysML-1.6, SysML-1.7, SysPhS-1.1, UML-2.5.1 Property::redefinedProperty, Property, Generalization Modelica, MD SysML, MagicDraw SysML, Cameo Systems Modeler, SysPhS
ISSUE, MODELLING, TIP, WARNING GOTCHA: MagicDraw SysML/Cameo 19SP3: Export to Modelica: 'entry', 'doActivity', or 'exit' Behaviors of a State must be directly owned (not just "wrapped") or they won't be seen on export! SysML-1.6, SysML-1.7, SysPhS-1.1, UML-2.5.1 State, State::entry, State::doActivity, State::exit, Behavior Modelica, MD SysML, MagicDraw SysML, Cameo Systems Modeler, SysPhS
WARNING GOTCHA: Just because an InitialNode MAY have more than one outgoing ControlFlow and offers tokens on every outgoing ControlFlow does NOT mean that every outgoing edge takes a control token; InitialNode does NOT act like an implicit fork! InitialNode, implicit fork
TIP, TOOL GOTCHA: Cameo: If you run a parametrics calculation from an instance symbol in a diagram it will just show computed values in the simulation window; if you run from an Instance Table diagram it will populate the instance Slots with the computed values. SysML Parametric Diagram Magic Model Analyst [Cameo Simulation Toolkit], Cameo Systems Modeler, calculation, simulation
ANTI-PATTERN, ISSUE GOTCHA: A SysML/SysPhS Connector (or Modelica connection) in an electronics model is NOT a wire! It's a contract between connected Ports. SysPhS-1.1 Connector ItemFlow SysPhS, SysML, antipattern
GOTCHA, ISSUE, TOOL GOTCHA/BUG: Cameo Simulation Toolkit v2021xR1 + Mathematica: Delegation to Mathematica from ConstraintBlocks FAILS if any of the input or output parameters are larger than 99999 because they get interpreted as 1.0e5 and that trips something! Aarrrggggh! Constraint ConstraintBlock, MD:ConstraintParameter, constraint parameter SysML, MD SysML, Mathematica, Wolfram, Cameo Systems Modeler, SysML Parametrics, calculation, CATIA Magic:v2021xR1