| |
| <!DOCTYPE html> |
| <!-- |
| Generated by Apache Maven Doxia at 2017-01-05 |
| Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin) |
| --> |
| <html xml:lang="en" lang="en"> |
| |
| <head> |
| <meta charset="UTF-8" /> |
| <title> |
| SysML - Developer | SysML Papyrus</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="description" content="" /> |
| <meta http-equiv="content-language" content="en" /> |
| |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/bootstrap.min.css" rel="stylesheet" /> |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/bootstrap-responsive.min.css" rel="stylesheet" /> |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/docs.css" rel="stylesheet" /> |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/reflow-skin.css" rel="stylesheet" /> |
| |
| |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/lightbox.css" rel="stylesheet" /> |
| |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/site.css" rel="stylesheet" /> |
| <link href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/print.css" rel="stylesheet" media="print" /> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> |
| <!--[if lt IE 9]> |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/html5.js"></script> |
| <![endif]--> |
| |
| |
| |
| <link rel="stylesheet" href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/css/highlightjs/default.min.css"></link> |
| </head> |
| |
| <body class="page-developer-index project-orgeclipsepapyrussysml14parent" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target"> |
| |
| <div class="navbar navbar-fixed-top"> |
| <div class="navbar-inner"> |
| <div class="container"> |
| <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </a> |
| <a class="brand" href="https://www.eclipse.org/papyrus/components/sysml/0.10.0/index.html">Papyrys <span class="color-highlight">SysML 1.4</span> Project</a> |
| <div class="nav-collapse collapse" id="top-nav-collapse"> |
| <ul class="nav pull-right"> |
| <li ><a href="http://www.eclipse.org/papyrus" title="Papyrus" target="_blank" class="externalLink">Papyrus</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li ><a href="../org.eclipse.papyrus.sysml14.targetplatform/index.html" title="SysML Target Platform">SysML Target Platform</a></li> |
| <li ><a href="../org.eclipse.papyrus.sysml14.core/index.html" title="SysML Core">SysML Core</a></li> |
| <li ><a href="../org.eclipse.papyrus.sysml14.diagram/index.html" title="SysML Diagram">SysML Diagram</a></li> |
| <li ><a href="../org.eclipse.papyrus.sysml14.table/index.html" title="SysML Table">SysML Table</a></li> |
| <li ><a href="../org.eclipse.papyrus.sysml14.gui/index.html" title="SysML GUI">SysML GUI</a></li> |
| <li ><a href="../org.eclipse.papyrus.sysml14.releng/index.html" title="SysML Releng">SysML Releng</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Parent <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li ><a href="../../components/index.html" title="Papyrus Shared Components Descriptor">Papyrus Shared Components Descriptor</a></li> |
| </ul> |
| </li> |
| <li class="dropdown active"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Doc <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li class="active"><a href="" title="Developer">Developer</a></li> |
| <li ><a href="../user/index.html" title="User">User</a></li> |
| <li ><a href="../norm/formal-15-06-03.pdf" title="SysML 1.4 Standard" target="_blank">SysML 1.4 Standard</a></li> |
| <li ><a href="http://www.omg.org/spec/SysML/1.4/" title="OMG" target="_blank" class="externalLink">OMG</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li ><a href="http://download.eclipse.org/modeling/mdt/papyrus/components/sysml14/" title="Update Site" target="_blank" class="externalLink">Update Site</a></li> |
| <li ><a href="http://download.eclipse.org/modeling/mdt/papyrus/components/sysml14/downloads/0.10.1-SNAPSHOT/rcps/?d" title="RCP" target="_blank" class="externalLink">RCP</a></li> |
| <li ><a href="http://download.eclipse.org/modeling/mdt/papyrus/components/sysml14/downloads/0.10.1-SNAPSHOT/drops/?d" title="Drop" target="_blank" class="externalLink">Drop</a></li> |
| <li ><a href="https://repo.eclipse.org/content/repositories/papyrus-releases/org/eclipse/papyrus/sysml/" title="Nexus" target="_blank" class="externalLink">Nexus</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div><!--/.nav-collapse --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| <!-- Masthead |
| ================================================== --> |
| |
| <header> |
| <div class="jumbotron subhead"> |
| <div class="row" id="banner"> |
| <div class="span12"> |
| <div class="pull-left"> |
| <a href="../https://www.eclipse.org/papyrus/components/sysml/0.10.0/index.html" id="bannerLeft"><h1>Eclipse <span class="color-highlight">Papyrus SysML</span> project</h1></a> |
| <p class="lead">a Papyrus DSML implementing the Sysml 1.4 OMG standard.</p> |
| </div> |
| <div class="pull-right"> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div> |
| <ul class="breadcrumb"> |
| <li><a href="../" title="SysML-1.4">SysML-1.4</a></li> |
| <li class="divider">/</li> |
| <li> |
| SysML - Developer</li> |
| </ul> |
| </div> |
| <hr class="toc-separator" /> |
| <div id="toc-bar" class="navbar" data-spy="affix" data-offset-top="250"> |
| <div class="navbar-inner"> |
| <div id="toc-scroll-target" class="container"> |
| <a class="btn btn-navbar" data-toggle="collapse" data-target="#toc-nav-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </a> |
| <div class="nav-collapse collapse" id="toc-nav-collapse"> |
| <ul id="toc" class="nav"> |
| <li class="toplevel"><a href="#Download" title="Download">Download</a></li> |
| <li class="divider-vertical"></li> |
| <li class="dropdown"> |
| <a href="#Requirements" title="Requirements" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Requirements <b class="caret"></b></a> |
| <ul class="dropdown-menu" role="menu"> |
| <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> |
| <li><a href="#Requirements" title="Requirements">Requirements</a></li> |
| <li class="divider"></li> |
| <li><a href="#Eclipse" title="Eclipse">Eclipse</a></li> |
| <li><a href="#Maven" title="Maven">Maven</a></li> |
| <li><a href="#Eclipse_plugins" title="Eclipse plugins">Eclipse plugins</a></li> |
| <li><a href="#SysML" title="SysML">SysML</a></li> |
| <li><a href="#Check_your_installation_by_a_basic_checkout_compilation" title="Check your installation by a basic checkout, compilation">Check your installation by a basic checkout, compilation</a></li> |
| <li><a href="#Target_Environment" title="Target Environment">Target Environment</a></li> |
| |
| </ul> |
| </li> |
| <li class="divider-vertical"></li> |
| <li class="dropdown"> |
| <a href="#Product_Life_Management" title="Product Life Management" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Product Life Management <b class="caret"></b></a> |
| <ul class="dropdown-menu" role="menu"> |
| <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> |
| <li><a href="#Product_Life_Management" title="Product Life Management">Product Life Management</a></li> |
| <li class="divider"></li> |
| <li><a href="#Run_a_default_installation" title="Run a default installation">Run a default installation</a></li> |
| <li><a href="#To_build_also_the_modules_relatives_to_RCP_and_Product_please_activate_the_following_profile" title="To build also the modules relatives to RCP and Product, please activate the following profile:">To build also the modules relatives to RCP and Product, please activate the following profile:</a></li> |
| <li><a href="#Generate_and_deploy_the_web_site" title="Generate and deploy the web site">Generate and deploy the web site</a></li> |
| <li><a href="#A_minimal_iteration" title="A minimal iteration">A minimal iteration</a></li> |
| <li><a href="#Tips" title="Tips">Tips</a></li> |
| |
| </ul> |
| </li> |
| <li class="divider-vertical"></li> |
| <li class="dropdown"> |
| <a href="#Standard_Operating_Procedures_and_FAQ" title="Standard Operating Procedures and FAQ" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Standard Operating Procedures and FAQ <b class="caret"></b></a> |
| <ul class="dropdown-menu" role="menu"> |
| <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> |
| <li><a href="#Standard_Operating_Procedures_and_FAQ" title="Standard Operating Procedures and FAQ">Standard Operating Procedures and FAQ</a></li> |
| <li class="divider"></li> |
| <li><a href="#SOPS" title="SOPS">SOPS</a></li> |
| <li><a href="#Dev_FAQ" title="Dev FAQ">Dev FAQ</a></li> |
| |
| </ul> |
| </li> |
| <li class="divider-vertical"></li> |
| <li class="dropdown"> |
| <a href="#Miscellaneous" title="Miscellaneous" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Miscellaneous <b class="caret"></b></a> |
| <ul class="dropdown-menu" role="menu"> |
| <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> |
| <li><a href="#Miscellaneous" title="Miscellaneous">Miscellaneous</a></li> |
| <li class="divider"></li> |
| <li><a href="#Libraries" title="Libraries">Libraries</a></li> |
| |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| </header> |
| |
| <div class="main-body"> |
| <div class="row"> |
| <div class="span12"> |
| <div class="body-content"> |
| <div class="section"> |
| <div class="page-header"> |
| <h2 id="Download">Download</h2> |
| </div> |
| <p>The developer guide could be downloaded as a pdf <a href="../pdf/developer-guide.pdf">here</a></p> |
| </div> |
| <div class="section"> |
| <h2 id="Requirements">Requirements</h2> |
| <div class="section"> |
| <h3 id="Eclipse">Eclipse</h3> |
| <p>Use Eclipse, at least Neon version</p> |
| </div> |
| <div class="section"> |
| <h3 id="Maven">Maven</h3> |
| <p>Use Maven 3.3.1 at least</p> |
| </div> |
| <div class="section"> |
| <h3 id="Eclipse_plugins">Eclipse plugins</h3> |
| <p>Install M2e plugin in your Eclipse</p> |
| <p>Install Tycho Configurator as an additional maven connector</p> |
| <p>No specific extra from papyrus</p> |
| </div> |
| <div class="section"> |
| <h3 id="SysML">SysML</h3> |
| <p> Have a look to the normative document of OMG: <a class="externalLink" href="https://hudson.eclipse.org/papyrus/view/Sysml/job/papyrus-sysml-website/ws/target/site/norm/formal-15-06-03.pdf#3">Embedded norm</a> </p> |
| </div> |
| <div class="section"> |
| <h3 id="Check_your_installation_by_a_basic_checkout_compilation">Check your installation by a basic checkout, compilation</h3> |
| <ul> |
| <li> Clone the sysml 14 git repository git clone https://git.eclipse.org/r/papyrus/org.eclipse.papyrus-sysml. </li> |
| <li> Run maven at the root of the repo: mvn clean install; it should pass </li> |
| <li> Get sysml14 plugins in your eclipse workspace </li> |
| <li>Et “Voila” you are good to go.</li> |
| </ul> |
| </div> |
| <div class="section"> |
| <h3 id="Target_Environment">Target Environment</h3> |
| <p>We have developed a target-platform-configuration artifact located at /org.eclipse.papyrus-sysml/org.eclipse.papyrus.sysml14.targetdef/org.eclipse.papyrus.sysml14.targetdef.target</p> |
| <p>Open it and click at the upper right corner to set it has the target platform.</p> |
| </div> |
| </div> |
| <div class="section"> |
| <h2 id="Product_Life_Management">Product Life Management</h2> |
| <p>The PLM is Maven with Tycho plugins for OSGI.</p> |
| <div class="section"> |
| <h3 id="Run_a_default_installation">Run a default installation</h3> |
| <div class="source"> |
| <pre>mvn clean install</pre> |
| </div> |
| </div> |
| <div class="section"> |
| <h3 id="To_build_also_the_modules_relatives_to_RCP_and_Product_please_activate_the_following_profile">To build also the modules relatives to RCP and Product, please activate the following profile:</h3> |
| <div class="source"> |
| <pre>mvn clean install -Pproduct </pre> |
| </div> |
| <p>It could be necessary to use the following workaround to ensure the version of Neon plugins, you used to build against:</p> |
| <div class="source"> |
| <pre>mvn clean install -Pproduct -Dtycho.localArtifacts=ignore</pre> |
| </div> |
| <p>Sometimes when Ecvlipse realse train is on the move, you will need to add the following option, to force to download directly from Eclipse main download site:</p> |
| <div class="source"> |
| <pre>-Dtycho.disableP2Mirrors=true</pre> |
| </div> |
| </div> |
| <div class="section"> |
| <h3 id="Generate_and_deploy_the_web_site">Generate and deploy the web site</h3> |
| <div class="source"> |
| <pre>mvn clean site site:stage-deploy scm-publish:publish-scm -Pdocumentation</pre> |
| </div> |
| </div> |
| <div class="section"> |
| <h3 id="A_minimal_iteration">A minimal iteration</h3> |
| <p>This section describes the different steps relative to the integration of a new feature or to the correction of a bug: from bug definition, to requirement, to code integration through gerrit review with the continuous integration system.</p> |
| <ul> |
| <li> Describe in Bugzilla the bug, feature you are working on. Please use the component SysML. And begins with [SysML 1.4] for Summary. </li> |
| <li> Get the code from the master with git,git clone https://git.eclipse.org/r/papyrus/org.eclipse.papyrus-sysml, and work on a local branch, </li> |
| <li> Add the new requirement in the different sysml 1.1 models located in the doc folder of the relevant plugin. have a look to <a href="sop4-requirement.html">SOP4: Requirement</a> </li> |
| <li>Modify the code</li> |
| <li>Push on Gerrit ssh://{ECLISPEUSERLOGIN}@git.eclipse.org:29418/papyrus/org.eclipse.papyrus-sysml </li> |
| <li>Ask for a review https://git.eclipse.org/r/#/dashboard/self</li> |
| <li>After a few iteration, you code should be merged and accessible in the master. </li> |
| </ul> |
| <p>Have a look to default rules <a href="miscellaneous.html">miscellaneous.html</a></p> |
| </div> |
| <div class="section"> |
| <h3 id="Tips">Tips</h3> |
| <p>If you are working with multiple version of Papyrus, it is possible that Tycho do not pull the right one. You can force it by using the following parameter in the build command. More details <a class="externalLink" href="https://wiki.eclipse.org/Tycho/Target_Platform#Locally_built_artifacts">here</a></p> |
| <div class="source"> |
| <pre>mvn clean install -Dtycho.localArtifacts=ignore </pre> |
| </div> |
| <p>Please find additional information here: <a href="miscellaneous.html">Miscellaneous</a></p> |
| </div> |
| </div> |
| <div class="section"> |
| <h2 id="Standard_Operating_Procedures_and_FAQ">Standard Operating Procedures and FAQ</h2> |
| <div class="section"> |
| <h3 id="SOPS">SOPS</h3> |
| <ul> |
| <li> <a href="sop1-normRequirementExtraction.html">SOP1: OMG Norm requirements automanual extraction</a> </li> |
| <li> <a href="sop2-toolGeneration.html">SOP2: From a OMG profile to a dedicated Papyrus application (elementype, palette etc...) </a> </li> |
| <li> <a href="sop3-upgradingNorm.html">SOP3: Extended the norm by adding a new operation.</a> </li> |
| <li> <a href="sop4-requirement.html">SOP4: Add a new requirement.</a> </li> |
| <li> <a href="sop5-release.html">SOP5: Make the release.</a> </li> |
| </ul> |
| </div> |
| <div class="section"> |
| <h3 id="Dev_FAQ">Dev FAQ</h3> |
| <ul> |
| <li><a href="faq-dev.html">FAQ.</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="section"> |
| <h2 id="Miscellaneous">Miscellaneous</h2> |
| <div class="section"> |
| <h3 id="Libraries">Libraries</h3> |
| <p><a href="libraries.html">QUDV and others</a></p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div><!-- /container --> |
| |
| <!-- Footer |
| ================================================== --> |
| <footer class="well"> |
| <div class="container"> |
| <div class="row"> |
| <div class="span3 bottom-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">DevLinks</li> |
| <li > |
| <a href="https://git.eclipse.org/c/papyrus/org.eclipse.papyrus-sysml.git" title="SourceCode by Git" target="_blank" class="externalLink">SourceCode by Git</a> |
| </li> |
| <li > |
| <a href="https://repo.eclipse.org/index.html#welcome" title="Repository by Nexus" target="_blank" class="externalLink">Repository by Nexus</a> |
| </li> |
| <li > |
| <a href="https://hudson.eclipse.org/papyrus/view/Sysml/" title="Integration by Hudson" target="_blank" class="externalLink">Integration by Hudson</a> |
| </li> |
| <li > |
| <a href="https://dev.eclipse.org/sonar/dashboard/index/113161" title="Quality by Sonar" target="_blank" class="externalLink">Quality by Sonar</a> |
| </li> |
| <li class="nav-header">References</li> |
| <li > |
| <a href="http://www.omg.org/spec/SysML/1.4/" title="OMG" target="_blank" class="externalLink">OMG</a> |
| </li> |
| </ul> |
| </div> |
| <div class="span3 bottom-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Modules</li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.targetplatform/index.html" title="SysML Target Platform">SysML Target Platform</a> |
| </li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.core/index.html" title="SysML Core">SysML Core</a> |
| </li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.diagram/index.html" title="SysML Diagram">SysML Diagram</a> |
| </li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.table/index.html" title="SysML Table">SysML Table</a> |
| </li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.gui/index.html" title="SysML GUI">SysML GUI</a> |
| </li> |
| <li > |
| <a href="../org.eclipse.papyrus.sysml14.releng/index.html" title="SysML Releng">SysML Releng</a> |
| </li> |
| <li class="nav-header">Parent</li> |
| <li > |
| <a href="../../components/index.html" title="Papyrus Shared Components Descriptor">Papyrus Shared Components Descriptor</a> |
| </li> |
| </ul> |
| </div> |
| <div class="span3 bottom-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Maven documentation</li> |
| <li > |
| <a href="../project-info.html" title="Project Information">Project Information <i class="icon-chevron-right"></i></a> |
| </li> |
| <li > |
| <a href="../project-reports.html" title="Project Reports">Project Reports <i class="icon-chevron-right"></i></a> |
| </li> |
| </ul> |
| </div> |
| <div class="span3 bottom-description"> |
| <blockquote>Eclipse <span class="color-highlight">Papyrus SysML 1.4</span> project based on a DSML is aiming at providing an integrated and user-consumable environment for editing any kind of SysML 1.4 model.</blockquote> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| <div class="container subfooter"> |
| <div class="row"> |
| <div class="span12"> |
| <p class="pull-right"><a href="#">Back to top</a></p> |
| <p class="copyright">Copyright ©2015-2017 <a href="https://www.eclipse.org/">Eclipse foundation</a>. All Rights Reserved.</p> |
| <p class="version-date"><span class="projectVersion">Version: 0.10.1-SNAPSHOT. </span><span class="publishDate">Last Published: 2017-01-05. </span></p> |
| <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p> |
| </div> |
| </div> |
| </div> |
| |
| <!-- Le javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/jquery.min.js"></script> |
| |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/bootstrap.min.js"></script> |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/lightbox.min.js"></script> |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/reflow-scroll.js"></script> |
| |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/highlight.min.js"></script> |
| <script src="https://www.eclipse.org/papyrus/components/sysml/0.10.0/js/reflow-skin.js"></script> |
| |
| </body> |
| </html> |
