The XML to request a UTS MATIP screen object is as follows:
<ScreenUts Columns="80" Rows="24">
<MatipClient HostName="yourhost" Addressing2Byte="false" ConcentratorHost="localhost" H1="yourH1" H2="yourH2" A1="yourA1" A2="yourA2" SID="yourSID" />
</ScreenUts>
Additional ScreenUts 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 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 be converted to 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 be converted to 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 be converted to 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. |
| MatipClient XML Parameters | ||
|---|---|---|
| Parameter | Value | Description |
| HostName | name | IP address or domain name of the MATIP 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. |
| SID | hexaddr | A hexadecimal Station Identifier (for example, 0x51) |
| 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. |
| 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. | |
| 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:
|
| 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. | |
| 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, BCFKS, PKS12) | Format of the Key Store file (required). |
| KeyStorePWD | password | Password used to create the Key Store file (required). |
| 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. |
 |
| Defining an XML Configuration |
| The Screen Object Model |
| Requesting a Screen Object |
| Using a MATIP Concentrator |