controller.properties

Edit the controller.properties file to create and configure global properties for the Remote Control controller component to use during a remote control session with a target. The property values apply to the controller component that is used in sessions that are started from the server. The values are the same for every user who runs the controller.

For more information about configuring global controller properties for peer-to-peer remote control sessions, see Configuring global controller properties.

Users can also configure a set of properties locally by using the Configure Controller feature in the controller UI. The local property values override the global property values. For more information about configuring local properties, see Creating a local configuration for the controller.

To enforce the global property value, you can set a property to mandatory so that a user cannot edit the property in the Configuration Window in the controller UI. The mandatory global property overrides the local property. To set a mandatory property, you must manually edit the controller.properties file. For more information about how to edit the file, see Editing the properties files.

To set a mandatory property, complete the following steps:
  1. Open the controller.properties file.
  2. For the property that you want to make mandatory, copy the property name and add .mandatory = true to the end.

    For example, to make the Enable Address History property mandatory so that it cannot be edited in the Configuration Window, set the following values:


    enable.address.history=false
    enable.address.history.mandatory=true

  3. Save the file.
  4. Click Admin > Reset Application.

For a detailed list of options, see Running tools on the target during a remote control session.

Preconfigured tools

The following list of tools are preconfigured and can be edited by using the Edit properties files option.
Note: Although the tools are preconfigured, they are displayed in the Perform action in target menu only if the command to run the tool is installed on the target. Therefore, some sessions can display all of the preconfigured tools and other sessions might display a few preconfigured tools. Windows™ tools are displayed only when you are connected to a Windows™ target. Linux™ tools are displayed only when you are connected to a Linux™ target.

tool01.ToolName = Control Panel
tool01.ToolCommand = [SystemFolder]\\control.exe
tool01.ToolParameters =
tool01.ToolUser =

tool02.ToolName = Command Prompt
tool02.ToolCommand = [SystemFolder]\\cmd.exe
tool02.ToolParameters =
tool02.ToolUser =

tool03.ToolName = Administrator Command Prompt
tool03.ToolCommand = [SystemFolder]\\cmd.exe
tool03.ToolParameters =
tool03.ToolUser = admin

tool04.ToolName = Task Manager
tool04.ToolCommand = [SystemFolder]\\taskmgr.exe
tool04.ToolParameters =
tool04.ToolUser =

tool05.ToolName = Windows™ Explorer
tool05.ToolCommand = [WindowsFolder]\\explorer.exe
tool05.ToolParameters =
tool05.ToolUser =

tool06.ToolName=Terminal
tool06.ToolCommand=/usr/bin/gnome-terminal
tool06.ToolParameters =
tool06.ToolUser =

tool07.ToolName=Control Panel
tool07.ToolCommand=/usr/bin/gnome-control-center
tool07.ToolParameters =
tool07.ToolUser =

Note:

If you need to add additional tools but there is no more room in the controller.properties configuration you need to manually edit this file on the Remote Control server. Stop the Remote Control server service before editing the file:
<server_install_folder>\wlp\usr\servers\trcserver\apps\TRCAPP.ear\trc.war\WEB-INF\classes\controller.properties.
You can create empty tool sections with progressive numbering then after the Remote Control server service restart you can proceed with the normal editing from the web interface as usual.

Sending key sequences to the target during a session

Configuration settings to add custom key sequence shortcuts to the controller to inject on the target system during a remote control session. For more information about of the supported key codes, see Send key sequences to the target during a remote control session. 
keyX.KeySequenceName=
Modifiable field keyX.KeySequenceName
Field Description Display name that is used in the Perform Action in target menu. Each defined key sequence name must have a different prefix. For more information, see Send key sequences to the target during a remote control session. X = 01 to n.
Possible Values User Defined. For example,

key01.KeySequenceName = Inject F1

The text, Inject F1, is displayed in the Perform Action in target menu.
Value Definition 
keyX.KeySequenceName.language=
Modifiable field keyX.KeySequenceName.language
Field Description Translations for the display name. This property is optional. X = 1 to n
Possible Values User Defined. For example,

key01.KeySequenceName.es = Inyectar F1
Value Definition 
keyX.KeySequenceValue=
Modifiable Field keyX.KeySequenceValue
Field Description Macro sequence. The sequences of keys that are defined here are sent to the target system. X = 1 to n
Possible Values User Defined. For example,

key01.KeySequenceValue = [F1]
Value Definition

End the session if audit messages cannot be uploaded to the server

Configuration setting to automatically end the session if audit messages cannot be uploaded to the server. 
abort.on.audit.fail=
Modifiable field abort.on.audit.fail
Field Description During a managed remote control session, when Force session audit is enabled, if the controller fails to send an audit message to the server, the session ends.
Possible Values true or false
Value Definition
true
The session ends automatically when an audit message cannot be sent to the server.
false
The session does not end when an audit message cannot be sent to the server.

Enabling and Disabling the execution of tools on the target during a remote session

To prevent the execution of tools on the target machine from Perform Action in target menu in the controller window, a new property has been added in trc_controller.cfg and controller.properties. Enabling this feature in the target removes the command entries in the Perform Action in target menu.
Property name Required Default Description
allow.user.commands Yes True Display/Hide the command entries under Perform Action in target menu.
To configure this controller property, complete the following steps:
Peer-to-peer sessions
  1. Edit the trc_controller.cfg file.
    Windows systems
    [controller install dir]\trc_controller.cfg

    Where [controller install dir] is the directory that the controller is installed in.

    Linux systems
    opt/bigfix/trc/controller/trc_controller.cfg
  2. Configure the property by setting true or false.
  3. Save the file.
Managed sessions
  1. Edit the controller.properties from the Server console.
  2. Configure the property by setting true or false.
  3. Save the file.