Prev Next

Cloud Server Installation

The basic installation process is quite straightforward and you, as the System or Network Administrator, can install and/or configure some of the components at a later time, allowing you to set up your working service in stages.

As outlined in the Introducing Cloud Services topic, there are 3 different Cloud Services products available. Each of these products has its own installer. Ensure you use the appropriate installer based on your requirements and licence/s:

Installers

Product

Access

Sparx Systems Cloud Services
(SparxCloud.msi)

This installer can be downloaded from the 'Registered User' section of the Sparx Systems website:

https://sparxsystems.com.au/registered/index.html#cloud-services

Sparx Systems Pro Cloud Server Express
(SparxProCloudExpress.msi)

If you have requested and received a Pro Cloud Server Express license then you will have received an email with a link to the installer.

Sparx Systems Pro Cloud Server
(SparxProCloud.msi)

If you have purchased the Pro Cloud Server you will have received an email with a link to the installer.

Installation Steps

If you already have the  Sparx System WAN optimizer installed on your server we recommend you remove it before starting the Cloud Server Installation.

The installer requires you to have Administration rights; right-click on the installer (msi file), select 'Run as Administrator', then perform the following steps:

  1. Click on the Next button.
  2. Select the option to accept the End User Licence Agreement.
  3. Click on the Next button on that page, and on the next two pages of the dialog, to display the 'Select Features' page.
  4. For a simple default installation on the one machine, go straight to step 6.
  5. If you want to install only specific components, for example, to have different components on separate machines, refer to the Cloud Server Components table and the Installation Options table, then return here to step 6.
  6. Click on the Next button. The system installs the Cloud Services components and displays a message to indicate success.
  7. Click on the Finish button. Now refer to the Cloud Server Configuration Help topic.

Cloud Server Components

The 'Custom Setup' page lists the various components that are available in the installer.  There is some variation to the component presented depending on which product/edition of the Pro Cloud Server is being installed.

For example the Pro Cloud Server Express will present:

  All Features

+ Pro Cloud Services

+ Management Client

+ WebEA

- IIS Integration

While the "Pro Cloud Server" will present:

   All Features

+ Pro Cloud Services

+ Management Client

+ WebEA

+ Integration Plugins

+ Visibility Levels

- IIS Integration

Each component can be controlled separately by clicking the small image in front of the component name and selecting the option you require.

Component

Description

Cloud Services

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 Client

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

- setting which databases a Cloud Service can connect to

- configuring those database connections

- configuring what HTTP/HTTPS ports the Cloud Service will listen on

- configuring various server options

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

WebEA

(For a Pro Cloud or Pro Cloud Express Installation); 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

(For a Pro Cloud installation) Integration Plugins or Server Based Plugin Interface (SBPI); this component installs the SBPI Server and the SBPI Plugins that allow the Pro Cloud Server to read data from external products, like Dropbox, Jira and Team Foundation Server.

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

Visibility Levels

(For a Pro Cloud installation) 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 same Cloud Server product then the new installer will automatically uninstall the old version, if however you are installing a different product, (ie you previously had Pro Cloud Express and you are about to install Pro Cloud) then you will need to manually uninstall the original product.

If you choose to perform a re-install typically it is better to manually stop the Sparx System Cloud Server service because the installer may 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 installation steps described above.

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 will 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 below.

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, the following command would perform the required copy:

robocopy "C:\Program Files (x86)\Sparx Systems\Cloud Services\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 Cloud Service. 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 Cloud Service installation.

Learn more