AT&T ESCORT 3270 User Manual

1-

-

~

ATSaT

t

308-380

Issue 1

AT&T

3270

lEmWlUa1.tCrf

ESCORTTM

User's Guide

-D-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-

L-o

•••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••

r!:.

~.

...............................................................

•

r·

-"

•••••••••••••••••••••••••••••

• I

•••••••••••••••••••••••••••••

• I

••••••••••••••••••••••••••••

•

"'_-'T1I" •••••••••••••••••••••••••••••

•

•••••••••••••••••••••••••••••

· ............................. .

· .............................. .

....

-

.............................................................

• I I

•••••••••••••••••••••••••••••

. , ............................ .

· ................................... .

· .............................. .

· .............................. .

· .............................. .

·

..

~,

............................ .

• I

•••••••••••••••••••••••••••••

• 1

••••••••••••••••••••••••••••••

....

"'

............................ .

· .............................. .

· .............................. .

· ................................

·.·A·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.·.x

:.:1

~.:.:.:.:.:.:.

· .............................. .

· .............................. .

· ............................. .

· . . . . . . . . . . . . . . . . . . . . . . . . . . . .

• r ~

•••

..

.... ' ..................... .

••

J

~...

•••

• • • • • • I •

·;"!r:·:·:·:·

. ............................ .

•

L._~·

••••••••••••••••••••••••••••••••••••••••••••••••••••••••

· .............................. .

·rr~~:.:.:.:.:.:.

. ............................ .

L.

.•

..J

••••••••••••••••••••••••••••••••••••••••••••••••••••••••••

· ............................... .

· ............................... .

:I~.:.:.:.:.:.:.

•

t..-.....I •••••••••••••••••••••••••••••

· .............................. .

~

.....................................•...•.•.•••

•

If

••••••••••••••••••••••••••••••

. ............................. .

·

~

............................. .

· ................................ .

-!

.. ! ..

!

.. ! ..

!.... •

:.:.:

.:.:.:

.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.x

[ -

........................

'

••••••••••••••••••••••••••••••••••••••••••

••••••••••••••••••••

.•

:-:

.:.:.:.:.

:.:.:.:.:.:.:.:.:.:.:.:.:.:.:-:.:.:

:.:.:.:.

:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:

:.:

.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.x

....

-!

... ! ... ! ... ! ...

!-~-~-.

-~-!-~-!-!-~-!-~-~-~-~-!-!-~-!-~.J!I-_

•

iii

•

.

..,.

••

..

.

.

...

~

...........

.

•••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••

...

:.:.:.:.:.:.:-:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:.:

+

..

1

1

©1988

All
Printed

NOTICE

The
assumes

DEC
Corporation.
I
Machines Corporation.
MS-DOS
Tektronix

AT&T

Rights Reserved

in

USA

information

is

a registered trademark

BM

is

a registered trademark

in

no

responsibility for any errors that may appear

is

a registered trademark of Microsoft Corporation.

is

a registered trademark of Tektronix,

this document

and

and

is

subject

VT100

CICS

to

change without notice.

in

this document.

is

a trademark of Digital Equipment

is

a trademark of International Business

Inc.

AT&T

Contents

1

2

Getting Started

Overview
What

Is

In

This Guide
Before You Begin
Other

ESCORT Documentation

Using ESCORT

OverView
Using Interactive, Script, and Tutorial Modes
Working in Host and Local Sessions
ESCORT Utility Files
Command Line
Special

Key

Combinations

Glossary

Appendix
Appendix

A:

Key Sequences

B:

Environment

Variables

1-1
1-3
1-7

1-9

2-1
2-3
2-23
2-39
2-41
2-43

A-1

8-1

Appendix

C:

Interpretation of

Attribute Bytes

Index

C-1

1 Getting Started

Overview 1

-1

What Is In This Guide 1 -3

Organization
Conventions

of

This Guide 1 -3

1

-4

Before You Begin 1 -7

Other ESCORT Documentation 1 -9

Overview

This user's guide contains the information you need to know to
use

ESCORT™.

This guide assumes

o operate

terminal

o use

host (for
VM/CMS, CICS

o use

based

Before you begin using

an

an

application running

an

application running

AT&T

that

IBM®

exampleiMan

3278 or

,or

3B

processor.

ESCORT, you should understand

a user knows how to

DEC®

on

IBM

host system under IMS, TSO,

VTAM)

on a UNIX®

VT100™ (or similar)

a synchronous or asynchronous

operating system

o the modes of operation featured in ESCORT

o

the

special features of the software

o the concept of accessing multiple sess'ions.

..

Overview

1-1

What Is

In

This Guide

Organization of This Guide

This guide

Getting Started

contains information about this user's guide. Read this chapter
to learn how
used throughout

Using ESCORT

discusses
multiple sessions. Special features,
files available,
presented

Appendices

is

divided into five parts:

the

guide

is

organized, and what conventions are

the

guide.

the

procedures for using ESCORT and accessing

the

types of ESCORT utility

~nd

ESCORT special key combinations are also

in

this chapter.

A:

Appendix

consists of tables
and/or key sequences for specific terminal types.

Appendix

provides informatton

Appendix

contains information

Key Sequences

that

present functions and

B:

Environment Variables

on

setting environment variables.

C:

Interpretation of

on

reading attribute bytes.

the

associated

Attrib~te

Bytes

keys

Glossary

contains definitions for terms and acronyms used in this guide.

Index

lists page references for locating specific items

What

in

this guide.

Is

In

This

Guide

1-3

Conventions

Documentation Conventions

The

conventions listed below are used throughout this guide:

o Special function keys

in a rectangle with rounded comers; for example,

o Standard alphabetic and numeric

keyboard are printed in bold; for example,

o Two or more

should press each key sequentially; for example,

keys

o Two keys separated by a hyphen indicate

hold down
second key; for example, ( CTRL) - d.

the

first key while simultaneously pressing

on

your terminal keyboard are enclosed

keys

on

your terminal

f.

separated by spaces indicate

that

you should

tfat

ESC

@.

YjU

f

the

1.

o Commands, functions, and keyword operands are printed in

bold capital letters. Functions always start with a dollar sign
($). For example,

$SCAN

is

a function.

o ESCORT specific key functions and other key functions are

printed in capital letters; for example, CLEAR.

o

The

following type

at

the

o

The

following type

system displays

terminal:

escort scrlpt-IJame

auto script generation started

is

used to indicate data

is

used to indicate information

on

the

screen:

that

the

user types

that

the

o

The

following type

CONNECT

o Multi

o Brackets [ ] indicate optional operands.

..

word operands are separated by

example,

str_expr represents

is

used to indicate program text:

(HI)

an

the

words, string expression.

o Braces { } indicate a choice of operands.

o

The

UNIX file
character
operating system and

versions of

1-4 Getting Started

path

names are shown with

(I). Scripts are portable between

the

MS

..

DOS®

ESCORT and you may, therefore, substitute

operating system

underscore. For

the

standard slash

the

UNIX

the

standard UNIX operating system slash character with
MS

..

DOS

operating system back

character. .

..

slash (\) file name separation

the

Note

Throughout this guide, default key combinations are shown for
ESCORT
Interrupt/Resume (I/R) key combination
sequence
amended by the
environment.

specific functions, for example,

~

f

2.

These default key combinations may be

System Administrator for your particular

If

the

ESCORT

amended you

key combinations for

combinations shown
the

example scripts and

in

this user's guide.

default key combinations are

must

substitute

the

default

in

the

the

the

ESCORT

is

shown

the

document text,

sample programs

as

amended

the

key

Data Entry Conventions

o

ESCORT
lowercase characters
to this

is

case

insensitive, which means

is

string constants.

the

same

as

uppercase.

that

it treats

The

exception

o

The

UNIX shell
lowercase characters differently from uppercase. Thus, when
you invoke
command line,
exactly

the

is

case

sensitive, which means

ESCORT with parameters from

the

same

parameters, such

as

those

in

the

as

file names, must be

file system.

that

the

UNIX shell

Definitions

The

following term

Host

is

used throughout this user's guide.

A host session refers to either a synchronous

or

an

session
otherwise specifically noted.

asynchronous session, unless

What

Is

In

This

Guide 1-5

it

treats

Before You Begin

Before you begin using ESCORT, you should review your specific
operating procedures with your System Administrator and

the

familiarize yourself with

key sequences used in ESCORT:

o Your System Administrator will install

on

the

3B computer and will arrange for
ESCORT to suit your particular location and operating
environment.
Administrator
operating
you of any specific restrictions or requirements.

o You should familiarize yourself with the key sequences

applicable to your terminal. Refer to Appendix A
Quick Reference Card for
your specific ASCII terminal.

of

Some
asynchronous environment. Refer to

the

for
sequences applicable in

o

The
keys, performs special tasks in
combinations are defined
your Quick Reference Card. Familiarize yourself with these
ESCORT specific key combinations.

o Part of

includes
different types
Review with your System Administrator any additional
combinations
environment. Your System Administrator will also advise
any changes to

VT100 terminal, in Appendix

Escape key,

the

When

the

ESCORT, your System Administrator will advise

the

key sequences listed may

System Administrator's installation procedure

the

customization

of

that

you review with your System

environment in which you will be

the

appropriate key sequences for

an

asynchronous environment.

~,

terminals

the

used with certain other terminal

ESCORT. These special key

in

this section and are also listed

of

the

that

will be used

have been defined for your operating

ESCORT specific key combinations.

the

ESCORT

the

customization of

not

be applicable in

the

key sequence table

A,

for

the

key

key sequences for

in

your system.

or

the

software

your

an

in

key

of

You can list these customized key sequences

on

provided

your Key Sequence Card.

Before You Begin 1-7

in

the

space

Refer to Appendix B for information

ESCORT environment variables.

Once

you become familiar with

the

proceed to

next section, which describes the procedures for

the

entering the three different modes of

on

setting

the

various

keyboard layout, you can

ESCORT.

1-8 Getting Started

Other ESCORT
Documentation

This User's Guide

ESCORT documentation.

includes the following:

o

AT&T
Programmer's Guides
AT&T
This binder contains the following three documents:

o

ESCORT
AT&T

publication number 308

ESCORT Overview
ESCORT User's Guide
ESCORT Programmer's Guide

publication number 308

is

part of the

3270

Emulator+

Quick Reference Card and

AT&T

The

entire documentation package

ESCORT

..

..

389.

3270 Emulator+

User's

402.

Key

and

Sequence Card,

Other

ESCORT

Documentation 1-9

2 Using ESCORT

Overview

Using

Interactive, Script,

and Tutorial Modes

Interactive Mode

Script Mode
Tutorial Mode
Interactive Mode Special Features

Working

in

Host and

Local Sessions

Session Identification

Active and Displayed Sessions

in Script Mode

Active and Displayed Sessions

in Interactive Mode

Status Line Information

Modes of Operation Summary

ESCORT Utility Files

2-1

2-3
2-4

2-7

2-12
2-15

2-23
2-23

2-24

2-27

2-34
2-35

2-39

Command Line

Special Key Combinations

2-41

2-43

Overview

The

first section of this chapter describe
modes of
description of the multiple sessions abilities of the software.

Read these sections to understand how to access different host

and local sessions either interactively or via script control.

The

utility files and command line structure, and the final section

describes the operation of

combinations.
chapter will allow you to make optimal use of

ESCORT.

next two sections of this chapter contain information

The

An

understanding

next

section provides a detailed

the

ESCORT specific key

of

the

three operating

the

information in this

ESCORT.

on

Overview

2-1

Using Interactive, Script,
and Tutorial Modes

There are three modes of operation in ESCORT: Interactive
Mode, Script Mode, and Tutorial Mode.

o Interactive (or Terminal Emulation) Mode. This mode

provides simultaneous access to multiple host applications.
Special

o Script Mode. This mode allows you to simulate a user on

one of
ESCORT accepts data from a script instead of from the
keyboard.
instructions contained in the script.

ESCORT features are available in this mode.

the

multiple sessions. While in Script mode,

ESCORT can simulate a user by executing the

o Tutorial Mode. This mode

however, it can be used to verify data entered by the operator
before sending data to the host.

This section contains

the

is

similar to Interactive mode,

procedures for using these three modes.

Using Interactive, Script, and Tutorial Modes 2-3

Interactive Mode

In

Interactive mode, you can work
you were entering data
DEC

VT100 asynchronous terminal connected to a host

on

an

computer.
To

enter Interactive mode:

1 Enter one of the following commands at the shell prompt,

depending

on

the session type.

on

your application just

as

IBM 3278 synchronous terminal or

if

D For a synchronous host, type escort and press (
D For

You

an

asynchronous host, type escort async.p t

( RETURN).

will see

the

ESCORT banner screen briefly before you

get to your initial application screen.

2

Log

in to your application and continue to use the terminal

as

you usually do.

3

To

leave Interactive mode and return to the UNIX shell, you
can use a special key combination, QUIT.
Interactive mode, press

~

f 1.

To

RETURN)

and

QUIT

•

press

t

The

async.p

ESCORT script
parameters to a specific asynchronous host.
SERINIT
operating environment.

2-4

Using

command contained in the script must be amended to suit your

ESCORT

is

used to initialize the communication port

The

default operands to the

The following diagram illustrates the relationship between the
UNIX shell and Interactive mode.
on

a synchronous host

by

host
pressing

(,piny escort Bsync.p, and return to the UNIX shell

ESC

f

1.

by

typing escort or

You

enter Interactive mode

on

an asynchronous

by

FIGURE

2-1

escort

synchronous

environment)

or

escort

async.p

(in

asynchronous

envir

nment)

UNIX

(in

f1

Interactive

Caution

As a general rule, you should complete all the required host
application operations before quitting Interactive mode. Quitting

may

Interactive mode without completing logoff procedures
by

itself, log you off the application.

on

the operating environment

as

The

follows:

process

is

dependent

not,

o Synchronous Communication.

mode, your terminal session
that

if you reenter Interactive mode, you
same application screen you were at
QUIT

The

special

key

combination ( ( ESC) f 1).

ability to resume an application after executing a

special key combination

Using Interactive, Script, and Tutorial Modes 2-5

may

is

dependent upon the protocol

When

you leave Interactive

still be active. This means

may

get back

to

when you executed the

QUIT

the

being used (bisynchronous communication,
Synchronous Data Link Control in

parameter defined in

and

the

application itself. Refer to

documentation to determine whether you will be able to

an

resume
environment.

In

addition,
environment may affect your ability to resume
after executing a
the

AT&T

Guides

application

the

3270 Emulator+ User's and System Administrator's

for further information.

the

host system front

in

your particular operating

controller configuration file in

QUIT

special key combination. Refer

an

the

bsc,

or

sna environment);

..

end,

VT

AM

appropriate

the

sna

an

application

the

..

GEN;

to

o Asynchronous Communication. Executing a

in

an

key combination

same result

disconnecting
If

the
using
Interactive mode will
application. However, unlike

you will

QUIT

the

While

features

in

of

as

,breaking the host connection by, for example,

the

Interactive asynchronous host operation

the

UNIX operating system nohup command, quitting

not

be

able to resume

special key combination.

Interactive mode, you can choose any

ESCORT:

asynchronous session produces

modem.

not

affect

the

operation of

the

synchronous environment,

the

application after executing

o Automatic Script Generation (ASG)

o Automatic Screen Logging (ASL)

o Display Screen Attributes (A TTRIB) ,

(synchronous communication only)

o Local Screen Printing

o Escape to

the

UNIX shell

o Activate, open and close host sessions

o Display active sessions (SHOW)

QUIT

was

of

the

special

the

executed

the

following

These features are described

2-6

Using

ESCORT

in

more detail later

in

this section.

Script Mode

Script mode
mode, you can simulate a user
mode,
keyboard. A script

To

activate Script mode, type

escort script-IJame

and press ( RETURN).
The

script-IJame

The

ESCORT
performs syntax checking and parsing. ESCORT
the

appropriate host application screen and starts to execute
commands from
data entered
application may be displayed

is

the

most powerful feature

at

a terminal. While

of

ESCORT.

ESCORT accepts data from a script instead

is

a set

of

commands contained in a file.

is

the

name

of

the

script you want to execute.

banner screen appears briefly while ESCORT

then

the

parsed list. During execution of

on

the

screen and responses received from

on

the

monitor.

of

In

in

this

your

displays

the

script,

the

Script

the

host

When
statement), ESCORT

the

last statement

in

the

program

is

terminated and control

is

reached (the

is

returned to

ENDP

the

UNIX operating system. You can also terminate script execution

the

prematurely (before

ENDP

quitting script mode (pressing

statement

@)

f 1).

is

encountered)

by

Using Interactive, Script,

and

Tutorial

Modes 2-7

The relationship betWeen Script mode and the UNIX shell

illustrated in
entering escort scrlpLname and exit to the UNIX shell with
ENDP

the

diagram below .

statement or

by

pressing

You

execute a script

@§)

f

1.

by

is

an

FIGURE

2·2

escort

script_name

or

ENDP

~

Script

At

any time during active host script execution, you can
interrupt script execution, exit to Interactive mode, and then
later resume script execution at exactly the same place where you
left off earlier.

Use the special key combination,
InterruptlResume

This

key

combination acts

between interrupting and resuming

interrupt script execution
Interactive mode,

In the synchronous environment, you may
Interactive mode immediately. Interactive mode
the current transaction
keyboard

synchronous host system).

2·8

Using

is

ESCORT

(IIR)

not

unlocked

operation.

as

by

to the UNIX shell.

is

completed

by

the application running

@§)

f

2,

a toggle switch

SC(ipt

ejecution.

pressing

ESC

(for

example, when the

to perform an

that

f

2,

not

be able to

alternates

When

you exit to

use

is

entered when

on

the

you

Interactive mode

asynchronous host script execution. However,

transaction may continue to execute.

is

entered immediately when you interrupt

the

current

Another

mode

command can be coded anywhere in your program. ESCORT

commands are discussed in detail

is

to use

way

to enter Interactive mode from active host Script

an

EXIT

command in a script.

in

the ESCORT

The

Programmer's

EXIT

Guide.

Once

you are in Interactive mode (either due to a manual

interrupt by pressing
script), you can press
combination) to

The

following diagram illustrates the relationship of host Script
mode to Interactive mode and
you want to quit script execution and return to
Use @ f 2 if you want to interrupt script execution and enter
Interactive mode.

@ f 2 or due to

an

EXIT

command in a

@ f 2 (the Interrupt/Resume (I/R) key

go

back to Script mode.

the

UNIX shell. Use @ f 1 if

the

UNIX shell.

Using Interactive, Script, and Tutorial Modes 2-9

FIGURE 2-3

escort

script_name

~

UNIX

f 1

Script

or

f2

EXIT

f2

~

Interactive

The

ability to exit to Interactive mode while executing a script
can be used to notify you of an error condition. For instance, if
a script cannot handle a particular situation it encounters,

script can inform you of

and can
recover from the problem condition and resume script execution.

then

exit to Interactive mode.

the

condition by displaying a message

You

can

then

the

attempt to

2-10

Using

ESCORT