Start 3270 Display Emulation (STREML3270)

The Start 3270 Display Emulation (STREML3270) command starts a 3270 device emulation session for a display device to a binary synchronous communications (BSC) or Systems Network Architecture (SNA) host system. The user can type this command on the command line or from any display station that allows CL commands to be specified. This command can also be issued from a batch job by specifying the display device (DSPDEV) parameter.

The STREML3270 command can be in a CL program specified as the INLPGM for a user profile that is run when the user signs on the display device.

More information on device emulation is in the 3270 Device Emulation Support book, SC41-5408.

Parameters

Keyword	Description	Choices	Notes
EMLCTL	Emulation controller, or	Name	Optional, Positional 1
EMLDEV	Emulation device, or	Name	Optional, Positional 2
EMLLOC	Emulation location	Communications name	Optional, Positional 3
DSPDEV	Display device, batch only	Name, *CURRENT	Optional
PAGEUP	Page Up (Roll Down) key	PA2, PA1, PA3, NONE, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24, CLEAR, ERASEINP, *CSRSLT	Optional
PAGEDOWN	Page Down (Roll Up) key	PA1, PA2, PA3, NONE, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24, CLEAR, ERASEINP, *CSRSLT	Optional
TESTREQ	Test Request key	DFT, CLEAR, *ERASEINP	Optional
CSRSLT	Cursor Select key	NONE, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, *F24	Optional
IGCEMLPC	SNA DBCS 3270PC emulation	NO, YES	Optional
EMLPRTDEV	Emulation printer device	Name, NONE, EMLCTL, *EMLLOC	Optional
INZWAIT	Timeout wait for host	1-32767, 120, *NOMAX	Optional
NUMLCK	Numeric lock keyboard	EMLDEV, NO, *YES	Optional
NULLS	Handle nulls	BLANK, REMOVE	Optional
LOGON	Host signon/logon command	Character value, *NONE	Optional
WAITRSP	Wait response	NO, YES	Optional
ENDCOND	End emulation conditions	Single values: NONE Other values (up to 2 repetitions): DACTLU, *UNBIND	Optional
ATNEMLMNU	Attention emulation menu	YES, NO	Optional
FKEYPGM	Function key program	Single values: NONE Other values: Element list*	Optional
	Element 1: Program	Qualified object name
	Qualifier 1: Program	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
	Element 2: Function keys	Single values: ALLFKEYS Other values (up to 24 repetitions): F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, *F24
KBDTYPE	Keyboard language type	DSPDEV, SYSVAL, LCL, AGB, AGE, AGI, AGM, ALI, ALM, BGB, BGE, BLI, BLM, BRB, BRE, CAB, CAE, CAI, CAM, CLB, CLE, CSB, CSE, CYB, DMB, DME, DMI, DMM, ESB, FAB, FAE, FAI, FAM, FNB, FNE, FNI, FNM, FQB, FQI, GKB, GNB, GNE, HIB, HNB, HNE, ICB, ICE, ICI, ICM, INB, INI, IRB, ITB, ITE, ITI, ITM, JEB, JEI, JKB, JPB, JPE, JUB, KAB, KOB, LAE, LTB, LVB, MKB, MKE, NCB, NCE, NEB, NEE, NEI, NEM, NWB, NWE, NWI, NWM, PLB, PKE, PLE, PRB, PRE, PRI, PRM, RCB, RMB, RME, ROB, ROE, RUB, RUE, SFI, SFM, SGI, SGM, SKB, SKE, SPB, SPE, SPI, SPM, SQB, SQE, SSB, SSI, SSE, SSM, SWB, SWE, SWI, SWM, TAB, THB, THE, TKB, TKE, TRB, TRE, UAE, UKB, UKE, UKI, UKM, USB, USE, USI, USM, VNE, YGI, YGM, TRNTBL	Optional
TRNTBLOUT	Outgoing translation table	Single values: KBDTYPE Other values: Qualified object name*	Optional
	Qualifier 1: Outgoing translation table	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
TRNTBLIN	Incoming translation table	Single values: KBDTYPE Other values: Qualified object name*	Optional
	Qualifier 1: Incoming translation table	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
EMLCFGE	Configuration entry	Name, QEMDFTCFGE, *NONE	Optional

Top

Emulation controller (EMLCTL)

Specifies the name of a binary synchronous communications (BSC) controller description or Systems Network Architecture (SNA) controller description that has attached 3270 emulation device descriptions. When this parameter is specified, the requesting display device is linked to an available 3270 emulation device on the emulation controller. At least one device attached to the controller must be available, and the requester of the command must be authorized to use the controller and device.

Either this parameter, the Emulation device prompt (EMLDEV parameter), or the Emulation location prompt (EMLLOC parameter) is required.

Emulation location (EMLLOC)

Specifies the remote location name that describes the location of the 3270 display emulation devices. This name is defined during device description configuration, and it refers to the remote location where communication takes place. When this parameter is specified, the requesting display device is linked to an available 3270 emulation device referred to by the remote location. At least one of the emulation devices referred to by the remote location must be available, and the requester of the command must be authorized to use the device. A remote location can refer to as many as 1,016 emulation display devices.

Either this parameter, the Emulation controller prompt (EMLCTL parameter), or the Emulation device prompt (EMLDEV parameter) is required.

Page Up (Roll Down) key (PAGEUP)

Specifies a 3270 function for the Page Up (Roll Down) key on the 5250 type keyboard when 3270 device emulation is active. This assignment is in effect when the number of input fields is not larger than the maximum number of input fields.

*PA-key: Specify the 3270 PA key assigned to the Page Up (Roll Down) key. The default is the *PA2 key.
*NONE: No function is assigned to the Page Up (Roll Down) key. When there are fewer input fields on the display than allowed by the 5250 display device, this key has no function.
*F-key: Specify the 3270 F key assigned to the Page Up (Roll Down) key.
*CLEAR: The 3270 CLEAR key is assigned to the Page Up (Roll Down) key.
*ERASEINP: The 3270 ERASE INPUT key is assigned to the Page Up (Roll Down) key.
*CSRSLT: The 3270 CURSOR SELECT key is assigned to the Page Up (Roll Down) key and does not allow the real Cursor Select key to be used.

Page Down (Roll Up) key (PAGEDOWN)

Specifies an added function for the Page Down (Roll Up) key on the 5250 type keyboard when 3270 device emulation is active. This assignment is in effect when the number of input fields is not larger than the maximum number of input fields.

*PA-key: Specify the 3270 PA key assigned to the Page Down (Roll Up) key. The default is the *PA1 key.
*NONE: No function is assigned to the Page Down (Roll Up) key. When there are fewer input fields on the display than allowed by the 5250 display device, the key has no function.
*F-key: Specify the 3270 F key assigned to the Page Down (Roll Up) key.
*CLEAR: The 3270 CLEAR key is assigned to the Page Down (Roll Up) key.
*ERASEINP: The 3270 ERASE INPUT key is assigned to the Page Down (Roll Up) key.
*CSRSLT: The 3270 CURSOR SELECT key is assigned to the Page Down (Roll Up) key and does not allow the real Cursor Select key to be used.

Test Request key (TESTREQ)

Specifies an added function for the Test Request key on the 5250 keyboard when 3270 device emulation is active.

*DFT: Normal function is assigned to the Test Request key. This is the system default. The normal function depends on whether the 3270 emulation display device uses binary synchronous communications (BSC) or Systems Network Architecture (SNA) protocol. BSC defaults to a 3270 Test Request function, while SNA defaults to a 3270 System Request function.
*CLEAR: The 3270 CLEAR key is assigned to the Test Request key.
*ERASEINP: The 3270 ERASE INPUT key is assigned to the Test Request key.

Emulation printer device (EMLPRTDEV)

Specifies the emulation printer device that is used for SNA DBCS 3270PC emulation. The printer emulation device is selected after the device emulation is selected. This parameter is valid only when *YES is specified on the SNA DBCS 3270PC emulation prompt (IGCEMLPC parameter).

*NONE: SNA DBCS 3270PC printer emulation with device emulation is not used. No printer emulation device is selected.
emulation-device-description-name: Specify the printer emulation device with the selected display emulation device for SNA DBCS 3270PC emulation.
*EMLCTL: The first available printer emulation device on the specified controller on the Emulation controller prompt (EMLCTL parameter) is used.
*EMLLOC: The first available printer emulation device from the specified location on the Emulation location prompt (EMLLOC parameter) is used.

Timeout wait for host (INZWAIT)

Specifies the initial amount of time (in seconds) that 3270 emulation waits for the first display data from the host system. If the host system does not send the first display in this time, the emulation session is ended, and a message is returned to the requester.

120: 3270 emulation waits 120 seconds for the first display from the host system.
*NOMAX: There is no limit on the amount of time 3270 emulation waits for the first display from the host system. This value can be used when the user is not sure when the host system is active to this session. The request can be ended by using the system request and ending request functions.
number-of-seconds: Specify the length of time (in seconds) that the 3270 emulation waits for the first display from the host system. Valid values range from 1 through 32767 seconds.

Numeric lock keyboard (NUMLCK)

Specifies whether numeric input fields will only allow numeric data on a 5250 keyboard.

*EMLDEV: Numeric lock is specified in the EMLNUMLCK field of the emulation device description. You can use the DSPDEVD command to display the current EMLNUMLCK value for the emulation device. The value can be changed using the BSC commands CRTDEVBSC or CHGDEVBSC or the SNA commands CRTDEVHOST or CHGDEVHOST.
*NO: 3270 emulation will allow any data to be typed in the numeric input fields.
*YES: 3270 emulation will only allow numeric data to be typed in the numeric input fields. Numeric data that can be typed include the characters 0 through 9, and symbols " + - , . " and the blank symbol, which is the character b with a slash on the stem.

Host signon/logon command (LOGON)

Specifies the sign-on text that is sent to the host system after SNA 3270 emulation is started. This text can be used to sign on to a specific host application.

This parameter is not allowed if specified for BSC 3270 emulation, SNA 3270 display station pass-through, or SNA DBCS 3270PC emulation.

*NONE: No text is sent to the host system after 3270 emulation is started.
host-logon-command: Specify text that is sent to the host system after 3270 emulation is started. The text must be enclosed in apostrophes if it contains blanks or other special characters. All apostrophes within the text must be represented by two apostrophes. A maximum of 256 characters can be specified.

End emulation conditions (ENDCOND)

Specifies additional ways in which the SNA 3270 device emulation session can end.

This parameter is not allowed if specified for BSC 3270 emulation, SNA 3270 display station pass-through, or SNA DBCS 3270PC emulation.

The possible values are:

*NONE

No additional ways to end 3270 device emulation are requested.

*DACTLU

The 3270 emulation session will end if it receives an SNA DACTLU from the host system. Please consider the following before selecting this end condition:

There are certain host system applications that issue a DACTLU before starting, such as Time Sharing Option (TSO), which will end the 3270 emulation session before the desired application is accessed. This end condition should be avoided when trying to access these applications.

*UNBIND

The 3270 emulation session will end if it receives an SNA UNBIND from the host system. Consider the following items before selecting this end condition:

This end condition should be used only when you need to access one host application for the duration of the session. An UNBIND will occur while switching from one application to the next, and the 3270 session will end before accessing the second application.
This end condition should only be used when the communication path to the host system is a simple one. A simple communication path is one that only involves accessing the iSeries system where the Start 3270 Display Emulation (STREML3270) command is run, and accessing the host system that contains the desired application. Intermediate systems can exist along this simple path as long as they are not accessed. If intermediate systems are accessed, an UNBIND will occur while switching from one system to the next, and the 3270 display emulation session will end before accessing the desired application.
There are certain host system applications that issue an UNBIND before starting, such as Time Sharing Option (TSO), which will end the 3270 display emulation session before the desired application is accessed. This end condition should be avoided when trying to access these applications.

Attention emulation menu (ATNEMLMNU)

Specify whether you want the Select 3270 Emulation Option for SNA menu or the Select 3270 Emulation Option for BSC menu to be displayed when the Attention key is pressed.

This parameter is not allowed if specified for either SNA 3270 display station pass-through or SNA DBCS 3270PC emulation.

The possible values are:

*YES: The Select 3270 Emulation Option for SNA or BSC menu is displayed when you press the Attention key.
*NO: The Select 3270 Emulation Option for SNA or BSC menu is not displayed when you press the Attention key. The attention program (if any) currently active in the job will get control when the Attention key is pressed. You can still display the Select 3270 Emulation Option for SNA or BSC menu by pressing the System Request key sequence and then selecting the Display 3270 emulation options menu option from the System Request menu.

Function key program (FKEYPGM)

Specifies a user-exit program and one or more function keys that call the program. When a specified function key is pressed during the 3270 display emulation session and is sent to the host system, the user-exit program is called. When the user-exit program ends, control is returned to the 3270 display emulation session at the point where the function key was pressed.

This parameter is not valid if specified for either BSC 3270 display emulation, SNA 3270 display station pass-through, or SNA DBCS 3270PC emulation.

The user-exit program is called only if the function key is successfully sent to the host system. If the function key fails to be received, an error reset message appears at the bottom of the display suggesting you try again.

The iSeries user-exit program must be coded to allow for input parameters. The following parameters are passed to the program in the specified order:

The function key identifier (10 characters). The identifier of the function key that was pressed. If function key 1 is pressed, the parameter value is *F1. If function key 2 is pressed, the parameter value is *F2, and so on, up to function key 24. The value is left-justified within the parameter.
The display name (10 characters). The name of the display on which the 3270 display emulation running. The value is left-justified within the parameter.
The cursor location (6 characters). The screen location of the cursor at the time the function key was pressed. The first three characters are the row position of the cursor location. The second three characters are the column position of the cursor location. For example, if the cursor location is row 24, column 1 when the function key is pressed, the value of the parameter is 024001. The row and column can be extracted from the variable using substring logic.

The possible program name values are:

*NONE: A user-exit program is not associated with any function key.
program-name: Specify the name and library of the user-exit program that is called when one of the specified function keys is pressed. The program cannot be a system program.

The possible library values are:

*LIBL: All libraries in the user and system portions of the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is used to locate the program. If no library is specified as the current library for the job, QGPL is used.

name: Specify the name of the library to be searched.

The possible function key values are:

*ALLFKEYS: All function keys call the specified user-exit program.
function-key: Specify a function key to call the user-exit program. A maximum of 24 values can be specified on this parameter.

Keyboard language type (KBDTYPE)

Specifies the 3-character keyboard language identifier which represents a specific full character identifier (CHRID - comprised of a character set and code page) that is used on the display station. To determine the full CHRID from the keyboard language identifier, see the CHRID Values table in the Create Device Display (CRTDEVDSP) command in the CL Reference.

This parameter does not apply when running SNA 3270 display station pass-through.

*DSPDEV: If a local display device is specified for the STREML3270 display device (DSPDEV) parameter, then use the specified display's device description current KBDTYPE value. If a remote display device is specified for the STREML3270 DSPDEV parameter, then use the current QKBDTYPE system value.
*SYSVAL: Use the current QKBDTYPE system value. This value is valid for both local and remote displays.
*LCL: The display device that requested 3270 device emulation is a local display device. The keyboard type is determined from the display device description.
*TRNTBL: Allows user-defined translation tables to be used. The character translation is defined in the translation tables specified by the Outgoing translation table prompt (TRNTBLOUT parameter) and the Incoming translation table prompt (TRNTBLIN parameter).
If a local display device is specified for the STREML3270 Display Device (DSPDEV) parameter, then use the specified display's device description current KBDTYPE value to determine the CHRID to be used. If a remote display device is specified for the STREML3270 DSPDEV parameter, then use the current QKBDTYPE system value.
keyboard-language-identifier: Specify the keyboard language identifier to be used.

Outgoing translation table (TRNTBLOUT)

Specifies the outgoing translation table that is used to translate characters sent from the host system to 3270 Emulation. If *TRNTBL is specified on the Keyboard language type prompt (KBDTYPE parameter), the Incoming translation table prompt (TRNTBLIN parameter), must also be specified.

*KBDTYPE: Translation is done using the language specified on the Keyboard language type prompt (KBDTYPE parameter).
table-name: Specify the name and library of the table that is used for outgoing translation.
The possible library values are:
*LIBL: All libraries in the user and system portions of the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is used to locate the outgoing translation table. If no library is specified as the current library for the job, QGPL is used.

name: Specify the name of the library to be searched.

Incoming translation table (TRNTBLIN)

Specifies the incoming translation table that is used to translate characters sent from 3270 Emulation to the host system. If *TRNTBL is specified on the Keyboard language type prompt (KBDTYPE parameter), the Outgoing translation table prompt (TRNTBLOUT parameter), must also be specified.

*KBDTYPE: Translation is done using the language specified on the Keyboard language type prompt (KBDTYPE parameter).
table-name: Specify the name and library of the table used for incoming translation.
The possible library values are:
*LIBL: All libraries in the user and system portions of the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is used to locate the incoming translation table. If no library is specified as the current library for the job, QGPL is used.

name: Specify the name of the library to be searched.

Configuration entry (EMLCFGE)

Specifies whether a configuration entry is used for this session. Configuration entries indicate 3270 emulation configuration options. Configuration entries are created with the Add Emulation Configuration Entry (ADDEMLCFGE) command.

The possible values are:

*NONE: No configuration entry is named and the configuration entry defaults are used.
QEMDFTCFGE: The default configuration entry QEMDFTDFGE is used. This entry is shipped with configuration entry defaults, and can be updated with the Change Emulation Configuration Entry (CHGEMLCFGE) command.
configuration-entry-name: Specify the name of the configuration entry to be used. If the configuration entry named does not exist in the configuration file, the configuration entry defaults are used.

Examples

STREML3270   EMLCTL(TSOHOST)  PAGEUP(*F7)  PAGEDOWN(*F8)

This command places the display device into an emulation session that uses the first available device on the controller description TSOHOST for which the user has authority. When there are fewer input fields on the display than the maximum allowed by the 5250 display device and the Page Up key is pressed, an F7 key value is sent to the host system. When the Page Down key is pressed, an F8 key value is sent to the host system.

Error messages

*ESCAPE Messages

CPF2619: Table &1 not found.
CPF269A: Library parameter is not set to "QSYS " on call.
CPF269B: T.61 conversion table not found.
CPF85EA: Screen address received from host is larger than screen size.
CPF85EB: 3270 device emulation session ended.
CPF85EC: Specifying text on the LOGON parameter is not supported.
CPF85ED: Values other than ENDCOND(*NONE) are not supported.
CPF85E2: 3270 display emulation is already active at this job.
CPF85E4: Not authorized to translation table &1 in library &2.
CPF85E5: 3270 emulation device &1 is reserved for device &2.
CPF85E6: Translation table &1 in library &2 was not found.
CPF8503: Emulation controller &1 not found.
CPF8504: Controller &1 does not support 3270 emulation.
CPF8505: Emulation device &2 not found.
CPF8506: Emulation location &1 not found.
CPF8507: Display emulation cannot open required file.
CPF8508: Host system did not respond.
CPF851A: Maximum number of shift in and shift out characters exceeded.
CPF8510: Internal error occurred on device &1.
CPF8511: Emulation ended by errors on device &2.
CPF8512: Emulation ended because device &2 was held.
CPF8513: Emulation ended by errors on device &2.
CPF8514: Error recovery stopped on device &1.
CPF8515: 3270 emulation session ended by host.
CPF8516: No match between host and device &2.
CPF8517: Received more than maximum number of fields allowed.
CPF8518: Emulation ended because of internal failure in system.
CPF8519: Function check in 3270 emulation.
CPF852A: Values other than FKEYPGM(*NONE) are not supported.
CPF852B: Program &1 not found.
CPF852C: Not authorized to program &1.
CPF8521: Not authorized to controller &1.
CPF8522: Not authorized to emulation device &2.
CPF8523: *NO on the ATNEMLMNU parameter is not supported.
CPF8524: Emulation cannot open its required display file.
CPF8525: KBDTYPE(*LCL) not allowed for remote display devices.
CPF8526: No 3270 display emulation devices available.
CPF8527: Emulation device &2 not available.
CPF8528: Device &2 is not a display emulation device.
CPF8530: Not authorized to use any display emulation device.
CPF8533: Display device not specified in a batch job.
CPF8534: Display device &1 is not available.
CPF8535: Display device &1 not found.
CPF8536: Not authorized to display device &1.
CPF8539: &1 keyboard type not supported by 3270 emulation.
CPF8546: No 3270 display emulation devices available.
CPF8547: No 3270 printer emulation devices available.
CPF8550: Emulation ended due to time-out internal failure.
CPF8551: Emulation ended with error code &1.
CPF8552: Emulation ended because of return code.
CPF8553: BSC controller or device not allowed without translation.
CPF8565: Emulation device &1 not found.
CPF8568: Device &1 not printer emulation device.
CPF8569: Not authorized to use any printer emulation device.
CPF8571: No 3270 printer emulation devices available.
CPF8572: Emulation device &1 not available.