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

Webtop tray applet parameters

The webtop tray 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%%).

AttachLabelToSide indicatoriconright

The side of the icon where labels appear.

BorderWidthInteger1

The width of the border that the webtop tray applet draws around highlighted links. Typically, you'll use values in the range 0 to 10. Use the value 0 to specify that highlighted links don't have a border.

BottomMarginInteger0

The gap between the webtop tray's bottom edge and the bottom of the last link. (If LayoutStyle is horizontal, this is the gap between the webtop tray's bottom edge and the bottom of all links.)

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%BOTTOMMARGIN value%%. For example, to use a value of 10: <param name="BottomMargin" value="%%BOTTOMMARGIN 10%%">.

DisplayOrderorderorganization

The order in which to display links.

HostBackgroundColorColor definition255,255,255 (White)

The background color of the webtop tray applet.

IconSizeInteger32

The size of any icons used to display links.

You can set this to 16 (16 x 16 pixels), 24, 32 or 48.

If you specify a size for which no corresponding images exist, Secure Global Desktop doesn't display icons as part of links (just as if you had specified ShowIcon to be false).

IconThemeStringsco/tta/standard

The icon theme of any icons used to display links.

If you specify a theme that doesn't exist, Secure Global Desktop doesn't display icons as part of links (just as if you had specified ShowIcon to be false).

IconToLabelGapInteger8

The gap between icons and their labels.

If ShowLabel or ShowIcon are set to false, this setting is ignored.

LabelColorColor definition0,0,0 (Black)

The color of links' labels.

LabelFontFamilyFont familyBrowser dependent

The font used to display links' labels.

LabelFontSizeIntegerBrowser-dependent

The point size of the font used to display links' labels

LabelFontStyleStyle indicatorplain

The style of font used to display links' labels.

LaunchWaitTimeOutinteger0

How long (in seconds) an application launch is assumed to take if the server doesn't notify the client that a launch has succeeded or failed. The webtop tray applet uses this parameter to reset a link to its default state (no highlighting).

LayoutStyleLayout indicatorvertical

How links appear on the webtop, either vertically (in a column) or horizontally (in a row).

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%LAYOUTSTYLE value%%. For example, to use a value of vertical: <param name="LayoutStyle" value="%%LAYOUTSTYLE vertical%%">.

LeftMarginInteger0

The gap between the webtop tray's left edge and the links' left edges. (If LayoutStyle is horizontal, this is the gap between the webtop tray's left edge and the first link's left edge.)

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%LEFTMARGIN value%%. For example, to use a value of 10: <param name="LeftMargin" value="%%LEFTMARGIN 10%%">.

LoggedInAsFormatstring""

The form of message displayed in the status bar when users move the cursor over the webtop tray applet's background.

The placeholder %%PERSONLABEL%% is replaced with the current user's name and connection type. For example, with the value "You are %%PERSONLABEL%%", users see a message like "You are Mulan Rouge (standard connection)".

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.

ObjectBackgroundColorColor definition255,255,255 (White)

The background color of all links.

ObjectBottomShadowColor definition0,0,0 (Black)

The color of the bottom border that the webtop tray applet displays around highlighted links.

The top border color is used for the bottom and right borders of unclicked (default) links, and the top and left borders of clicked links.

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.

ObjectGapInteger10

The gap between links. If LayoutStyle is vertical, this is the gap between the bottom of one link and the top of the next. If LayoutStyle is horizontal, this is the gap between the right side of one link and the left of the next.

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%OBJGAP value%%. For example, to use a value of 10: <param name="ObjectGap" value="%%OBJGAP 10%%">.

ObjectHeightInteger34

The height of each link.

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%OBJHEIGHT value%%. For example, to use a value of 40: <param name="ObjectHeight" value="%%OBJHEIGHT 40%%">.

ObjectNumberInteger0

The number from which links are numbered.

ObjectTopShadowColor definition255,255,255 (White)

The color of the top border that the webtop tray applet displays around highlighted links.

The top border color is used for the top and left borders of unclicked (default) links, and the bottom and right borders of clicked links.

ObjectWidthInteger100

The width of each link.

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%OBJWIDTH value%%. For example, to use a value of 130: <param name="ObjectWidth" value="%%OBJWIDTH 130%%">.

PageNamestringNo default

The name of the page/file hosting the applet.

This parameter is required if you are using Internet Explorer 6.0 with Sun Java™ Plug-in.

This parameter is harmless if it is used in a web client that doesn't need it.

RightMarginInteger0

The gap between the webtop tray's right edge and the links' right edges. (If LayoutStyle is horizontal, this is the gap between the webtop tray's right edge and the first link's right edge.)

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%RIGHTMARGIN value%%. For example, to use a value of 10: <param name="RightMargin" value="%%RIGHTMARGIN 10%%">.

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.

ShowIconBooleantrue

Specifies whether the webtop tray applet displays icons as part of the links it shows.

ShowLabelBooleantrue

Specifies whether the webtop tray applet displays labels as part of the links it shows.

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.

TopMarginInteger0

The gap between the webtop tray's top edge and the top of the first link. (If LayoutStyle is horizontal, this is the gap between the webtop tray's top edge and the top of all links.)

If you're using the %%CALCWIDTH%% and %%CALCHEIGHT%% placeholders, specify this parameter's value in the form %%TOPMARGIN value%%. For example, to use a value of 10: <param name="TopMargin" value="%%TOPMARGIN 10%%">.

UseHierarchyBooleanfalse

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

Related topics