SCADA Server Parameters

1. Fernhill SCADA
2. Help
3. SCADA Server
4. Parameters

Introduction

You can use the Fernhill SCADA Server Parameters to change how the SCADA Server runs. There are two places where you can set parameters:

• As parameters in the Server Configuration File.
• As options to the Server Command Line.

The recommended way to set server parameters is using the Server Configuration File.

SCADA Server Parameters

The Fernhill SCADA Server supports these parameters:

• Help
• Daemon
• PidFile
• TestConf
• GuestLogin
• RecordFailedLoginPassword
• WorkingFolder
• PortNumber
• Location
• MaxSQLResultSize
• ServerLogDetail
• ServerLogFolder
• ServerLogSize
• DriverLogDetail
• DriverLogFolder
• DriverLogSize
• HistoricDataFolder
• EventLogFolder
• EventLogRecords
• OpcUAServer
• OpcUAServerPort
• OpcUAServerLogDetail
• OpcUAServerWeakSecurity
• StandbyServerName
• StandbyServerBackupLink
• StandbyServerPort
• StandbyServerPassword
• StandbyTransferInterval

Help

Displays the supported commands and then stops.

Daemon

Runs the Fernhill SCADA Server as a daemon.

PidFile=FILE

Writes the process identifier of the daemon to a file. Intended for use with the systemd services manager. For more information see Manage the Fernhill SCADA Server with systemd.

TestConf

Tests the server configuration file then stops.

GuestLogin

Enables guest login with username 'Guest' and an empty password. This option also enables Anonymous login in the OPC UA Server.

RecordFailedLoginPassword

Enables recording of passwords of failed logins in the event log. Normally a failed login is recorded in the event log using this message:

An attempt to login failed: User 'XXXXXX'

When RecordFailedLoginPassword is enabled, a failed login is recorded using this message:

An attempt to login failed: User 'XXXXXX', Password 'YYYYY'

This option should only be used to help diagnose failed logins.

WorkingFolder=FOLDER

Changes the working folder to a different path.

PortNumber=PORT

Changes the port number the server listens on for connections.

Location=LOCATION

A text string describing the location of the Fernhill SCADA Server. If set, this string appears in the tag status report of the database root folder. This can help users of the Configuration Tool identity the server they are connected to.

MaxSQLResultSize=SIZE

Sets the maximum size of a result set of an SQL query.

ServerLogDetail=N

The level of detail in the server log files:

0. None
1. Create Delete
2. Request
3. Request Create Delete
4. Read Write
5. Reference Counts
6. Data

ServerLogFolder=PATH

The location of the server log files.

ServerLogSize=SIZE

The total size of all server log files.

Diagnostic information from the Fernhill SCADA Server is stored in a rolling set of log files. Each log file in the set is limited to a maximum size. When the current log file reaches the maximum size, a new log file is opened. When the total size of the log files reaches this parameter, the oldest log file is deleted.

DriverLogDetail=N

The level of detail in the driver log files:

0. None
1. Tasks
2. Raw Data
3. Alarms
4. Events
5. Commands
6. Tag State
7. Transaction
8. Transaction Analysis
9. I/O Calls
10. Timers
11. Tag Database Update

DriverLogFolder=PATH

The location of the driver log files. Note: The new path will be used when the Fernhill SCADA Server next starts.

DriverLogSize=SIZE

The total size of one set of driver log files.

The Fernhill SCADA Server usually creates multiple sets of log files for drivers. One log file set is created for each:

• Active driver
• Communication channel or logical connection

Each log file in the set is limited to a maximum size. When the current log file reaches the maximum size, a new log file is opened. When the total size of the log files in the set reaches this parameter, the oldest log file is deleted.

HistoricDataFolder=PATH

The location of the historic data files. When changing this parameter use these steps to avoid data loss:

1. Create the new folder.
2. Set a value for HistoricDataFolder in the Server Configuration File.
3. Shutdown the Fernhill SCADA Server.
4. Copy the existing historic data files to the new folder.
5. Restart the Fernhill SCADA Server.

EventLogFolder=PATH

The location of the files for the Event Log. When changing this parameter use these steps to avoid data loss:

1. Create the new folder.
2. Set a value for EventLogFolder in the Server Configuration File.
3. Shutdown the Fernhill SCADA Server.
4. Copy the existing event log files to the new folder.
5. Restart the Fernhill SCADA Server.

EventLogRecords=SIZE

The total number of records to store in the Event Log.

The size of one event record is 512 bytes. To calculated the total storage required by the event log, multiply this parameter by 512.

OpcUAServer

Whether the SCADA Server also runs the OPC UA Server.

OpcUAServerPort=PORT

The TCP Port number of the OPC UA Server.

OpcUAServerLogDetail=N

The level of detail for requests to the OPC UA Server:

0. None
1. Create Delete
2. Request
3. Request Create Delete
4. Read Write
5. Reference Counts
6. Data

If not set, the parameter default is 2 (Request).

OpcUAServerWeakSecurity

Whether the OPC UA Server enables the deprecated security policies Basic128Rsa15 and Basic256. By default these security policies are not enabled.

StandbyServerName=ADDR

The address of the computer running the standby Fernhill SCADA Server. The ADDR parameter can be:

• An IP Address, for example 192.168.1.5.
• A node name, for example SERVER1.
• A fully qualified domain name, for example server1.example.com.

StandbyServerBackupLink=ADDR

An alternative link to the standby Fernhill SCADA Server. The ADDR parameter can be:

• An IP Address, for example 192.168.1.5.
• A node name, for example SERVER1.
• A fully qualified domain name, for example server1.example.com.

StandbyServerPort=PORT

The TCP Port number of the standby Fernhill SCADA Server.

StandbyServerPassword=PASS

The password used to authenticate server to server communication. To set up a redundant server pair, both servers must use the same password.

StandbyTransferInterval=TIME

The interval between the transfer of changes from the main server to the standby server. The default interval is 2s (seconds). Use a smaller interval to reduce the delay in the transfer of data from the main to the standby server.

Note: Using a very small interval could result in high CPU usage in the SCADA Server.

Server Configuration File

The Server Configuration File is a text file that allows you to set SCADA Server Parameters. The location of the file depends on the operating system:

--WorkingFolder=FOLDER

In the Server Configuration File you can use any of the Server Parameters where Configuration File column contains a Yes. For example:

# Allow login with the username 'Guest' and
# an empty password.
# Type: Boolean
GuestLogin = True

Server Command Line

To set a Server Parameter on the command line, you should prefix the command with two hyphens (-). For example:

--GuestLogin=True

Where to enter Command Line Parameters depends on the operating system:

Further Information

Fernhill SCADA Server

To learn more about the Fernhill SCADA Server.

Fernhill SCADA

To learn about the tools in Fernhill SCADA.

To learn about configuring Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.

Fernhill SCADA Version 4.1 (20231126.1). Copyright © 2012-2023 Fernhill Software Ltd: All rights reserved.