Server Administration

Administration Views

The Team for Capella client comes with two views useful to perform some administrative tasks:

Durable Locks Management View

Important: The durable locking is deactivated by default since Team For Capella 1.1.4 and 1.2.1.

Activate the durable locking

The durable locking mechanism allows to configure the explicit locks manually taken by a user as persistent locks. If a user takes explicit locks and then terminates his connection to the remote model (by closing his shared project or exiting the Team for Capella client), his explicit locks are not released and he will retrieve them on the next connection to the repository.

The durable locking can be activated by a client by adding the following option in the plugin_customization.ini file:

fr.obeo.dsl.viewpoint.collab/PREF_ENABLE_DURABLE_LOCKING=true 

If the plugin_customization.ini file is not present, you need

-pluginCustomization 
plugin_customization.ini

Note that the activation or deactivation of durable locking will have no effect on existing connection projects. The client have to remove the local connection project and to connect to the remote project again.

The following sections describe the case where the durable locking is activated.

Use the View

Team for Capella provides the Durable Locks Management view to list existing locking sessions and delete them if needed.

When doing the first operation with this view, you will be asked to logon with the following dialog:

It is allowed to remove Locking Sessions only if the corresponding user is not connected.

Additional information on Locking Sessions

The Durable Locks Management view displays all locking sessions existing on the repository and the locks created by these locking sessions (if any).

A locking session is created whenever a team project is created on a client (Connect to remote model). So if a user creates several team projects, he can have several locking sessions (as user1 in the screenshot above). Each locking session has a unique ID stored in the local .aird file.

Locks are owned by a locking session, so if the same user has two locking sessions (<=> 2 team projects) and he locks an element in the first locking sessions, this element will appear with a red lock in the second locking session.

Remove Locking Sessions

As explained above, using the Durable Locks Management view, locking session can be removed (this action is available by all users but should be done by the administrator only). A locking session can be removed only if nobody is connected using it.

All locks hold by the locking session are removed with it.

If a user tries to connect to the repository using an existing connection project referencing a removed Locking Session ID, an error dialog is displayed (see below) and a new locking session is created. The ID of this new locking session will replace the old one in the local .aird file on the next save action.

User Management View

Team for Capella provides the User Management view to manage users on the Team for Capella Server.

The Durable Locks Management view is useful only if the Team for Capella Server is configured to work with the access control “ Identification”.

The view is shown.

When doing the first operation with this view, you will be asked to logon with the following dialog:



Administration Tools

Repository maintenance application

The repository might have some inconsistent data and might need to be maintained.

The Repository maintenance application will look for broken links between Representation Descriptor and their representation(a Diagram, a table or a tree). This link might be broken if the representation has been deleted or if the internal index of the Representation Descriptor list is incorrect. That can cause some troubles for the different users connected to the project.

The application aims to delete orphan Representation Descriptors.

Once done the application will close the server.

Job configuration

There are two jobs available for maintenance in the Scheduler:

The application needs credentials to connect to the CDO server if the server has been started with authentication or user profile. Credentials can be provided using -credentials parameter. Here is a list of arguments that can be passed to the application or using the job (in maintenance.bat or the job config):

Arguments Description
-credentials Login and password can be provided using a credentials file.

To use this property file

  • Add the following program argument: -credentials <path_to_credentials_file>
  • Fill the specified file using the following format (only one line allowed):
aLogin:aPassword
-hostname defines the team server hostname (default: localhost).
-port defines the team server port (default: 2036).
-repoName defines the team server repository name (default: repoCapella).
-connectionType The connection kind can be set to tcp or ssl (keep it in low case) (default: tcp)
-consolePort The port to access the osgi console (default: 2036). This value has to be equal to the console eclipse parameter of the server.ini.
-diagnosticOnly Allowed values are true or false. If true, only the diagnostic is done. The database will be unchanged. (default: false)
-launchBackup Allowed values are true or false. If true, the capella_db backup is done before any change is done on the database. (default: true)
-archiveFolder Indicates where the backup zip will be stored.

REST Admin Server

An experimental administration feature through WebServices is available for the Team for Capella Server: it brings users and repositories management capabilities through REST WebServices and exposes an OpenAPI description:

Refer to documentation available in the folder server/experimental to discover how to install and enable it.