Host Connect

This Host Interface tool step establishes a connection with the host mainframe. (Actually it tells the Host Server to establish a connection with the host (mainframe or AS400). It returns a host connection handle that can be used by other Host Tools in this handler or a subroutine running off this handler. Host Connect is typically the first Host Interface tool used when starting a session.

If a Host Disconnect step from a previously running handler cached its connection, this tool can use that cached connected to quickly establish communication with the host. Cached connections are effective when handlers are running so frequently that the host doesn’t time out the connection.

For more information on using Host tools, see Overview of Host Interface tools.

Inputs

Host Profile

The name of the Host Profile to use when establishing this connection. See host profile for more information. This profile contains the connection settings.

Use cached connection if available

Once an open connection is cached, other Host Connect steps in other instances of this handler can quickly connect to the host over this same connection. This enables other handlers to run faster because they do not have to log in to the host. You should choose this option if the handler is going to run frequently and the host won’t have time to time out the connection.

Outputs

Host Connection

The handle for the connection to the host mainframe. Other host tools can use this handle when sending commands to the Host Server.

Exit Paths

Success

This step takes the Success exit path if a connection with the host is established and no cached connection was available.

Cache

This step takes the Cache exit path if a cached connection was established.

Failure

This step takes the Failure exit path if a normal or cached connection was not established. This occurs if the mainframe disconnects for some reason.