Secure Global Desktop Administration Guide > Users and authentication > Login script variables

Login script variables

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

Guaranteed variables store the names of commands to run, the application server to log in to, and the connection method to use. All login scripts use at least some of these variables. Guaranteed variables always exist, though they may have a null value.
Optional variables store additional information about the application, the user and their session. These variables are often used to test conditions and modify the login script's behavior accordingly. Optional variables only exist if they have a specified value (for example, the TTA_ResumeTimeOut variable only exists if you've specified a value for the application object's Resumable For attribute.

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_AUXCOMMANDS`	Any auxiliary commands to run on the application server. This corresponds to the application object's Window Manager attribute.
`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 server load balancing, from those shown in the Hosts tab.
`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 Secure Global Desktop server. If set to null, messages aren't stored. To log messages in this file, include the code `log_file $env(TTA_LOGFILE)` in your login script.
`TTA_PRIMARY_DNSNAME`	The primary Secure Global Desktop server's fully qualified DNS name. This lets the login script choose the correct Secure Global Desktop printer when setting the default printer value. It's used to differentiate between multiple entries in the `/etc/ttaprinter.conf` file.
`TTA_WILLDISCONNECT`	Whether the connection will be broken once the command has been executed.
`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 third tier if the user's password is aged.
`TTA_THIRD_TIER_VARS`	The list of variables to export to the environment on the application server.
`TTA_STDERR`	A temporary error file.

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 user's person object's attributes are also available in this way.

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

Variable	Description
`TTA_Appearance`	Corresponds to the application object's Border Style attribute.
`TTA_AppletHeight`	Corresponds to the application object's Application Height attribute.
`TTA_AppletWidth`	Corresponds to the application object's Application Width attribute.
`TTA_ApplicationName`	The application object's TFN name.
`TTA_ApplicationPlacement`	Corresponds to the application object's Display Using attribute. This variable can have the values `mainbrowser` (means webtop), `multiplewindows` (means client window management), `newbrowser` (means new browser window), `awtwindow` (means independent window), `kiosk` (means kiosk), `localx` (means local X server) nd `seamlesswindows` (means seamless window).
`TTA_Arguments`	Corresponds to the application object's Arguments For Command attribute.
`TTA_Autowrap`	Corresponds to the application object's Wrap Long Lines attribute.
`TTA_CachePassword`	Whether the Save This Password box was checked if the user supplied their username and password for the application server.
`TTA_CLIENT_IPADDR`	The IP address of the user's client device.
`TTA_CodePage`	Corresponds to the 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 application object's Color Map attribute.
`TTA_Columns`	Corresponds to the application object's 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 application object's Escape Sequences attribute. This variable can have the value `7-bit` or `8-bit`.
`TTA_Cursor`	Corresponds to the application object's Cursor attribute. This variable can have the value `off`, `block` or `underline`.
`TTA_CursorKeyMode`	Corresponds to the application object's Cursor Keys attribute. This variable can have the value `application` or `cursor`.
`TTA_DelayedUpdate`	Corresponds to the application object's Allow Delayed Updates attribute.
`TTA_DisplayEnginePage`	Corresponds to the application object's Emulator Applet Page attribute.
`TTA_DisplayName`	Corresponds to the person object's Name attribute.
`TTA_Domain`	Corresponds to the application object's Windows NT Domain attribute.
`TTA_EuroMapping`	Corresponds to the application object's Euro Character attribute. 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 application object's Fixed Font Size attribute.
`TTA_FontFamily`	Corresponds to the application object's Font Family attribute. This variable can have the value `courier`, `helvetica` or `timesroman`.
`TTA_FontSize`	Corresponds to the application object's Font Size attribute.
`TTA_GraphicsAcceleration`	Corresponds to the application object's Use Graphics Acceleration attribute.
`TTA_Height`	Corresponds to the application object's Application Height attribute. This variable provides the same information as `TTA_AppletHeight`.
`TTA_HostName`	The application server that the login script connects to. This is chosen by application server load balancing, from those shown in the Hosts tab.
`TTA_Icon`	Corresponds to the application object's Webtop Icon attribute.
`TTA_InstanceName`	The emulator session ID.
`TTA_InterlacedImages`	Corresponds to the application object's Interlaced Images attribute. This variable can have the value `automatic`, `on` or `off`.
`TTA_KeymapLock`	Corresponds to the application object's Lock Keymap attribute.
`TTA_KeypadMode`	Corresponds to the application object's Keypad attribute. This variable can have the value `application` or `numeric`.
`TTA_Lines`	Corresponds to the application object's Lines attribute.
`TTA_LocalAddr`	The IP address of the Secure Global Desktop host.
`TTA_LoginScript`	Corresponds to the application object's Login Script attribute.
`TTA_MiddleMouseTimeout`	Corresponds to the application object's Middle Mouse Timeout attribute.
`TTA_ParentName`	The application object's TFN name. This variable provides the same information as `TTA_ApplicationName`.
`TTA_PortNumber`	Corresponds to the 3270 application object's Port Number attribute.
`TTA_ProtocolArguments`	Corresponds to the application object's Protocol Arguments 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 Resumable For attribute.
`TTA_RootColor`	Corresponds to the application object's Color attribute.
`TTA_RootType`	Corresponds to the application object's Root Window attribute. This variable can have the value `default` or `color`.
`TTA_ScrollStyle`	Corresponds to the application object's Scroll Style attribute. This variable can have the value `normal`, `jump` or `smooth`.
`TTA_SecureConnection`	Corresponds to the person object's Connections attribute.
`TTA_SessionExit`	Corresponds to the application object's Session Ends When attribute. This variable can have the value `lastclient` (means Last Client Exits), `windowmanager` (means Window Manager Exits), `windowmanageralone` (means Only Window Manager Remains), `loginscript` (means Login Script Exits) and `nowindows` (means No Visible Windows).
`TTA_StatusLine`	Corresponds to the 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 Resumable attribute. This variable can have the value `never`, `session` (means Webtop Session) and `forever` (means Always).
`TTA_TerminalClass`	Corresponds to the application object's Emulation Type attribute. This variable can have the value `scoconsole`, `vt420` or `wyse60`.
`TTA_TerminalType`	Corresponds to the application object's Terminal Type 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 TFN name of the user this emulator session is for.
`TTA_UserSecurityEquivalent`	Corresponds to the person object's Username attribute.
`TTA_ViewHostReply`	Corresponds to the application object's Keep Launch Connection Open attribute.
`TTA_WebTop`	Corresponds to the person object's Webtop Theme attribute.
`TTA_Width`	Corresponds to the application object's Application Width attribute. This variable provides the same information as `TTA_AppletWidth`.
`TTA_WinCursor`	Corresponds to the application object's Use Windows Cursor attribute.
`TTA_WindowsApplicationServer`	Corresponds to the 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 application object's Try Running From Client First attribute.

Related topics
What are login scripts? Login scripts supplied with Secure Global Desktop Introducing application server load balancing