Organize and Share Architectures and Artifacts

Create large-scale architecture models in projects, interact with source control, and compare and merge differences

Use Simulink^® projects in System Composer™ to organize large-scale architecture modeling projects. You can use projects to find required files, manage and share files and settings, and interact with source control. Store architecture models and their artifacts such as data dictionaries, requirements, allocations, profiles, behavior models, test files, and scripts in a project. Use the System Composer Comparison Tool and System Composer Three-Way Merge Tool to compare System Composer architecture models and review, merge, and save changes.

If you are new to projects, for an introduction, see Projects in the MATLAB^® documentation. For guidance specific to Simulink, see What Are MATLAB Projects in Simulink? and Using MATLAB Projects in Simulink.

You can access remote repositories compliant with SysML^® v2 in System Composer programmatically. You can also export MATLAB projects into SysML v2 textual files using systemcomposer.sysml.exportFromMLProject.

Classes

expand all

Architecture Models

`systemcomposer.arch.Architecture`	Architecture in model
`systemcomposer.arch.Model`	System Composer model

Data Dictionaries

systemcomposer.interface.Dictionary Architectural data of data dictionary of architecture model

SysML v2 Repositories

`systemcomposer.sysml.Repository`	Interface to access projects in SysML v2 repository (Since R2026a)
`systemcomposer.sysml.Project`	Interface to access contents of SysML v2 project (Since R2026a)
`systemcomposer.sysml.Workspace`	Cache for SysML v2 project snapshot when workspace is created (Since R2026a)
`systemcomposer.sysml.Element`	Single SysML v2 project element or relationship (Since R2026a)

Functions

expand all

Projects

`openProject`	Load an existing project
`matlab.project.createProject`	Create blank project
`matlab.project.deleteProject`	Stop folder management and delete project definition files
`matlab.project.rootProject`	Get root project
`addFile`	Add files or folders to project

SysML v2 Repositories

`connect`	Connect to repository server by URL (Since R2026a)
`getProjects`	Get all projects in SysML v2 repository (Since R2026a)
`getProjectById`	Get project by ID in SysML v2 repository (Since R2026a)
`createWorkspace`	Create SysML v2 workspace (Since R2026a)
`getElements`	Get all elements in SysML v2 workspace (Since R2026a)
`getRootElements`	Get root elements in SysML v2 workspace (Since R2026a)
`getElementRelationships`	Get relationship elements (Since R2026a)
`getElement`	Get element with provided ID (Since R2026a)
`getElementsByTypeAndName`	Get elements by type and name (Since R2026a)
`executeQuery`	Execute query (Since R2026a)
`getMembershipHierarchy`	Get elements in membership hierarchy of element (Since R2026a)
`getOwnershipHierarchy`	Get elements in ownership hierarchy of element (Since R2026a)
`getAncestors`	Get SysML v2 ancestors (Since R2026a)
`getDescendants`	Get SysML v2 descendants (Since R2026a)
`getUsages`	Get SysML v2 usages (Since R2026a)
`get`	Get element property (Since R2026a)
`meta`	Get element metaclass (Since R2026a)
`systemcomposer.sysml.exportFromMLProject`	Export project to SysML v2 textual file (Since R2026a)

Architecture Models

`systemcomposer.createModel`	Create System Composer model
`systemcomposer.loadModel`	Load System Composer model
`systemcomposer.openModel`	Open System Composer model
`open`	Open architecture model
`save`	Save architecture model or data dictionary
`close`	Close architecture model
`createArchitectureModel`	Create architecture model from component (Since R2021b)
`createArchitectureSubsystem`	Create architecture subsystem from component (Since R2023a)
`linkToModel`	Link component to model
`inlineComponent`	Remove reference architecture or behavior from component
`systemcomposer.exportToVersion`	Export architecture model and dependencies to previous release of System Composer

Data Dictionaries

`systemcomposer.createDictionary`	Create data dictionary
`systemcomposer.openDictionary`	Open data dictionary
`saveToDictionary`	Save interfaces to dictionary
`linkDictionary`	Link data dictionary to architecture model
`unlinkDictionary`	Remove linked data dictionary from architecture model
`moveInterface`	Move interface to another data dictionary (Since R2023b)
`addReference`	Add reference to dictionary
`removeReference`	Remove reference to dictionary
`makeOwnedInterfaceShared`	Convert owned interface to shared interface (Since R2022a)

Tools

Architectural Data Editor	Manage architectural data (Since R2023b)
Interface Editor	Create and author interfaces in local and shared data dictionaries
Profile Editor	Create and manage profiles with stereotypes and properties
System Composer Comparison Tool	Diff and merge changes between System Composer architecture models (Since R2022a)
System Composer Three-Way Merge Tool	Resolve conflicts in System Composer architecture models (Since R2023b)

Topics

Choose Architecture Template for System Design
Select an architecture template based on domain-specific extensions.
Organize System Composer Files in Projects
Use projects to organize your work, manage files and settings, and interact with source control.
Manage Interfaces with Data Dictionaries
Save, link, and delete interfaces.
Establish Traceability Between Architectures and Requirements
Link between architectures and requirements to show traceability.
Best Practices for Profile Design
Learn about using profiles in systems engineering design, extending stereotypes, and specifying profile usages.
Compare and Merge System Composer Architecture Models
Use the Comparison Tool to compare and merge System Composer architecture models and their artifacts. (Since R2022a)
Resolve Conflicts in Architecture Models Using Three-Way Merge
Use the Three-Way Merge Tool to investigate and resolve conflicts in System Composer architecture models.
Best Practices for Large-Scale Architecture Modeling
Build models using guidelines for best performance.

Related Information

Featured Examples

Modeling System Architecture of Small UAV

Set up and refine the architecture of a small unmanned aerial vehicle.

Open Live Script

Simulate Mobile Robot with System Composer Workflow

Simulate a mobile robot architecture with a systems engineering workflow.

Open Live Script

Model-Based Systems Engineering for Space-Based Applications

Explore the CubeSat model-based systems engineering project template.

Open Live Script

Build Architecture Models Programmatically

Programmatically build an architecture model.

Open Live Script