Requesting a UTS INT-1 Screen Object

In order to request a UTS INT-1 screen object, you must create an XML configuration and one or more XML environments. XML environments may be embedded within the configuration XML or may be stored as separate files.

The XML to request a UTS INT-1 screen object is as follows:

<ScreenUts Columns="80" Rows="24">
        <Int1Interface EnvironmentName="UDSSRC" AutoConnect="True"  TerminalId="T1234" DeviceType="UTS60" envPath="yourpath" />
</ScreenUts>

Additional ScreenUts and Int1Interface XML configuration 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">

Sample Environment as a Separate .xml File

The following sample is from an environment .xml file called "Sample DEMAND environment for UTS.xml", which is referenced by a separate configuration file ("Sample DemoConfig2.xml for UTS"). Both files are available at <Installation Location>\samples\xml.

<Int1 AppName="DEMAND" InitTrans="">
	<tp0 Tsap="RSDCSU" InetAddress="yourhost.yourcompany.com"/>
</Int1>

The ScreenUTS XML configuration references the "DEMAND" XML environment by setting the XML parameter "EnvironmentName" equal to "DEMAND" as shown below (from "Sample DemoConfig2.xml for UTS"). In addition, the envPath specifies where the configuration should look for the environment file.

<ScreenUts Columns="80" Rows="24">
 	<Int1Interface EnvironmentName="DEMAND" AutoConnect="true" TerminalId="T120" DeviceType="UTS60" 
           envPath="pathname" />
</ScreenUts>

Sample Environment as Embedded XML

Each embedded environment takes the form of an EnvironmentData section within the Int1Interface section, as follows:

<EnvironmentData  Name="environmentName"  XMLData="yourEnvironmentXML" />

The following example shows a UTS INT-1 configuration with two embedded environments. In this example, the DEMAND environment is used for the initial connection because it is specified by the EnvironmentName parameter in the Int1Interface section. To use the UDSSRC environment once the connection is open, you would change the EnvironmentName parameter to UDSSRC in the Int1Interface section.

<ScreenUts Columns="80" Rows="24">
  <Int1Interface EnvironmentName="UDSSRC" AutoConnect="True" TerminalId="TerminalId" DeviceType="UTS60">
     <EnvironmentData   Name="UDSSRC"
        XMLData="<Int1 AppName=&quot;UDSSRC&quot; InitTrans=&quot;&quot;> <tp0 Tsap=&quot;TIPCSU&quot; InetAddress=&quot;YOURHOST.YOURCOMPANY.com&quot; /> </Int1>"
     />
     <EnvironmentData   Name="DEMAND"
        XMLData="<Int1 AppName=&quot;DEMAND&quot; InitTrans=&quot;&quot;> <tp0 Tsap=&quot;RSDCSU&quot; InetAddress=&quot;YOURHOST.YOURCOMPANY.com&quot; /> </Int1>"
     />
  </Int1Interface>
</ScreenUts>

Additional Int1, tp0, and Telcon environment parameters are also shown in the tables below.

XML Configuration Parameters

In the following tables, 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 sent with SendKeys are placed in the Presentation Space. The letters that appear uppercase only are determined by the CaseLowBoundry and CaseHighBoundry. Any letters between the specified letters are placed in the Presentation Space only in uppercase.
False Both lowercase and uppercase characters sent with SendKeys are placed in the Presentation Space.
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

Int1Interface XML Parameters
Parameter Value Description
EnvironmentName filename The name of the environment XML file found in envPath or on the server or the name of an embedded environment.
envPath path The full path to the XML specified in the EnvironmentName parameter.
TerminalId terminalid The terminal identifier, also know as a TID, to use to connect to the mainframe.

The default value is blank.

DeviceType value The type of terminal the presentation space emulates. Valid values are UTS20, UTS40, and UTS60. The default is UTS60.
AutoConnect True The UTS session connects to the host when the Open method is called.
False The UTS session does not connect to the host when the Open method is called. This allows your session to be connected to Int1 without automatically being connected to the host.
ConnectString string The command to use to establish a session with the host (up to 10 characters).

The default value is $$OPEN.

DisconnectString string The command to use to end a session with the host (up to 10 characters).

The default value is $$CLOSE.

TryAlternateFirstOnRecovery False Specifies that the session should try the primary host first when recovering the connection.
True Specifies that the session should try an alternate host first when recovering the connection.

If this option is set, you must also set AltInetAddress, which is listed in the tp0 parameters.

HostDownDelay milliseconds Specifies a number of milliseconds to delay after the connection fails before attempting to recover the host connection. The default value is 5 seconds.
ReconnectDelay milliseconds Specifies the delay in milliseconds between attempts to reconnect to the host. The default value is 2 seconds.
ConnectAttempts number Specifies the number of times to try to connect to the host before attempting to connect to the alternative host or failing the connection. The default value is 1 connection attempt.

Back to top

XML Environment Parameters

The XML parameters in the Int1, tp0, and telcon sections are to be used in the XML environment specification. These parameters also use a name="value" syntax where name is the name of a parameter and value is a valid value for that parameter.

In the following tables, 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.

Int1 XML Parameters
Parameter Value Description
InitTrans transaction The character, word, or phrase that the client sends to the host when communication with the host is first established (up to 15 characters).

This parameter is optional and is primarily used with TIP. For example, you might use ^ to run MAPPER. This parameter can also be used to transmit passwords.

InsertPads True The session will insert INT1 PADs into the datastream.

Some older host applications expect pieces of the INT1 data to be received in a fixed format; when this is the case, setting InsertPads to True will satisfy the host application.

False The session will not insert INT1 PADs into the datastream.
DeviceType value The type of terminal the presentation space emulates. Valid values are UTS20, UTS40, and UTS60. The default is UTS60.
TransparentMode False Indicates that the session operates as a normal INT-1 session.
True Enables Transparent Mode.

Certain control characters, which are normally replaced with "?", are instead passed through.

Back to top

tp0 XML Parameters
Parameter Value Description
RemotePort number The number of the host port to use.

The default value is 102. Add a RemotePort to the environment file only if you need to use a different host port. For the appropriate port number, contact your host administrator.

SocketLinger seconds Instructs the TCP stack how to close host connections. A value of 0 tells the stack to send a TCP RST when the connection is closed and flush any pending data. With any other value, the stack will send a TCP FIN after waiting the specified number of seconds for any unsent data to be sent.
Note This parameter may not work with some older JVMs.

The value must be greater than or equal to zero. The default is 3.

InetAddress ipaddr The IP address of the host front-end.
Tsap string The Transport Service Access Point to use to access the specified host application (up to 32 characters). For example, you might use TIPCSU for TIP connections, or RSDCSU for Demand connections. If you're not sure of the value to use, contact your host administrator.
LocalIPAddress ipaddr Specifies the local IP address to bind to.
Listening False Specifies that the application should use the normal connection to the host address.
True Specifies that Outbound Open is enabled. The application waits for the host to initiate the connection.
LocalPortValue 0 The TCP port to use for a TCP/IP connection. The default is 0, which means the OS selects the local TCP port.
number Specifies a number to use as the local port number.
AltInetAddress ipaddr Specifies an alternate host address to use if connection to primary host fails.

This is used in conjunction with ConnectAttempts, ReconnectDelay, TryAlternateFirstOnRecovery, and HostDownDelay in the Int1Interface XML object.

Back to top

Telcon XML Parameters
Parameter Value Description
RemotePort number The number of the host port to use.

The default value is 256. Add a RemotePort to the environment file only if you need to use a different host port. For the appropriate port number, contact your host administrator.

SocketLinger seconds Instructs the TCP stack how to close host connections. A value of 0 tells the stack to send a TCP RST when the connection is closed and flush any pending data. With any other value, the stack will send a TCP FIN after waiting the specified number of seconds for any unsent data to be sent.
Note This parameter may not work with some older JVMs.

The value must be greater than or equal to zero. The default is 3.

InetAddress ipaddr The IP address of the host front-end.
Listening False Specifies that the application should use the normal connection to the host address.
True Specifies that Outbound Open is enabled. The application waits for the host to initiate the connection.
LocalPortValue 0 The TCP port to use for a TCP/IP connection. The default is 0, which means the OS selects the local TCP port.
number Specifies a number to use as the local port number.
AltInetAddress ipaddr Specifies an alternate host address to use if connection to primary host fails.

This is used in conjunction with ConnectAttempts, ReconnectDelay, TryAlternateFirstOnRecovery, and HostDownDelay in the Int1Interface XML object.

Back to top

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