Requesting an ALC Apollo Screen Object

The XML to request an ALC Apollo screen object is as follows:

<ScreenAlc TerminalType="D1">
        <ApolloClient ClientID="yourclientid" ConfigServer1="yourserver.com" GTIDIndex="0" ConnectionType="Terminal" />
</ScreenAlc>

Additional ScreenAlc and ApolloClient XML parameters are shown in the tables below. Except where noted, these parameters use the following syntax:

name="value"

where name is the name of a parameter and value is a valid value for that parameter. These tags should be placed within the object being defined. For example, to add the DisplayNewLines parameter, the first line of the XML shown above would be changed from

<ScreenAlc TerminalType="D1">
to
<ScreenAlc TerminalType="D1" DisplayNewLines="True">

The default values are shown in bold in the Value column or given in the Description column. If a parameter is not included in the XML, its default value is used automatically.

ScreenAlc XML Parameters
Parameter Value Description
TerminalType D1 ALC terminal with a fixed size of 15 x 64.
D2 ALC terminal with a fixed size of 23 x 64.
D3 ALC terminal with a fixed size of 23 x 80.
D4 ALC terminal with a fixed size of 30 x 64.
D5 ALC terminal with a fixed size of 24 x 80.
DisplayNewLines True Display the newline character at the end of each line when the presentation space receives data from the host.

When this option is set to True, CR appears in the status line.

False Do not display the newline character at the end of each line.
ForceCaps True Display uppercase characters as you type, even if you type lowercase characters.
False Display the text you type in both uppercase and lowercase.
SwordMode True Transmit all data from the current cursor location to the preceding start-of-message (SOM) indicator or to the upper-left corner of the presentation space, whichever is encountered first. This ensures that the presentation space does not wrap from the upper-left corner of the presentation space to the lower-right corner of the presentation space in search of an SOM indicator. (Sword screens normally do not include an SOM indicator.)
False Transmit all data from the current cursor location to the preceding SOM indicator. If the SOM indicator occurs after the cursor location, the presentation space transmits all the data from the cursor to the upper-left corner of the presentation space, as well as all data from the lower-right corner of the presentation space to the SOM indicator.
SystemDownStatus text Up to 12 characters of text to display on the status line when a connection with the host is not currently established. The default is Sys Unavail.
PushRepeatStatus text Up to 9 characters of text to display on the status line when there is a problem with a message received from the host. The default is Push Rpt.
ReenterStatus text Up to 9 characters of text to display on the status line when an error occurs in the transmission to the host, or when the format is not correct. The default is Reenter.
KeyboardLockedStatus text Up to 12 characters of text to display on the status line when the keyboard is locked. The default is Kybd Locked.

Back to top

ApolloClient XML Parameters
Parameter Value Description
ClientID clientid This required parameter is used to identify the workstation to the configuration server. The default is "".
ConfigServer1 ipaddr The IP address or domain name of the primary Galileo configuration server.
ConfigServer2 ipaddr The IP address or domain name of the secondary Galileo configuration server. This server is used only if the primary configuration server is not available.
GTID gtid The global terminal ID.

Either GTID or GTIDIndex should be specified, but not both. If the GTID is specified, it must be valid for the workstation and the configured ClientID.

GTIDIndex number An index into the list of GTIDs returned from the configuration server.

Either GTID or GTIDIndex should be specified, but not both. If the GTID is specified, it must be valid for the workstation and the configured ClientID.

The number of available GTIDs is configured on the configuration server. Zero indicates that the GTID list will be treated as a pool of GTIDs and the first available GTID will be used. The default is 0.

Back to top

Related Topics
Defining an XML Configuration
The Screen Object Model
Requesting a Screen Object
  Footer