Class SysMLProjectHelper

java.lang.Object
com.dassault_systemes.modeler.magic.sysml.core.SysMLProjectHelper

@OpenApiAll public final class SysMLProjectHelper extends Object
Utility methods for working with SysML v2 projects.

This helper provides a small set of project-related operations, including:

  • creating a project from the SysML v2 template,
  • adding a locally created UPS project to Teamwork Cloud,
  • loading an existing Teamwork Cloud project by qualified name, and
  • opening an existing UPS project.
  • Method Details

    • createTWCProject

      public static void createTWCProject(String projectName) throws Exception
      Creates a Teamwork Cloud SysML v2 project.
      Parameters:
      projectName - the name of the project to create
      Throws:
      Exception - if project creation or Teamwork Cloud registration fails
    • loadTWCProject

      public static void loadTWCProject(String projectName) throws Exception
      Loads an existing Teamwork Cloud project by its qualified name.
      Parameters:
      projectName - the qualified name of the Teamwork Cloud project
      Throws:
      Exception - if the project descriptor lookup or project opening fails
    • loadUPSProject

      public static void loadUPSProject(String projectName) throws Exception
      Opens an existing UPS project.
      Parameters:
      projectName - the name of the UPS project to open
      Throws:
      Exception - if the project cannot be opened
    • createUPSProject

      @CheckForNull public static Project createUPSProject(String projectName)
      Creates a new UPS project.
      Parameters:
      projectName - the name of the project to create
      Returns:
      the created project, or null if project creation failed
    • createUPSProject

      @CheckForNull public static Project createUPSProject(String projectName, @CheckForNull String category)
      Creates a new UPS project using the SysML v2 template.
      Parameters:
      projectName - the name of the project to create
      category - the category of the project; may be null
      Returns:
      the created project, or null if project creation failed