SysML v1 to SysML v2
Move your SysML v1 model to SysML v2 without redrawing it.
Drop a SysML v1 model saved as XMI (.xmi, .xml, .uml) or as an .mdzip project archive into a SysML v2 project. Holarch converts it to SysML v2 text, checks the text, and reports every element as converted, approximated or left out, with the reason, before anything is imported.
The converter is part of every plan, Free included. New accounts start a 30-day Individual trial at their first sign-in: 10,000 items per project, no card, back to Free when it ends. Have an account? Start the trial.
Proof: the CubeSat EO-1 model
| Result | Elements |
|---|---|
| Converted | 1,007 |
| Approximated | 32 |
| Left out | 3 |
| Elements read | 1,042 |
| Problems in the SysML v2 text | 0 |
The converted text checks with no errors and no warnings, and the same model converts to the same text every time. What was approximated and left out
Import a SysML v1 Model
Import a SysML v1 model's XMI file or .mdzip project into a SysML v2 project. Before anything is created, a conversion report lists every element as converted, approximated or left out, with the reason, and saves as a CSV file. The example is the CubeSat EO-1 model: 1,042 elements, imported with no problems.
What you get from the converter
A SysML v2 model you can work in, and a clear list of what to review.
No redrawing
Blocks become part defs, ports, connectors and item flows come across, requirements keep their ids and text, and satisfy, verify and allocate relationships stay traced.
A report of every element
Each element of the v1 model is listed with its v1 kind, its result, the SysML v2 name it became and, for anything approximated or left out, the reason in words. Filter it on screen or download it as CSV.
Checked before you import
The engine that checks the SysML v2 Editor as you type checks the converted text. You see the result, the text and the report first; the import is one undo step.
Re-import as the v1 model changes
Elements take their ids from the v1 model's XMI ids. Import a newer export into the same project and elements update in place, also when they were renamed or moved, with their diagram layouts, comments, links and history.
A model you can work in
The Editor, the views, requirements, verification and the other pages of a SysML v2 project read the converted model like any other.
Your v1 model stays as it is
Holarch reads an export of it and never writes back, so the v1 model remains the reference while the team reviews the SysML v2 version.
How it works
- Drop the file. In a SysML v2 project, click Model → Import and Export, choose Into this project or Into a new SysML v2 project, and drop the
.mdzip,.xmi,.umlor.xmlfile. A progress card shows reading, converting and checking. - Review the report. Conversion from SysML v1 gives the counts, says whether the text checks without problems, and lists the approximated and left-out elements with the reason for each. Show the SysML v2 text opens the result; download the report or the
.sysmlfile to keep them. - Import. Clear any packages you do not want and import. One Undo removes the whole import again.
Step by step, with the export settings of each tool: Importing SysML v1 models in the Docs, and the migration guide for planning a whole program's move.
A converted block
part def Rover {
@SysMLv1Library::BlockData { isEncapsulated = true; }
part battery : Battery;
part computer : Computer;
attribute 'power budget' : Types::Power = 120 [SI::W];
connection 'power bus' connect battery.'out' to computer.'in';
satisfy Requirements::'Power Margin' by battery;
flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
}Converter output for an encapsulated block with two parts, a value property in watts, a connector between proxy ports with an item flow, and a satisfy relationship. The migration guide shows the whole small model, before and after.
What it reads
- SysML v1 as XMI 2.x: UML 2.5 with the SysML 1.x profile.
.xmi: an XMI file..xml: XMI saved with the.xmlextension..uml: an XMI model file..mdzip: a zipped project archive that contains the model as XMI; Holarch reads the XMI inside.- Other project formats: a tool that keeps models in its own project format exports the model as XMI first.
One file per import, up to 64 MB, 250,000 elements and 512 levels of nesting.
What comes out
- SysML v2 text in the open project or in a new SysML v2 project, imported as one undo step.
- A check of the text, shown before you import.
- A conversion report of every element, filterable on screen and downloadable as CSV.
- The
.sysmlfile to download, for review or for another SysML v2 tool.
The conversion is based on the SysML v1 to SysML v2 transformation in the OMG SysML 2.0 specification.
Converted, approximated or left out
Every element of the v1 model gets one of three results, so you know exactly where to look.
Converted
The element has a direct SysML v2 counterpart. A block becomes a part def, an interface block a port def, a requirement keeps its id and text.
Approximated
The element is kept in a changed form. A full port typed by an interface block becomes a port; a transition through a choice becomes one transition per path; a unit that is not a mapped SI unit becomes a real number with the unit in its documentation.
Left out
SysML v2 has no counterpart, or the element points to something that is not in the file. Examples are flow final nodes, activity partitions, use case extensions and relationships to unnamed elements.
SysML v1 properties without a SysML v2 keyword, such as an encapsulated block, a full port or a refine relationship, are kept as metadata from the SysMLv1Library package, which Holarch loads in every SysML v2 project. Your own stereotypes become metadata definitions with their tagged values, and opaque behaviors, guards and constraints keep their bodies as textual representations, such as language "OCL" /* … */.
What converts to what
The main mappings. The Docs list them all.
| SysML v1 | SysML v2 |
|---|---|
| Package | package, nested as in v1 |
| Block, actor | part def |
| Value type, enumeration | attribute def, enum def; a value type with a known SI unit specializes the ISQ quantity |
| Part, reference and value properties | part, ref part, attribute, with multiplicities and default values |
| Interface block, proxy port, flow property | port def, port, directed item or attribute |
| Connector, binding connector, item flow | connect, bind, flow |
| Activity, actions, control and object flows | action def, actions, successions with guards, flows between parameters |
| State machine, states, transitions | state def, states, transitions with accept, guards and effects |
| Requirement, satisfy, verify, derive | requirement with its id and text, satisfy, verify, derivation connections |
| Allocate, refine, trace | allocate; dependency with SysMLv1Library metadata |
| Use case, interaction, constraint block | use case def, occurrence def with messages, constraint def |
| Stereotypes and tagged values | metadata def per stereotype, applied with its tags |
A worked example: the CubeSat EO-1 model
The CubeSat EO-1 demo exported as SysML 1.6 XMI and imported into a new SysML v2 project: 1,042 elements read, 1,007 converted, 32 approximated, 3 left out. The SysML v2 text checks with no errors and no warnings, and the new project opens with the satellite's structure, functions, requirements and traces. Every approximated and left-out element, by reason:
| Elements | Result | Reason |
|---|---|---|
| 10 connectors | Approximated | A connector end sits inside a part; the path to it was worked out from the part types. |
| 8 transitions | Approximated | 4 change and time triggers, such as when Undervoltage, are kept as documentation; 4 events without a signal, such as Contact Start, got an item definition of that name. |
| 6 item flows | Approximated | The name is used twice in the same place; the flow was renamed with a suffix. |
| 5 value types | Approximated | The unit (%, GB, Mbps, mNms, W/m^2) is not an SI unit Holarch maps; the value type is a real number with the unit in its documentation. |
| 2 control flows | Approximated | A branch without a guard next to guarded ones; it got the guard true. |
| 1 final state | Approximated | A final state became a plain state. |
| 1 use case extension | Left out | SysML v2 has no use case extensions. |
| 2 trace relationships | Left out | They point to elements without a name, which SysML v2 text cannot refer to. |
The EO-1 file is Holarch's own SysML 1.6 export, so it uses the part of SysML v1 that Holarch writes. A model from another tool usually uses more of the language, and its numbers will differ: the report of your own model is the measure that counts, and you see it before anything is imported. Holarch's test models, written in the XMI forms of several SysML v1 tools, also convert to text that checks with no problems, and the same model converts to the same text every time.
Questions
What is lost in the conversion?
Diagrams and their layout are not converted: create views in the SysML v2 project for the diagrams that matter. Elements SysML v2 has no counterpart for are left out, such as use case extensions, flow final nodes and activity partitions, and so are relationships to unnamed elements, because SysML v2 text refers to elements by name (name the elements you trace to before you export). Approximated elements are kept in a changed form; they are where the meaning may differ from the v1 model, so review them first. The report names every one of them, with the reason.
Is the converted model ready to use?
It checks without problems and every page of a SysML v2 project works with it, but treat it as a starting point. Some differences between the languages are worth a modeling decision, not only a translation. What SysML v2 projects support, and the known gaps: SysML v2 language coverage.
How large a model can I convert?
One file of at most 64 MB, with at most 250,000 elements nested at most 512 levels deep, and at most 8 MB of converted text. Export a larger model one package at a time. Your plan's items per project apply to the converted model: 1,000 on Free, 10,000 on Individual and 50,000 on Team. See what counts as an item. For a model above 10,000 items, ask for a Team evaluation.
Can I keep working in my SysML v1 tool?
Yes. Holarch reads an export and never changes the v1 model. When the v1 model changes, export it again and import the new file into the same project: elements take their ids from the XMI file, so they update in place, also after a rename or a move. Elements with the same name in one place are renamed with a suffix such as _2, and the report lists each rename.
Where does my file go?
Holarch reads and converts the XMI or .mdzip file in your browser; the file itself is not uploaded. On app.holarch.app the converted SysML v2 text is sent to Holarch to prepare the preview, and it is saved in your project only when you import. The hosted service does not accept CUI or export-controlled material; for that, Holarch runs in your own environment (Enterprise). More in Security.
What about requirements kept in a requirements management tool?
They travel as ReqIF (.reqif, .reqifz), the standard requirements interchange format. Holarch imports and exports ReqIF in LML and SysML v2 projects. In a SysML v2 project, a ReqIF file becomes requirements, requirement definitions and packages, with a report of what was converted, and the requirements export back with their original identifiers. In our round trip of the CubeSat EO-1 demo from Holarch to ReqIF and back, all 407 items and 979 attribute values came back unchanged. ReqIF in LML projects · ReqIF in SysML v2 projects
What does the converter cost?
Nothing extra: it is part of every plan, Free included. The plans differ in items per project and in what they include beyond modeling; see Pricing.
Building a migration into your own tool?
The converter is part of the Holarch Language Engine, the engine behind Holarch's SysML v2 projects, and is licensed to tool vendors and integrators as the migration add-on. It is the same converter that runs in Holarch.
- Your product reads the XMI file, the engine converts: send the v1 model as JSON in the documented neutral form, and get back the SysML v2 text, the engine's check of it, and the report of every element with a stable reason code and the SysML v2 name it became, as JSON.
- Runs where your product runs: in the browser as WebAssembly in a Web Worker, or on your server through Node.js or the Python extension with server use.
- Repeatable and bounded: the same model converts to the same text every time; models of up to 250,000 elements, and a larger one gets an error answer, never a hang.
- Switched on by your license token, with no rebuild and no code change. The free 60-day evaluation runs on your own computer with the documentation and examples.
A request and its answer
// Request (the model shortened)
{ "op": "v1_convert",
"model": { "format": "holarch-xmi-model", … } }
// Answer (shortened)
{ "text": "package 'Rover Model' { … }",
"diagnostics": [],
"report": {
"summary": { "elements": 31, "converted": 27,
"approximated": 2, "dropped": 2 },
"items": [ { "kind": "Association",
"status": "dropped",
"reason": "association" }, … ] } }
The v1_convert request in the engine's API reference. The engine also offers simulation and server use as add-ons.
See your own model in SysML v2.
Convert it, read the report, and import only when you are satisfied.
New accounts start a 30-day Individual trial at their first sign-in: 10,000 items per project, no card, back to Free when it ends. Have an account? Start the trial in Account Settings → Plan & Billing.