Cloud Server Configuration

Many configuration settings for the Cloud Server are set by directly editing the configuration file SSCloudServices.config found in your service directory.

To edit the configuration file, open it in a text editor (running as an administrator).

Once it is opened, you can edit the file to set configuration options, including the ports the server will listen on.

Management Client Connection Settings

The first settings you will see in the configuration file are to control how the Management Client will connect to the server. The default values are:

     SERVER_PORT=803

     SERVER_PASSWORD=

Use of the Management Client is discussed in the Cloud Server Management Client topic.

Setting

Description

SERVER_PASSWORD

SERVER_PASSWORD is the password to protect the administration functions of the server.

Note: This can be changed within the Management Client, which means a full server restart will not be necessary.

SERVER_PORT

SERVER_PORT is used when you connect to the Management Client or opt to use the IIS integration instead of the integrated web-server. For more detail see the Cloud Server Using IIS topic.

Note: When changing this port, check for other services on the same one. We recommend that this port is not exposed to any external networks, as encryption cannot be applied to it.

General Settings

The next list of settings is the default global settings across the entire service:

     DBMAN_DEFAULTMAXSIMQUERIES=10

     AUDIT_TIME_PERIOD=3600

     TEMP_DIRECTORY=%SERVICE_PATH%\Temp

     LOGGING_LEVEL=SYSTEM

     LOGGING_DIRECTORY=%SERVICE_PATH%\Logs

     LOGGING_FILECOUNT=3

     LOGGING_FILESIZE=1048576       

Setting

Description

AUDIT_TIME_PERIOD

The number of seconds between the system logs recording activity on each database.

DBMAN_DEFAULTMAXSIMQUERIES

The default maximum number of queries that can be run at a time for any configured database. This can be changed directly within the Management Client (see Default Max Simultaneous Queries under Global Server Options in the Cloud Server Management Client topic).

Note: As this can be set directly within the Management Client, a full server restart will not be required.

TEMP_DIRECTORY

The location to write temporary files before they are sent to clients. You should not generally need to change this.

LOGGING_LEVEL

Determines how verbose the server should be when writing log files. The valid values are: OFF, FATAL, WARNING, INFO and SYSTEM. The value can be changed directly within the Management Client. (See Log Level under Global Server Options in the Cloud Server Management Client topic).

Note: As this can be set directly within the Management Client, a full server restart will not be required.

LOGGING_DIRECTORY

Defines where the log files are to be stored. The default is set to:

     =%SERVICE_PATH%\Logs

Note: The =%SERVICE_PATH% refers to the directory where the Cloud service is installed.

LOGGING_FILECOUNT

Determines the maximum number of rolling log files kept. When the file count is exceeded, the oldest file is automatically deleted.

LOGGING_FILESIZE

Determines the maximum file size of each log file. When the logging file size is reached a new log file is created.

For more details on using the logs see the Cloud Server Troubleshooting topic.

Client Connection Settings

Using the Cloud Server you can define an arbitrary number of different ports on which to listen for connections from Enterprise Architect, each with a different configuration. Each port is denoted in the configuration file, with open and close parentheses, on their own lines.

     (

     SERVER_PORT=804

     REQUIRE_SSL=0

     DEFAULT_MODEL=

     MODEL_AUTHENTICATION=

     GLOBAL_AUTHENTICATION=user model

     OSLC_SUPPORT=1

     )

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.

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 in Cloud Server Installation.

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.

Restarting the Sparx Cloud Server

If you make any changes to the configuration file you must restart the server for the changes to take effect. A server restart is carried out in the Windows Services application.

Depending on the server operating system, there are two methods for restarting the Cloud Server:

1)  Using Window Services. This is available in all versions of Windows (see 'Control Panel | Administrative Tools | Services').

2)  Using the Server Manager on Windows Server 2012.

Notes

  • If you need to assign passwords to user IDs for a model or models that will be accessed via the Cloud, then:
  1. Open the reference model using a direct connection or via a Cloud connection on a port that does not have either MODEL_AUTHENTICATION or GLOBAL_AUTHENTICATION set.
  2. Enable security and assign a new administrator password.
  3. Open the Cloud Server Management Client for the new database and set the checkbox 'Require a secure and authenticated connection'. (Now that you have a valid account, this model will no longer be accessible without https and http level authentication.)
  4. Connect to the model on a port that does have an _AUTHENTICATION setting and use the Maintain Users procedure to assign passwords to the user IDs in the model.

Learn more