TN3270 Server Manual Abstract A Tandem TCP/IP service, the Guardian TN3270 Server enables you to use popular TN3270 client software to access 3270 applications on Tandem systems. The Tandem TN3270 server provides TCP/IP access to Pathway, TACL, TEDIT, PS Mail, and other Tandem 3270 applications from terminals, hosts, and a wide variety of workstations. Product Version TN3270 Server D41 Supported Releases This manual supports D41.00 and G01.
Document History Part Number Product Version Published 108429 TN3270 Server D41 August 1996 424097-001 TN3270 Server D41 August 1999 Ordering Information For manual ordering information: domestic U.S. customers, call 1-800-243-6886; international customers, contact your local sales representative. Document Disclaimer Information contained in a manual is subject to change without notice. Please check with your authorized representative to make sure you have the most recent information.
TN3270 Server Manual Glossary Index Figures Tables What’s New in This Manual ix Manual Information ix New and Changed Information ix About This Manual xi Who Should Read This Manual Related Manuals xi xi Organization of This Manual xii Your Comments Invited xiii Notation Conventions xiv 1.
3. Using the Guardian TN3270 Server Contents 3. Using the Guardian TN3270 Server Initializing the Startup Environment 3-1 Starting the Guardian TN3270 Server 3-2 3270 Local and Remote Commands Name Resolution EMS Events 3-5 3-6 3-7 Completion Codes 3-8 4.
4. Using TN32COM (continued) Contents 4. Using TN32COM (continued) TRACE PROCESS 4-22 5. CRT Communication Protocol CRT Mode 5-1 Message Format for Outbound Data Message Format for Inbound Data AM3270 Mode 5-1 5-2 5-2 CONTROL 22 Operation 5-3 READ[x] Request Procedure 5-5 SETMODE Function 59 Procedure 5-7 WRITE[x] Request Procedure SNAX/XF Mode 5-6 5-8 Two-Step READ Requests 5-8 SNAX/XF CRT SETMODE Procedure 5-8 Extended Highlighting in SNAX/XF Mode 5-10 6.
. ITI Communication Protocol (continued) Contents 6. ITI Communication Protocol (continued) WRITE [x] Procedure 6-24 WRITEREAD [x] Procedure 6-25 7. SPI Interface Commands Summary 7-1 Commands and Responses 7-2 ZTN3-CMD-ABORT 7-2 7-3 ZTN3-CMD-ADD ZTN3-CMD-ALTER 7-4 ZTN3-CMD-DELETE 7-5 7-5 ZTN3-CMD-GETVERSION ZTN3-CMD-INFO 7-6 ZTN3-CMD-LISTOPEN 7-7 ZTN3-CMD-STATUS ZTN3-CMD-STOP 7-7 7-9 ZTN3-CMD-TRACE 7-9 8.
8. Event Messages (continued) Contents 8. Event Messages (continued) ZTN3-TKN-BANNER 8-11 9. Trace Formatter A. Terminal Models AM3270 Mode SNAX/XF Mode A-1 A-3 B. Client Messages C. TN32COM Error Messages Error Messages C-1 D. Guardian TN3270 Server Messages E.
E. Subsystem-Specific Tokens (continued) Contents E.
Tables (continued) Contents Tables (continued) Table 3-1. Setting the -r Option 3-5 Table 3-2. 3270 Command Set Table 3-3. Name Resolution Table 7-1. Command and Object Combinations 7-2 Table A-1. Supported AM3270 Mode Terminals A-1 Table A-2. Supported SNAX/XF Mode Terminals Table F-1.
Contents TN3270 Server Manual—424097-001 viii
What’s New in This Manual Manual Information TN3270 Server Manual Abstract A Tandem TCP/IP service, the Guardian TN3270 Server enables you to use popular TN3270 client software to access 3270 applications on Tandem systems. The Tandem TN3270 server provides TCP/IP access to Pathway, TACL, TEDIT, PS Mail, and other Tandem 3270 applications from terminals, hosts, and a wide variety of workstations. Product Version TN3270 Server D41 Supported Releases This manual supports D41.00 and G01.
New and Changed Information What’s New in This Manual TN3270 Server Manual—424097-001 x
About This Manual This manual describes the Tandem Guardian TN3270 Server product. The Guardian TN3270 Server enables you to use client software to access IBM 3270-series applications on Tandem NonStop operating systems.
Organization of This Manual About This Manual • • • • • • DSM Template Services Manual EMS Manual Distributed Systems Management (DSM) Manual (for D series only) Guardian Procedure Calls Reference Manual G-Series Highlights and Migration Planning Guide (for G series only) DSM/SCM User’s Guide You will also find useful information in the following publications: • • • • • • • Kelly, B. “TN3270 Enhancements.” RFC 1647, Auborn University, July 1994. Postel, J., and J. Reynolds.
Your Comments Invited About This Manual • • • • • • • • • • • Section 5, CRT Communication Protocol, describes the Guardian TN3270 CRT communication protocol, including message formats, application file system procedures, and error handling. Section 6, ITI Communication Protocol, describes the Guardian TN3270 Server ITI communication protocol, including message formats, subdevice information, application file system procedures, and error handling.
Notation Conventions About This Manual back to top Notation Conventions General Syntax Notation The following list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS. Uppercase letters indicate keywords and reserved words; enter these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH lowercase italic letters. Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required.
Notation for Messages About This Manual … Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address-1 [ , new-value ]... [ - ] {0|1|2|3|4|5|6|7|8|9}... An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char..." Punctuation.
Notation for Messages About This Manual lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For example: Event number = number [ Subject = first-subject-value ] A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed.
1 Introduction to the Guardian TN3270 Server The Guardian TN3270 Server is a Transmission Control Protocol/Internet Protocol (TCP/IP) service that acts as a Guardian 3270 access method. It allows workstations running the public-domain TN3270 client to access 3270 block-mode or conversational applications residing on Tandem. These applications include Pathway, TACL, TEDIT, and PSMAIL/3270. Note.
Introduction to the Guardian TN3270 Server Clients Guardian TN3270 Server can run as either a single process or a NonStop process pair. A startup option specifies which configuration to invoke and which CPU to use as the backup processor when running in NonStop mode. When operating in the NonStop mode, the primary process records dynamic data to the backup processor. If the primary process or processor fails, the backup process takes over immediately and continues Guardian TN3270 Server support.
Option Negotiation Introduction to the Guardian TN3270 Server Option Negotiation Guardian TN3270 Server expects the negotiation sequence shown in Figure 1-1. Figure 1-1. Option Negotiation Sequence Guardian TN3270 Server Client DO TTYPE SEND TTYPE WILL TTYPE TTYPE IS term-model WILL, DO BINARY WILL, DO EOR WILL, DO BINARY WILL, DO EOR 3270 DATA CDT 002.CDD In Figure 1-1, term-model is one of the supported terminal model names listed in Section A, Terminal Models.
Guardian TN3270 Server Environment Introduction to the Guardian TN3270 Server Guardian TN3270 Server Environment This section describes typical Guardian TN3270 Server environments. Figure 1-2 shows the environment of a simple Guardian TN3270 Server environment. Figure 1-2. Simple Guardian TN3270 Server Environment Guardian System 3270 Application Guardian TN3270 Server ($TN32) TCP/IP ($ZTC0) Workstation TLAM TN3270 Client 5600 / 361x Ethernet LAN CDT 003.
Guardian TN3270 Server Environment Introduction to the Guardian TN3270 Server access to TACL, while another copy could provide access to a Pathway application; however, each copy of the Guardian TN3270 Server requires a different port number. Figure 1-3 shows a Guardian TN3270 Server configuration that has a single TCP/IP configuration. Note that port number 2000 has been assigned to the Guardian TN3270 Server to avoid a conflict with the Tandem TELSERV (Telnet server) program default port number 23.
Guardian TN3270 Server Environment Introduction to the Guardian TN3270 Server Figure 1-4 shows a Guardian TN3270 Server configuration with a multiple TCP/IP configuration. Note that default port number 23 is retained for the Guardian TN3270 Server. There is no conflict with the default port number 23 used for the Tandem TELSERV (Telnet server) program because TELSERV runs on a different TCP/IP process. In this environment, the user must connect to different IP addresses. Figure 1-4.
Introduction to the Guardian TN3270 Server Application Considerations Application Considerations This subsection describes considerations for the Guardian TN3270 Server application interface. Safeguard Considerations If you add a Guardian TN3270 Server window as a Safeguard-protected terminal and the Guardian TN3270 Server is stopped and restarted, Safeguard suspends the Safeguardprotected terminal.
Introduction to the Guardian TN3270 Server • Custom Application Considerations Set the Pathway terminal attribute DIAGNOSTIC to OFF for Guardian TN3270 Server terminals. Setting DIAGNOSTIC ON can prevent terminal threads from being reused.
2 System Setup This section tells you how to set up the Guardian TN3270 Server on your system. It gives the system requirements and installation steps. This section also provides instructions on configuring TCP/IP and verifying the TCP/IP configuration. System Requirements Before you begin using the Guardian TN3270 Server, check that your system meets the requirements listed below. Note. See the Guardian TN3270 Server softdoc for updates on the latest software versions required. Table 2-1.
Files System Setup Table 2-1.
Installing the Guardian TN3270 Server System Setup Table 2-2. Guardian TN3270 Server Files (page 2 of 2) File Name Location Type Description ZTN3TAL ZSPIDEF 101 SPI/EMS definitions file for TAL ZTN3TMPL ZTEMPL 844 DSM templates file ZTN3SEGF ZSPISEGF 440 TACL file segment with EMS/SPI definitions Installing the Guardian TN3270 Server Follow these steps to install the Guardian TN3270 Server: 1.
Troubleshooting the Installation System Setup If the TCP/IP HOSTNAME attribute is set, error messages sent to the client are prefixed with “host-name.” Troubleshooting the Installation After starting TCP/IP, you can verify the network connection from the workstation to the host using one of the following methods: • • Use the PING utility located in the PCTCP subdirectory. PING sends a probe packet from one end of a TCP/IP connection to another and verifies that an acknowledgment was received.
3 Using the Guardian TN3270 Server This section describes how to initialize the startup environment and start the Guardian TN3270 Server. Initializing the Startup Environment To initialize the startup environment for the Guardian TN3270 Server, issue the following optional commands as appropriate for your system environment. All parameters and defines have default values.
Starting the Guardian TN3270 Server Using the Guardian TN3270 Server • A custom host file is used. Starting the Guardian TN3270 Server To start the Guardian TN3270 Server, issue the TN32SERV command from the TACL prompt using the following syntax. TN32SERV / tacl-options / port [ tn32-options ] tacl-options are the standard TACL run options described in the Tandem Advanced Command Language (TACL) Reference Manual.
Starting the Guardian TN3270 Server Using the Guardian TN3270 Server SWAP swap-name specifies a swap volume, where swap-name is the swap volume name. Two swap files are used. The swap files require a total of approximately 600 pages. This space must be available on the swap volume. You can change the amount of swap space allocated for the buffer segment with the -m command line option described later. The Guardian TN3270 Server ignores any IN or OUT file specification.
Using the Guardian TN3270 Server Starting the Guardian TN3270 Server -f forces a Saveabend file to be produced automatically in most circumstances when the Guardian TN3270 Server abends. For common startup errors, the Saveabend file is suppressed. -h causes pool-checking on every memory-management call. Due to increased overhead, you should use this option only when you suspect corruption of the memory pool. -k specifies that a TN3270 Server process supports the Kanji character set in CRT mode windows.
3270 Local and Remote Commands Using the Guardian TN3270 Server AM3270. The mode selected applies to all windows of a TN3270 Server process. The mode for a process cannot be changed once it has been selected. Note. If you run the Guardian TN3270 Server with no command line arguments, the startup syntax is displayed and the Guardian TN3270 Server terminates. Example TN32SERV /NAME $tn32,NOWAIT,PRI 178/ 2000 -n1 Where: • • The port number is 2000. Name resolution is done from the default hosts file.
Name Resolution Using the Guardian TN3270 Server Table 3-2 shows the various 3270 command sets defined by IBM. Table 3-2. 3270 Command Set 3270 Command ASCII Local EBCDIC Remote EBCDIC COPY x’37’ Note 1 x’f7’ ERASE ALL UNPROTECT x’0f’ x’6f’ x’3f’ ERASE WRITE x’35’ x’05’ x’f5’ ERASE WRITE ALT x’3d’ x’0d’ x’7e’ READ BUFFER x’32’ x’02’ x’f2’ READ MODIFIED x’36’ x’06’ x’6’ READ MODIFIED ALL x’3e’ Note 1 x’6e’ WRITE x’31’ x’01’ x’01’ NO-OPERATION Note 2 x’03’ N.A.
EMS Events Using the Guardian TN3270 Server • If -n2 is specified, the method of host name resolution is determined by the presence or absence of the TCPIP^HOSTS^FILE and TCPIP^RESOLVER^NAME as expressed by the rules in Table 3-3. Note. If host name resolution through a Domain Name Resolver is specified, and the resolver is not accessible, significant delays will be encountered by all sessions during the establishment of a new session.
Completion Codes Using the Guardian TN3270 Server Completion Codes The Guardian TN3270 Server returns the following completion codes: 0 Process terminated normally (STOP PROCESS). A shutdown event is sent to EMS. 1 Process terminated with a startup error. Either an EMS event is generated or an error message is written to the hometerm file. 2 Process abended. Either an EMS event is generated or an error message is written to the hometerm file.
4 Using TN32COM This section tells how to use TN32COM, the operator interface to the Guardian TN3270 Server. Starting TN32COM This subsection describes how to start TN32COM and how to use TN32COM commands. To start TN32COM, enter the following command at the TACL prompt: tn32com [/tacl-opts/] [ tn32-name ] [ ; cmd ... ] tacl-opts are the standard TACL options, for example, IN, OUT, or PRI. tn32-name is the process name of the Guardian TN3270 Server process to be opened.
Completion Codes Using TN32COM Completion Codes TN32COM returns the following completion codes: 0 Program terminated normally (EXIT). 1 Process terminated with warning messages. 2 Program abended.
TN32COM Commands by Type Using TN32COM TN32COM Commands by Type TN32COM provides the following commands, which are listed by type. Each command is described in this subsection, listed in alphabetical order.
TN32COM Command Descriptions Using TN32COM TN32COM Command Descriptions This subsection contains descriptions of the TN32COM commands. ABORT WINDOW This command terminates a session on the specified window. The session with the client will be disconnected. Error 140 (FEMODEMERR) will be returned to all outstanding application I/Os. ABORT WINDOW window-name window-name is #window for the specified window or asterisk (*) for all windows.
ADD WINDOW Using TN32COM ADD WINDOW This command adds a static window to the Guardian TN3270 Server configuration. ADD WINDOW window-name [ , caller-spec ] window-name is #window. caller-spec is CALLER ip-address [, PORT port-num ]. If you specify the CALLER ip-address, the window will be assigned to only a session initiated by that IP address. If you omit the CALLER, the window may be used by any session.
ALTER PROCESS Using TN32COM ALTER PROCESS These commands allow you to modify the process attributes by switching EMS event logging to the specified EMS collector, enabling and disabling national language support translation, and modifying character values in the national language support translation tables. ALTER PROCESS , {LOGFILE collector} {TRANSLATE ON|OFF} {INPUTTABLE|OUTPUTTABLE, A|ADDRESS integer, V|VALUE integer} collector is an EMS primary or alternate collector.
ALTER WINDOW Using TN32COM ALTER WINDOW This command allows you to modify the CALLER attribute of the window. ALTER WINDOW window-name , caller-spec window-name is #window for the specified window or an asterisk (*) for all windows. caller-spec is a specified CALLER or CALLER ip-address [, PORT port-num ]. ip-address is a TCP/IP address in dotted decimal form. If you specify ip-address, the window will be reserved for clients with that IP address.
COMMENT Using TN32COM COMMENT This command causes all text up to a semicolon (;) or end-of-line to be ignored. COMMENT any-text any-text is a text string.
DELETE WINDOW Using TN32COM DELETE WINDOW This command deletes a window from the Guardian TN3270 Server configuration. The window being deleted must not be in use. DELETE WINDOW window-name window-name is #window for a specified window or an asterisk (*) for all windows.
EXIT Using TN32COM EXIT This command exits TN32COM.
FC Using TN32COM FC The FC command, short for “Fix Command,” allows you to edit (fix) a command you previously entered. FC Examples -> FC ..STARFUS WINDOW #WIN001 DDIT ..STATUS WINDOW #WIN001 R002 ..
HELP Using TN32COM HELP This command displays online help for the specified command or for all commands. HELP [ command-name | ALL ] HELP displays the syntax of all commands. HELP command-name displays the syntax and description of the specified command. HELP ALL displays the syntax and description of all commands.
INFO PROCESS Using TN32COM INFO PROCESS This command displays static and dynamic information from the Guardian TN3270 Server process. INFO PROCESS [ table-id [ cell-spec ] [ base ] ] table-id is either INPUTTABLE for the national language input translation table or OUTPUTTABLE for the national language output translation table. cell-spec is the decimal address of the table cell to display in decimal. If cell-spec is omitted, the entire table is displayed in the specified base.
LISTOPENS [WINDOW] Using TN32COM LISTOPENS [WINDOW] This command displays the openers of the specified window. LISTOPENS [WINDOW] window-name window-name is #window for the specified window.
OPEN [PROCESS] Using TN32COM OPEN [PROCESS] This command opens the specified Guardian TN3270 Server process. The server banner will be displayed. All subsequent commands will be sent to the currently open process. OPEN [PROCESS] process-name process-name is the name of the specified Guardian TN3270 Server process to be opened.
STATUS PROCESS Using TN32COM STATUS PROCESS This command displays the status of the Guardian TN3270 Server process. STATUS PROCESS Example ~STATUS PROCESS Number of windows: 3 Logfile: \CSO.
STATUS PROCESS Using TN32COM (6) current allocated is the current number of bytes allocated from the memory pool. Percent current allocated (7) is the percentage of configured (1) memory. (8) maximum allocated is the maximum number of bytes allocated from the memory pool. Percent maximum allocated (9) is the percentage of configured (1) memory. (10) current count is the current number of allocations from the buffer pool. (11) maximum count is the maximum number of allocations from the buffer pool.
STATUS SESSION Using TN32COM STATUS SESSION This command displays the status of the specified session. STATUS SESSION is used to locate the window with the specified IP address. STATUS SESSION ip-address ip-address is a TCP/IP address in dotted decimal format. Example ~STATUS SESSION 130.252.161.97 Session Port Window State 130.252.161.097 01387 #WIN001 Idle Session is the TCP/IP address of the session. Port is the remote port number of the client.
STATUS WINDOW Using TN32COM STATUS WINDOW This command displays the status of the specified window. STATUS WINDOW window-name [ , DETAIL [ , STATS ] ] window-name is #window for the specified window or an asterisk (*) for all windows. DETAIL displays additional detailed information on the status of the window. STATS displays the elapsed time, the number of messages sent and received, and the number of bytes sent and received for the session is displayed.
STATUS WINDOW Using TN32COM These are the Window states: State Meaning CLOSED The window has been added, but no application has opened it. OPEN An application has opened the window, but it has not yet posted a Control11 (wait for modem connect). CTRL-11 A Control-11 is pending from an application. SESS-ESTAB A Control-11 is pending and the session has been established. The STATE MACHINE is waiting for 3270 mode negotiation to be completed.
STOP PROCESS Using TN32COM STOP PROCESS This command terminates the current Guardian TN3270 Server process.
TRACE PROCESS Using TN32COM TRACE PROCESS This command starts and stops tracing the Guardian TN3270 Server process. The trace file is created with the ownership and security of the process access ID of the Guardian TN3270 Server process. TRACE PROCESS trace-opts TRACE PROCESS , STOP trace-opts are TO trace-file, PAGES num-pages, RECSIZE recsize. trace-file is the name of the trace file. num-pages is the size of the trace file in pages. The range is from 50 to 65,000 pages. The default is 200 pages.
5 CRT Communication Protocol This section is divided into three parts. • • • CRT Mode describes the format of Telnet 3270 data in CRT mode. AM3270 Mode on page 5-2 describes the application interface to the Guardian TN3270 Server when it is configured to emulate AM3270. SNAX/XF Mode on page 5-8 describes the applicable file system procedures for running the Guardian TN3270 Server in SNAX/XF mode.
Message Format for Inbound Data CRT Communication Protocol Message Format for Inbound Data For inbound data, as shown in Figure 5-2, the buffer returned to the application contains the complete data message, starting with the Attention ID (AID) character, as it was received from the client. Communications characters are stripped. A single buffer is returned to the application. Figure 5-2.
CONTROL 22 Operation CRT Communication Protocol CONTROL 22 Operation Use the CONTROL operation to perform device-dependent I/O operations. For a normal file system READ request, the READ call COUNT parameter specifies how much buffer space the file system must allocate for the duration of the READ request. Data buffer space can be exhausted quickly when many subdevices exist simultaneously for a given configuration and each subdevice has one or more outstanding READ requests of substantial size.
CONTROL 22 Operation CRT Communication Protocol request should be issued as soon as possible after termination of the CONTROL 22 operation. CONTROL 22 Operation Syntax The following CONTROL operation is called to invoke a two-step READ request. CALL CONTROL (filenumber, 22, size [, tag ]); filenumber INT:value is the number assigned to the subdevice when opened. 22 INT:value is the CONTROL operation. size INT:value is the size, in bytes, issued for the actual call to the READ request.
READ[x] Request Procedure CRT Communication Protocol READ[x] Request Procedure After a normal READ request is completed (a CONTROL 22 operation is not used), and the client responds with text, the blocks received by the Guardian TN3270 Server are collected and stripped of any communications control characters. When the final block is received, the read is completed by transferring the data to the application process, as shown in Figure 5-2 on page 5-2.
SETMODE Function 59 Procedure CRT Communication Protocol SETMODE Function 59 Procedure A SETMODE function 59 procedure returns the actual count of bytes read as a result of a CONTROL 22 operation (two-step READ request) completion. CALL SETMODE (filenumber, 59, , , last-params); filenumber INT:value is the file to receive the SETMODE function. 59 INT:value is the SETMODE number for obtaining the actual count of the bytes read. last-params INT .ref:2 is a value that must be provided.
WRITE[x] Request Procedure CRT Communication Protocol WRITE[x] Request Procedure A WRITE request procedure adds communication control characters to the data and writes it to the client. Transfer of the data to the TCP/IP process completes the WRITE request. WRITE[x] (filenumber, buffer, write-count [, count-written] [, tag ]); filenumber INT:value is the number of an open file that identifies the file to be written. buffer INT .ref:* (For WRITE) STRING .
SNAX/XF Mode CRT Communication Protocol SNAX/XF Mode You can configure the Guardian TN3270 Server process to emulate the SNAX/XF application interface by specifying the -s switch on the command line. The Guardian TN3270 Server runs in AM3270 mode by default.
SNAX/XF CRT SETMODE Procedure CRT Communication Protocol A SETMODE function 144 procedure also returns a value indicating the IBM device type. The IBM device type code returned depends on which IBM terminal emulation is selected for the window during Telnet terminal type negotiation. If the -k option is selected, a value of 2 is returned, indicating that the terminal is not a 3277 or 3276 terminal.
Extended Highlighting in SNAX/XF Mode CRT Communication Protocol last-params [1].<8:15> is the double-byte character set. If the -k option is not selected, the Guardian TN3270 Server returns a 0 by default, indicating no double-byte character set. If the -k option is selected, the Guardian TN3270 Server returns a 3, indicating IBM MIXED. Other SNAX/XF CRT SETMODE Procedures Some SNAX/XF SETMODE procedures do not function in a TCP/IP environment or with the Guardian TN3270 Server.
6 ITI Communication Protocol This section is divided into three parts. • • • Interactive Terminal Interface describes the interactive terminal interface (ITI). Applicable File System Procedures (AM3270 Mode) on page 6-4 describes the application interface to TN3270 Server when it is configured to emulate AM3270. Applicable File System Procedures (SNAX/XF Mode) on page 6-14 describes the application interface to TN3270 Server when it is configured to emulate SNAX/XF.
Message Formats ITI Communication Protocol Message Formats The ITI protocol, as shown in Figure 6-1, takes an output buffer containing text to be written and adds the following information before the existing text: 1. A command character (CMD) 2. A write control character (WCC) 3. Appropriate 3270 screen orders The text line is following by: 1. An IS-A-COMMAND (IAC) character 2. An end-of-record (EOR) character Figure 6-1.
ITI Considerations ITI Communication Protocol • • The ITI protocol does not handle the BACKSPACE and LINE DELETE terminal local operations. The ITI protocol maintains an output line count and cursor address. The output data display wraps. A screen separator of a line of equal signs (=) indicates the bottom of the screen. The screen separator updates each time a READ or WRITEREAD request is completed.
Applicable File System Procedures (AM3270 Mode) ITI Communication Protocol Applicable File System Procedures (AM3270 Mode) The Guardian TN3270 Server runs in AM3270 mode by default. The following file system procedures are recognized by the Guardian TN3270 Server when it is operating in AM3270 mode: AWAITIO CONTROL OPEN CANCEL DEVICEINFO READ[x] CLOSE FILEINFO SETPARAM WRITE[x] SETMODE WRITEREAD[x] All file system procedures are documented in the Guardian Procedure Calls Reference Manual.
CONTROL Operations ITI Communication Protocol CONTROL Operations The CONTROL operation performs device-dependent I/O operations. CONTROL 11 and 12 operations are used for session management. CONTROL 11 waits for a session to be established. CONTROL 12 disconnects a session. CALL CONTROL (filenumber, operation, parameter [, tag ]) filenumber INT:value is the number of an open file, identifying the file to which the CONTROL procedure performs an I/O operation.
READ[x] Procedure ITI Communication Protocol READ[x] Procedure A READ procedure causes the blocks received by the Guardian TN3270 Server to be collected and stripped of any communication control characters. When the final block is received, the READ request is completed to the application process with text only. CALL READ[x] (filenumber, buffer, read-count [, count-read ] [, tag ]) filenumber INT:value is the number of the file to be read. buffer INT .ref:* (for READ) STRING .
SETMODE Function Procedures ITI Communication Protocol SETMODE Function Procedures The SETMODE function procedures are used to set specified terminal characteristics for the ITI protocol. The function parameter can be 8, 11, 12, or 20. Uses for parameter-1 and parameter-2 vary, depending on the value of function. CALL SETMODE (function [, parameter-1 ] [, parameter-2 ]) function INT:value 8 sets the transfer mode: parameter-1 0 conversational mode (default). 1 block mode.
SETMODE Function Procedures ITI Communication Protocol 20 sets the display or nondisplay of keyboard data: parameter-1 INT:value 0 causes the next WRITE request to the terminal to be preceded by a non-display video attribute, which in turn inhibits the display of all characters following the current cursor position.
SETPARAM Function 3 Procedure ITI Communication Protocol SETPARAM Function 3 Procedure The SETPARAM function 3 procedure sets or fetches the parameters for handling a BREAK key indication received from a terminal. CALL SETPARAM (filenumber, function [, param-array ] [, param-count ] [, last params ] [, last-param-count ]) filenumber INT:value is the number of an open file to which BREAK handling parameters are sent. function INT:value sets or fetches parameters for BREAK handling.
SETPARAM Function 3 Procedure ITI Communication Protocol param-count INT:value is the number of bytes in param-array. The value for this parameter must be 8. last-params INT .ref:1 is the returned previous parameter settings of function passed by reference (INT .ref:1). last-params[n] is an integer array containing: last-params[0] sets BREAK ownership: 0 disable BREAK (default). 1 enable BREAK.
SETPARAM Function 3 Procedure ITI Communication Protocol BREAK Message Considerations Whenever the Guardian TN3270 Server detects the input of a PA1 key (simulated BREAK key) from a 3270 terminal configured for ITI protocol, a BREAK message is sent to the owner of the break for that terminal. The six parameters of the BREAK message are: 1. -20, which identifies the BREAK message 2. The logical device number of the I/O operations process 3. The system number of the I/O operations process 4.
WRITE [x] Procedure ITI Communication Protocol WRITE [x] Procedure A WRITE procedure adds communication characters to the text to be written, and then writes the data to the device. WRITE procedures to the application process complete immediately, advancing an internal line counter. If the new line count positions the next line to be written at the bottom of the screen, the bottom of the screen wraps to the top.
WRITEREAD [x] Procedure ITI Communication Protocol WRITEREAD [x] Procedure A WRITEREAD procedure is processed by the Guardian TN3270 Server as a WRITE request followed by a READ request from the application process. CALL WRITEREAD[x] (filenumber, buffer, write-count, read-count [, count-read ] [, tag ]) filenumber INT:value is the number of the file where the WRITEREAD is to occur. buffer INT .ref:* (for WRITEREAD) STRING .
Applicable File System Procedures (SNAX/XF Mode) ITI Communication Protocol Applicable File System Procedures (SNAX/XF Mode) You can configure the Guardian TN3270 Server process to emulate the SNAX/XF application interface by specifying the -s switch on the command line. The Guardian TN3270 Server runs in AM3270 mode by default.
CONTROL Operations ITI Communication Protocol CONTROL Operations CONTROL operations perform device-dependent I/O operations. The CONTROL 11 and 12 procedures are used for session management. CONTROL 11 is used to wait for a session to be established. CONTROL 12 disconnects a session. CALL CONTROL (filenumber, operation, parameter [, tag ]) filenumber INT:value is a number of an open file, identifying the file to which the CONTROL procedure performs an I/O operation.
READ[x] Procedure ITI Communication Protocol READ[x] Procedure A READ procedure causes the blocks received by the Guardian TN3270 Server to be collected and stripped of any communication control characters. When the final block is received, the READ request is completed to the application process with text only. CALL READ[x] (filenumber, buffer, read-count [, count-read ] [, tag ]) filenumber INT:value is the number of the file to be read. buffer INT .ref:* (for READ) STRING .
SETMODE Function Procedures ITI Communication Protocol SETMODE Function Procedures The SETMODE function procedures are used to set specified terminal characteristics for the ITI protocol. The function parameter can have the value of 8, 11, 12, or 20. Uses for parameter-1 and parameter-2 vary, depending on the value of function. CALL SETMODE (function [, parameter-1 ] [, parameter-2 ]) function INT:value 6 (set spring control) is not supported. 7 (set auto line feed) is not supported.
SETMODE Function Procedures ITI Communication Protocol parameter-2 INT:value 0 normal access to terminal (default). 1 BREAK access to terminal. 20 sets the display or nondisplay of keyboard data: parameter-1 INT:value 0 causes the next WRITE procedure to the terminal to be preceded by a non-display video attribute, which in turn inhibits the display of all characters following the current cursor position.
SETMODE function 144 Procedure ITI Communication Protocol SETMODE function 144 Procedure The SETMODE function 144 procedure is used in a SNAX environment to find the single-byte character set and double-byte character set (if any) defined for the logical unit (LU). In a TN3270 Server environment, SETMODE function 144 returns hardcoded values for the Katakana (single-byte) and Kanji (double-byte) character set codes.
SETMODE function 144 Procedure ITI Communication Protocol last-params [0].<8:15> is the value of ALLOWEDMIX LU attribute. The Guardian TN3270 Server always returns a 0. last-params [1].<0:7> is the logical unit (LU) single-byte character set. If the -k option is not selected, the Guardian TN3270 Server returns a 9 by default, indicating EBCDIC. If the -k option is selected, the Guardian TN3270 Server returns a 14, indicating Katakana EBCDIC. last-params [1].<8:15> is the double-byte character set.
SETPARAM Function 3 Procedure ITI Communication Protocol SETPARAM Function 3 Procedure The SETPARAM function 3 procedure sets or fetches the parameters for handling a BREAK indication received from a terminal. CALL SETPARAM (filenumber, function [, param-array ] [, param-count ] [, last params ] [, last-param-count ]) filenumber INT:value is the number of an open file to which BREAK handling parameters are sent. function INT:value sets or fetches parameters for BREAK handling. param-array INT .
SETPARAM Function 3 Procedure ITI Communication Protocol param-count INT:value is the number of bytes in param-array. The value for this parameter must be 8. last-params INT .ref:1 is the returned previous parameter settings of function passed by reference (INT .ref:1). last-params[n] an integer array containing: last-params[0] sets BREAK ownership: 0 disable BREAK (default). 1 enable BREAK.
SETPARAM Function 3 Procedure ITI Communication Protocol BREAK Message Considerations Whenever the Guardian TN3270 Server detects the input of a PA1 key (simulated BREAK key) from a 3270 terminal configured for ITI protocol, a BREAK message is sent to the owner of the break for that terminal. The six parameters of the BREAK message are: 1. -20, which identifies the BREAK message 2. The logical device number of the I/O operations process 3. The system number of the I/O operations process 4.
WRITE [x] Procedure ITI Communication Protocol WRITE [x] Procedure A WRITE procedure adds communication characters to the text to be written, and then writes the data to the device. WRITE procedures to the application process complete immediately, advancing an internal line counter. If the new line count positions the next line to be written at the bottom of the screen, the bottom of the screen wraps to the top.
WRITEREAD [x] Procedure ITI Communication Protocol WRITEREAD [x] Procedure A WRITEREAD procedure is processed by the Guardian TN3270 Server as a WRITE request followed by a READ request from the application process. CALL WRITEREAD[x] (filenumber, buffer, write-count, read-count [, count-read ] [, tag ]) filenumber INT:value is the number of the file where the WRITE/READ is to occur. buffer INT .ref:* (for WRITEREAD) STRING .
WRITEREAD [x] Procedure ITI Communication Protocol TN3270 Server Manual—424097-001 6- 26
7 SPI Interface This section summarizes the Subsystem Programmatic Interface (SPI) commands and describes those supported by the Guardian TN3270 Server.
Commands and Responses SPI Interface Table 7-1 lists valid command and object combinations. Table 7-1. Command and Object Combinations Objects Commands Windows ABORT X ADD X ALTER X DELETE X Process X GETVERSION X INFO X LISTOPEN X STATUS X X STOP TRACE Session X X X X Errors are returned in the token ZSPI-TKN-RETCODE. Error values are enumerated in ZTN3-DDL-RETCODE-ENM. Commands and Responses This subsection describes the Guardian TN3270 Server SPI commands and responses.
ZTN3-CMD-ADD SPI Interface Token descriptions: ZTN3-TKN-SUBDEV is the window name. To abort all windows, set the value to an asterisk (*). ZTN3-TKN-SUBDEV and ZTN3-TKN-RETCODE are returned for each window aborted. ZSPI-TKN-CONTEXT is returned if you specify abort for all windows and not all response records could be returned in the buffer provided. In this case, you must issue a continuation request with the ZSPI-TKN-CONTEXT token to abort the remaining windows.
ZTN3-CMD-ALTER SPI Interface ZTN3-CMD-ALTER Command: ZTN3-CMD-ALTER Object: ZTN3-OBJ-PROCESS Purposes: a. Switches logging to the specified EMS collector. b. Changes NLS character values. c. Enables and disables national language support (NLS) translation Request tokens: a. ZTN3-TKN-FILENAME b. ZTN3-TKN-NLS-TABLENAME ZTN3-TKN-NLS-TABLEADDRESS ZTN3-TKN-NLS-TABLEVALUE c. ZTN3-TKN-NLS-TRANSLATION Response tokens: a. ZTN3-TKN-FILE-ERROR b. None. c. None.
ZTN3-CMD-DELETE SPI Interface ZTN3-CMD-DELETE Command: ZTN3-CMD-DELETE Object: ZTN3-OBJ-WINDOW Purpose: Deletes a window from the Guardian TN3270 Server process. Request tokens: ZTN3-TKN-SUBDEV Response tokens: [ ZSPI-TKN-DATALIST ] ZTN3-TKN-SUBDEV ZTN3-TKN-RETCODE [ ZSPI-TKN-ENDLIST ] [ ZSPI-TKN-CONTEXT ] The window must be in the CLOSED state. Token descriptions: ZTN3-TKN-SUBDEV is the window name. You can use an asterisk (*) to delete all windows.
ZTN3-CMD-INFO SPI Interface ZTN3-CMD-INFO Command: ZTN3-CMD-INFO Object: ZTN3-OBJ-PROCESS Purposes: a. Returns static information about the Guardian TN3270 Server process. b. Returns the contents of the NLS translation tables. Request tokens: a. None. b. ZTN3-TKN-NLS-TABLENAME ZTN3-TKN-NLS-TABLEADDRESS ZTN3-TKN-NLS-DISPLAY-BASE ZTN3-TKN-NLS-ALLORONE-CHOICE Response tokens: a. ZTN3-TKN-BANNER b.
ZTN3-CMD-LISTOPEN SPI Interface ZTN3-CMD-LISTOPEN Command: ZTN3-CMD-LISTOPEN Object: ZTN3-OBJ-WINDOW Purpose: Returns a list of openers of the specified window. Request tokens: ZTN3-TKN-SUBDEV Response tokens: ZSPI-TKN-DATALIST ZTN3-TKN-LISTOPEN-RSP ZSPI-TKN-ENDLIST Token descriptions: ZTN3-TKN-SUBDEV is the window name. ZTN3-TKN-LISTOPEN-RSP contains the process identification of the opener.
ZTN3-CMD-STATUS SPI Interface ZTN3-MAP-STATUS-SESSION-RSP is an extensible structured token containing information about the session. Command: ZTN3-CMD-STATUS Object: ZTN3-OBJ-WINDOW Purpose: Returns the status of a window. Request tokens: ZTN3-TKN-SUBDEV Response tokens: [ ZSPI-TKN-DATALIST ] ZTN3-TKN-SUBDEV ZTN3-MAP-STATUS-WINDOW-RSP [ ZTN3-MAP-STATUS-SESSION-RSP ] [ ZTN3-TKN-SESSION-STATS ] [ ZSPI-TKN-ENDLIST ] [ ZTN3-TKN-CONTEXT ] Token descriptions: ZTN3-TKN-SUBDEV is the window name.
ZTN3-CMD-STOP SPI Interface ZTN3-CMD-STOP Command: ZTN3-CMD-STOP Object: ZTN3-OBJ-PROCESS Purpose: Terminates the Guardian TN3270 Server process. Request tokens: None. Response tokens: None. ZTN3-CMD-TRACE Command: ZTN3-CMD-TRACE Object: ZTN3-OBJ-PROCESS Purpose: Initiates/terminates tracing of the Guardian TN3270 Server process. Request tokens: [ ZTN3-TKN-TRACE-OPTS ] Response tokens: ZTN3-TKN-TRACE-ERROR Token descriptions: ZTN3-TKN-TRACE-OPTS is omitted to stop tracing.
ZTN3-CMD-TRACE SPI Interface TN3270 Server Manual—424097-001 7- 10
8 Event Messages This section describes the Event Management Service (EMS) event messages for the Guardian TN3270 Server.
ZTN3-EVT-ASSERTION-FAILURE Event Messages ZTN3-EVT-ASSERTION-FAILURE Event ZTN3-EVT-ASSERTION-FAILURE Tokens ZTN3-TKN-ASSERTION-CONDITION ZTN3-TKN-SOURCE-FILE ZTN3-TKN-EDIT-SEQNUM Token Descriptions ZTN3-TKN-ASSERTION-CONDITION is a text string containing the illogical condition. ZTN3-TKN-SOURCE-FILE is the NonStop operating system file name of the source file where the illogical condition occurred.
ZTN3-EVT-FILE-ERROR Event Messages ZTN3-EVT-FILE-ERROR Event ZTN3-EVT-FILE-ERROR Tokens ZTN3-TKN-FILE-OP ZTN3-TKN-FILE-ERROR [ ZTN3-TKN-SUBDEV ] [ ZTN3-TKN-HOST-NAME ] [ ZTN3-TKN-SOCKADDR-IN ] Token Descriptions ZTN3-TKN-FILE-OP specifies which NonStop operating system procedure returned the error. ZTN3-TKN-FILE-ERROR is the error returned by the NonStop operating system procedure. ZTN3-TKN-SUBDEV is the window name, if the error occurred while in session.
ZTN3-EVT-FSM-ERROR Event Messages ZTN3-EVT-FSM-ERROR Event ZTN3-EVT-FSM-ERROR Tokens ZTN3-TKN-FSM ZTN3-TKN-FSMID ZTN3-TKN-FSMOBJ Token Descriptions ZTN3-TKN-FSM is a structure containing the previous state, the event, the action, and the next state. ZTN3-TKN-FSMID is an enumeration identifying the state machine that encountered the error. ZTN3-TKN-FSMOBJ contains the name of the object on which the state machine error occurred.
ZTN3-EVT-LOG-SWITCH Event Messages ZTN3-EVT-LOG-SWITCH Event ZTN3-EVT-LOG-SWITCH Tokens ZTN3-TKN-FILENAME Token Descriptions ZTN3-TKN-FILENAME is the name of the new EMS collector. ZTN3-EVT-NET-ERROR Event ZTN3-EVT-NET-ERROR Tokens ZTN3-TKN-OPCODE ZTN3-TKN-SOCKET-ERROR ZTN3-TKN-PROCESS-NAME Token Descriptions ZTN3-TKN-OPCODE specifies the socket operation that returned the error. ZTN3-TKN-SOCKET-ERROR specifies the error returned by the socket operation.
ZTN3-EVT-QUIT Event Messages ZTN3-EVT-QUIT Event ZTN3-EVT-QUIT Tokens None. ZTN3-EVT-RECV-ABORT Event ZTN3-EVT-RECV-ABORT Tokens ZTN3-TKN-FILE-ERROR ZTN3-TKN-OPNAME Token Descriptions ZTN3-TKN-FILE-ERROR is the NonStop operating system error that occurred. ZTN3-TKN-OPNAME is the NonStop operating system procedure that returned the error.
ZTN3-EVT-SESS-ERROR Event Messages ZTN3-EVT-SESS-ERROR Event ZTN3-EVT-SESS-ERROR Tokens ZTN3-TKN-OPCODE ZTN3-TKN-SOCKET-ERROR ZTN3-TKN-SUBDEV ZTN3-TKN-SOCKADDR-IN [ ZTN3-TKN-HOST-NAME ] Token Descriptions ZTN3-TKN-OPCODE specifies the socket operation that returned the error. ZTN3-TKN-SOCKET-ERROR is the error returned by the TCP/IP socket library. ZTN3-TKN-SUBDEV is the name of the window associated with the session on which the error occurred.
ZTN3-EVT-SESS-ESTAB Event Messages ZTN3-EVT-SESS-ESTAB Event ZTN3-EVT-SESS-ESTAB Tokens ZTN3-TKN-SUBDEV ZTN3-TKN-SOCKADDR-IN [ ZTN3-TKN-HOST-NAME ] Token Descriptions ZTN3-TKN-SUBDEV is the window name. ZTN3-TKN-SOCKADDR-IN is a structure containing the IP address and port number of the client. ZTN3-TKN-HOST-NAME is present if name resolution is enabled and the client’s IP host name was found.
ZTN3-EVT-SESS-TERM Event Messages ZTN3-EVT-SESS-TERM Event ZTN3-EVT-SESS-TERM Tokens ZTN3-TKN-REASON ZTN3-TKN-SESSION-STATS ZTN3-TKN-SUBDEV ZTN3-TKN-SOCKADDR-IN [ ZTN3-TKN-HOST-NAME ] Token Descriptions ZTN3-TKN-REASON specifies the reason the session was terminated. ZTN3-TKN-SESSION-STATS contains the elapsed time, number of messages sent and received, and the number of bytes sent and received. ZTN3-TKN-SUBDEV is the window name. This token is present only if the session was connected to a window.
ZTN3-EVT-SPI-ERROR Event Messages ZTN3-EVT-SPI-ERROR Event ZTN3-EVT-SPI-ERROR Tokens ZTN3-TKN-SPI-ERROR ZTN3-TKN-OPNAME Token Descriptions ZTN3-TKN-SPI-ERROR is the error returned by the SPI procedure. ZTN3-TKN-OPNAME is the SPI procedure that returned the error. ZTN3-EVT-STARTED Event ZTN3-EVT-STARTED Token ZTN3-TKN-BANNER Token Description ZTN3-TKN-BANNER contains the version string of the Guardian TN3270 Server process.
ZTN3-TKN-BANNER Event Messages ZTN3-TKN-BANNER Event ZTN3-TKN-BANNER Token ZTN3-TKN-BANNER Token Description ZTN3-TKN-BANNER contains the version string of the Guardian TN3270 Server process.
ZTN3-TKN-BANNER Event Messages TN3270 Server Manual—424097-001 8- 12
9 Trace Formatter The section describes the Guardian TN3270 Server trace formatter. The trace formatter prints the results of traces captured by the trace facility. To start the trace formatter, enter the following command at a TACL prompt. RUN isv.fmttrace / tacl-opts / [ objname ] isv is the installation volume-subvolume. tacl-opts IN trace-file is the name of the trace file to be printed. It must be the name of an existing disk file or the name of a currently executing Guardian TN3270 Server process.
Trace Formatter (Part 2 - information about a $RECEIVE message) (1) (2) (3) (4) opener-pid FILE = opener-file-num [ READ CNT = count ] MSGTAG = msgtag (5) SYNCID = syncid (6) sys-msgtype (Part 3 - the contents of the buffer) An example of the contents of the buffer follows, shown in hexadecimal, ASCII, and EBCDIC. (Part 1) (1) 20:28:00.972 (2) (3) UC.00 P=%006742 AWAITIO (4) FNUM=000 (5) (7) $RECEIVE COUNT=0036 (8) system message received (6) (Part 2) (1) FROM \CSO.03.
A Terminal Models This appendix lists the terminal model numbers that the Guardian TN3270 Server recognizes when performing terminal-type subnegotiation in AM3270 and SNAX/XF modes. AM3270 Mode The Guardian TN3270 Server recognizes the following terminal model numbers when performing terminal-type subnegotiation in AM3270 mode. Table A-1.
AM3270 Mode Terminal Models Table A-1.
SNAX/XF Mode Terminal Models SNAX/XF Mode The Guardian TN3270 Server recognizes the following terminal model numbers when performing terminal-type subnegotiation in SNAX/XF mode. Table A-2.
SNAX/XF Mode Terminal Models Table A-2.
B Client Messages The following is a list of messages that the Guardian TN3270 Server can send to the client. All messages, unless otherwise indicated, terminate the session. [host-name:] APPLICATION DISCONNECTED Cause. The application terminated the session. Effect. The session between TN32 and the application is terminated. Recovery. Informative message only; no corrective action is needed. CLIENT REFUSED OPTION: required-telnet-option Cause. Client sent DONT or WONT for a required Telnet option.
Client Messages SUBOPTION NOT SUPPORTED Cause. The client sent a TERM-TYPE subnegotiation option other than TTYPE-IS. Effect. The session could not be established with the client. Recovery. Notify your system operator that the client is requesting a suboption that the system does not support. TERM TYPE NOT RECOGNIZED Cause. During option negotiation, the client did not send a recognized terminal type. Effect. The session could not be established with the client. Recovery.
C TN32COM Error Messages This appendix describes each error message displayed by TN32COM, the operator interface to the Guardian TN3270 Server. Error Messages 1 PAGES must be >= 10 and <= 62255 Cause. The number of pages specified for a trace was outside the range of 10 through 62,255, inclusive. Effect. TN32COM was not started. Recovery. Reenter the start command, specifying a number from 10 through 62,255, inclusive. 2 Illegal file name Cause. An illegal file name was specified. Effect.
Error Messages TN32COM Error Messages 4 RECSIZE must be <= 4095 Cause. The RECSIZE value exceeded the maximum size for trace records of 4095 bytes. Effect. The trace process was not started. Recovery. Reenter the command, specifying a record size from 1 through 4,095, inclusive. 5 Illegal subdevice Cause. The subdevice identifier was invalid. Effect. The command did not execute. Recovery. Reenter the command, specifying a valid window name.
Error Messages TN32COM Error Messages 8 Process is not TN32SERV Cause. The Guardian TN3270 Server process name was invalid. Effect. The command did not execute and the Guardian TN3270 Server did not start. Recovery. Ensure that the process you are trying to open is executable by TN32SERV and then reenter the command. 9 SSID is not TN32SERV Cause. A process was opened that returned an incorrect subsystem ID (SSID). Effect. The command did not execute. Recovery.
Error Messages TN32COM Error Messages 12 SPI: Invalid command Cause. The Guardian TN3270 Server received an SPI command that it did not recognize. Effect. The command did not execute. Recovery. Check the input for accuracy. If necessary, enter the HELP ALL command to display a list of valid commands. 13 SPI: Invalid object Cause. The Guardian TN3270 Server received an SPI command containing an object type that it did not recognize. Effect. The command did not execute. Recovery.
Error Messages TN32COM Error Messages 16 Unknown return code: return-code Cause. The currently open process returned an unrecognized error in response to an SPI command, where return-code specifies the return code. Effect. The command did not execute. Recovery. Advise your Tandem representative of the circumstances of the condition. 17 WINDOW NOT FOUND Cause. A command referred to a window that could not be located. Effect. The command did not execute. Recovery.
Error Messages TN32COM Error Messages 20 TOO MANY WINDOWS Cause. An additional window could not be added because 255 windows are already defined. Effect. The command did not execute. Recovery. Informative message only; no corrective action is needed. 21 SPI: WRONG SSID Cause. The Guardian TN3270 Server rejected the SSID from TN32COM. Effect. The command did not execute. Recovery. Ensure that the process you are trying to open is executable by TN32SERV. 22 SIO: Error err Cause.
Error Messages TN32COM Error Messages 24 SPI: Invalid buffer format Cause. The SPI interface detected an invalid buffer. Effect. The command did not execute. Recovery. Advise your Tandem representative of the circumstances of the condition. 25 SPI: Illegal parameter Cause. The SPI interface detected an invalid parameter. Effect. The command did not execute. Recovery. Check the input for parameter accuracy. If necessary, enter the HELP command to display a description of the parameter(s).
Error Messages TN32COM Error Messages 29 SPI: checksum error Cause. A checksum error was detected on the SPI buffer. Effect. The command did not execute. Recovery. Advise your Tandem representative of the circumstances of the condition. 30 SPI: internal error Cause. An internal error occurred in one of the SPI routines. Effect. The command did not execute. Recovery. Advise your Tandem representative of the circumstances of the condition. 31 SPI: token not found Cause.
Error Messages TN32COM Error Messages 34 Error err switching EMS collectors Cause. A file system error occurred when opening a new EMS collector process, where err specifies the error. Effect. The command did not execute and the EMS collector was not switched. Recovery. Resolve the error condition as described in the Guardian Procedure Errors and Messages Manual and then reenter the command. 35 Syntax error Cause. A command with incorrect syntax was entered.
Error Messages TN32COM Error Messages 38 Trace usesegment error err Cause. An error occurred in a USESEGMENT call, where err specifies the error returned by USESEGMENT. Effect. The command did not execute. Recovery. Advise your Tandem representative of the circumstances of the condition. 39 Trace already active Cause. You attempted another trace while one was in progress. Effect. The command did not execute. Recovery. Informative message only; no corrective action is needed.
Error Messages TN32COM Error Messages 42 Writeread error: err Cause. An error occurred during a WRITEREAD request to the Guardian TN3270 Server process, where err specifies the NonStop operating system file system error. Effect. The command did not execute and the trace process was not started. Recovery. Resolve the error condition as described in the Guardian Procedure Errors and Messages Manual and then reenter the command. 43 Integer too large Cause.
Error Messages TN32COM Error Messages 46 Version mismatch with server process Cause. An attempt was made to open a Guardian TN3270 Server process whose version is incompatible with the TN32COM process. Effect. The command did not execute. Recovery. Make sure that the versions of both TN32COM and TN32SERV are compatible. See the Guardian TN3270 Server softdoc for updates on the latest software versions required. If necessary, advise your Tandem representative of the circumstances of the condition.
D Guardian TN3270 Server Messages This appendix describes messages sent by the Guardian TN3270 Server. 1 STARTED banner banner is the version of the Guardian TN3270 Server software for the process. Cause. The Guardian TN3270 Server process was started. Effect. The Guardian TN3270 Server process can be configured. Recovery. Informational message only; no corrective action is needed. 2 SHUTDOWN Cause. The Guardian TN3270 Server received a STOP PROCESS command. Effect.
Guardian TN3270 Server Messages port is the remote port number of the client of the Guardian TN3270 Server session. Cause. A session was established with the Guardian TN3270 Server process. Effect. A Guardian TN3270 Server window is assigned to the user initiating the session, if one is available. Recovery. Informational message only; no corrective action is needed.
Guardian TN3270 Server Messages 5 Session terminated. Reason reas Window subdev [ Host: host-name ] IPADDR=ipaddr PORT=port Elapsed days Days hrs:mins:secs Msgs sent/rcvd: msgs-sent / msgs-rcvd Bytes sent/rcvd: bytes-sent / bytes-rcvd reas is the reason the user session was terminated. subdev is the name of the window associated with the session that was terminated. host-name is the name of the internet protocol (IP) host (if known) running the Guardian TN3270 Server client session.
Guardian TN3270 Server Messages Cause. A user session was terminated for the reason specified by reas. Effect. The window is available for reuse unless it was closed due to an application failure. Recovery. Reestablish the session if necessary. 7 SPI opname Error err opname is the name of a Tandem NonStop Kernel file-system operation. err identifies the error returned by the Subsystem Programmatic Interface (SPI) procedure. Cause. An error occurred on a call to a SPI routine. Effect.
Guardian TN3270 Server Messages 9 fsmid State machine error State=fsm.state Event=fsm.event ( objname ) fsmid is the identification of the finite state machine (FSM) within the Guardian TN3270 Server that generated the event. fsm.state is the current state of the FSM. fsm.event is a signal causing a predetermined action based on the current state and error. objname is the name of the object for which the FSM error occurred. Cause. A finite state machine (FSM) error occurred. Effect.
Guardian TN3270 Server Messages err identifies a file-system error. subdev is the name of the window (if known) associated with the session on which the error occurred. host-name is the name of the internet protocol (IP) host (if known) running the Guardian TN3270 Server client session. ipaddr is the remote internet protocol (IP) address of the client (if known) of the Guardian TN3270 Server session. port is the remote port number of the client (if known) of the Guardian TN3270 Server session. Cause.
Guardian TN3270 Server Messages source-file identifies the Tandem NonStop Kernel source file where the condition occurred. edit-linenumber identifies the line number of the Tandem NonStop Kernel source file where the condition occurred. Cause. The Guardian TN3270 Server encountered a logical inconsistency in the code. Effect. The Guardian TN3270 Server terminates, and then creates an Inspect save file. Recovery. Restart the Guardian TN3270 Server process.
Guardian TN3270 Server Messages The Guardian TN3270 Server stops or abends for other errors. If the Guardian TN3270 Server had been running as a NonStop process pair, the backup process automatically assumes the primary process role and attempts to maintain the socket with TCP/IP. Monitor the Guardian TN3270 Server to see if the socket is functioning properly with TCP/IP. If the socket is not functioning properly, restart the TCP/IP process.
Guardian TN3270 Server Messages Cause. The primary process of a Guardian TN3270 Server NonStop pair started. Effect. The primary process tries to start a backup process. Recovery. Informational message only; no corrective action is needed. 17 Backup Process Established: Process Name = process-name process-name is the Guardian TN3270 Server process. Cause. The backup process of a Guardian TN3270 Server NonStop pair started. Effect. NonStop operation can begin. Recovery.
Guardian TN3270 Server Messages TN3270 Server Manual—424097-001 D -10
E Subsystem-Specific Tokens Tokens specific to the Guardian TN3270 Server subsystem are described in this appendix. They are identified by a token name that starts with ZTN3.
Token List Subsystem-Specific Tokens (Continued from previous page) ZTN3-TKN-OPNAME Token Code (See page E-17) ZTN3-TKN-PROCESS-NAME Token Code (See page E-17) ZTN3-TKN-REASON Token Code (See page E-18) ZTN3-TKN-RETCODE Token Code (See page E-19) ZTN3-TKN-SESSION-STATS Token Code (See page E-20) ZTN3-TKN-SOCKADDR-IN Token Code (See page E-20) ZTN3-TKN-SOCKET-ERROR Token Code (See page E-21) ZTN3-TKN-SOURCE-FILE Token Code (See page E-23) ZTN3-TKN-SPI-ERROR Token Code (See page E-23) ZTN3-TKN-SUBDEV Token
Token Definitions Subsystem-Specific Tokens Token Definitions Tokens specific to the Guardian TN3270 Server subsystem are defined in the following subsection. ZTN3-MAP-INFO-TABLE-RSP Token Map This structured token contains the national language support table values displayed. Token Map ZTN3-MAP-INFO-TABLE-RSP Token Type ZTN3-TYP-INFO-TABLE Token Definition Definition ZTN3-DDL-INFO-TABLE-RSP. 02 CONTENTS Type BINARY 16[256]. 02 SENTINEL Type BINARY 16.
ZTN3-MAP-STATUS-PROCESS-RSP Token Map Subsystem-Specific Tokens ZTN3-MAP-STATUS-PROCESS-RSP Token Map This extensible structured token returns status information about the Guardian TN3270 Server process. Token Map ZTN3-MAP-STATUS-PROCESS-RSP Token Type ZTN3-TYP-STATUS-PROCESS Token Definition Definition ZTN3-DDL-STATUS-PROCESS-RSP. 02 NUM WINDOWS Type BINARY 16. 02 POOL STATS Type ZTN3-DDL-POOL-STATS. 02 LOG-FILE Type ZSPI-DDL-CHAR50. 02 LOG-FILE-LEN Type BINARY 16. 02 TRACE-FILE Type ZTN3-DDL-CHAR50.
ZTN3-MAP-STATUS-SESSION-RSP Token Map Subsystem-Specific Tokens ZTN3-MAP-STATUS-SESSION-RSP Token Map This is an extensible structured token that contains information about one session. Token Map ZTN3-MAP-STATUS-SESSION-RSP Token Type ZTN3-TYP-STATUS-SESS-RSP Token Definition Definition ZTN3-DDL-STATUS-SESSION-RSP. 02 SESSION-STATE Type 02 HOST-NAME Type 02 SOCKADDR-IN Type 02 TERM-MODEL Type 02 WINDOW-NAME Type End BINARY 16. ZTN3-DDL-HOST-NAME. ZTN3-DDL-SOCKADDR-IN. ZTN3-DDL-TTYPE. ZSPI-DDL-CHAR8.
ZTN3-MAP-STATUS-WINDOW-RSP Token Map Subsystem-Specific Tokens ZTN3-MAP-STATUS-WINDOW-RSP Token Map This is an extensible structured token containing information about one window. Token Map ZTN3-MAP-STATUS-WINDOW-RSP Token Type ZTN3-TYP-STATUS-WINDOW-RSP Token Definition Definition ZTN3-DDL-STATUS-WINDOW-RSP. 02 WINDOW-STATE Type 02 DEV-TYPE Type 02 NUM-OPENS Type 02 CALLER Type End BINARY 16. BINARY 16. BINARY 16. ZTN3-DDL-SOCKADDR-IN. WINDOW-STATE contains the status of the specified window.
ZTN3-TKN-ABORT-TEXT Token Code Subsystem-Specific Tokens ZTN3-TKN-ABORT-TEXT Token Code This token contains a description of the cause of the error. Token Code ZTN3-TKN-ABORT-TEXT Token Type ZTN3-TYP-ABORT-TEXT Token Definition Definition ZTN3-DDL-ABORT-TEXT Type Character Occurs Varying. ZTN3-TKN-ASSERTION-CONDITION Token Code This token is a text string containing the illogical condition.
ZTN3-TKN-EDIT-SEQNUM Token Code Subsystem-Specific Tokens ZTN3-TKN-EDIT-SEQNUM Token Code This token is a structure containing the line number on which the illogical condition was detected. Token Code ZTN3-TKN-EDIT-SEQNUM Token Type ZTN3-TYP-EDIT-SEQNUM Token Definition Definition ZTN3-DDL-EDIT-SEQNUM. 02 LINE-NUMBER 02 FRACTION End Type BINARY 16. Type BINARY 16. ZTN3-TKN-FILE-ERROR Token Code This token contains the NonStop operating system file system error that occurred.
ZTN3-TKN-FSM Token Code Subsystem-Specific Tokens ZTN3-TKN-FSM Token Code This token is a structure containing the previous state, the event, the action, and the next state. Token Code ZTN3-TKN-FSM Token Type ZTN3-TYP-FSM Token Definition Definition ZTN3-DDL-FSM. 02 STATE 02 EVENT 02 ACTION 02 NEXT-STATE End Type Type Type Type BINARY BINARY BINARY BINARY 16. 16. 16. 16. ZTN3-TKN-FSMID Token Code This token identifies the state machine that encountered the error.
ZTN3-TKN-FSMOBJ Token Code Subsystem-Specific Tokens ZTN3-TKN-FSMOBJ Token Code This token contains the name of the object for which the state machine error occurred. Token Code ZTN3-TKN-FSMOBJ Token Type ZSPI-TYP-STRING ZTN3-TKN-HOST-NAME Token Code This token contains the IP host name of the TCP/IP process, if it is known. Token Code ZTN3-TKN-HOST-NAME Token Type ZSPI-TYP-CHAR50 Token Definition Definition ZTN3-DDL-HOST-NAME Type ZSPI-DDL-CHAR50.
ZTN3-TKN-GETHOST-ERR Token Code Subsystem-Specific Tokens ZTN3-TKN-GETHOST-ERR Token Code This token identifies the error returned by the GETHOSTBYADDR function. Token Code ZTN3-TKN-GETHOST-ERR Token Type ZTN3-TYP-GETHOST-ERR Token Definition ZTN3-DDL-GETHOST-ERR-ENM. ZTN3-DDL-GETHOST-ERR-ENM identifies possible GETHOSTBYADDR errors. Definition ZTN3-DDL-GETHOST-ERR-ENM.
ZTN3-TKN-LISTOPEN-RSP Token Code Subsystem-Specific Tokens ZTN3-TKN-LISTOPEN-RSP Token Code This token returns information about an opener of the Guardian TN3270 Server process. Token Code ZTN3-TKN-LISTOPEN-RSP Token Type ZTN3-TYP-LISTOPEN-RSP Token Definition Definition ZTN3-DDL-LISTOPEN-RSP. 02 OPENER 02 OPENER-LEN 02 PRIMARY 02 BACKUP End Type Type Type Type ZSPI-DDL-CHAR50. BINARY 16. ZTN3-DDL-OPENID. ZTN3-DDL-OPENID. OPENER is the process name of the opener.
ZTN3-TKN-NLS-ALLORONE-CHOICE Token Code Subsystem-Specific Tokens ZTN3-TKN-NLS-ALLORONE-CHOICE Token Code This token specifies whether one cell (value=1) or all cells (value=0) of an NLS translation table are displayed. Token Code ZTN3-TKN-ALLORONE-CHOICE Token Type ZSPI-TYP-INT ZTN3-TKN-NLS-DISPLAY-BASE Token Code This token specifies the numeric base in which NLS table data is displayed.
ZTN3-TKN-NLS-TABLENAME Token Code Subsystem-Specific Tokens ZTN3-TKN-NLS-TABLENAME Token Code This token specifies that the input NLS translation table (value=4) or the output NLS translation table (value=5) is displayed. Token Code ZTN3-TKN-TABLENAME Token Type ZSPI-TYP-INT ZTN3-TKN-NLS-TABLEVALUE Token Code This token specifies the character byte value placed in the table cell identified by ZTN3TKN-NLS-TABLEADDRESS.
ZTN3-TKN-OPCODE Token Code Subsystem-Specific Tokens ZTN3-TKN-OPCODE Token Code This token contains the socket operation that returned the error. Token Code ZTN3-TKN-OPCODE Token Type ZTN3-TYP-OPCODE Token Definition TRACE-OP-CODES.
ZTN3-TKN-OPCODE Token Code Subsystem-Specific Tokens TRACE-OP-CODES identifies various I/O operations. Definition TRACE-OP-CODES.
ZTN3-TKN-OPNAME Token Code Subsystem-Specific Tokens ZTN3-TKN-OPNAME Token Code This token contains the name of the procedure that returned the error. Token Code ZTN3-TKN-OPNAME Token Type ZSPI-TYP-CHAR16 ZTN3-TKN-PROCESS-NAME Token Code This token contains the name of TCP/IP process that is reporting the error.
ZTN3-TKN-REASON Token Code Subsystem-Specific Tokens ZTN3-TKN-REASON Token Code This token identifies the reason the session was terminated. Token Code ZTN3-TKN-REASON Token Type ZTN3-TYP-REASON Token Definition ZTN3-DDL-REASON-ENM. ZTN3-DDL-REASON-ENM lists the reasons a session was terminated. Definition ZTN3-DDL-REASON-ENM.
ZTN3-TKN-RETCODE Token Code Subsystem-Specific Tokens ZTN3-TKN-RETCODE Token Code This token identifies errors that are returned for a SPI command. Token Code ZTN3-TKN-RETCODE Token Type ZTN3-TYP-RETCODE Token Definition ZTN3-DDL-RETCODE-ENM. ZTN3-DDL-ERROR-ENM lists the errors that can be returned to a SPI command. Definition ZTN3-DDL-RETCODE-ENM.
ZTN3-TKN-SESSION-STATS Token Code Subsystem-Specific Tokens ZTN3-TKN-SESSION-STATS Token Code This token returns statistical information about a session, including the elapsed time and number of messages and bytes transferred. Token Code ZTN3-TKN-SESSION-STATS Token Type ZTN3-TYP-SESSION-STATS Token Definition Definition ZTN3-DDL-SESSION-STATS. 02 ELAPSED.
ZTN3-TKN-SOCKET-ERROR Token Code Subsystem-Specific Tokens ZTN3-TKN-SOCKET-ERROR Token Code This token identifies an error returned by a socket operation. Token Code ZTN3-TKN-SOCKET-ERROR Token Type ZTN3-TYP-SOCKET-ERR Token Definition ZTN3-DDL-SOCKET-ERR-ENM.
ZTN3-TKN-SOCKET-ERROR Token Code Subsystem-Specific Tokens ZTN3-DDL-SOCKET-ERR-ENM lists the errors that can be returned by a socket operation. Definition ZTN3-DDL-SOCKET-ERR-ENM.
ZTN3-TKN-SOURCE-FILE Token Code Subsystem-Specific Tokens ZTN3-TKN-SOURCE-FILE Token Code This token contains the name of the NonStop operating system source file where the condition occurred. Token Code ZTN3-TKN-SOURCE-FILE Token Type ZSPI-TYP-STRING ZTN3-TKN-SPI-ERROR Token Code This token contains the error returned by the SPI procedure. Token Code ZTN3-TKN-SPI-ERROR Token Type ZTN3-TYP-SPI-ERROR ZTN3-TKN-SUBDEV Token Code This token contains the name of a Guardian TN3270 Server window.
ZTN3-TKN-TRACE-ERROR Token Code Subsystem-Specific Tokens ZTN3-TKN-TRACE-ERROR Token Code This token returns error information if a START TRACE command was unsuccessful. Token Code ZTN3-TKN-TRACE-ERROR Token Type ZTN3-TYP-TRACE-ERROR Token Definition Definition ZTN3-DDL-TRACE-ERROR. 02 ERROR Type ZTN3-DDL-TRACE-ERROR-ENM. 02 INFO Type ZSPI-BINARY 16. End ZTN3-DDL-TRACE-ERROR-ENM enumerates errors returned by START TRACE. Definition ZTN3-DDL-TRACE-ERROR-ENM.
F D-Series System Migration Considerations This appendix discusses the compatibility of the D20 version with earlier versions of the Guardian TN3270 Server. Because the SPI interface to the Guardian TN3270 Server changed in the D20 version, you cannot use C30 versions of TN32COM to control a D20 TN32SERV process. Conversely, you cannot use a D20 TN32COM process to control a C30 TN32SERV process. The TN32COM process reports an error and stops if it opens an incompatible TN32SERV process.
D-Series System Migration Considerations TN3270 Server Manual—424097-001 F-2
Index Numbers 3270 commands 3-5 A ABORT WINDOW command 4-4 ADD WINDOW command 4-5 ALTER PROCESS command 4-6 ALTER WINDOW command 4-7 Application considerations 1-7 ASCII 3270 commands 3-5 Audience xi B CRT Protocol AM3270 mode CONTROL 22 operation 5-3 Normal READ request 5-3 SETMODE function 59 procedure 5-6 SNAX/XF mode Two-step READ request 5-8 CRT protocol SNAX/XF mode WRITE[x] request procedure 5-7 CRT SETMODE procedure 5-8 Custom application considerations 1-8 D BREAK message 6-11, 6-23 C Client
F Index Event (continued) ZTN3-EVT-RECV-ABORT 8-6 ZTN3-EVT-SESS-ERROR 8-7 ZTN3-EVT-SESS-ESTAB 8-8 ZTN3-EVT-SESS-TERM 8-9 ZTN3-EVT-SPI-ERROR 8-10 ZTN3-EVT-STARTED 8-10, 8-11 ZTN3-TKN-BANNER 8-11 EXIT command 4-10 Extended highlighting in SNAX/XF mode 5-10 F FC command 4-11 Features supported 1-1 TN3270 protocol, unsupported 1-3 unsupported 1-2 Files names and locations 2-2 Fix (FC) command 6-2 ITI protocol AM3270 mode BREAK message 6-11 Control operation 6-5 READ[x] procedure 6-6 WRITEREAD[x] procedure 6
O Index O OPEN [PROCESS] command 4-15 Operation CONTROL 6-5 CONTROL 22 5-3 Outbound data message format 5-1 P Pathway considerations 1-7 Procedure SETPARAM Function 3 6-9 R Starting Guardian TN3270 Server 3-2 TN32COM 4-1 Startup environment, initializing 3-1 STATUS PROCESS command 4-16 STATUS SESSION command 4-18 STATUS WINDOW command 4-19 STOP PROCESS command 4-21 Supported features 1-1 Supported terminal models AM3270 mode A-1 SNAX/XF mode A-3 System requirements 2-1 T READ request normal 5-3 two-s
W Index Two-step READ request 5-8, 6-3 W WRITEREAD[x] procedure 6-13, 6-25 WRITE[x] procedure 6-12, 6-24 WRITE[x] request procedure CRT protocol 5-7 Z ZTN3-CMD-ABORT SPI command 7-2 ZTN3-CMD-ADD SPI command 7-3 ZTN3-CMD-ALTER SPI command 7-4 ZTN3-CMD-DELETE SPI command 7-5 ZTN3-CMD-GETVERSION SPI command 7-5 ZTN3-CMD-INFO SPI command 7-6 ZTN3-CMD-LISTOPEN SPI command 7-7 ZTN3-CMD-STATUS SPI command 7-7 ZTN3-CMD-STOP SPI command 7-9 ZTN3-CMD-TRACE SPI command 7-9 ZTN3-EVT-ABORT event 8-1 ZTN3-EVT-ASSERTI
Z Index ZTN3-TKN-SOURCE-FILE token code E-23 ZTN3-TKN-SPI-ERROR token code E-23 ZTN3-TKN-SUBDEV token code E-23 ZTN3-TRACE-ERROR token code E-24 TN3270 Server Manual—424097-001 Index- 5
Z Index TN3270 Server Manual—424097-001 Index- 6
