Topics
Prev Next

WebEA Quick Start Guide

The purpose of the WebEA Quick Start Guide is to provide the complete process for quickly installing and configuring WebEA in a new environment using the most common options.

The process is based on these assumptions:

  • A clean Windows 7 (or later) based machine has been selected to host both the Pro Cloud Server and Web Server; that is, no other Web Servers or applications are configured to listen on port 80
  • The latest version of XAMPP will be used to install Apache as the Web Server
  • The Small Business edition of the Pro Cloud Server is being installed
  • WebEA will access one brand new Firebird model (because it is the simplest, as it does not require any third party ODBC drivers)

1. Download the Pro Cloud Server

Step

Description

See also

1.1

When you purchase the Sparx Systems Pro Cloud Server the sales team will send you a link to download the installer.

2. Install the Web Server

Step

Description

See also

2.1

XAMPP is available at https://www.apachefriends.org/download.html. Download the latest version for Windows, to the machine's desktop.

2.2

The XAMPP installer should be run with Administration privileges; on the desktop, right-click on the XAMPP installer icon and select 'Run as Administrator'.

2.3

Proceed through the installation process, accepting the defaults until the Select Components screen displays.

Deselect these checkboxes: MySQL, FileZilla, Mercury, Tomcat, Perl, phpMyAdmin, Webalizer and Fake Sendmail. WebEA only requires the minimum XAMPP installation of Apache and PHP.

Click on the Next button.

2.4

The installation folder should be set to C:\xampp. Click on the Next button until the installation starts.

When the installation finishes, select the option to open the Control Panel, then complete the installation.

3. Configure the Web Server

With the default XAMPP configuration, the default website will use port 80. Its base folder is C:\xampp\htdocs.

Step

Description

See also

3.1

Using the XAMPP control panel, start Apache. No errors should be reported at this stage.

4. Install Pro Cloud Server

Step

Description

See also

4.1

The Pro Cloud Server installer is a standard MSI; double-click on it to start the installation.

Note: Depending on a number of factors, you might be prompted for the credentials of a user with elevated permissions; these must be entered before the installation will continue.

4.2

The 'Sparx Systems Pro Cloud Services Setup' dialog displays. Click on the Next button.

4.3

Read the license agreement and select the checkbox for indicating that you accept the terms. Click on the Next button.

4.4

Read the information about the Pro Cloud Server. Click on the Next button.

4.5

The 'Custom Setup' page displays. Click on the Next button to accept the defaults.

4.6

Click on the Install button to run the installation.

5. Configure the Pro Cloud Server

The Pro Cloud Server will have installed all of its files to the 'C:\Program Files (x86)\Sparx Systems\Cloud Services\' folder.

Step

Description

See also

5.1

Open your text editor of choice with 'Administrator' privileges, then open the file 'C:\Program Files (x86)\Sparx Systems\Cloud Services\Service\SSCloudServices.config'.

5.2

Near the top of the file, locate the option "LICENSE=" and add the license key that was provided in purchase confirmation email. The completed field should have this format:

    LICENSE={00000000-0000-0000-0000-000000000000}

Note: The SERVER_PORT option is set to 803; we will need this later.

5.3

Scan down the file looking for the first open parentheses (around line 28) and look for "SERVER_PORT=804". On the next line add:

     "OSLC_SUPPORT=1"

This server port is the HTTP port that the Cloud Service will listen on, so this is the port that both WebEA and Enterprise Architect will use.

5.4

Save the changes to the SSCloudService.config file and close it.

5.5

Open the standard Windows Services console (command "services.msc"), locate and select the service "Sparx Systems Professional Cloud", then restart it.

5.6

Navigate to the folder C:\Program Files (x86)\Sparx Systems\Cloud Services\Client and run the SSProCloudClient.exe application.

Enter the Server address of "localhost:803" and click on the OK button.

5.7

Click on the Add button and type the name 'fb-procloud.fdb' in the connection string field, then click on the OK button.

Select the new entry in the list and click on the Configure button.

On the Configure Database Manager screen, select the 'Enabled' and 'Enable extended OSLC interface for WebEA' checkboxes.

Click on the Save button.

For a more in depth explanation of how to add database managers, see the Help topic Add Database Manager.

6. Copy WebEA files to Website

Step

Description

See also

6.1

Copy the folder C:\Program Files (x86)\Sparx Systems\Cloud Services\WebEA\ to C:\xampp\htdocs.

7. Configure WebEA to access the model

To give a better demonstration of the WebEA options, we will define three different WebEA model connections. All will connect to the same physical Firebird database.

Each model connection will have its own set of options that control how users will be able to interact with the data.

Step

Description

See also

7.1

Open the file 'C:\xampp\htdocs\WebEA\includes\webea_config.ini' with a text editor.

7.2

In the "[model_list]" section, remove the 'model4' and 'model5' lines. Edit the remaining model names to:

model1 = "Pro Cloud Model (no updates)"

model2 = "Pro Cloud Model with discussions"

model3 = "Pro Cloud Model with access code"

7.3

In the "[model1 : settings]" section change the SSCS_DB_ALIAS option to "fb-procloud". The remaining default options should remain unchanged.

7.4

In the "[model2 : settings]" section change the SSCS_DB_ALIAS option to "fb-procloud". The remaining default options should remain unchanged.

7.5

Delete the "[model3 : settings]" and "[model5 : settings]" sections, rename the "[model4 : settings] section header to [model3 : settings]", then set these options as shown:

   sscs_port = "804"

   sscs_db_alias = "fb-procloud"

   sscs_port = "804"

   sscs_use_ssl = "false"

   sscs_model_user = ""

   ssc_model_pwd = ""

   auth_code = "password01".

   login_prompt = "false"

7.6

Save the changes to the file webea_config.ini in C:\xampp\htdocs\WebEA\includes.

8. Configure your firewall(s) to allow client access

Step

Description

See also

8.1

Firewall rules will have to be adjusted to allow traffic between the [Client] and [Web Server], on ports 80 and 443.

8.2

Firewall rules will have to be adjusted to allow traffic between the [Web Server] and [Pro Cloud Server], on ports 804 and 805.

9. Use Enterprise Architect to add content

The initial Firebird model we created earlier will be empty. The easiest way to add content to the model is with Enterprise Architect.

Step

Description

See also

9.1

On a client machine with access to the web server, open Enterprise Architect v12 or later.

9.2

From the main menu select 'Open Project...' or, from the ribbon, select the ' > Open Project' option.

9.3

Click on the Connect to Cloud button.

9.4

On the 'Cloud Connection' screen set these parameters:

Name: fb-procloud

Protocol: http://

Server: {your servername}

Port: 804

Model Name: fb-procloud

Click on the OK button.

9.5

Create a sample set of Model Views, Packages, diagrams and elements, so that they can be viewed in WebEA later.

10. Configure automatic viewable components

In a traditional Enterprise Architect model, saved diagrams and linked documents are not stored in a viewable format that browsers can use, so in order for WebEA to view them Enterprise Architect has to be configured to save HTML compatible versions of these components each time they are updated. The Pro Cloud Server includes a 'worker' application that can be automated to save HTML compatible versions of diagrams and linked documents.

Step

Description

See also

10.1

On the Web Server machine, navigate to the folder C:\Program Files (x86)\Sparx Systems\Cloud Services\.

10.2

Create a new 'Scripts' folder and open it.

10.3

Create a new text file and name it 'fbprocloud.eap'. Notice the .EAP extension; this is important.

10.4

Open the file 'fbprocloud.eap' with a text editor, and paste the following text on a single line (that is, without any carriage returns):

     EAConnectString:fbprocloud ---;Connect=Cloud=protocol:http,address:localhost,port:804;Data Source=fb-procloud;

Save the changes and close the file, but leave the text editor open - we will need it for the next step.

10.5

Using the text editor, create a new file called 'autogen_fbprocloud.cmd' (in the same folder as for the previous step) with the contents:

"C:\Program Files (x86)\Sparx Systems\Cloud Services\Service\Worker\EA.exe"/cloudupdate:30 "fbprocloud.eap"

Note: All text should be entered on a single line.

Save the changes and close the file.

10.6

Double click on the 'autogen_fbprocloud.cmd' file to run it.

Note: EA Worker does not provide any feedback to the console as it runs; the command window will remain open if everything is correct, but if it closes a problem has occurred while the Worker was trying to make a connection to the model. If this occurs, double check all your settings.

Sparx Systems recommends that this batch/command file is added to Startup so that it runs automatically when the server starts.

For a more in-depth explanation of how to configure automatic viewable components, see the Help topic How to configure automatic viewable components.

11. Test WebEA access

Step

Description

See also

11.1

On a client machine, open an internet browser and enter the URL http://{yourwebserver}/WebEA/login.php, where the value '{yourwebserver}' is either the name or IP number of the machine hosting the WebEA website. The WebEA login screen displays, listing the three model connections we defined earlier:

  • Pro Cloud Model (no updates)
  • Pro Cloud Model with discussions
  • Pro Cloud Model with access code

11.2

Select the first model connection - Pro Cloud Model (no updates) - and click on the Next button. This connects you to the model and displays the model views that are defined.

From here you should be able to navigate through the model by selecting Packages, diagrams and elements. When you select an element, its complete details are displayed. Because of the way this model connection is defined, the bottom of the properties section will NOT contain the 'Discussions' section.

11.3

Click on the 'hamburger' icon in the top right corner of the display, and select the 'Logout' option. Then select the second model connection - Pro Cloud Model with discussions - and click on the Next button. You should see the same model views as before; now navigate to an element and confirm that the 'Discussions' section is visible.

11.4

Once again, click on the 'hamburger' icon in the top right corner, and select the 'Logout' option.

Select the third model connection, 'Pro Cloud Model with access code' and click on the Next button. This time you should be presented with a prompt for the Access Code; enter 'password01' (as we defined in step 7.5) and click on the Login button. You should see the same model views as before. Navigate to an element; this time there should be a blue 'hamburger' menu in the element details area that allows the creation of element features such as tests and resource allocations. There should also be a pencil icon next to the element notes area that, when clicked on, will allow the modification of element notes.

Complete

This quick start procedure is now complete. It has shown you how to install and configure a basic installation of WebEA. The Sparx System's online Help documentation has more detailed instructions and explains all possible options that can be configured. See the section 'Model Repository | Cloud Based Repositories | Pro Cloud Server' in the Enterprise Architect online Help.