Collaboration Workspace - archimatetool/archi-modelrepository-plugin2 GitHub Wiki

The Collaboration Workspace

The Collaboration Workspace is a coArchi panel that organises models that have been configured for collaboration. You can toggle this panel from the main "Collaboration" menu or the toolbar. You can also open it from the right-click "Show in Collaboration Workspace" menu if you have the root node of a model selected in the Models Tree.

Collaboration Workspace

Models are arranged in a tree in optional groups. A model entry in the tree is simply a reference to an actual file location for the repository. The folder location is as follows, where "XXXXXXXXXXXX" is a unique number:

<user home>/Documents/Archi/repositories/XXXXXXXXXXXX

  • If the target folder location is deleted it will not appear in the tree
  • Double-clicking on a model entry opens the model in the Models Tree if it is not open already
  • You can organise models and groups using drag and drop
  • Selecting a model entry or group updates the Archi Properties panel
  • The model name shown in the tree is the same as the model's name
  • Right-clicking on a model entry or group in the tree allows you to perform various actions related to the selected model entry or group

Status indicators

The text colour of a model is red if the model has unpublished commits, there are new commits on the remote repository, or there are local changes to commit. The model icon also changes to reflect these states.

The state is also shown as text in the status bar when a model is selected. Possible states are:

  • There are changes to commit
  • There are unpublished commits
  • There are new commits on the remote
  • Up to date

Actions

Import Remote Model to Workspace

This action allows you to import a model present on a remote repository into the Collaboration Workspace. See Import Remote Model to Workspace for more details.

Add Existing Repository

This action allows you to add an existing local repository to the Collaboration Workspace. Select the folder of the repository when prompted to add it. This can be useful if you have previously removed a local repository and wish to add it back again. Or you might have moved the local repository to a different file location and want to add it from there.

New Group

Selecting this menu/toolbar item allows you to create a new group. Provide a name for the group when prompted.

Update Status of all Repositories

This action will query the remote locations of all repositories in the Collaboration Workspace. The updated status of each repository can be seen in the Status Indicators. You can then run the Refresh action for a repository if necessary.

Delete

Selecting this action will open a dialog box asking you to either delete the model or remove it from the Collaboration Workspace.

  • If you choose "Delete" the model and its containing folder are permanently deleted.

Caution

The only way to restore the model if it is deleted is to re-import it from its online repository, if there is one.

  • If you choose "Remove" the model is simply removed from the Collaboration Workspace panel. It is not deleted. You can re-add it to the Collaboration Workspace later if you wish. See Collaboration Workspace for more details.

Other Actions

Other actions available from the right-click context menu are:

⚠️ **GitHub.com Fallback** ⚠️