Several aspects of the client behavior can be configured in the text based configuration file /home/satnms/client.properties. The following chapter descripes the different option and related functionalities.
All chances in this file we be applied for every client which connects to the server after this configuration file was written.
Addressing users and hosts
All keys in this file may be prepended by a user name (the user name to log into the sat-nms GUI) or a host name. If the value for a key 'some.key' is searched, the software first tries 'user.some.key' where 'user' is replaced by the current user's login name. If this key was not found, it tries 'hostname.some.key' where hostname ist the client's host name as reported by the operating system. If this also fails, the as the last fall back the plain key is searched.
This search method gives the capability to overwrite some client properties for specific users or client hosts.
Examples:
## disable edit/take mode for client with hostname "pc1":
pc1.gui.useEditTake=false
## disable edit/take mode for sat-nms user "user1" on any client pc:
user1.gui.useEditTake=falseTime zone settings
By default the sat-nms software displays all timestamps in UTC. you may change this with the timezone parameter. IF CHANGED, THE PARAMETER MUST BE CHANGED IN BOTH, vlc.properties AND client.properties TO THE SAME VALUE !!
Examples for non-UTC time zones:
timezone=GMT+03
timezone=GMT-10Exclusive login
Setting this true enables _exclusive login*, meaning that only client may be logged in at a time.
login.exclusive=false
login.exclusive=trueWhen trying to login on a system with enabled exclusive login* and there is already another user logged in, the login dialog will report this with the message another client is logged in and gives you the option to *FORCE your own login and kick out the connected user. Forcing login is only possible with an administrator account (privilege level 150)
Primary client
Setting this to an IP address of a certain client computer gives this client instance an exclusive priority: no other client may force the log out of the primary client, but the primary client may log out any other client.
This option is meaningful only if login.exclusive=true
A typical application scenario is, that a client installed at the antenna site should be able to block a remote connected users.
login.primary=192.168.0.101Automatically timed logout
Setting this to a value greater 0 enables automatically logout of users sat-nms client users after the given number of minutes of (user-) inactivity.
To make special setting for a given user or host add username or hostname in front of autologout parameters. By default this automatically logout is disabled (0).
Example disable autologout for user _operator* but set it to 5 minutes for all others:
## other users
operator.autologout=0
autologout=5Device list windows access level
The privilege level necessary to open the device list in the toolbar in the VLCFrame / MCFrame windows. Default required privilege level to open the device list windows is 100 (operator).
devicelist.privilege=110Config parameter access level
The privilege level necessary to change device setup parameters at the maintenance / setup window.
Default is 150, select a lower number will allow different users than normal administrators to change these settings. Recommendation is to define users with level 140.
configParameters.privilege=140Macro scheduler access level
This defines the privilege level necessary to edit the schedule of the system macro scheduler.
scheduler.privilege=110Screen element background color
True makes the configured background color of disabled screen elements override the system 'disabled' background. Works only with entry fields, read-only fields and with the searchable drop down list field.
gui.overrideBackground=trueLook and feel of read-only elements
True lets read-only elements look "enabled" even if the operator is not logged in. This is the way, satnms2 did show read-only fields. Default is false
gui.keepReadOnlyEnabled=trueEdit/Take mode
True makes the user interface use the edit/take mode for all device screens. This option change the behavior of device screens. With enabled edit/take mode commands will be not send directly if you enter a new value or select a dropdown entry. But all device windows will show 2 additional buttons : EDIT and TAKE.
The EDIT button enables all read/write parameter fields to change the values and the TAKE button send all changed parameters to the device.
By default this mode is disabled.
gui.useEditTake=true*Event sort order
True makes the event report and event log windows sort recent fault messages first (on top). Default is false.
gui.eventSortRecentFirst=trueFault list window background color
If set true, in the fault list window warnings are shown with a yellow background, faults with a red background (may be changed by a toolbar button of the window)
gui.faultListColored=trueFault list window line color
If set true, the fault list window sorts the lines fist by device, then by time (may be changed by a toolbar button of the window)
gui.faultListByDevice=trueSuppress warnings fault list window
If set true, the fault list window suppresses all warnings (may be changed by a toolbar button of the window)
gui.faultListSuppressWarnings=trueSuppress signal on emblem
True prevents device icons showing the 'signal on' emblem, even if the device state is recognized as 'signal on' and an image file for the emblem has been found.
gui.suppressSignalOnEmblem=trueNew fault popup
If set true, each new fault makes the fault list window pop up (or come to front). applies only to the M&C client. The -o command line switch of satnms3.gui.MCFrame has the same effect.
gui.faultListPopUpOnNewFault=trueShow tree view button
True makes the M&C client window show a toolbar button to launch a tree view window, false suppresses this button. This feature is enabled by default, the tree view button is shown if this definition is missing
gui.showTreeViewButton=trueTree view default device icon
The treeview client/window uses this device icon to build dynamically generated device screens.
gui.treeview.dynamicDeviceIcon=device-rectangle.gifAlternative Switch icon set
Define different switch icons for the screen editor
gui.editor.predefinedSwitch.1=cwgswitch
gui.editor.predefinedSwitch.2=cwgswitch-mirrored
gui.editor.predefinedSwitch.3=ccxswitch
gui.editor.predefinedSwitch.4=ccxswitch-mirrored
gui.editor.predefinedSwitch.5=clswitch
gui.editor.predefinedSwitch.6=crswitchVLC player integration
The full path of the VideoLAN media player. Required to run the VLC player on Windows client machines from a "VideoLAN" frame button.
Backslashes must be doubled, the whole path must be enclosed in double quotes if it contains spaces. You can also defined this setting by host to target client PCs with different operating systems.
videolan.exe="vlc.exe"
videolan.exe="C:\\Program Files (x86)\\VideoLAN\\VLC\\vlc.exe"Event DB
Defines the IP Address of the EventDB Server used by the client to show the Eventlog. This is usually not configured: The Client will use the IP address of the MNC server.
In case the EventDB is not available locally on the MNC server but on any other machine you can configure here the IP address of the "external" EventDB Server.
eventdb.server=10.10.1.111