E.3. Login Script Variables

SGD login scripts use and support a number of variables. The variables can be divided into guaranteed variables, that are always available, and optional variables, that are only available if they have a value.

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

The following sections list the guaranteed and optional variables, and a description of their purpose.

E.3.1. Guaranteed Login Script Variables

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 the guaranteed variables.

Guaranteed variables always exist, though they might have a null value.

Variable

Description

ALTDISPLAY

The fully qualified Domain Name System (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 show a dialog box on the application server if the user's password is aged, missing or incorrect. This variable can have the following values:

  • user - If the user holds down the Shift key when they click an application's link or if there is a password problem

  • system - Only when there is a password problem

  • none - 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 listed on the Hosting Application Servers tab for the application object.

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 where error and diagnostic messages are logged.

By default, this has 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 following code in your login script:

log_file $env(TTA_LOGFILE)

TTA_PORT

The port used 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 that 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 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 guaranteed variables are also defined in runsubscript.exp. These are variables used by the SGD server when starting applications:

  • LANG

  • LANGUAGE

  • LC_ALL

  • LC_CTYPE

  • LC_NUMERIC

  • LC_TIME

  • LC_COLLATE

  • LC_MONETARY

  • LC_MESSAGES

  • LC_PAPER

  • LC_NAME

  • LC_ADDRESS

  • LC_TELEPHONE

  • LC_MEASUREMENT

  • LC_IDENTIFICATION

  • PATH

  • TTA_PreferredLocale

  • TTABASEDATADIR

  • TTADATADIR

  • TTADIR

E.3.2. Optional Login Script Variables

Optional variables store additional information about the application, the user, and their session.

Optional variables are often used to test conditions and modify the login script's behavior accordingly. Optional variables only exist if they have a value. For example, the TTA_ResumeTimeOut variable only exists if the application object's Application Resumability attribute has a value.

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. Other optional variables contain additional information about the user's session.

Variable

Description

TTA_AdminMode

Corresponds to the Windows application object's Console Mode attribute.

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 fully qualified name.

TTA_ApplicationPlacement

Corresponds to the application object's Window Type attribute.

This variable can have the value multiplewindows - client window management, awtwindow - independent window, kiosk - kiosk, localx - local X server, and seamlesswindows - 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 in the Administration Console.

This variable can have the value low, medium, and high.

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 - No Buttons), 1 - 2 Rows, 2 - 4 Rows, 3 - 6 Rows, and 4 - 8 Rows.

TTA_CachePassword

Whether the user selected the Save This Password? box when they supplied 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_DisableCursorSettings

Corresponds to the Windows application object's Cursor Settings attribute.

TTA_DisableCursorShadow

Corresponds to the Windows application object's Cursor Shadow attribute.

TTA_DisableFullWindowDrag

Corresponds to the Windows application object's Full Window Drag attribute.

TTA_DisableMenuAnimations

Corresponds to the Windows application object's Menu Animations attribute.

TTA_DisableTheming

Corresponds to the Windows application object's Theming attribute.

TTA_DisableWallpaper

Corresponds to the Windows application object's Desktop Wallpaper 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_EnableFontSmoothing

Corresponds to the Windows application object's Font Smoothing 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 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 listed on the Hosting Application Servers tab for the application object.

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_NoPrintPrefs

Corresponds to the Windows application object's Printer Preference Caching attribute.

TTA_ParentName

The application object's fully qualified 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 attribute.

TTA_RemoteAddr

The IP address of the application server used to run the application.

TTA_RemoteAudio

Corresponds to the Windows application object's Remote Audio attribute.

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 - Last Client Exit, windowmanager - Window Manager Exit, windowmanageralone - Only Window Manager Remaining), loginscript - Login Script Exit), nowindows - No Visible Windows, and loginscriptnowindows - 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 - Prompt User for Action, 1 - Exit Emulator, 2 - Reconnect, and 3 - 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 fully qualified 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 in the Administration Console.

This variable can have the value low, medium, and high.

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

The protocol used to connect to a Windows application server.

This variable can have the value wincenter, wincentermf - Citrix UNIX Integration Services, merge - SCO Merge, winframe - Citrix ICA), wts - Microsoft RDP, or none. Only Microsoft RDP is supported. The other protocols can only be used with legacy SGD Windows application objects.

TTA_WindowsApplicationSupport

Corresponds to the Windows application object's Local Client Launch attribute.

Note

This attribute is no longer used.

TTA_WorkingDir

Corresponds to the Windows application object's Working Directory attribute.