Prev Next

Pro Cloud Server Configuration

This topic discusses the configuration of the Pro Cloud Server. There are several other configuration files associated with the Floating License Server, WebEA and Visibility Levels components of the server. The procedures for editing those files are described in the separate topics for those features.

The SERVER_PORT and SERVER_PASSWORD need to be set by directly editing the configuration file SSProCloud.config, which is found in your Service directory. To edit the configuration file, open it in a text editor (using the 'Run as administrator' option).

A number of additional general options can be defined in the config file as described here; however, these can typically be left with their default values.

After defining the Server Port/Password, you can open the Configuration Client and configure Ports and Model/Database connections.

Note:  It is important to realize that the Pro Cloud Server only reads the configuration file once, when it starts up.  If you manually change the options in the configuration file then the Pro Cloud Server must be restarted.

Configuration Client Connection Settings

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

     SERVER_PORT=803

     SERVER_PASSWORD=

Use of the Configuration Client is discussed in the Pro Cloud Configuration 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 Configuration Client, which means a full server restart will not be necessary.

SERVER_PORT

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

Note: When changing this, check firewall settings and other services using the 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.

General Settings

The next list of settings includes 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

DBMAN_DEFAULTMAXSIMQUERIES

The default for the maximum number of simultaneous 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 Pro Cloud Server Configuration Client topic). There is no explicit limit for this default value.

Note: if this setting is changed within a of the Configuration Clients, a full server restart will not be required.

AUDIT_TIME_PERIOD

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

TEMP_DIRECTORY

The location to write temporary files before they are sent to clients. Generally you should not change this, as there are security implication. For example the owning user of the Windows service will need full write permissions to this directory.

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 Pro Cloud Configuration Client - Application topic).

Note: if this setting is changed within a of the Configuration Clients, 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 Pro Cloud Server is installed.  ie by default 'C:\Program Files (x86)\Sparx Systems\Pro Cloud Server'

LOGGING_FILECOUNT

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

LOGGING_FILESIZE

Determines the maximum file size of each log file. Whenever the current log file has reached its maximum size a new log file is created as 'SparxCloudServicesLog-1.log' and all older ones have their number incremented.

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

Restarting the Sparx Systems Professional Cloud service

If you make any manual changes to the configuration file you must restart the service for the changes to take effect (unless otherwise stated). A service restart is carried out in the Windows Services application.

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

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

Restarting the Sparx Cloud Service

2)  Using the Server Manager on Windows Server 2012.

Restarting the Sparx Cloud Service

Pro Cloud Configuration Clients

With the release of version 3 of the Pro Cloud Server, Sparx Systems now offers two different Configuration Clients, the original Windows based application and the new web based application.  Each client is capable of managing the main settings of the Sparx Systems Pro Cloud Server.  We expect that most users will prefer to use the web based application, although it does require one extra step during setup, to install the web pages into a supported web server (like Apache or IIS).

Windows Application benefits

- no third party products required, you can connect to the Pro Cloud Server immediately after install using the default settings

Web based Application benefits

- can be configured to use SSL (HTTPS)

- one interface for all component settings

For details on each of the Configuration Clients, see the following topics:

Windows based application

Web based application

Learn more