2. Archi Beginner

Navigate the User Interface

1. In Archi, select [Toggle Collaboration Workspace] and [Toggle Branches View] from the Collaboration menu. The Workspace and Branch windows will be docked within Archi. Archi/coArchi supports repository branches.

   

   The Collaboration Workspace is used to navigate between different models and individual branches checked out while the Branches View provide the ability to manipulate branches within the selected model.

Refresh the Model

IMPORTANT: To ensure that the local repository remains synchronized with the upstream repository and to prevent overwriting any changes made since the last pull from the server, it is crucial to refresh the model from GitHub before applying any modifications. Regular refreshs of the model not only maintain alignment with the upstream repository but also mitigate the risk of merge conflicts.

1. To refresh your local copy of the model, open the model / branch from the Collaboration Workspace and select [Refresh Model] from the Collaboration application menu.

   

   Alternatively, you can - in archi - select [Toggle Collaboration Workspace] from the Collaboration application menu and refresh Model there.

   

Add New Branch

To protect the integrity of the main branch and avoid overwriting updates from someone else, it is recommended to create a branch for each new piece of work. Branches could be named by feature_[topic name] or fix_[topic name]. Branches can be created either through the coArchi plugin or via Github.com.

Via the coArchi plugin

1. In Archi, select [Toggle Branches View] from the Collaboration menu.

   

2. In Branches Workspace, click on the [Add branch] icon.

   

3. Select [Add branch and checkout]. This will create the local topic branch and set it as the active branch. This action won't create the upstream branch (on Github server yet).

   

4. The final step is to publish the new topic branch. This will make the new topic branch available on GitHub.co. To publish your new topic branch, select [Publish changes] from the Collaboration menu.

   

5. To ensure that your new topic branch have been successfully published, you can verify by visiting your topic branch on https://github.com/NBility-Model to see if your new topic branch appears in the specific repository you've worked on.

Switch Branches

1. In archi, select [Toggle Branches View] from the Collaboration menu.

2. In archi, right click on the branch you like to switch to and click on [Switch branch].

   

Commit and Publish Changes

1. To commit your latest changes, select [Commit changes] from the Collaboration menu.

   

2. Enter your user details and a commit message. By committing changes you create a local snapshot of the repository into a single package. IMPORTANT: This does not upload the changes to the upstream branch, but only create a local packaged copy.

   

3. The final step is to publish the committed package back to the upstream repository. This will insert the last committed package into the upstream branchat GitHub.com. To publish your latest changes, select [Publish changes] from the Collaboration menu.

   

4. To ensure that your changes have been successfully committed and published, you can verify by visiting your topic branch on https://github.com/NBility-Model to see if your commit appears in the specific branch you've worked on.

Manage Pull Requests

On regular intervals all committed and published branches need to be merged into the main branch which will trickle down into all subsequent branches.

1. Log onto your GitHub Account at GitHub.com.

2. In https://github.com/NBility-Model, create a Github pull request from your topic branch on by clicking on the button [Compare & Pull Request].

   

3. Add a title and description to your pull request. To finalize your pull request, click on the button [Create pull request].

   

4. Pull requests will be reviewed by one of the maintainers of NBility Model who may discuss, offer constructive feedback, request changes, or approve the work.

5. Upon receiving the sign-off of one of the maintainers of NBility Model you may merge your changes, or if you do not have permission to do that, you may request a maintainer to merge it for you.

   

Export to XML

1. Open Archi on your local machine and select the architecture repository which you would like to export. For the purpose of this example, we choose Nbility-business-capabilities-EN. See image below.

   

2. Then select, File > Export > Model to Open Exchange File.

   

3. A pop up window open where in you can select the folder location to save the .xml file. See image below.

   

4. The .xml file will be saved in the chosen folder, along with three .xsd files.

Export to CSV

1. Open Archi on your local machine and select the architecture repository which you would like to export. For the purpose of this example, we choose Nbility-business-capabilities-EN. See image below.

   

2. Then select, File > Export > Model to CSV.

   

3. A pop up window open where in you can select the folder location to save the .csv file. You can also select relevant option for example, delimiting character an MS Excel compatibility. See image below.

   

4. Three .csv file will be saved in the chosen folder. one each for elements, properties en relations.

Export to PDF, Word, or PowerPoint

1. In archi, select [Report] and then [Jasper] in the File menu.

   

2. Select [MS Powerpoint, PDF and MS Word] in Formats to generate and click on the button Finish.

   

3. The generated files are available at the specified location.