Connection Application

The connection application is used to create a local project connected to a shared project on a remote repository. It uses the same processes as the connection wizard.

1. Connection application strategy

The connection application supports one strategy :

Connection: the connection application establishes a connection to the targeted repository, checks that the targeted shared project exists and then create a local project that references the remote project.
- Credentials might be required if the server has been configured to use identification, authentication or user profiles, see Server Configuration job documentation.

2. Connection application parameters

connect.bat file uses -vmargs as a standard eclipse parameter. Eclipse parameters that are used by connect.bat override the value defined in capella.ini file. So if you want to change a system property existing in capella.ini (-vmargs -Xmx3000m for example) do not forget to do the same change in connect.bat.

The connection 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 either -repositoryCredentials or -repositoryLogin and -repositoryPassword parameters. Here is a list of arguments that can be set to the connection application (in connect.bat or in a launch config):

Arguments Description

Arguments	Description
-repositoryCredentials	Login and password can be provided using a credentials file. To use this property file Add the following program argument: `-repositoryCredentials <path_to_credentials_file>` Fill the specified file using the following format (only one line allowed): aLogin:aPassword Notes: This parameter must not be used with `-repositoryLogin` or `-repositoryPassword` parameters else the importer will fail. If the credentials do not contain any password, the password will be searched in the eclipse secure storage. See how to set the password in the secure storage. Login can also be provided with `fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.login` environment variable or system property. Password can also be provided with `fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.password` environment variable or system property.
-repositoryLogin	The connection application needs a login to connect to the CDO server if the server has been started with authentication or user profile. Notes: `-repositoryPassword` must not be used with `-repositoryCredentials` else the application will fail. Login can also be provided with `fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.login` environment variable or system property.
-repositoryPassword	This parameter is used to provide a password to the connection application accordingly to the login. Notes: Warning: some special characters like double-quote might not be properly handled when passed in argument of the importer. If `-repositoryPassword` is not used, the password will be searched in the eclipse secure storage. See how to set the password in the secure storage. `-repositoryPassword` must not be used with `-repositoryCredentials` else the application will fail. Password can also be provided with `fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.password` environment variable or system property.
-hostname	Define the team server hostname (default: localhost).
-port	Define the team server port (default: 2036).
-connectionType	The connection kind can be set to tcp or ssl (keep it in low-case) (default: tcp)
-repoName	Define the team server repository name (default: repoCapella).
-remoteAirdPath	Define the path specifying the remote aird to connect with (using "/" and not "\").
-localProjectName	Define the name of the local project to create.
-deleteLocalProjectOnError	Define the Boolean value to declare if the application should delete the local project if an error is detected (False by default).
-logFolder	Define the folder where to save logs (default: -outputFolder).
-addTimestampToResultFile	Add a time stamp to result files name (.zip, logs, commit history) (default: true).
-help	Print help message.

-repositoryCredentials

To use this property file

Add the following program argument: -repositoryCredentials <path_to_credentials_file>
Fill the specified file using the following format (only one line allowed):
```
aLogin:aPassword
```

Notes:

This parameter must not be used with -repositoryLogin or -repositoryPassword parameters else the importer will fail.
If the credentials do not contain any password, the password will be searched in the eclipse secure storage. See how to set the password in the secure storage.
Login can also be provided with fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.login environment variable or system property.
Password can also be provided with fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.password environment variable or system property.

-repositoryLogin

The connection application needs a login to connect to the CDO server if the server has been started with authentication or user profile.

Notes:

-repositoryPassword must not be used with -repositoryCredentials else the application will fail.
Login can also be provided with fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.login environment variable or system property.

-repositoryPassword

This parameter is used to provide a password to the connection application accordingly to the login.

Notes:

Warning: some special characters like double-quote might not be properly handled when passed in argument of the importer.
If -repositoryPassword is not used, the password will be searched in the eclipse secure storage. See how to set the password in the secure storage.
-repositoryPassword must not be used with -repositoryCredentials else the application will fail.
Password can also be provided with fr.obeo.dsl.viewpoint.collab.credentials.tools.net4j.password environment variable or system property.

-hostname

Define the team server hostname (default: localhost).

-port

Define the team server port (default: 2036).

-connectionType

The connection kind can be set to tcp or ssl (keep it in low-case) (default: tcp)

-repoName

Define the team server repository name (default: repoCapella).

-remoteAirdPath

Define the path specifying the remote aird to connect with (using "/" and not "\").

-localProjectName

Define the name of the local project to create.

-deleteLocalProjectOnError

Define the Boolean value to declare if the application should delete the local project if an error is detected (False by default).

-logFolder

Define the folder where to save logs (default: -outputFolder).

-addTimestampToResultFile

Add a time stamp to result files name (.zip, logs, commit history) (default: true).

-help

Print help message.

2.1. How to set the password in secure storage

The connection application does not use the same credentials as the user. It is stored in a different entry in the Eclipse 'Secure Storage'. Storing and clearing the credentials requires a dedicated application that can be executed as an Eclipse Application or using a Jenkins job.

3. Examples

example1: creation of local project "capella_test_local" in workspace "connection-workspace" connected to shared project "capella_test" on default location (localhost:2036/repoCapella)

connect.bat -nosplash -data connection-workspace
-remoteAirdPath /capella_test/capella_test.aird
-localProjectName capella_test_local

example2: creation of local project "capella_test_local" in workspace "connection-workspace" connected by WSS protocol to shared project "capella_test" on server capella.mydns.com through port 2037 and repository named "CapellaSharedProjects"

connect.bat -nosplash -data connection-workspace
-connectionType wss
-hostname capella.mydns.com
-port 2037
-repoName CapellaSharedProjects
-remoteAirdPath /capella_test/capella_test.aird
-localProjectName capella_test_local