User Manual

Content

Create an ESF Project

Click "New > Project..." either from the "Project Explorer" or the "File" menu.

New Project Menu

From the "New Project" dialog, select "ESF Project" and click "Next >".

Create ESF Project

Name the project as "RecoverySystemESF" and the model file as "recoverySystemESF", then click "Next >".

ESF Project Settings Page 1

Name the root model element as "RecoverySystemESF" and click "Finish".

ESF Project Settings Page 2

The ESF project will be created and opened in the Papyrus perspective.

ESF Project Created

System Architecture

Remarks

In UML the Port element does not have direction. But for certains safety analyses, this information is mandatory. For this reason, before to import an architecture model (see below) or apply the "ESFArchitectureConcepts Annotation" (see more below), it is recommended follow this instruction:

For each port, go to the "Properties View" and click on "Comments" tab. In "Owned comments" add a comments: "in", "input", "out" or "output".

Set Port Direction By Comment

If you cant not modify the architecture model, you can modify the "Direction" attribute of SPort (stereotype applied on a port). For each port applied by SPort, go to the "Properties View", click on "ESFArchitectureConcepts" tab and set the "Direction" attribute: "IN" or "OUT". "INOUT" is a default value.

Set SPort Direction

Import an Existing Architecture to an ESF Project

Firstly, import the existing system architecture project to the workspace. Click the "File" or "New > Project..." either from the "Project Explorer".

Import System Architecture

The system architecture project (RecoverySystem) will be imported and opened in the workspace.

ImportedArchitecture

Then double click on the ESF model, right click on the root element in model explorer and click "ESF Import Model > Import UML Model...".

Imported UML Model Menu

Select the uml model to import and click "OK".

Select the UML Model

Select the uml model element to import and click "OK".

Select the Elements to Import

Lastly, if a dialog box display asking for enabling writing or not, click "OK".

EnableWrite

Imported system architecture appears inside the root element of the ESF model.

Note that for the imported copy of the original system architecture model, another model file (in this case, recoverySystem_1479374458104.di) in the system architecture project (RecoverySystem) is created also.

ArchitectureImportedToESF

Create a New Architecture inside an ESF Project

A new UML system architecture can be created inside an ESF project thanks to Papyrus.

Right click on the root element and then click "New Child > Model".

Create Architecture Model

Rename the created model as "RSArchitecture".

Rename Architecture Model

Continue creating the other elements inside the model until finishing the system architecture.

Finished Architecture Model

Right click on the "RSArchitecture" model element and then click "Apply ESFArchitectureConcepts Annotation".

Annotation Menu

ESFArchitectureConcepts annotations will be applied and the editor will be updated.

Annotated Architecture Model

The ESF Architecture Diagram

ESF offers a diagram named "ESF Architecture Diagram" (EAD). This diagram is a specialization of "Structure Composite Diagram" from UML. With EAD, you can create the elements with the "ESF Architecture Concepts" stereotypes applied.

For creating a new EAD, right click on a "SBlock" element and then click "Create ESF Architecture Diagram".

Create ESF Architecture Diagram

The EAD offers a palette with the elements of ESF Architecture Concepts.

Palette of ESF Architecture Diagram

Note:When a SPart is added a dialog is opened for setting a type to SPart. By the dialog, there are two ways to define a type: the first, it is to create a new SBlock element; the second, it is to select a SBlock element present in the model.

SPart Type Dialog

Example of Recovery System with ESF Architecture Diagram:

Recovery System with ESF Architecture Diagram

Note:When the EAD is created, some existent elements of SBlock don't be displayed. They should be drag and drop in the EAD.