Book a Demo
Prev Next

WebConfig - Server Settings

The 'Server Settings' page provides various options and information regarding the Pro Cloud Server Configuration.

Server Settings

Item

Description

See also

Default Max Queries

Model connections can specify the maximum number of requests that can be serviced concurrently. This setting determines the default 'Max Simultaneous Queries' when defining a new model connection.

Default: 10

Logging Level

Click on the drop-down arrow and select the level of information to be written to the log file. The valid options are:

  • OFF - No logging is performed
  • FATAL - Only fatal errors are logged
  • WARNING - Warnings are logged
  • INFO - Information messages that provide general advice on what actions are occurring
  • SYSTEM  - More detailed messages
  • DEBUG - (new in PCS v4.1) Normally only used to help debug potential issues
  • TRACE - (new in PCS v4.1) The most detailed level of logging

Log Levels are cumulative; for example, the INFO level includes all messages of type FATAL, WARNING and INFO.

OSLC Session Time Out

To use an OSLC session each client must first log into a repository, however due to the stateless nature of HTTP/HTTPS requests the server does not always know when the client has completed their session and as such needs to enforce a timeout period due to inactivity.  This option controls that inactivity timeout period.  The timeout is important in situations where a PCS "Token" license is used. In this case, a token is considered 'consumed' as soon as the client sends the login request and it is released when the client logs out, however if the client fails to log out the token will stay consumed until the inactivity period is reached.

Click on the drop-down arrow and select the maximum time period, in minutes, after which an inactive OSLC user is logged out of the model.

Default Value: 30

Private App

Added in Pro Cloud Server v5.0.

When this value is checked the Pro Cloud Server does not include its Application Name, Version or Author on the HTML page returned to clients when its URL (e.g. http://localhost/:1804) is opened.

Default Value:  Unchecked

Manage PCS Licenses

Navigates to the 'Pro Cloud Server Licenses' screen, which allows you to add or remove Pro Cloud Licenses.

Change Password

Allows you to change the password for accessing the Cloud Configuration (or set a password if one has not already been set).

Changing or setting a password will also log you out of the Cloud Configuration, returning you to the login screen.

Export Config

Use this option to export the Pro Cloud Server settings to a file ('pcsconfig.pcscfg'). This includes the Server Settings, Model Connections, Port and Integration settings. This is particularly useful when moving the Pro Cloud Server Installation to a different server, or setting up multiple servers with similar configurations.

The exported file can be imported via the 'Import Config' option in the Pro Cloud Configuration Client Windows application. See the 'Extended Server Properties' topic for details.

Extended Server Properties

Admin White List

Added in Pro Cloud Server v4.1.

Default Value:  127.0.0.1 and ::1

The Admin Whitelist can be used to restrict access to the Pro Cloud Server configuration:

  • When using the Configuration Client (Windows Application), users will only be able to connect if their IP address is on the Whitelist.
  • When using WebConfig, the IP of the web server (hosting WebConfig) will need to be included in the Whitelist, which unfortunately means there is no way to restrict individual users, as all users request will arrive at the PCS with the IP of the web server.

Whether the IP address is represented as IPv4 or IPv6 depends on a number of factors (like the connection method, the type of client application, the client's operating system etc) however Sparx Systems would recommend that for each authorized user both their IPv4 and IPv6 numbers should be defined in the white list.

Use the 'Add an IP Address' button, and the Delete button in the Action column to maintain the client IP numbers.

Note:

  • An empty White List will allow all clients without any restrictions.
  • If WebConfig is hosted on the same machine as the Pro Cloud Server you will typically need to add 127.0.0.1 or ::1 to the admin whitelist.

Client White List

Default Value:  <empty>

The Client Whitelist allows you to configure what Enterprise Architect clients are authorized to communicate with the Pro Cloud Server. By default all clients are authorized, however if your environment requires a higher level of security then it is possible to limit exactly what clients can access the Pro Cloud Server.

Note, when using WebEA the IP of the web server (hosting WebEA) will need to be included in the whitelist, which unfortunately means there is no way to restrict individual WebEA users, as all users request will arrive at the PCS with the IP of the web server.

Whether the IP address is represented as IPv4 or IPv6 depends on a number of factors (like the connection method, the type of client application, the client's operating system etc) however Sparx Systems would recommend that for each authorized user both their IPv4 and IPv6 numbers should be defined in the white list.

Use the 'Add an IP Address' button, and the Delete button in the Action column to maintain the client IP numbers.

Note:

  • An empty White List will allow all clients without any restrictions.
  • If WebEA is hosted on the same machine as the Pro Cloud Server you will typically need to add 127.0.0.1 or ::1 to the admin whitelist.

Logged-in OSLC Users

The Logged-in OSLC Users table shows the list of users who are currently logged into models using OSLC.

Note :

  • Users logged into non-security enabled models will be represented as {User-<COUNT>} - for example : {User-1}

More Info

The 'More Info' section contains a number of read-only fields providing information regarding the Cloud Server Configuration.

Log File Count

The number of log files that should be retained. All logging is written to files named 'SparxCloudServicesLog-X.log' where X represents the file number.

File 'SSProCloudServerLog-1.log' is always the current file. When the maximum file size is reached, all existing files are renamed by incrementing the file number and a new 'SSProCloudServerLog-1.log' created.

Log File Size (bytes)

The maximum file size of each log file. When the file reaches this maximum, a new file is created.

Log Audit Time Period (sec)

The number of seconds between audit reports.

Log Directory

The directory into which the log files are saved.

Floating License Keystore

The full path of the Floating License Keystore file.

Floating License Group Config

The full path of the Floating License Keystore group configuration file.

Cloud Installation Directory

The directory into which the Cloud Server is installed.

Temp Directory

The Cloud Server Temp directory.

Learn more