User Guide
In this guide we will see how to use our platform.
The first page shown to the user is the following:
Here the unregistered user can log in, register, retrieve his password or view the public repositories of all other registered users. By clicking on "Public Repositories" you can view the list of all public repositories even if this user is not logged in:
Once the user selects the repository he wants to use, the following page shows the list of folders and .bpmn files present at the repository level. The user will open these resources in read-only mode, in fact it will not be able to modify, upload files or folders; there is also a search bar to perform a search based on parameters such as "Name", "Creation date" and "Author": by setting the search values, the underlying list of contents is filtered.
Clicking on the affected file will open a preview page of the file. If the user is not logged in he can only select the version of the model he is interested in, without being able to upload other versions.
Once the desired version is selected, the model opens in the editor. The user can only export the model or make temporary changes: even here the changes that the user not logged in will bring to this file, can not be saved.
Let's create a user now. To do so, click on the SignUp item in the upper left menu. Now the user must enter the registration information.
Once registered, the user can log in to the login page using email and password. Once logged in, the user will see his dashboard:
In the lower part of the dashboard there is a list of all the repositories, both public and private, of the logged in user. At this point, the user can create a new repository: clicking on the "+ Create New Repository" button will open a popup that will allow you to enter a name for the repository you are creating and visibility, which can be public or private.
The newly created private repository will only appear in the creator's dashboard and will not be shown in the public repositories list. Returning to the list of public repositories, this time the registered user can open files and folders of all public repositories also in writing mode, then can make changes to files, upload, move files etc. We see these same operations by observing them within the newly created private repository. Clicking on the repository name will open a drop-down menu where the user can make changes to the repository, create a folder, create a new file, import a new file or share the same repository with another.
If the user clicks the "Modify Repository" option, he will be able to change the name of the repository by a popup. Let's insert the new name:
With the "Create folder" option, the user is given the possibility to create a folder to organize his models better. Once the folder is created, this is displayed in the list of resources contained in the repository.
Another option to take into consideration is that of "Sharing repository": the user can select an email to send a link to another user, if he wants to share the repository. Note that a private repository, once shared with another user, will become public, so it will also appear in the list of public repositories.
With the "Import file" option, the user can upload a file on his local machine. At this point, this .bpmn file will be shown in the resource list. Note that for this file, its version 1 will be generated immediately.
Now let's create a new file. A window will open that will allow the user to create a file of type collaboration or choreography:
Once the file is created, the user will be redirected to the editor and can create the relative model. Once you have created the model you can save it as it is a registered user.
When the user saves the newly created file (hence version number 1) now, he will be asked to enter a name:
Now that the file has been created it is possible to reopen it from the list of resources contained in the repository. At this point, however, is shown a page that will allow the user to create a new version for that same file, choose the version of that file to open, to delete or download locally.
By clicking on the "Create new version" button, a new version of the file is created. The new version is created starting from the current selected version, then a copy of the desired version is made and the first available next version number is assigned. The list of versions of the same file is shown in the drop-down menu on the left:
Within the page where you can select the version for a specific file, you can also perform a series of operations:
- Modify File Name: allows the user to change the file name.
- Move File: allows the user to move a file within a folder of the same repository.
- Share file: allows you to share the file with another user. If the repository where the file is located is private, a new public repository is created containing the copy of this file and shared with another user by means of a link sent by email.
- Download ZIP models: allows the user to download locally a zip file containing all the versions of this file.
- Delete File: allows the user to delete the file, so all versions for that file.
In this page you can also decide to merge the model with another collaboration model already present in your system.
If there is the right matching of the message flows in the two models, the merge will be correct and you will show the result in a new page.
This is the c4 initial page for matching two models. In this page you can choose two models from your system, one collaboration and one choreography and then apply the matching.
This is the result of the two file matched. The results are the two .aut files. You can download the files or see the diagram.
Then you can check the equivalence of the two models that show the result and a counterExample.
