Framework applet parameters

The framework applet has the following parameters:

ParameterTypeDefaultDescription
AnonLoginBooleanfalse

This parameter is used to control whether users see the standard Tarantella login page or the kiosk-style login page. Whether anonymous users can log or not is controlled by the Anonymous user login authority setting in Array Manager.

Use the placeholder %%ANONLOGIN%% to let Tarantella 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.

AsadKeepAliveInteger100

The interval in seconds at which "keep alive" packets are sent from the client to the server.

AsadPortIntegerNo default

The TCP port the framework applet uses to communicate with the Tarantella server.

Use the placeholder %%ASADPORT%% to let Tarantella 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 Tarantella server is only possible if you supply a valid TCP port number (or use %%ASADPORT%%).

DoLoginBooleantrue

This parameter is used to determine whether the applet should start the login process.

DoLogoutBooleanfalse

This parameter is used to determine whether the applet should start the logout process.

This parameter takes precedence over DoLogin if both parameters are simultaneously set to true.

LoginGUIMaskInteger"2"

A bitmask in the range 0 to 15 which controls the appearance of the Tarantella 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.

Note This parameter is only active in scripting mode.

ProxyFrameString"_self"

The frame which the applet using this parameter runs in.

This parameter is used by the applet that determines the proxy configuration and should not be changed unless you know what you are doing.

ProxyServerString"DIRECT"

This parameter is used to determine which proxy server, if any, should be used. If this parameter is omitted, Tarantella will ignore any proxy server configuration and attempt to connect directly to the Tarantella server.

Use the placeholder %%PROXY%% to let Tarantella supply the correct value for this parameter.

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 Tarantella 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 Tarantella as a different user.

Note This parameter is only active in scripting mode.

TarantellaUsernameStringNo default

The username the applet uses to log in to a Tarantella server.

If this parameter is used, the applet tries to log the user in to Tarantella 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).

Note This parameter is only active in scripting mode.

TargetFrameString"WebtopFrame"

The name of the frame into which the framework applet loads other components, such as the login applet.

URLLoginFailureString""

The URL of the page that is to be loaded into the TargetFrame if the login fails.

If this parameter is missing, the standard Tarantella login page is loaded into the TargetFrame. This loads the Tarantella Login applet.

If the value of this parameter is "", no page is loaded.

Note This parameter is only active in scripting mode.

URLLoginSuccessString""

The URL of the page that is to be loaded into the TargetFrame if the login succeeds.

If this parameter is missing, the standard Tarantella webtop is loaded into the TargetFrame.

If the value of this parameter is "", no page is loaded.

Note This parameter is only active in scripting mode.

Using scripting mode to log a user in

When both the DoLogin and DoLogout parameters are missing or set to false, the framework applet is in "scripting mode". This means you can use the TarantellaUsername, TarantellaPassword, LoginGUIMask, URLLoginSuccess and URLLoginFailure parameters to log a user in to Tarantella.

If the TarantellaUsername parameter is missing and bit 1 of the LoginGUIMask parameter is set, the user will be prompted to log in. If the LoginGUIMask parameter is missing or bit 1 is not set, you can only log a user in using the login method.

If the TarantellaUsername parameter contains a username (any text), the applet tries to log the user in as that username and it uses the value of the TarantellaPassword parameter as the password. If the value of the TarantellaUsername parameter is an empty string (""), the applet tries to log the user in anonymously.

If the login succeeds and the URLLoginSuccess parameter is:

If the login fails and the URLLoginFailure parameter is:

Related topics
  • Framework applet
  • Applet parameter data types