Model management

1. Create a new model

To create a model, follow these steps from the toolbar of the Explorer View:

  1. Click the New model action in the explorer toolbar.

  2. Complete the model name.

  3. Choose the model type.

  4. Click the Create button.

Create New Model

Upon creation, the new model appears in the Explorer View.

New Model result

2. Upload a model

Sirius Web supports the upload of XMI and JSON files.

For JSON models, only models exported in the specific JSON format recognized by Sirius Web can be re-uploaded by using the upload action. Ensure that your models are exported using the Download Model action to enable successful re-uploading to Sirius Web.

To upload a model from a file previously exported, follow these steps:

  1. Go to the Project Workbench.

  2. Open the Explorer View.

  3. Click the Upload button at the top of the Explorer View in the toolbar.

  4. It opens the Upload Model modal.

  5. Select a model from your file system.

    Upload model
  6. The uploaded model is automatically created and opened.

3. Rename a model

You can update the model name from the Explorer View:

  1. Click the Explorer Contextual Menu next to the model in the Explorer View.

  2. Select the Rename option.

  3. Update the name in the editable field.

  4. Click Rename.

4. Delete a model

Deleting a model and its content is a significant action, and it’s important to note that the entire model, along with its contents, is permanently removed. This includes all associated semantic elements, representations, and any other data within the model. Exercise caution when performing this operation, as it can’t be reversed.

The deletion affects everyone.

To delete a model, follow these steps:

  1. Select the model in the Explorer View.

  2. Open the Explorer Contextual Menu next to the model.

  3. Click Delete.

Delete model

A confirmation dialog appears when the model is deleted via the Model Explorer. This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog.

Semantic Deletion

This preference is stored in the local storage of the browser. You can reset it using the settings page of the project or by clearing the Sirius Web data in the local storage of your browser.

5. Download a model

You can download a model from the Explorer View:

  1. Click the Explorer Contextual Menu next to the model in the Explorer View.

  2. Select the Download option.

Download model

The model is downloaded in JSON format. The JSON format used by Sirius Web is specific to the tool.

6. Create a new element

The process to create a new element in a model involves the following steps:

  1. Open the Explorer Contextual Menu next to the parent element.

  2. Click New object.

  3. Select the desired type of object to create.

  4. Click Create.

Create New Element

Upon completion, the newly created element is automatically selected in the Explorer View.

7. Read an element

  1. To navigate through the details of a semantic element, use the Explorer View to navigate through the model and locate the needed element.

  2. Select the element in the Explorer View.

  3. On the right panel, access the Details View. This view presents all the available properties for the selected element, providing a comprehensive overview of its characteristics.

Read element

8. Rename an element

It’s possible to rename an element either from the Explorer View, the Details View or a representation.

8.1. From the Explorer View

You can update the element name from the Explorer View:

  1. Click the Explorer Contextual Menu next to the element in the Explorer View.

  2. Select the Rename option.

  3. Update the name in the editable field.

  4. Click Rename.

Rename element from project explorer

Alternatively, cancel the operation by pressing the ESC key.

8.2. From the Details View

You can update the element properties from the Details View:

  1. Select the property in the Details View.

  2. Update the value in the editable field.

  3. Validate the changes by pressing the RETURN key or clicking anywhere.

Rename element from Details

8.3. From a representation

You can update the element name from a representation (diagram…​):

  1. Select the element in the representation.

  2. Select the Edit tool in the Diagram Contextual Palette.

  3. Validate the changes by pressing the RETURN key or clicking elsewhere.

Rename element from representation

Alternatively, cancel the operation by pressing the ESC key.

Instead of using the tool in the toolbar, you can press F2 key or start typing the new value directly to efficiently update the element name.

9. Update an element

It’s possible to update element properties either from the Details View or a representation.

9.1. From the Details View

You can update the element properties from the Details View:

  1. Select the property in the Details View.

  2. Update the value in the editable field.

  3. Validate the changes by pressing the RETURN key or clicking anywhere.

9.2. From a representation

You can update the element name from a representation (diagram…​):

  1. Select the element in the representation.

  2. Select the Edit tool in the Diagram Contextual Palette.

  3. Validate the changes by pressing the RETURN key or clicking anywhere.

Instead of using the tool in the toolbar, you can press F2 key or start typing the new value directly to efficiently update the element name.

10. Delete an element

This operation is irreversible, once done there is no mean to get the element back. The element and its children - semantic element and representations - are deleted.

The deletion affects everyone.

To delete an element, follow these steps:

10.1. From the Explorer View

  1. Open the Explorer Contextual Menu next to the element.

  2. Click Delete.

Delete element from explorer

10.2. From a representation

  1. Select the element in the representation.

  2. Click the Delete tool in the Diagram Contextual Palette or press the DEL key on your keyboard.

Delete element from representation
Use the DEL key cautiously, as it’s a direct shortcut for the delete operation.

A confirmation dialog appears when an element is deleted via the Delete from model tool in the palette or via the Explorer Contextual Menu. This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog.

Semantic Deletion

This preference is stored in the local storage of the browser. You can reset it using the settings page of the project or by clearing the Sirius Web data in the local storage of your browser.