The XML to request an ALC SabreIP screen object is as follows:
<ScreenAlc TerminalType="D1"> <SabreIPClient PrimaryLoadBalancer="yourhost.com" Class="yourpool"\> <\ScreenAlc>
Additional ScreenAlc and SabreIPClient XML parameters are shown in the tables below. Except where noted, these parameters use the following syntax:
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" 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 Web page, its default value is used automatically.
|ScreenAlc XML Parameters|
|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 viewer 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 upercase 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 viewer window, whichever is encountered first. This ensures that the viewer does not wrap from the upper-left corner of the window to the lower-right corner of the window 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 viewer transmits all the data from the cursor to the upper-left corner of the window, as well as all data from the lower-right corner of the window 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 9 characters of text to display on the status line when the keyboard is locked. The default is Kybd Locked.|
Back to top
|SabreIP XML Parameters|
|PrimaryLoadBalancer||ipaddr||The IP address or domain name of the primary Sabre host load balancer.|
|SecondaryLoadBalancer||ipaddr||The IP address or domain name of the secondary Sabre host load balancer. This server is used only if the primary load balancer is not available.|
|LoadBalancerPort||number||The hexadecimal TCP/IP port number (0x1-0xFFFF) that the client should use to connect to the load balancer.
The default is 0x2EE1.
|Class||pool||Pool from which to obtain TA from load balancer.|
|LNIATA||hexaddr||Used to specify the hexadecimal terminal address (000000-FFFFFF). The default is "".
LNIATA stands for Line Number, Interchange Address, and Terminal Address.
|LocalPort||number||The TCP port to use for a TCP/IP connection. The default is 0, which means the OS selects the local TCP port.|
|CnfUrl||URL||The URL of an Attachmate Lantern Gateway CNF file (if any) that contains additional configuration information.|
|KeepAlive||True||The Open Front-End Processor (OFEP) will send packets to the client periodically to confirm that a connection still exists. This ensures that any loss of communication can be detected more quickly, and the session can be terminated cleanly. Sabre recommends that this be set to True.|
|False||Do not have the OFEP send packets to the client to confirm a connection. Setting this to False reduces network traffic and may speed the performance of your applications.|
|UseTidServer||True||The viewer obtains its Terminal Address (TA) from ID Manager.
If UseTidServer is True, any value associated with LNIATA is ignored.
|False||The viewer uses the TA specified by the LNIATA parameter.
If UseTidServer is False, any value associated with UserName or AddressPool is ignored.
|UserName||username||The name of the user for whom to obtain a TA from ID Manager. This name must match a user name in ID Manager.
If UseTidServer is False, or if a value is specified for AddressPool, any value associated with UserName is ignored.The default value is blank.
|AddressPool||poolname||The name of the address pool from which to obtain a TA. This name must match an address pool name in ID Manager.
If UseTidServer is False, any value associated with AddressPool is ignored. If a value is specified for AddressPool, any value associated with UserName is ignored.The default value is blank.
Back to top
|The Screen Object Model|
|Requesting a Screen Object|