Secure Global Desktop Administration Guide > Applets > Terminal emulator applet parameters

Terminal emulator applet parameters

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

Applet parameters take precedence over object attributes. For example, if you have an application object with its Font Family attribute set to Courier, but display it in an HTML page containing the terminal emulator applet with its FontFamily parameter set to Helvetica, the application will be displayed in a Helvetica font. Applet parameters that override object attributes in this way are listed in the table below with a default of "Object attribute value".

ParameterTypeDefaultDescription
AnswerBackMessageStringObject attribute value

A message. When an inquiry is sent from the application server to the emulator, the emulator transmits back an answerback message. The answerback message is sent automatically whenever a connection is opened.

This parameter is only available to terminal emulators of TerminalType vt420 and wyse60.

AppearanceBorder typeObject attribute value

The appearance of the display frame's border, normal (flat), raised or indented.

ApplicationStringObject attribute value

The full pathname of the application on the application server, for instance, /home/bin/scripts/shell.

To enter command line arguments, use the Arguments parameter.

ApplicationKeyModeBooleanObject attribute value

Whether you want the application to change the codes generated by keypad keys. Otherwise, the keypad generates numbers.

This parameter is only available to terminal emulators of TerminalType wyse60.

ApplicationServerHostObject attribute value

The application server you want to run the application on.

ArgumentsStringObject attribute value

Any command line arguments to the application.

AsadPortIntegerNo default

The TCP port the terminal 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%%).

AutoWrapBooleanObject attribute value

Whether characters you type beyond the right-hand edge of the emulator window will appear on the following line. If not, any characters you type after you reach the right-hand edge of the emulator window will not be visible, although they will still be placed in the keyboard input buffer.

BackgroundColorColor definition000000 (black)

The background color.

CodePageStringObject attribute value

The character set you want the terminal emulator to use. You can set this to 437 (International), 850 (Multilingual), 860 (Portuguese), 863 (Canadian-French), or 865 (Danish-Norwegian).

This parameter is only available to terminal emulators of TerminalType ansi.

ColornColor definitionObject attribute value

An entry in the color map, where n is the number of the entry in the range 0 to 15. Use this to override entries in the color map specified in an object's Color Map attribute.

ColumnsIntegerObject attribute value

The number of columns in the emulator window Secure Global Desktop displays.

Scroll bars appear if the number of lines you specify results in an emulator window larger than the terminal emulator applet.

ConnectionMethodConnection methodObject 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.

ControlCodeControl codeObject attribute value

Whether escape sequences are sent to the application server as 7-bit or 8-bit control codes.

This parameter is only available to terminal emulators of TerminalType vt420.

CursorCursor typeObject attribute value

The cursor style used in the terminal emulator.

  • Off means no cursor is shown.
  • Block means the cursor is a single, filled character square.
  • Underline means the cursor is a single underscore character.
CursorKeyModeBooleanObject attribute value

Whether you want the cursor keys to always generate cursor movement codes. Otherwise, the application can change the codes generated by the cursor keys.

This parameter is only available to terminal emulators of TerminalType vt420.

EnvironmentStringObject 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:

<PARAM NAME="Environment" VALUE="Variable=Setting">
<PARAM NAME="Environment1" VALUE="Variable=Setting">
<PARAM NAME="Environment2" VALUE="Variable=Setting">
FixedFontSizeBooleanObject attribute value

Whether Secure Global Desktop can choose the best font size to use for the given size of the terminal emulator applet.

The value true indicates that Secure Global Desktop is allowed to choose the best font size. false indicates that Secure Global Desktop must use the font size specified by FontSize.

FontFamilyFont nameBrowser dependent

The font to use in the application.

FontSizeIntegerBrowser dependent

The font's point size.

ForegroundColorColor definitionFFFFFF (white)

The foreground color.

KeyboardMapStringObject attribute value

The keyboard map used by the application. Secure Global Desktop provides default text-format keyboard maps. See Terminal Emulator Keyboard Maps for more information.

KeypadModeKeypad modeObject attribute value

The behavior of the keypad.

  • Numeric means the keypad generates numbers.
  • Application means the application can change the codes generated by the keypad keys.

This parameter is only available to terminal emulators of TerminalType vt420.

LinesIntegerObject attribute value

The number of lines in the emulator window Secure Global Desktop displays.

Scroll bars appear if the number of lines you specify results in an emulator window larger than the terminal emulator applet.

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.

LoginScriptStringObject attribute value

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

ObjectXFNString""

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.

PasswordStringPassword cache or promptA 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 prompt 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.

PromptforAuthBooleanfalse

Whether to display a dialog box that prompts the user for application server authentication.

ResumableResumability typeObject attribute value

The resumability model for the application.

  • Use never to specify that users can't resume the application.
  • Use session to specify that users can only resume the application until they log out of Secure Global Desktop.
  • Use forever to specify that users can always resume the application.
ScottaappletheightIntegerObject attribute value

The height of the application in pixels.

ScottaappletwidthIntegerObject attribute value

The width of the application in pixels.

ScottaattributemapStringObject attribute value

The full pathname of the attribute map to use.

ScottacolormapStringObject attribute value

Specifies the color map to use for the application. A color map maps logical colors, Color_1, Color_2 and so on, to displayed colors.

ScottaemulatorStringNo default

The type of emulation required for the application: SCO Console, VT420 or Wyse 60.

Note that not all character application attributes apply to all emulation types.

ScottafullscreenBooleanObject attribute value

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

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.

ScrollStyleScroll styleObject attribute value

The scrolling speed of output sent to the terminal emulator.

  • Normal specifies that data appears a single line at a time.
  • Jump specifies that data appears several lines at a time. This is the fastest style of scrolling.
  • Smooth specifies that data appears one pixel at a time. This is the slowest style of scrolling.
StatusLineStringObject attribute value

The information displayed in the status line.

For VT420 emulators:

  • None specifies that no status line appears.
  • Indicator displays the position of the cursor and the print mode.
  • HostWritable displays messages from the host.

For Wyse 60 emulators:

  • None specifies that no status line appears.
  • Standard displays the time according to the terminal's clock, and cursor, line and column indicators.
  • Extended displays the Protection, Write Protect, Insert and Lock flags.

This parameter is only available to terminal emulators of TerminalType vt420 and wyse60.

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.

TerminalTypeTerminal typeObject attribute value

The type of terminal being emulated: ansi, vt420, or wyse60.

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

TerminationURLString""

The URL to display when the emulator session terminates. The URL 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" page when the emulator session ends.

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

Related topics