Installing SECollab Publisher

SECollab Publisher is an extension dedicated to the client workstations allowing the publication of works by connecting to supported applications.

This section describes the procedure for installing SECollab Publisher and, if applicable, to configure it before deploying it on the end user's computer.

Prerequisites

Before installing SECollab Publisher, verify that the client computer is compliant with the prerequisites below.

• Operating System: Windows
• Processor: 2 GHz or higher recommended.
• RAM: 1GB minimum (32bits version), 6GB recommended.
• Resolution: Minimum 1024 x 768 or higher recommended.
• Disk space: 1 Gb minimum.
• Java:
  • Version: Java 8
  • Architecture: 64 bits

SECollab Publisher connects to supported applications on the same client computer as SECollab Publisher. Please refer to the respective application installation guides for their own prerequisites and installation steps.

Below are the applications with which SECollab Publisher can interface:

• MEGA HOPEX
• IBM Rational DOORS versions 8.2+
• IBM Rational System Architect versions 11.4.3, as well as SA Unicom 11.4.4
• Sparx Systems Enterprise Architect version 10 to 14
• PolarSys Capella versions 0.8.1 to 1.2.0
• IBM Rational Rhapsody versions 8.1.4 to 8.3.0
• NoMagic MagicDraw version 18.5
• Microsoft Word, Excel and Powerpoint, version 97 or more

Installing SECollab Publisher on a local station

The secollab-publisher-win32-x86_64.zip SECollab Publisher client provides support for the following applications and document types:

• MEGA HOPEX
• IBM Rational DOORS
• IBM Rational System Architect
• Sparx Systems Enterprise Architect
• IBM Rational Rhapsody
• Microsoft Word
• Microsoft Excel
• Microsoft Powerpoint
• PDF

Choose the publication client that corresponds to your runtime platform and unzip the file to a folder of your choice.

Some connectors require updating the SECollabPublisher.ini file available in the unzipped folder, in order to add specific parameters.

• Rhapsody: add the JVM parameter rhapsody.omroot with Rhapsody's share folder as value, e.g. -Drhapsody.omroot=C:\ProgramData\IBM\Rational\Rhapsody\8.3x64\Share

Installing SECollab Publisher on Capella

The SECollab Publisher is integrated with Capella and needs to be installed using an update site.
In order to do that:

• Start Capella
• Click on Help > Install New Software ...
• In the Install popup, click on the button Add...
• Click on Archive... to browse on your computer files and select the Capella SECollab Publisher secollab-to-capella-update-site.zip file
• Enter a name for the new Repository, for example, SECollab Publisher for Capella
• Click Ok
• In the list, check the plugin Capella to SECollab, and click Next
• If you accept the terms of the license agreement, check the value I accept the terms of the license agreement and click Finish
• Restart Capella to finish the installation

Installing SECollab Publisher on MagicDraw

A MagicDraw Plugin has to be installed in order to run the publishing from MagicDraw. To install the plugin:

• Open MagicDraw
• Select Menu Help > Resource Manager
• Click on the Import button
• Select the MagicDraw plugin (file com.sodius.mdw.clm.client.tool.md.launcher.zip) provided with SECollab
• When MagicDraw finishes copying resource’s files, click OK
• Restart MagicDraw
• A new menu Tools > Publish to SECollab... is now available

Setting up the license agreement

On the first run, SECollab Publisher will ask the user to configure the local license or the license server. The administrator can pre-configure the location of the license to use, in view of the deployment of SECollab Publisher on multiple computers, so that each user does not have to perform this step on first use.

To pre-configure the license:

1. Edit the file <install_dir>/publisher/SECollabPublisher.ini
2. Insert the following line at the end of the file: -Dmdw.license=@serveurDeLicence (See possible values ​​below)
3. Save and close the file SECollabPublisher.ini
4. Then run the application to verify that the configuration is valid. If this is the case, you can then distribute the file <install_dir>/publisher to users.

The property mdw.license can reference two types of license locations:

• A license server, with the syntax port@serveur. The port is optional and usually does not need to be filled in. Example: @serveurDeLicence
• A license file deployed locally on the client device. The location must then be the absolute path of this local file. Example: c:\licences\secollab.lic

Example of the file SECollabPublisher.ini :

-startup
plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20140603-1326
--launcher.XXMaxPermSize
256m
-vmargs
-Xms40m
-Xmx2048m
-Dmdw.license=@serveurLicence

Configuring the User Interface Language

The SECollab Publisher user interface is available in English and French. The language selected by default is the one configured by default in the operating system.

The administrator can change the interface language if necessary:

1. Edit the file <install_dir>/publisher/SECollabPublisher.ini
2. Insert the following lines at the beginning of the file: -nl then fr (See possible values ​​below)
3. Save and close the file SECollabPublisher.ini
4. Then run the application to verify that the configuration is valid. If this is the case, you can then distribute the file <install_dir>/publisher to users.

The property -nl can have the following values:

• en: English
• fr: French

Example of the file SECollabPublisher.ini :

-nl
fr
-startup
plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20140603-1326
...

SECollab Publisher Application Verification

Run the file<install_dir>/publisher/SECollabPublisher.exe to launch the publication client.