You can use command line options to change the way the operator interface starts. For example the --Connect option will automatically connect the operator interface to a Fernhill SCADA Server.
These command line options are supported:
| Option | Description |
|---|---|
| --Connect=CONNSTR |
Automatically connects the operator interface to a Fernhill SCADA Server. The
CONNSTR option value starts with a node name, which can be any of the following:
|
| --ConnectLocalService |
Automatically connects the operator interface to the Fernhill SCADA Server running on the local computer.
This is equivalent to: --Connect=localhost. |
| --DiagnosticMode |
Enables diagnostic mode. When enabled:
|
| --StartView=TAGNAME | Overrides the starting page to TAGNAME. |
| --Title=TITLE | Overrides the application window title to TITLE. |
| --Toolbar=POSITION |
Defines where the Operator Toolbar appears in the
Operator Interface.
POSITION can be one of these values:
|
| --FullScreen |
Starts the Operator Interface in full screen mode. To exit full screen mode, press F11. |
| --InactivityTimeout=TIME |
Sets an inactivity timeout.
For the TIME parameter use an IEC 61131-3 interval literal.
For example: --InactivityTimeout=T#5mIf there is no interaction with the Operator Interface for the TIME duration, one of the following actions will occur:
|
| --AutoRetryConnection=TIME |
Enables automatic retry of a failed connection to the Fernhill SCADA Server.
The TIME parameter is optional. If used, the TIME parameter should be an IEC 61131-3 interval literal.
For example: --AutoRetryConnection=T#15sLeaving out the TIME parameter is equivalent to: --AutoRetryConnection=T#30s |
| --RemoveUserRights=X |
Restricts the user rights for Operators using this Operator Interface.
The X parameter is a list of user rights to remove separated by the plus sign (+).
For the list of possible values, see User Rights. Examples:
|
| --OperatorIFLocation=L |
Sets the location of this Operator Interface.
Use the GetOperatorIFLocation Function to read the value of this parameter in:
|
| --NoOperatorMenu |
Removes the fixed-function
Operator Interface Menu.
Using this option implies the following options:
|
| --NoDisconnect |
Prevents the operator returning to the Operator Interface Start Page.
When this option is used:
|
| --NoSaveAs | Removes the "Save As..." option from the Operator Interface Menu. |
| --NoPrint | Removes the "Print" option from the Operator Interface Menu. |
| --NoHelp | Removes the "Help" option from the Operator Interface Menu. |
| --NoTooltips | Stops the display of tooltips. |
| --NoGraphicPanZoom | Disables pan and zoom operations on Graphic Pages. |
| --TouchScreen |
Enables touch screen mode. When enabled:
|
| --DetectLongPress | Enables long press detection for the left mouse button. This option allows operators to open a right-click context menu using a long press of the left mouse button. It is useful in situations where the operator interface is a touch screen with no mouse pointer. |
| --NoAlarmBellSound |
Starts the Operator Interface with the alarm bell sound disabled. For more information see Alarm Bell Sound. |
| --TimeZone=ZONE |
Overrides the time zone used to display date and time of day values. For example --TimeZone=America/Los_Angeles overrides the operator interface to display timestamp values in Pacific Standard Time. |
| --Locale=LOCALE |
Overrides the locale used to display messages in an alternative language. For example --Locale=de overrides the operator interface to display messages in the German language. Note: Translation of the user interface into alternative languages is work in progress. |
| --DateFormat=DFORMAT |
Overrides the way date values are displayed. For example --DateFormat=dd-MMM-yyyy overrides date values to show: date, month name, and year. For example 12-Mar-2019. See Date and Time of Day Format for the format of the DFORMAT value. |
| --TimeFormat=TFORMAT |
Overrides the way time of day values are displayed. For example: --TimeFormat=HH:mm.ss.SXXX overrides time of day values to:
|
| --ListAttributes=LATTR |
Defines the appearance of lists opened by any of these methods:
|
| --GraphicMode=MODE |
Selects the graphics API used to draw graphics. MODE can be one of these values:
|
| --ScreenDensity=D |
Sets the screen density of the display used for the Operator Interface.
The value D should be restricted to these values:
|
| --BarcodePort=PORT | Sets the serial port name of the optional barcode reader. Use --BarcodeSettings=X to set the communication settings of the serial port. |
| --BarcodeSettings=X |
Sets the serial communication format of the of the BarcodePort.
For information on the format of X, see Serial Port Mode String.
The default format is:Baud=9600 Data=8 Partity=N Stop=1 |
The first part of the CONNSTR option value is always the node name of the computer to connect to. You can append additional parameters to the CONNSTR option value to change how the connection is made. These additional parameters are supported:
| CONNSTR Parameter | Description |
|---|---|
| User=name | The username to login with. Use the special name Guest to login to the guest account. If this parameter is not used, the connection will try to use Windows Integrated Authentication. |
| Pass=secret | The password to authenticate the user with. This connect option is ignored if the User parameter is not included. |
| Port=number | Use this parameter to connect to a Fernhill SCADA Server using a non-standard port. If this parameter is not used, the default port number 20295 will be used. |
| BackupConnection=value |
The alternate connection to use if the main connection fails.
This value of this parameter can be any of the following:
|
| Timeout=value | The timeout for the connection in seconds. If this parameter is not used, the timeout defaults to 30 seconds. |
Use quotation marks to escape complex CONNSTR option values. For more information see Escape Option Values below.
Examples:
--Connect=scadasvr
Note: Windows integrated authentication requires both client and server computer to run Windows.
--Connect='192.168.1.5;User=Guest'
Note: This example uses Linux style single quotes to escape the option value.
For more information see Escape Option Values below.
--Connect="192.168.1.5;Port=30599;User=Guest"
Note: This example uses Windows style double quotes to escape the option value.
For more information see Escape Option Values below.
--Connect='192.168.1.5;BackupConnection=192.168.2.5;User=Operator;Pass=*****'
Note: This example uses Linux style single quotes to escape the option value.
For more information see Escape Option Values below.
The ViewName parameter of the command line option: --StartView=ViewName defines the first view shown to the operator. The ViewName parameter uses this syntax:
ViewName ::= full-tag-name { '?' type-name }
type-name ::= [ 'Graphic' | 'Trend' | 'ValueDurationPlot' | 'Text' | 'Alarms' ]
Where:
Examples:
| Example | Description |
|---|---|
| --StartView=Graphics.Index | Shows the Graphic Page Tag "Graphics.Index" to the operator. |
| --StartView=Graphics.Index?Graphic | Shows the Graphic Page Tag "Graphics.Index" to the operator. |
| --StartView=Example.River Levels?Trend | Shows the Trend Plot Tag "Example.River Levels" to the operator. |
| --StartView=?Alarms | Shows all alarms to the operator |
| --StartView=System?Alarms | Shows the alarms in the folder "System" to the operator |
The Operator Toolbar can appear in one of two locations:
The default behavior of the Operator Interface is to automatically choose the best location for the current screen orientation.
You can use the Toolbar option to override the default behavior:
| Option | Description |
|---|---|
| Auto | This is the default, where the Operator Interface chooses between Horizontal and Vertical. |
| Horizontal | The toolbar is placed along the top edge of the Window. |
| Vertical | The toolbar is placed along the left and right edges of the Window. |
| None |
No toolbar is displayed.
Note: This option is intended for use in kiosk applications where graphic pages provide their own navigation. |
Operating systems often provide more than one library for drawing graphics. For example in Windows:
The Operator Interface automatically chooses the best option for drawing graphics. You can override the automatic selection and tell the Operator Interface which graphics library to use. This table shows which modes are supported on the different types of hardware.
| Mode | Windows | Linux | Android | macOS | iOS |
|---|---|---|---|---|---|
| Direct3D | Yes | No | No | No | No |
| OpenGL | Yes | Yes | Yes | Yes | Yes |
| GDI | Yes | No | No | No | No |
| Cairo | No | Yes | No | No | No |
| RAW | Yes | Yes | No | Yes | No |
If you want to use spaces, or special characters, in a Command Option Value you will need to use quotation marks. The quotation marks tell the command line where a Command Option Value begins and ends. The type of quotation mark to use depends on the operating system you are using:
--Connect="localhost;User=X;Pass=Y"
--Connect='localhost;User=X;Pass=Y'
If you are setting up the Operator Interface to work in kiosk mode, the command line can get very long. You can use multi-line commands to make the command line easier to read.
On Windows, use the circumflex accent (^) to extend a command onto the next line. For example:
"C:\Program Files\Fernhill Software\Fernhill SCADA\FHViewApp.exe" ^
--Connect=192.168.1.10 ^
--Title="Equipment Monitoring Station" ^
--StartView=HomeScreen ^
--FullScreen ^
--TouchScreen ^
--NoDisconnect
Note: For a powershell command use a grave accent (`) to continue each line.
On Linux and macOS use a backslash (\) to extend the command onto the next line. For example:
FHViewApp \
--Connect=192.168.1.10 \
--Title='Equipment Monitoring Station' \
--StartView=HomeScreen \
--FullScreen \
--TouchScreen \
--NoDisconnect
To learn about the other features of the Operator Interface.
For an overview of how alarms are generated and managed.
For the meaning of terms used in Fernhill SCADA.