OnDemand properties file

Edit the ondemand.properties file to create and configure properties for remote control sessions with on-demand targets.

The ondemand.properties file is used to configure properties that are used during remote control sessions with on-demand targets.
  • You can edit the file from the server UI by clicking Admin > Edit properties file.
  • You can also edit the file manually. The file is in the following directory:
    Windows operating systems:
    [installdir]\wlp\usr\servers\trcserver\apps\TRCAPP.ear\trc.war\WEB-INF\classes. [installdir] is the Remote Control server installation directory. For example, C:\Program Files (x86)\BigFix\TRC\server\wlp\usr\servers\trcserver\apps\TRCAPP.ear\trc.war\WEB-INF\classes
    Linux operating systems:
    [installdir]/wlp/usr/servers/trcserver/apps/TRCAPP.ear/trc.war/WEB-INF/classes. [installdir] is the Remote Control server installation directory. For example, /opt/Bigfix/server/wlp/usr/servers/trcserver/apps/TRCAPP.ear/trc.war/WEB-INF/classes
  • After you edit the file, you must click Admin > Reset Application.

Properties to customize landing page URL

The ondemand.url property is set to http://localhost/trc/ondemand/index.jsp?conncode=%c by default. Replace localhost with the address of your remote control server. To use a reverse proxy, replace localhost/trc/ondemand with the public fully qualified domain name of the broker that is configured as a reverse proxy. For example, http://broker.example.com/index.jsp?conncode=%c. For more information about configuring a reverse proxy, see On-demand target portal access for internet users. If you do not replace localhost, the value that is defined for the ServerURL property in the trc_broker.properties file is used to create the URL that is displayed to the controller. The %c variable is replaced with the session connection code when the URL is displayed in the controller window. The default page requires the session connection code to be entered.

You can also set the property to a URL for your own customized web page.
Table 1. How the URL is displayed to the controller user.
ondemand.url= ServerURL= URL is displayed as.
http://localhost/trc/ondemand/index.jsp https://mycompany.com/trc https://mycompany.com/trc/ondemand/index.jsp
http://www.mypage.com/ondemand/index.jsp https://mycompany.com/trc http://www.mypage.com/ondemand/index.jsp
http://www.mypage.com/index.jsp?conncode=%c https://mycompany.com/trc https://mypage.com/trc/ondemand/index.jsp?conncode=1234567

When the connection code is 1234567.

ondemand.url=
Modifiable field ondemand.url
Field Description URL for a page that the target user can access to start the process to download and temporarily install the target software.
Possible Values User-defined URL. For example, http://localhost/trc/ondemand/index.jsp
Value Definition Default value is http://localhost/trc/ondemand/index.jsp?conncode=%c

Properties to determine how the on-demand target is downloaded and started

ondemand.enable.plugins=
Modifiable field ondemand.enable.plugins
Field Description Determines whether the plug-ins (Firefox plug-in, Internet Explorer active X, or Java Applet) method is used for downloading and starting the on-demand target. For more information about the methods that are used to start the on-demand target, see On-demand target installation methods.
Possible Values true or false
Value Definition
true
Depending on the browser that is being used, the plug-ins (Firefox plug-in, Internet Explorer active X, or Java Applet) method is used for downloading and starting the on-demand target.
false
The plug-ins (Firefox plug-in, Internet Explorer active X, or Java Applet) method is not used to download and start the on-demand target.
ondemand.enable.executable=
Modifiable field ondemand.enable.executable
Field Description Determines whether the stand-alone executable file is used for downloading and starting the on-demand target. Also, determines whether a failover link to use the executable method is provided if the on-demand target fails to start. This failover link is provided when the plug-ins (Firefox plug-in, Internet Explorer active X, or Java Applet) method is used. For more information about the methods that are used to start the on-demand target, see On-demand target installation methods.
Possible Values true or false
Value Definition
true
If the ondemand.enable.plugins property is set to false the executable file is used to download and start the on-demand target.

If the ondemand.enable.plugins property is set to true, and the plug-ins are not detected or the Java plug-in is not installed or enabled, the executable method is used.

A failover link to use the executable method is provided if the on-demand target fails to start when the plug-in method or Java applet method is used.

false
The executable file is not used to download and start the on-demand target. A failover link to use the executable method is not provided if the on-demand target fails to start when the plug-in method or Java applet method is used.
ondemand.enable.jnlp=
Modifiable field ondemand.enable.jnlp
Field Description Determines whether the Java Web Start method is provided as an option for downloading and starting the on-demand target. Also, determines whether a failover link to use the Java Web Start method is provided if the on-demand target fails to start when the plug-in method, Java applet method, or executable method is used. For more information about the methods that are used to start the on-demand target, see On-demand target installation methods.
Possible Values true or false
Value Definition
true
If ondemand.enable.plugins and ondemand.enable.executable are set to false, the Java Web Start method is used to download and start the on-demand target.

If ondemand.enable.plugins or ondemand.enable.executable are set to true, a failover link to use the Java Web Start method is provided if the on-demand target fails to start when the plug-in method, Java applet method, or executable method is used.

false
A failover link to use the Java Web Start method is not provided if the on-demand target fails to start.

Properties to add custom fields to the web page that is accessed from the configured URL

Use the following properties to add custom fields to the web page that is accessed from the URL that is defined in the ondemand.url property. Four custom fields are available by default. To add more custom fields, manually edit the ondemand.properties file.
Note: After manually editing the file, restart the server service to display the new tools on the screen.
ondemand.custom.field.x.label=
Modifiable field ondemand.custom.field.x.label
Field Description Display name that is used for the extra input fields on the default web page that is used to start a session with an on-demand target. x = 1 - 9.

If you do not set a value for this property, the field is not displayed. For example, the following sample configuration would result in defining a custom Name field. The definitions for index 1 are discarded because no ondemand.custom.field.1.label is defined:

ondemand.custom.field.0.label=Name
ondemand.custom.field.1.required=true
ondemand.custom.field.1.label.fr=Numéro de téléphone

Possible Values User Defined. For example,

ondemand.custom.field.1.label=Name

The text, Name, is displayed on the web page menu.

Value Definition
ondemand.custom.field.x.required=
Modifiable field ondemand.custom.field.x.required=
Field Description Determines whether the custom field is a required field.
Possible Values True, False.
Value Definition
True
The target user must enter data in the field.
False
The target user can optionally enter data in the field.
ondemand.custom.field.x.label.locale=
Modifiable field ondemand.custom.field.x.label.locale
Field Description Translation for the custom field label name. x=1 - 9
Possible Values User Defined. For example,

ondemand.custom.field.1.label.fr=Numéro de téléphone
Value Definition If no translations are present for the locale of the browser, the value in the ondemand.custom.field.x.label property is displayed.

Properties to configure Lite Web Portal

liteweb.portal.enable=
Modifiable field liteweb.portal.enable
Field Description This enables the “Lite Web Portal” feature. It determines whether all accesses via the OnDemand channel related to the “Lite Web Portal” are accepted or rejected.
Possible Values True, False.
Value Definition
True
All accesses via the OnDemand channel related to the “Lite Web Portal” will be accepted.
False
All accesses via the OnDemand channel related to the “Lite Web Portal” will be rejected and Ignored. Default is False.
liteweb.portal.autodetect.url=
Modifiable field liteweb.portal.autodetect.url
Field Description The “Lite Web Portal” build the response by dynamically resolving the broker that has originated the request.
Possible Values True, False.
Value Definition
True
Set it to True when using the portal both from within the corporate network and from outside. Default is True.
False
When set to false, the liteweb.portal.url is used to build the responses.
liteweb.portal.url=
Modifiable field liteweb.portal.url
Field Description The URL of the Reverse Proxy Broker in the form https://hostname:port.
Possible Values User-defined URL in the form of https://hostname:port.
Value Definition Used only when liteweb.portal.autodetect.url is set to False.