Skip past navigation linksSecure Global Desktop 4.31 Administration Guide > Applets > X emulator applet parameters

X emulator applet parameters

The parameters in this topic may be used with the X emulator applet.

Applet parameters take precedence over object attributes. For example, if you have an application object with its Middle Mouse Timeout attribute set to 50, but display it in an HTML page containing the X emulator applet with its MiddleMouseTimeout parameter set to 100, the timeout will be 100 milliseconds. Applet parameters that override object attributes in this way are listed in the table below with a default of "Object attribute value".

Parameter Type Default Description
Application String Object attribute value

The full pathname of the application on the application server, for instance, /usr/local/bin/xclaim.

To enter command line arguments (such as -geometry), use the Arguments parameter.

To launch a complete Windows session, use - (a single hyphen).

ApplicationServer Host Object attribute value

The application server you want to run the application on.

Arguments String Object attribute value

Any command line arguments to the application, for instance, -geometry. Note that as the X Protocol Engine runs on the Secure Global Desktop server, you must not set the -display argument.

AsadPort Integer No default

The TCP port the emulator applet uses to communicate with the Secure Global Desktop server.

Use the placeholder %%ASADPORT%% to let Secure Global Desktop supply the correct value for this parameter. You should only enter a particular value for this parameter (rather than the placeholder) if you're sure you know what you're doing.

This parameter has no default value. Communication with the Secure Global Desktop server is only possible if you supply a valid TCP port number (or use %%ASADPORT%%).

BackgroundColor Color definition 000000 (black)

The background color.

Compression Boolean with automatic Object attribute value

Whether X protocol requests are compressed for transmission. Compressing requests can increase the performance of many applications. For some applications, however, compressing requests can decrease performance.

  • On specifies that X protocol requests are compressed for transmission.
  • Off specifies that X protocol requests aren't compressed for transmission.
  • Automatic specifies that Secure Global Desktop compresses X protocol requests only when it would increase the performance of the application.
ConnectionMethod Connection method Object attribute value

The mechanism for accessing the application server.

The settings telnet and rexec let you use the corresponding standard UNIX communication tools.

The setting ssh lets Secure Global Desktop servers communicate securely with application servers. This option is only available if you've already obtained and installed SSH.

Continuous Boolean with automatic Object attribute value

Whether X protocol requests are executed in order, or optimized for best performance.

  • On specifies that X protocol requests are optimized (may be executed out of order).
  • Off specifies that X protocol requests aren't optimized (are always executed in order). Use this mode for applications where the order in which requests are executed is critical (applications that use animation, for example).
  • Automatic specifies that Secure Global Desktop optimizes X protocol requests only when it would increase the performance of the application.
DelayedUpdate Boolean Object attribute value

Whether delayed updates of the display are allowed.

If you allow delayed update, Secure Global Desktop accumulates changes before updating the display. This can improve the performance of your application.

If your application's display must always be exact, use the value false.

Environment String Object attribute value

Any environment variable settings required by the application on the application server. Enter these in the form VARIABLE=Setting. To set more than one variable, use the parameter names Environment1, Environment2 and so on. For example, to set three environment variables, specify them as follows:

Skip past preformatted text<PARAM NAME="Environment" VALUE="Variable=Setting">
<PARAM NAME="Environment1" VALUE="Variable=Setting">
<PARAM NAME="Environment2" VALUE="Variable=Setting">
ForegroundColor Color definition FFFFFF (white)

The foreground color.

GraphicsAcceleration Boolean Object attribute value

Whether acceleration is allowed.

Acceleration optimizes how graphics are rendered and improves performance at the expense of smoothness and accuracy. For instance, colors may not always be accurate.

If your application's display must always be accurate, use the value false.

KeymapLocked Boolean Object attribute value

Whether the keyboard mappings are fixed. The value false means an X client can change the default keyboard mappings.

LoginGUIMask Integer "2"

A bitmask in the range 0 to 15 which controls the appearance of the Secure Global Desktop log in dialog.

The bits are as follows:

  • Bit 1 - controls whether or not the log in dialog box displays. This is where the user enters their username and password.
  • Bit 2 - controls whether or not the ambiguous/aged password dialog box displays.
  • Bit 3 - controls whether or not the error dialog box displays.
  • Bit 4 - controls whether or not the log in dialog displays before credentials are submitted. This forces the user to click OK to log in. The values for the username and password are taken from the TarantellaUsername and TarantellaPassword parameters.

If the value of this parameter is:

  • 0 - no dialog boxes display.
  • 15 - all dialog boxes display.

See Logging in with the Secure Global Desktop applets for details of when and how you use this parameter.

LoginScript String Object attribute value

The login script used to log in to the application server, for example unix.exp.

MiddleMouseTimeout Integer Object attribute value

The maximum time (in milliseconds) which may elapse between pressing the left and right mouse buttons.

This setting enables you to emulate the middle mouse button on a two-button mouse by pressing the left and the right mouse buttons in quick succession.

ObjectXFN String ""

The application object's TFN name.

Use the placeholder %%OBJECTNAME%% to let Secure Global Desktop supply the correct value for this parameter. You should only enter a particular value for this parameter (rather than the placeholder) if you're sure you know what you're doing.

Password String Password cache or prompt

A password to authenticate users on an application server.

If a valid password is specified, together with a valid username in the Username parameter, this username and password is used instead of any previously cached password for the authentication server.

If you don't specify values for both the Username and Password parameters, Secure Global Desktop uses a cached username and password, if available.

In all other circumstances (specifying a valid Password but not specifying a value for Username, for example), Secure Global Desktop prompts users for a valid username and password.

Users can still press the Shift key when they click a link to force Secure Global Desktop to prompt for this information.

PromptforAuth Boolean false

Whether to display a dialog box which prompts the user for third tier authentication.

Resumable String Object attribute value

The resumability model for the application. You can set this to never, session, or forever. Never means that the application can never be resumed and clicking the link always starts a new application instance. Session means that the application keeps running and is resumable until the user logs out of Secure Global Desktop. Forever means that the application keeps running after the user logs out of Secure Global Desktop, and can be resumed when they next log in. See the Resumability attribute.

RootColor Color name Object attribute value

The X emulator's background color.

This parameter only has an effect if you specify a RootType value of color.

RootType Root type Object attribute value

The appearance of the X emulator's background.

  • default means the X emulator's background uses the X windows default background pattern and color.
  • color means the X emulator's background is the color specified by RootColor.
Scottaappletheight Integer Object attribute value

The height of the application in pixels.

Scottaappletwidth Integer Object attribute value

The width of the application in pixels.

Scottaeurokeymapping String Object attribute value

The keycode mapping required by the application to support the euro character. The options are unicode and iso8859-15.

Scottafullscreen Boolean Object attribute value

Whether the application starts at the maximum size (true) or sized according to the Width and Height attributes (false).

Scottainterlacedimages String Object attribute value

How images are transmitted and displayed. The options are automatic, on and off. See Interlaced Images for details.

Scottamonitorresolution Integer Object attribute value

The monitor resolution (in dots per inch) which Secure Global Desktop reports to X applications asking for this information.

Scottantdomain String No default

The Windows domain to use for the application server authentication process.

Scottaprotocolarguments String No default

The command-line arguments to use with the Windows Protocol.

Valid settings depend on the Windows Protocol.

Scottashareresources Boolean Object attribute value

Whether emulator sessions for applications configured to Display Using client window management try to share resources.

Scottatrylocalwindowsapplication Boolean false

Whether to try starting the Windows application from the user's client device.

Scottawincursor Boolean false

Causes WinCenter to display the appropriate cursor from the Windows application in addition to the cursor from the client device.

This attribute applies to the WinCenter Windows Protocol only.

Although the WinCenter protocol is no longer supported, legacy windows application objects can continue to use it.

Scottawindowcloseaction String Object attribute value

What happens if the user closes the main application window using the Window Manager decoration. See Window Close Action for details.

Scottawindowsapplicationserver String No default

The full TFN name of application servers that can run the Windows application. For example, .../_ens/o=Indigo Insurance/ou=IT/cn=london.

If you don't specify an application server, the application may run on any Secure Global Desktop server in the array that supports that type of application.

Scripting Boolean "false"

This parameter is used with the scriptStart method to release/wake-up the applet.

If the parameter is missing or incorrect, the default of false is used.

SessionEndsWhen Session end type Object attribute value

What causes the X emulator session to terminate.

  • LastClient specifies that Secure Global Desktop maintains a count of the number of X clients running on a particular session. When this count reaches zero, the session terminates.
  • WindowManager specifies that Secure Global Desktop terminates the session when the window manager exits. This is irrespective of the number of X clients running in the window manager.
  • WindowManagerAlone terminates the session when the last remaining client is the window manager.
  • LoginScript terminates the session when the login script completes.
  • NoWindows terminates the session when no windows are visible. This is useful for window managers (such as OpenLook) that run X clients in the background.
  • LoginScriptNoWindows terminates the session when either the login script completes or no windows are visible. Use this for applications that are always resumable and that use X clients as this forces a session to close if an application server is re-booted or disconnected from the network.
TarantellaPassword String ""

The password the applet uses to log in to a Secure Global Desktop server.

If the value of the TarantellaUsername parameter is an empty string (""), the applet tries to log the user in anonymously (without a password).

If you are concerned about security, you may not want to use this parameter. Users can see the password you supply (by viewing the page source) and they may be authenticated to Secure Global Desktop as a different user.

See Logging in with the Secure Global Desktop applets for details of when and how you use this parameter.

TarantellaUsername String No default

The username the applet uses to log in to a Secure Global Desktop server.

If this parameter is used, the applet tries to log the user in to Secure Global Desktop using the values for the TarantellaUsername and TarantellaPassword parameters. If the value of this parameter is an empty string (""), the applet tries to log the user in anonymously (without a password).

See Logging in with the Secure Global Desktop applets for details of when and how you use this parameter.

TerminationFrame String Current frame

The frame in which Secure Global Desktop displays the URL specified by TerminationURL.

If no value is specified for TerminationURL, this parameter has no effect.

TerminationURL String ""

The URL to display when the emulator session terminates. It is displayed in the current frame, or in the frame specified in the TerminationFrame parameter.

By default, no URL is displayed when the emulator session terminates: Secure Global Desktop continues to display the HTML page containing the terminal emulator applet.

If you're using the sco/tta/standard webtop theme, you could set this to display.html to display the "Your Webtop" message when the emulator session ends.

Username String Password cache or prompt

A username to authenticate users with on the application server. This username is used to authenticate all users who run the application.

If a valid username is specified, together with a valid password in the Password parameter, this username and password is used instead of any previously cached password for the authentication server.

If you don't specify values for both the Username and Password parameters, Secure Global Desktop uses a cached username and password, if available.

In all other circumstances (specifying a valid Username but not specifying a value for Password, for example), Secure Global Desktop prompts users for a valid username and password.

Users can still press the Shift key when they click a link to force Secure Global Desktop to prompt for this information.

Note You may not want to use this parameter if you are concerned about security. Users will be able to see the password you supply here using their web browsers, and may be authenticated to the application server as another user.

ViewHostReply Boolean Object attribute value

Whether messages from the application server are also logged on the Secure Global Desktop server.

WindowManager String Object attribute value

Any command lines to execute additional applications on the application server. You can use this to run a window manager required by the main application. To set more than one, use the parameter names WindowManager1, WindowManager2 and so on. For example, to set three applications, specify them as follows:

Skip past preformatted text<PARAM NAME="WindowManager" VALUE="application">
<PARAM NAME="WindowManager1" VALUE="application">
<PARAM NAME="WindowManager2" VALUE="application">
Related topics