Requesting an ALC MATIP Screen Object

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

<ScreenAlc TerminalType="D1">
        <MatipClient HostName="yourhost" Addressing2Byte="false" ConcentratorHost="localhost" H1="yourH1" H2="yourH2" A1="yourA1" A2="yourA2" TA="yourTA" />
</ScreenAlc>

Additional ScreenAlc and MatipClient 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

MatipClient XML Parameters
Parameter Value Description
HostName name IP address or domain name of the MATIP concentrator or host.

If you are using outbound opens (for example, the MATIP host initiates the connection to the SDK), then the HostAddress should be set to "*".

H1 hexaddr The hexadecimal (0x0-0xFF) addressing byte to use for this configuration.

The values for the H1, H2, A1, and A2 parameters are collectively a cluster address, which is called an ASCU address.

H2 hexaddr The hexadecimal (0x0-0xFF) addressing byte to use for this configuration.

The values for the H1, H2, A1, and A2 parameters are collectively a cluster address, which is called an ASCU address.

A1 hexaddr The hexadecimal (0x0-0xFF) addressing byte to use for this configuration.

The values for the H1, H2, A1, and A2 parameters are collectively a cluster address, which is called an ASCU address.

A2 hexaddr The hexadecimal (0x0-0xFF) addressing byte to use for this configuration.

The values for the H1, H2, A1, and A2 parameters are collectively a cluster address, which is called an ASCU address.

TA hexaddr The hexadecimal (0x0-0xFF) terminal address to use for this configuration.
ConnectionStatusInterval seconds The number of seconds of inactivity (no data exchanged between the client and host) that should elapse before the client verifies whether or not the connection with the host still exists. This is also the number of seconds that will elapse between connection status queries if the value for ConnectionStatusRetries is greater than 1.

If ConnectionStatusRetries is 0 or blank, any value for ConnectionStatusInterval is ignored.

The default value is 0.
ConnectionStatusRetries number The number of consecutive unanswered connection status queries that should be made before the session is closed. A typical number of retries would be between 1 and 10.

If ConnectionStatusRetries is 0 or blank, the client will not make any connection status queries.

The default value is 0.
CnfUrl URL The URL of an Attachmate Lantern Gateway CNF file (if any) that contains additional configuration information.

Sample .cnf files are located in <Installation Location>\CNF.

ConcentratorHost ipaddr IP address or domain name of MATIP concentrator.

The recommended value is localhost.

If you are bypassing the Concentrator, set this value to "".

ConcentratorPort number TCP port on which MATIP concentrator is listening for connections. The default value is 350.
SODelay milliseconds Time in milliseconds before MATIP Sign On (SO) packet is sent to the host after a TCP/IP connection is established.
Addressing2Byte True Use 2-byte addressing when connecting to MATIP Concentrator or host.
False Use 4-byte addressing when connecting to MATIP Concentrator or host.
LocalPort 0 Autoselects the Local Port.
integer Enter the port number to specify a local port to use.
HostPort 350 Sets the default host port.
integer Specifies a remote/host port to use.
CharEncoding IPARS Specifies that padded IPARS characters will be used.
ASCII Specifies that ASCII characters will be used.
EBCDIC Specifies that EBCDIC characters will be used.
WSE False Disables the Worldspan Extended MATIP protocol (uses normal MATIP).
True Enables Worldspan Extended MATIP protocol.

This parameter is valid only when you are using a MATIP Concentrator.

WSEPIN string Specifies the security PIN from Worldspan (up to a five digit string).

This parameter is valid only when Worldspan Extended MATIP is enabled.

HostToHost False Disables the host-to-host MATIP support (uses Terminal MATIP).
True Enables the host-to-host MATIP support.
SITA False Specifies the IATA host-to-host support (disables SITA).

This parameter is valid only when HostToHost is enabled.

True Enables SITA host-to-host support.
MultiFlow False Disables MultiFlow.
True Enables MultiFlow.

This parameter is valid only when HostToHost and SITA are both enabled.

FlowID flowID Address to use in HostToHost communications

This parameter is valid only when HostToHost, SITA, and MultiFlow are all enabled.

HostRejectCodes string The string contains a comma-separated list of values to be reported for the errors below in the order listed. Values may be omitted, in which case the default code is reported.

For example, HostRejectCodes="0x40,,65,,,0x42,67" results in the reject code table "0x40, 0x91,0x41, 0x93,0x94,0x42,0x43,0x97,0x98."

The following are the default Host Rejection Codes:

  • 0x90—No sessions are currently listening for opens

  • 0x91—None of the listening sessions matched the H1 and H2 of the request

  • 0x92—None of the listening sessions matched the connection type

  • 0x93—None of the listening sessions matched the ASCU

  • 0x94—None of the listening sessions matched the presentation type

  • 0x95—None of the listening sessions matched the encoding

  • 0x96—None of the listening sessions matched the requested hdr/mpx settings

  • 0x97—The request itself was invalid

  • 0x98—The listening session was marked Operator Disabled

OperatorDisable False The listen request, if used, functions normally. This is the default behavior.
True Disables a particular listen request, so that outbound opens of that particular MATIP address will be rejected with the last reject code in the HostRejectCodes table.

Back to top

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