| Prev | Next |
Pro Cloud Server Configuration
This topic discusses the configuration of the Pro Cloud Server. The main settings of the Pro Cloud Server are stored in the configuration file .\Services\SSProCloud.config which will be created and populated with the default values during the initial installation process. By design, subsequent installations/updates of the Pro Cloud Server will not change the contents of this file, so your settings will not be lost.
The Pro Cloud Server Configuration Clients (both Application and Web) are designed to manage all Pro Cloud Server settings, except SERVER_PORT which defines the Port on which the Pro Cloud Server service will listen for requests from the Pro Cloud Server Configuration Client application. By default the SERVER_PORT is set to 1803 (since PCS v5.0, but earlier versions used Port 803), we would expect this value to be acceptable for most environments; however, if this does not suit or you simply want to use a different Port this can be manually changed by editing the SSProCloud.config file using a text editor (*) and restarting the Pro Cloud Server service (**).
(*) Depending on the current user's permissions the SSProCloud.config might have to be edited using the 'Run as administrator' option.
(**) Restarting the Pro Cloud Server after manually changing its configuration file is necessary because it only reads the file as it starts up.
Configuration Summary
Below is a brief summary of the Pro Cloud Server configuration steps. These steps are covered in more detail in the topics below.
Step |
Details |
See also |
|---|---|---|
|
1 |
If necessary, edit the configuration file (.\Services\SSProCloud.config) and change the SERVER_PORT to a suitable Port, then restart the Pro Cloud Server Service. |
|
|
2 |
Use Pro Cloud Server Client (either the Windows Client or the Webconfig) to:
See the Pro Cloud Configuration Clients Help topic for details. |
Pro Cloud Server Configuration Client - Application Pro Cloud Server Configuration Client - Web |
|
3 |
Consider configuring additional Pro Cloud Server features, such as:
|
Floating License Server Integration Plug-ins WebEA |
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 (such as 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 of each of the Configuration Clients, see these Help topics:
Configuration Client Connection Settings
Normally the first settings you will see in the configuration file are to control how Pro Cloud Server Configuration Clients will connect to the server. The default values are:
SERVER_PORT=1803
ADMIN_WHITE_LIST=127.0.0.1|::1
Setting |
Description |
|---|---|
|
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 Pro Cloud Server using IIS Help topic. Note: When changing this setting, 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. |
|
ADMIN_WHITE_LIST |
ADMIN_WHITE_LIST defines a separated list of client IP addresses that are allowed to administer the Pro Cloud Server. If a client address attempts to logon to the Pro Cloud Server Configuration Client that is not specified in the White List they will be denied access. Default value: 127.0.0.1|::1 Supported Versions: PCS v4.1 and later This setting was added in PCS version 4.1, prior versions did not impose any restrictions on what client addresses could change the Pro Cloud Server settings. The default value is 127.0.0.1|::1, which grants access to the current machine hosting the Pro Cloud Server service, via its IPv4 address (127.0.0.1) and IPv6 address (::1). |
|
SERVER_PASSWORD |
SERVER_PASSWORD is the password to protect the administration functions of the server. As a security precaution this setting is encrypted and as such can only be changed by using the Configuration Client. This value should not be set or modified by directly editing the configuration file. Default value: pcsadm1n (value is stored encrypted) Supported Versions: All Note: The default value of this setting was changed in PCS version 4.1, prior versions did not define a default password. |
General Settings
This 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 in the Extended Server Properties Help topic under Pro Cloud Server Configuration Client - Application). There is no explicit limit for this default value. Note: If this setting is changed via one of the Configuration Clients, then a server restart is not required. |
|
AUDIT_TIME_PERIOD |
The number of seconds between the recording activities by system logs on each database. |
|
TEMP_DIRECTORY |
The location to which to write temporary files before they are sent to clients. Generally you should not change this, as there are security implications. 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 in the Extended Server Properties Help topic under Pro Cloud Configuration Client - Application). Note: If this setting is changed via one of the Configuration Clients, then a server restart is not 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 in which the Pro Cloud Server is installed; this is, 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 'SSProCloudServerLog-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 directly; this is available in all versions of Windows (see 'Control Panel | Administrative Tools | Services').
2) Using the Server Manager on Windows Server 2012.
