Prev Next

Pro Cloud Server Installation

The basic installation process is quite straightforward. Typically you can simply download, and run the installer on your server, then follow the prompts.

Download the Installer

The Pro Cloud Server installer can be downloaded from the 'Registered User' section of the Sparx Systems website.

Installation Steps

If you already have the 'Sparx Systems WAN optimizer' or 'Sparx Systems Cloud Services' installed on your server we recommend you manually remove them before commencing the Pro Cloud Server Installation.

To remove any potential permission issues, we recommend that the installation is performed by a user with Administrator level permissions, to install follow these steps:

  1. Run the SparxProCloud.msi installer
  2. On the Welcome page, click the Next button.
  3. Read the End User Licence Agreement, and accept the terms outlined in it, and click Next button.
  4. The Readme Information page contains the minimum system requirements, so make sure that the host server meets the outlined requirements, and then click the Next button.
  5. The Custom Setup page allows you to choose what components of the Pro Cloud Server are installed, for the simplest installation (I.e. using the defaults), go straight to step 7.
  6. If you want to install specific components, for example, to have different components on separate machines, refer to the Pro Cloud Server Components table below, then return here to step 7.
  7. The Ready to Install page, is the last step before the installation begins, when ready click the Install button.
  8. The installation progression will be shown and once finished the wizard should state that the process has completed, click the Finish button.
  9. Now refer to the Pro Cloud Server Configuration Help topic.

https://sparxsystems.com//help/model_repository/cloud_server_configuration.html

To assist you in performing and understanding the installation process, watch the Sparx Systems webinar Setting Up Pro Cloud Server for Enterprise Architect. Click on the link to access this webinar.

Pro Cloud Server Components

The 'Custom Setup' page lists the various components that are available in the installer. Each component can be controlled separately by clicking the small disk image in front of the component name and selecting the option you require.

Component

Description

Pro Cloud Server service

This component is the Windows service that will accept connections from Enterprise Architect and the configuration client. For Pro Cloud Server, this includes the Sparx Systems Floating License Server. The default option is to install this component.

Generally, the only time you would choose not to install this component is when you have already installed it on one machine and are now installing other components on a different machine.

Management Clients

When the Management Client component is selected the Pro Cloud Server Configuration Client application will be installed, which supports the execution of management tasks, including:

  • Setting which databases a Pro Cloud Server can connect to
  • Configuring those database connections
  • Configuring what HTTP/HTTPS ports the Pro Cloud Server will listen on
  • Configuring various server options

The default option is to install this component; Sparx Systems recommends that the Configuration Client should be installed whenever the Pro Cloud Server service is installed.

WebConfig

This component installs the application files (PHP, CSS and JavaScript) for the Web Base Configuration Client ("WebConfig").

The default option is to install this component; you can unselect this component if you do not plan to use the Web Based Configuration Client.

WebEA

This component installs the WebEA application files (PHP, CSS and JavaScript) that enable a web user to view an Enterprise Architect model on a mobile, android or remote desktop machine without having to install Enterprise Architect on that device.

The default option is to install this component; you can unselect this component if you do not plan to use WebEA.

Integration Plugins

Integration Plugins or Server Based Plugin Interface (SBPI), this component installs the SBPI Server and all the SBPI Plugins that allow the Pro Cloud Server to read data from external products such as Dropbox, Jira and Team Foundation Server. There is a separate SBPI Plugin for each external product.

The default option is to install this component; you can unselect the component if you do not plan to link your Enterprise Architect models to external products.

Visibility Levels

Visibility Levels; this component installs a set of SQL scripts to be applied to your MS SQL Server 2016 + or Oracle based Enterprise Architect repositories.

The default option is install this component; you can unselect this component if you do not plan to use the Visibility Level functionality.

IIS Integration

An optional component providing integration with IIS.

The default option is to not install this component; however, if your server requires advanced authentication methods available through IIS then this component should be installed.

Installing New Versions

If you are installing a newer version of the Pro Cloud Server product then the new installer will automatically uninstall the old version. Before doing so, typically it is better to manually stop the 'Sparx System Professional Cloud' Windows service because the installer might have problems performing this task and will require the machine to be rebooted after the installation is finished.

Note:  The installer has been designed to not override any configuration settings of a previous installation.

Steps

1. Run the installer using the earlier installation steps.

2. The installer will have copied the newest version of  WebEA to the location specified during installation; if this location is not being used by your web server, you need to manually copy (and override) all WebEA files (except the includes/webea_config.ini file) from the installation folder to the web server folder.  See WebEA Note.

3. As above, if you use the WebConfig client you should copy the contents of the WebConfig folder (specified during installation) to the appropriate location on your Web Server, overriding the existing WebConfig files (except settings.php).

Upgrading from PCS3 to PCS4 Note: With the release of Pro Cloud Server 4 and default installation folder has been changed to C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\ and the configuration filename changed to SSProCloud.config.  This means that if you are upgrading from version 2 or 3 of the Pro Cloud Server to version 4 or later and you want to keep your existing configuration the old SSCloudServices.config file in C:\Program Files (x86)\Cloud Services\Service\ will need to be manually copied into the new installation folder, renamed from SSCloudServices.config to SSProCloud.config and the Pro Cloud Server Windows Service restarted.

Additionally because of the change of installation location all Firebird based database managers will need to be manually removed, their files physically moved from the old path to the new one and then re-added with PCS4.

Old Firebird model location:

'C:\Program Files (x86)\Sparx Systems\Cloud Services\Service\Models\'

New Firebird model location:

'C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\Service\Models\'

WebEA Note: In regard to WebEA, consider the situation that WebEA was installed to the default location and your website is being served by Apache in C:\Xampp\htdocs\webea, this command would perform the required copy and not override your existing configuration file in the live site:

robocopy "C:\Program Files (x86)\Sparx Systems\Pro Cloud Server\WebEA" "C:\xampp\htdocs\webea" /MIR /e /DCOPY:T /njh /ndl /nfl /xf webea_config*.ini

Firewall Note: The installer creates a Firewall rule for the Pro Cloud Server. This rule is removed and re-created during an upgrade. If you had previously modified this rule then you will need to apply these changes again after the Pro Cloud Server installation.

Learn more