Secure Global Desktop Administration Guide > Applets > Webtop script applet parameters

Webtop script applet parameters

The webtop script applet has the following parameters.

ParameterTypeDefaultDescription
AsadPortIntegerNo default

The TCP port the webtop tray or webtop script 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%%).

LoginGUIMaskInteger"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.

LogoutAfterInteger0 The number of minutes of the timeout period. If a webtop is idle for this period of time, the user is automatically logged out.

A value of 0 means do not automatically log out.

If the value is missing or not an integer, the value defaults to 0.

This parameter is only available to web browsers with Java™ technology enabled. It is not available to the Sun Secure Global Desktop Native Client.

Suspended applications are counted as running and so prevent automatic logout.

The applet checks for running sessions every 1/20th of the timeout period and so could miss short bursts of activity and wrongly log a user out.

The applet does not take into account print or client drive mapping activity and so, for example, a user could be printing when they are logged out.

ObjectCountInteger0

The number of links on the webtop.

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

ObjectNumberInteger0

The number from which links are numbered.

ScriptingBoolean"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.

TarantellaPasswordString""

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.

TarantellaUsernameStringNo 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.

TargetFrameString"DisplayFrame"

The name of the frame used to display document objects that don't have the Open In New Browser Window attribute set, and for application objects that have their Display Using attribute set to Webtop.

DisplayFrame (the default) is the frame used by the sco/tta/standard webtop theme.

UseHierarchyBooleanfalse

If set to true, enables webtop hierarchy mode and the scripting interface for manipulating the visible hierarchy.

Related topics