Skip past navigation linksSecure Global Desktop 4.40 Administration Guide > Users and Authentication > Login Script Variables

Login Script Variables

Secure Global Desktop login scripts use and support a number of variables. The following two types of variable are supported:

To be able to use a variable in a login script, it must be defined in the runsubscript.exp login script.

Guaranteed Variables

Variable Description
ALTDISPLAY The fully qualified DNS name of the user's client device and the display number being used.
DISPLAY The IP address of the user's client device and the display number being used.
TTA_AGEDPASSWORD Whether to use the manual or dialog method of dealing with aged passwords.
TTA_ALLOWTHIRDTIERDIALOG Whether to allow a dialog box on the application server if the user's password is aged, missing or incorrect.

This variable can have the values user (means if the user holds down the Shift key when they click an application's link or if there is a password problem, system (means only when there is a password problem), and none (means never show a dialog box).
TTA_AUXCOMMANDS Any auxiliary commands to run on the application server. This corresponds to the application object's Window Manager attribute.
TTA_CLIENT_IPADDR The IP address of the user's client device. This is the IP address obtained by the SGD Client.
TTA_COMMAND The command to run on the application server. This corresponds to the application object's Application Command attribute.
TTA_CONNECTIONSERVICE The transport used to connect to the application server. This corresponds to the application object's Connection Method attribute.
TTA_ENVIRONMENT Any environment variable settings required on the application server. This corresponds to the application object's Environment Variables attribute.
TTA_HOSTNAME The application server that the login script connects to. This is chosen by application load balancing, from those shown in the Hosting Application Servers tab.
TTA_HOSTPROBE The path to the ttahostprobe binary. Used to check whether an application server is available.
TTA_IPADDRESS The application server's IP address.
TTA_LOGFILE The name of a file in which error and diagnostic messages are logged.

By default, this is of the form scriptID.log, where script is the name of the login script and ID is its process ID on the SGD server.

If set to null, messages are not stored.

To log messages in this file, include the code log_file $env(TTA_LOGFILE) in your login script.
TTA_PORT The port on which to connect to the application server for the Connection Method configured for the application object.
TTA_PRIMARY_DNSNAME The primary SGD server's fully qualified DNS name.

This lets the login script choose the correct SGD printer when setting the default printer value. It is used to differentiate between multiple entries in the /etc/ttaprinter.conf file.
TTA_SCRIPT The Expect script which runs after runsubscript.exp, for example unix.exp.
TTA_SECOND_TIER_DNSNAME The fully qualified DNS name of the SGD server hosting the application session.

Used with TTA_THIRD_TIER_DNSNAME to determine whether the application server and the SGD server are the same and use an optimized launch process if it they are.
TTA_THIRD_TIER_DNSNAME The fully qualified DNS name of the application server hosting the application.

Used with TTA_SECOND_TIER_DNSNAME to determine whether the application server and the SGD server are the same and use an optimized launch process if it they are.
TTA_THIRD_TIER_VARS The list of variables to export to the environment on the application server.
TTA_STDERR A temporary error file.
TTA_WILLDISCONNECT Whether the connection is broken once the command is executed.
TTA_XLAUNCH Whether the application is an X application. The value of this variable is 0 or 1.

The following variables are also guaranteed variables and defined in runsubscript.exp. These are variables used by the SGD server when launching applications:

Optional Variables

Most optional variables contain the values of object attributes. The application being started has its application object's attributes made available as optional variables. Similarly, the attributes of the user profile are also made available in the same way.

The remaining optional variables contain additional information about the user's session.

Variable Description
TTA_Appearance Corresponds to a character application object's Border Style attribute.
TTA_AppletHeight Corresponds to the application object's Window Size: Height attribute.
TTA_AppletWidth Corresponds to the application object's Window Size: Width attribute.
TTA_ApplicationName The application object's Federated Naming name.
TTA_ApplicationPlacement Corresponds to the application object's Window Type attribute.

This variable can have the value multiplewindows (means client window management), awtwindow (means independent window), kiosk (means kiosk), localx (means local X server), and seamlesswindows (means seamless window).
TTA_Arguments Corresponds to the application object's Arguments For Command attribute.
TTA_AudioQuality Corresponds to the Windows audio quality attribute on the Global Settings » Client Device tab.

This variable can have the value low (means Low Quality), medium (means Medium Quality), and high (means High Quality).
TTA_Autowrap Corresponds to the character application object's Line Wrapping attribute.
TTA_BackgroundColor Corresponds to the Background Color attribute for a 3270 or 5250 application object.
TTA_ButtonLevels Corresponds to the 3270 or 5250 application object's Displayed Soft Buttons attribute.

This variable can have the value 0 (means No Buttons), 1 (means 2 Rows), 2 (means 4 Rows), 3 (means 6 Rows), and 4 (means 8 Rows).
TTA_CachePassword Whether the user selected the Save Password box when they supply a user name and password for the application server.
TTA_CodePage Corresponds to the character application object's Code Page attribute.

This variable can have the value 437, 850, 852, 860, 863, 865, 8859-1, 8859-2, Multinational, Mazovia or CP852.
TTA_ColorMap Corresponds to the character application object's Color Map attribute.
TTA_Columns Corresponds to the character application object's Window Size: Columns attribute.
TTA_Compression Corresponds to the application object's Command Compression attribute.

This variable can have the value automatic, on or off.
TTA_ContinuousMode Corresponds to the application object's Command Execution attribute.

This variable can have the value automatic, on or off.
TTA_ControlCode Corresponds to the character application object's Escape Sequences attribute.

This variable can have the value 7-bit or 8-bit.
TTA_Cursor Corresponds to the character application object's Cursor attribute.

This variable can have the value off, block or underline.
TTA_CursorKeyMode Corresponds to the character application object's Cursor Key Codes Modification attribute.

This variable can have the value application or cursor.
TTA_DelayedUpdate Corresponds to the application object's Delayed Updates attribute.
TTA_DisplayEnginePage Corresponds to the application object's Emulator Applet Page attribute.

Note This attribute is no longer used.
TTA_DisplayName Corresponds to the user profile's Name attribute.
TTA_Domain Corresponds to the application object's Domain Name attribute.
TTA_EuroMapping Corresponds to the application object's Euro Characterattribute.

This variable can have the value iso8859-15 or unicode.
TTA_FilePath Corresponds to the application object's Application Command attribute.
TTA_FixedFontSize Corresponds to the character application object's Font Size: Fixed attribute.
TTA_FontFamily Corresponds to the character application object's Font Family attribute.

This variable can have the value courier, helvetica or timesroman.
TTA_FontSize Corresponds to the character application object's Font Size attribute.
TTA_ForegroundColor Corresponds to the 3270 or 5250 application object's Foreground Color attribute.
TTA_GraphicsAcceleration Corresponds to the application object's Graphics Acceleration attribute.
TTA_Height Corresponds to the application object's Window Size: Height attribute.

This variable provides the same information as TTA_AppletHeight.
TTA_HostLocale Corresponds to the application server object's Prompt Locale attribute.
TTA_HostName The application server that the login script connects to.

This is chosen by application server load balancing, from those shown in the Hosting Application Servers tab.
TTA_IBMHostName Corresponds to the 3270 or 5250 application object's Server Address attribute.
TTA_Icon Corresponds to the application object's Icon attribute.
TTA_InstanceName The application session ID.
TTA_InterlacedImages Corresponds to the application object's Interlaced Images attribute.

This variable can have the value automatic, on or off.
TTA_KeyboardType Corresponds to the 3270 or 5250 application object's Keyboard Type attribute.

This variable can have the value pc, sun4, sun5, and hp.
TTA_KeymapLock Corresponds to the application object's Keyboard Map: attribute.
TTA_KeypadMode Corresponds to the character application object's Numpad Codes Modification attribute.

This variable can have the value application or numeric.
TTA_Lines Corresponds to the character application object's Window Size: Lines attribute.
TTA_LocalAddr The IP address of the SGD host.
TTA_LoginScript Corresponds to the application object's Login Script attribute.
TTA_Maximise Corresponds to the 3270 or 5250 application object's Window Size attribute.
TTA_MiddleMouseTimeout Corresponds to the application object's Middle Mouse Timeout attribute.
TTA_ParentName The application object's Federated Naming name.

This variable provides the same information as TTA_ApplicationName.
TTA_PortNumber Corresponds to the 3270 or 5250 application object's Server Port attribute.
TTA_ProtocolArguments Corresponds to the Windows application object's Arguments for Protocol attribute.
TTA_RemoteAddr The IP address of the application server which is to run the application.
TTA_RequiresDisplayEngine Whether or not the application requires a display engine.
TTA_ResumeTimeOut Corresponds to the application object's Application Resumability: Timeout attribute.
TTA_RootColor Corresponds to the application object's Window Color: Custom color attribute.
TTA_RootType Corresponds to the application object's Window Color attribute.

This variable can have the value default or color.
TTA_ScrollStyle Corresponds to the character application object's Scroll Style attribute.

This variable can have the value normal, jump or smooth.
TTA_SecureConnection Corresponds to the user profile's Security tab.
TTA_SessionExit Corresponds to the application object's Session Termination attribute.

This variable can have the value lastclient (means Last Client Exit), windowmanager (means Window Manager Exit), windowmanageralone (means Only Window Manager Remaining), loginscript (means Login Script Exit), nowindows (means No Visible Windows) and loginscriptnowindows (means Login Script exit or No Visible Windows).
TTA_SettingsItem Corresponds to the 3270 or 5250 application object's 'File' and 'Settings' Menus attribute.
TTA_StatusLine Corresponds to the character application object's Status Line attribute.

This variable can have the value none, indicator and host writable, standard or extended.
TTA_Suspend Corresponds to the application object's Application Resumability attribute.

This variable can have the value never, session (means User Session) and forever (means Always).
TTA_TerminalClass Corresponds to the character application object's Emulation Type attribute.

This variable can have the value scoconsole, vt420 or wyse60.
TTA_TerminalType Corresponds to the character application object's Terminal Type attribute.
TTA_TNClose Corresponds to the 3270 or 5250 application object's Connection Closed Action attribute.

This variable can have the value 0 (means Prompt User for Action), 1 (means Exit Emulator), 2 (means Reconnect), and 3 (means Close Connection).
TTA_TopMenuBar Corresponds to the 3270 or 5250 application object's Menu Bar attribute.
TTA_Transport Corresponds to the application object's Connection Method attribute.

This variable can have the value rexec, telnet or ssh.

The guaranteed variable TTA_CONNECTIONSERVICE also provides this information.
TTA_UserName The Federated Naming name of the user this application session is for.
TTA_UserSecurityEquivalent Corresponds to the user profile's User Name attribute.
TTA_UNIXAUDIO_QUALITY Corresponds to the UNIX audio quality attribute on the Global Settings » Client Device tab.

This variable can have the value low (means Low Quality), medium (means Medium Quality), and high (means High Quality).
TTA_UNIXAUDIOPRELOAD Corresponds to the X application objects Audio Redirection Library attribute.
TTA_ViewHostReply Corresponds to the application object's Keep Launch Connection Open attribute.
TTA_WebTop Corresponds to the Webtop Theme attribute.

Note This attribute is no longer used.
TTA_Width Corresponds to the application object's Window Size: Width attribute.

This variable provides the same information as TTA_AppletWidth.
TTA_WinCursor Corresponds to the application object's Use Windows Cursor attribute.

Note This attribute is no longer used.
TTA_WindowsApplicationServer Corresponds to the Windows application object's Windows Protocol attribute.

This variable can have the value wincenter, wincentermf (means Citrix UNIX Integration Services), merge (means SCO Merge), winframe (means Citrix ICA), wcpwts (means Microsoft RDP) or none. Only Citrix ICA and Microsoft RDP are supported. The other protocols can only be used with legacy windows application objects.
TTA_WindowsApplicationSupport Corresponds to the Windows application object's Windows Protocol: Try Running From Client First attribute.
Related Topics

Copyright © 1997-2007 Sun Microsystems, Inc. All rights reserved.