Install Sparx PCS and Prolaborate

1 Overview

This article describes the steps involved in setting up Prolaborate. It also describes the specific environment settings that are required in the database, web server and other supporting software.

2 Pre-requisites

2.1 Supported Operating Systems

  • Windows Server 2008 - SP2 Required
  • Windows Server 2008 R2 - SP1 Required
  • Windows Server 2012
  • Windows Server 2012 R2
  • Windows Server 2016
  • Windows 7 – SP1 Required
  • Windows 8 +
  • Windows 10

2.2 Supported Enterprise Architect Databases

  • SQL Server 2008 R2 and above (recommended)
  • SQL Server Express 2008 R2 and above
  • MySQL Server
  • Oracle Server
  • Postgres SQL Server

We don't support Firebird database as of now.

Note:
  1. If you are using MSSQL database, SQL Server Authentication mode should be enabled.
  2. If you are using Postgres database, run the following query in all the repositories: create extension hstore

2.3 Supported Databases for Prolaborate

  • SQL Server 2008 R2 and above (recommended)
  • SQL Server Express 2008 R2 and above
  • MySQL Server
It is recommended to use ‘SQL Server Authentication’ mode.

2.4 Disable FIPS Security

It is recommended that you disable FIPS. If FIPS is not disabled, password encryption cannot happen in Prolaborate and so you will not be able to login to Prolaborate.

Kindly refer to the appendix for details on how to disable FIPS.

2.5 Hardware Specifications

The following are the minimum requirements. The deployment will depend on usage and other environmental factors.

Memory 8.0GB
CPU 2.4 GHz x4
Disk (Operating System) 15 GB
Disk (Database) 5 GB

2.6 Software

The softwares that are needed are
  • Internet Information Service (IIS) 7.5 and above
  • Microsoft .Net Framework 4.5 and above.

It is recommended to install the .NET Framework after installing IIS. If you install IIS after installing .Net Framework, you will probably need to register ASP.Net for use with IIS Ports and protocols. Please refer Appendix for more details.

Note: Installation will fail if these softwares are not installed.

2.7 Supported Browsers

Prolaborate is compatible with following browsers:
  • Chrome 44 or above (recommended)
  • Firefox 38 or above
  • Safari 9 or above
  • Internet Explorer 10 or above

A minimum screen resolution of 1280x720 is required for the best use of Prolaborate.

2.8 Sparx Enterprise Architect

While it is fine to use any version of EA above 11, it is recommended to use EA 13.5 for optimal performance.

Please refer appendix for more details on the compatibility.

2.9 Sparx Pro Cloud Server License Key

Please obtain license key of Pro Cloud server from the Prolaborate team if you don’t have one.

2.10 EA Database Driver Versions

The following driver versions need to be used for optimal performance:

2.11 Optional Requirements

For optimized performance, please do the following:
  • Active Directory Access for Live Sync
  • SMTP configuration. (Access to SMTP Port and SMTP mail server)

The port numbers configured with SMTP and the Active Directory should be opened on Firewall Outbound rules on the network as well as the Machine where Prolaborate is installed.

  • SMTP (Default SSL Port: 465)
  • Active Directory (Default Port: 389)

Kindly refer to the appendix for further details.

3 Setup – Sparx Systems Pro Cloud Server

Please check out the step by step video tutorial of the complete installation process.

3.1 Install Pro Cloud Server

It is recommended to not have Sparx Enterprise Architect installed on the server where Pro Cloud Server is going to be installed.

The Pro Cloud Server installer is a standard Microsoft Installer; double click on it to start the installation and follow the onscreen steps.

3.2 Configure Pro Cloud Server

Kindly follow these steps to configure the Cloud Server:

  1. Open your text editor of choice with 'Administrator' privileges, then open this file: C:\Program Files (x86)\Sparx Systems\Cloud Services\Service\SSCloudServices.config
  2. Please locate this option near the top of the file: "LICENSE=" and add the license key that was provided in the purchase confirmation email sent by Prolaborate.

    The completed field should have this format: LICENSE={00000000-0000-0000-0000-000000000000}

  3. Note: the SERVER_PORT option is set to 803; we will need this later. Scan down the file looking for the first open parentheses (around line 28) and look for "SERVER_PORT=804". On the next line check whether this has been added: "OSLC_SUPPORT=1". This server port is the HTTP port that the Cloud Service will listen on.
  4. Now, save the changes to the SSCloudService.config file and close it.
  5. Open the standard Windows Services console (command "services.msc"), locate and select the service "Sparx Systems Professional Cloud", then restart it.
  6. Navigate to the folder C:\Program Files (x86)\Sparx Systems\Cloud Services\Client and run the SSProCloudClient.exe application. Sparx Systems Cloud Service Configuration client will open up. Enter the Server address of "localhost:803" and click on 'OK'.
  7. Click on 'Add' in the window and “Add Database Manager” window will pop up.
  8. Click on Browse icon near the Connection String field and Data Link Properties will popup. Select the DB type based on the DB of EA repository. Click on Next.
    1. Select or Enter the server name, Enter the login credentials and select database on the server. Click Ok and you the popup will close.
  9. Note: Test the connection to ensure the details are valid.
  10. Click Ok on the Add Database Manager window and entry will get added in the Cloud Service Configurations Client.
  11. Select the entry you just added and click on Configure. On the Configure Database Manager screen, select the 'Enabled' option under Database Manager and 'Enable extended OSLC interface for WebEA' option. Click on the 'Save'.
  12. Note: : Firewall rules will have to be adjusted to allow traffic between the [Web Server] and [Pro Cloud Server], on ports 804 and 805.

4 Install Prolaborate

Please note that Prolaborate database needs to be created before you proceed with the installation. Database server details like server name, database name, username, and password will be asked during the installation and you need to have them ready for the installation to continue. To know how to set up the database, please refer Appendix (Section 6.5 or 6.6)

4.1 Check Status Of Prerequisites

To start the installer, administrator privileges are required. Run the “Setup.exe” as administrator. The installer will check the status important components and show you the status. Click on “Next”

In the next dialogue box that appears, click on 'Next' to proceed.

4.2 Accept License Agreement

Please accept the terms in the license agreement to proceed with the installation.

4.3 Set Installation Mode

Choose the installation mode:
  • Automated Installation: Includes installation of Prolaborate components and required configurations (IIS setup, Database setup, Registry entry and configuration file setup).
  • The steps described further in this article is part of the Automated installation process.
  • Manual Installation: Prolaborate components will be installed but configuration (IIS setup, Database setup, Registry entry and configuration file setup) needs to be done manually.
  • Manual installation is little complex and so, you would need assistance from Prolaborate team.

4.4 Set Installation Path

Choose a path to install Prolaborate.

4.5 Configure Sql Server and Prolaborate Database

A full SQL Server setup or an Express edition setup will suffice.

Valid SQL server details (Database Host name, Username, Password and Database name) should be provided in order to proceed with the installation. To know how to set this up, please refer Appendix

Choose the installation mode to proceed further:

  • Fresh Installation: Create a Prolaborate scheme for the provided database.
  • Database already exists: No operation will be performed in the database.
Now, provide the SQL server details.

4.6 Configure Prolaborate Web App

4.6.1 IIS Server Setup

Port Number: Ensure that the Port is available and opened in the firewall settings.

Note: Set the Site URL to either the IP address or DNS. Do not use "localhost".

4.6.2 Setup Push Notifications

IP Address/ Host name : Machine IP or Machine name should be given

Port: Ensure that the Port is available and opened in the firewall settings.

4.6.3 Install Prolaborate

Please note down the login credentials shown in the installer. These are Super Admin credentials, with which you can login to Prolaborate.

Click on 'Install' to install Prolaborate.

Once the Installation is complete, the following screen will appear:

Select 'Finish' to complete the installation.

Note: Please set the Startup Type of Prolaborate Services(Prolaborate, Mailer, Lookup) to Automatic from Services (Task Manager > Services > Open Services).

5 Create Data Cache

If you have installed Prolaborate in a server which has Sparx Enterprise Architect 13 or up, you need to create Data Cache before going ahead. To do it, open Sparx Enterprise Architect and connect to the repository you are going to add in Prolaborate. Click on Options in the Configure tab. In the popup that opens up, under Data Cache, check the two check boxes and click on Create.

If you have installed Prolaborate in a server which does not have Sparx Enterprise Architect or has EA with version less than 13, just restart the Prolaborate services once after adding a repository to create Data cache.

Note: If you are using MSSQL database, SQL Server Authentication mode should be enabled.

6 Getting Started with Prolaborate

In order to get started with Prolaborate, please follow the below guides.

Install License - You will need to have the right licenses installed, for your users to have complete access to the application.

Add Repositories - A repository is the first thing you see once you login to your account. Prolaborate users can only manage repositories which they have access to; New Repositories can be created by the Prolaborate administrator only.

Configure Sections - You will need to define which packages from the EA are to be accessed through Prolaborate.

Set up Access Permissions -An admin can use this feature to give controlled access to users or groups in Prolaborate, the web platform for Enterprise Architecture.

Set up Guest Access - The guest sign-up feature allows anybody to quickly sign up and gain a read-only access to the application.

Configure SMTP - Emails for Activations, Notifications, Reviews, etc. are sent out from Prolaborate through the SMTP server. Thus, in order to receive emails without any issues, SMTP should be properly configured.

Setup Active Directory - The Active Directory feature enables the users, configured in your Active Directory, to login to Prolaborate with the same credentials.

Add Users- Users are the participants working together in a particular repository. Users can view and configure the repository as per their individual access rights provided by the Prolaborate administrator.

7 Appendix

7.1 Disable FIPS Security

Steps to Disable FIPS Mode:

Step 1. Press Windows Key+R to open the Run dialog.

Step 2. Type “gpedit.msc” into the Run dialog box (without the quotes) and press Enter.

Step 3. Navigate to 'Computer Configuration\Windows Settings\Security Settings\Local Policies\Security Options' in the Local Computer Policy.

Step 4. Locate the 'System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing' settings in the right panel and double-click on it.

Step 5. Set the setting to 'Disabled', click on 'OK' and restart your computer.

7.2 Register Asp .Net Libraries

Register ASP .NET libraries (for any OS older than Win 8.1):
  1. Run Cmd prompt in admin mode
  2. 32-bit Windows
    1. %windir%\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe –i
  3. 64-bit Windows
    1. %windir%\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe –i
  4. Restart IIS Server (using IIS Manager)

7.3 Sparx Enterprise Architect and Pro Cloud Server Compatibility Report

The following report gives details of the compatibility based on our extensive tests.

Server Server Server Client Client Client Client
Case # EA Worker Available EA Availability EA Version EA Version 13.5 EA Version 13.1 EA Version 12 EA Version 11
1 Yes Yes 13.5 Compatible Compatible Not Compatible Not Compatible
2 Yes Yes 13.1 Compatible Compatible Compatible Compatible
3 Yes Yes 12 Compatible Compatible Compatible Compatible
4 Yes Yes 11 Compatible Compatible Compatible Compatible
5 No Yes 13.5 Compatible Compatible Not Compatible Not Compatible
6 No Yes 13.1 Not Compatible Not Compatible Not Compatible Not Compatible
7 No Yes 12 Not Compatible Not Compatible Not Compatible Not Compatible
8 No Yes 11 Compatible Compatible Not Compatible Not Compatible
9 Yes No Not Applicable Not Applicable Compatible Compatible Compatible
Note: PCS version 2.0.15 was used for the analysis.

7.4 How To Open a Port

Make sure the firewall is enabled by confirming that "Firewall state" is set to 'On' and not to 'Off'.

Step 1: Open the Server Manager from the task bar.

Step 2: In the right-hand side of the top navigation bar, click on 'Tools' and select Windows Firewall with Advanced Security.

Step 3: Select either of the Inbound Rules under Windows Firewall with Advanced Security on the left side of the management console.

Step 4: From the right side of the Inbound Rules tab click on 'New Rule'. The new rule wizard launches.

Step 5: Select 'PORT' and click 'Next'.

Step 6: Select 'TCP' and click 'Next'.

Step 7: Select 'Specific local ports' and enter the Port number which needs to be opened and click on 'Next'.

Step 8: Select 'Allow the connection' and click 'Next'.

Step 9: Make sure all Domains, Private and Public are checked and click 'Next'.

Step 10: Specify the Name and Description for the port and click 'Finish'.

7.5 Setup Sql Server

7.5.1 Enable Sql Server Authentication

‘SQL server authentication’ must be enabled and an admin account must be created. The following settings must be accomplished

Step 1. Create a new Database called Prolaborate

Step 2. Create a new user by using the ‘New Login’ option under Security -> Login section

Step 3. Uncheck ‘Enforce password policy’

Step 4. Set the default database to ‘Prolaborate’

Step 5. Configure ‘Server Roles’, grant access to all admin privileges.

Step 6. ‘User Mapping’, maps the Prolaborate database to the new user.

7.6 Setup MySQL Server

Please follow the below steps:

Step 1. Open MySQL Workbench and create a new connection

Step 2. Open the new connection

Step 3. Create new schema

Step 4. Review SQL Script

Step 5. Apply SQL Sript

7.7 Setup Sparx Pro Cloud Server

7.7.1 Port Settings

Setting Description
SERVER_PORT

The port on which the server will listen for HTTP connections; each connection must be unique and not used by any other services on the machine. You must check that no firewalls are blocking this port on the client or server. You can use the standard HTTP port (80) or HTTPS port (443).

Note: When changing this, check firewall settings and other services using that port. Additionally, when the service is running on Wine you should not use privileged ports - those below 1024. Under Wine, most applications are only able to listen on ports above 1024.
REQUIRE_SSL

Should be set to 1 to enable HTTPS on this port; HTTPS should be enabled for all connections that are being exposed on public networks. HTTPS requires a private key file (server.pem), to be included in the same directory as the configuration file, before it will run.

Note: This unique file must be user-created. See Creating a Self-Signed Certificate using OpenSSL.
DEFAULT_MODEL Allows a single model to be exposed on a port, making it possible to use a different port for each model. Model names are discussed further in the Connecting Enterprise Architect to a Cloud Server topic.
MODEL_AUTHENTICATION

Can be set to 1 to request HTTP authorization using the user security defined in the Enterprise Architect model being connected to. Passwords must be explicitly and individually assigned in that model using the Maintain Users procedure; the default administrator password and any passwords imported from Windows Active Directory do not work. Note that if you are not using SSL to connect, the usernames and passwords will be sent in plain text. If the model does not have security enabled, the Cloud user is not prompted for a password.

This option is mutually exclusive with GLOBAL_AUTHENTICATION.

GLOBAL_AUTHENTICATION

Can be set to the name of an Enterprise Architect model with security enabled that will provide the list of users for all models accessed by the connection. This is helpful if you want to provide multiple models but only manage one list of users. Passwords must be explicitly and individually assigned in the reference model using the Maintain Users procedure; the default administrator password and any passwords imported from Windows Active Directory do not work.

This option is mutually exclusive with MODEL_AUTHENTICATION.

OSLC_SUPPORT

Enabled by default. It allows models to be queried using the 'Open Services for Lifecycle Collaboration' standard. This is discussed further in the OSLC Requirements Management topic.

Set to 0 to disable.

7.7.2 Cloud Services Configuration Client

Item Description
Database Managers This panel lists the defined repositories. Each row contains two columns of information - the database connection string of the repository and the number of active and available connections.
Refresh Click on this button to reload the contents of the 'Database Managers' list.
Add Click on this button to display the dialog on which you define a new database.
Remove Click on this button to permanently delete the selected database from the Cloud Server.
Configure Click on this button to display the dialog on which you change the settings for the currently selected database.
Server Options Click on this button to display the dialog on which you change the Cloud Server global options.

7.7.3 Cloud Services Logon Screen

Cloud services log on:
Option Description
Server Address

The Server Address format is:

(ServerURI):(Port)

The server URI can be ‘localhost’, an IP address, a DNS name or a machine name; for example, MyWebServer. If you are working on the web server, 'localhost' will be sufficient.

Password Enter the password you defined in Management Client Connection Settings, in the Cloud Server Configuration topic. By default this password is blank; you can reset it to a new value, as described in the Help topic Global Server Options.
OK Click on this button to log in to the Management Client.

7.8 Install .Net 4.5 Framework

Setup Microsoft .NET 4.5 Framework. Download the latest Microsoft .NET Framework 4.5 from Microsoft

Note: This step is not needed if you are running versions higher than Windows 8.0 and Windows Server 2012

7.9 Enable Internet Information Server (IIS)

7.9.1 Configure Windows Features To Turn On IIS

Step 1. Under Control Panel-> Programs -> Programs and Features -> Turn Windows features on or off.

Step 2. Click next on Installation Type and Server selection steps

Step 3. In Server Roles step, select Web Server. Click on Add Feature on the popup.

Step 4. In Features step, select ASP.NET 4.5

Step 5. In Role Services step, select Application Development and all the options under it. Click on Add Features if prompted.

7.9.2 Start IIS Server

Step 1. To start the server, type “inetmgr” in the Run Window and click on “Ok”.

Step 2. In the 'Internet Information Service Manager', select the Local host and click on 'start'.

Step 3. Expand the server and under 'sites', you will find the option 'Default Web Site'. Select this and click 'Start'.

Step 4. After starting the site, select 'Browse'. It should open the default website on the browser.

Step 5. Ensure that the Internet Information Services landing page is displayed in the default web browser.

Scroll to Top