Verastream SDK for Airlines
Requesting a UTS PEPGate Screen Object

The XML to request a UTS PEPGate screen object is as follows:

<ScreenUts Columns="80" Rows="24">
        <PEPGateClient GWAddress="yourhost.com" RID="yourRID" SID="yourSID" DID="yourDID" />
</ScreenUts>

Additional ScreenUts and PEPGateClient 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 set the TransmitMode parameter, the first line of the XML shown above would be changed from

<ScreenUts Columns="80" Rows="24">
to
<ScreenUts Columns="80" Rows="24" TransmitMode="ALL">

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.

ScreenUts XML Parameters
Parameter Value Description
TransmitMode VAR Only unprotected data is transmitted.
ALL All data is transmitted.
CHAN Only changed data is transmitted.
DestructiveSpace True The character at the cursor location is deleted when you send a space character with SendKeys.
False Sending a space character with SendKeys moves the cursor to the right without deleting any characters.
UpperCaseOnly True Only uppercase characters are displayed in the presentation space. The letters that appear uppercase only are determined by the CaseLowBoundry and CaseHighBoundry. Any letters between the specified letters display only in uppercase.
False Both lowercase and uppercase characters are displayed.
CaseLowBoundry character The letter that indicates the beginning of the range of characters that should appear in uppercase when UpperCaseOnly is True. For example, if CaseLowBoundry is b and CaseHighBoundry is y, and UpperCaseOnly is True, the letters b through y will appear only in uppercase, but any characters outside of that range (in this example, a and z) will appear in both lowercase and uppercase.

The default value is a.

CaseHighBoundry character The letter that indicates the end of the range of characters that should appear in uppercase when UpperCaseOnly is True.

The default value is z.

Rows number The number of rows in the presentation space.

The default is 24 rows.

Columns number The number of columns in the presentation space.

The default is 80 columns.

Back to top

PEPGateClient XML Parameters
Parameter Value Description
HeartBeatInterval seconds The number of seconds of inactivity (no data exchanged between the client and host) that can elapse before the client sends a data packet to the gateway to keep the connection established.

If the HeartbeatInterval is 0 or blank, no data packet is ever sent.

The default value is 0.

RID hexid A hexadecimal remote identifier (0x21-0x7F) for this session.

The default value is blank.

SID hexid A hexadecimal station identifier (0x21-0x7F, excluding 0x50) for this session.

The default value is blank.

Scrid value The unique screen ID (up to 8 characters) to use to connect to the host.

The default value is blank.

VirtualAddress address A configured network address for the workstation.
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.

*

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

Back to top

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