Verastream SDK for Airlines
Requesting an ALC Shares Screen Object

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

<ScreenAlc TerminalType="D1">
        <SharesClient HostName="yourhost.com" LN="yourLN" IA="yourIA" TA="yourTA"/>
</ScreenAlc>

Additional ScreenAlc and SharesClient 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 9 characters of text to display on the status line when the keyboard is locked. The default is Kybd Locked.

Back to top

SharesClient XML Parameters
Parameter Value Description
HostName name The domain name or IP address of the host, or one of the following values: SHA, SHB, MOM, POP, PRT, or TEST. The default is SHA.

If Network is set to Shares, HostIP (if specified) takes precedence over the HostName.

Network Shares Specify this to use a predefined host.
System1 If you specify a System1 host, the HostIP parameter is required.
Amadeus If you specify an Amadeus host, the HostIP parameter is required.
UseTCP true Uses a TCP connection instead of a UDP connection. This must be prearranged with EDS.
HostPort number

If UseTCP is set to "false", this parameter sets the UDP port on which the host is listening for connections. For the Shares network type, the default is 3020. For Amadeus or System1 network types, the default is 3000.

If UseTCP is set to "true", this parameter sets the TCP port on which the host is listening for connections.  This value must be supplied by EDS.

LocalPort number

If UseTCP is set to "false", this parameter sets the UDP port of the local terminal. The default is the configured TA value plus 3000. If multiple SDK sessions are opened with identical TAs, but different IAs or LNs, the LocalPort must be configured so they don't conflict with each other.

If UseTCP is set to "true", this parameter sets the TCP port to be used by the local terminal.  If not specified, a random available port will be used.

HostIP ipaddr The IP address of the host. If Network is System1 or Amadeus, you must specify a HostIP. If Network is Shares, this parameter is optional; if it is specified, it takes precedence over the HostName.
LN hexaddr The hexadecimal (0x01-0xFF) line number to use for this configuration. The default value is 0.
IA hexaddr The hexadecimal (0x01-0xFF) interchange address to use for this configuration. The default value is 0.
TA hexaddr The hexadecimal (0x01-0xFF) terminal address to use for this configuration. The default value is 0.
IDMgr URL The URL needed to access the Reflection ID Manager.
For example: “http[s]://DNSName.com[:port]/rwebidm”
*IDMgrPool PoolName Will be sent as specified
*IDMgrIPAddress address The actual IP address will be sent if you supply an empty string, but it may not be the address you expect.
*IDMgrDomainName name The DNS name of the system will be sent if you supply an empty string.
*IDMgrUserName user The name of the current user will be sent if you supply an empty string.
*IDMgrSessionName name A dummy session name will be sent if you supply an empty string.
*IDMgrHostAddr address Will be sent as specified.
*IDMgrHostPort port Will be sent as specified.
*IDMgrApplication appl Will be sent as specified.
*IDMgrAssocSet assoc Will be sent as specified.
**SecureConnection true Create a TLS-secured connection.
false Create a normal unsecured TCP connection (default).
**FIPSMode true Enforce FIPS 140-2 operation (default).
false Allow non-FIPS-approved operation.
**KeyStoreFile path Path to the Key Store file (required).
**KeyStoreFormat (JKS, BKS, PKCS12) Format of the Key Store file (required).
**KeyStorePWD password Password used to create the Key Store file (required).
*

The IDMgrPool, IDMgrIPAddress, IDMgrDomainName, IDMgrUserName, IDMgrSessionName, IDMgrHostAddr, IDMgrHostPort, IDMgrApplication, and IDMgrAssocSet take effect only if the IDMgr parameter is set with a URL.
**

The SecureConnection, FIPSMode, KeyStoreFile, KeyStoreFormat, and KeyStorePWD parameters take effect only if UseTCP is true.

Back to top

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