Host Environment Commands › ADDRESS EPI Commands › EPI DEFINE—Define a Virtual Terminal to EPI

EPI DEFINE—Define a Virtual Terminal to EPI

EPI DEFINE defines a virtual terminal to EPI.

EPI DEFINE has the following format:

ADDRESS EPI "DEFINE keywords"

{termname}
[PASSWORD(termpswd)]
[APPLID(prodappl)]
[LOGMODE(modename)]
[LOGONPARM('parmstring')]
[ACCEPT|REJECT]
[NORETRY|RETRY(seconds)]

termname

Provides the name of the virtual terminal being changed, which must match the name of an APPL statement in your VTAM definition list library.

PASSWORD(termpswd)

(Optional) Provides the password for the named virtual terminal, or for all virtual terminals if you are issuing the CHANGE ALL command. Use this keyword only if the VTAM APPL statement for this virtual terminal includes the PRTCT keyword, which allows VTAM to provide password protection. The password that you specify with the CHANGE command must match the password, if any, on the VTAM APPL statement for this virtual terminal.

Alternatively, you can specify the PASSWORD keyword on the EPI ENABLE command.

APPLID(prodappl)

(Optional) Defines the VTAM application name of the external product that this virtual terminal is logged on to. See the description of the EPI LOGON command. You can either specify the APPLID keyword in the CHANGE command or enter it when you log on to EPI. If you supply a prodappl value at logon and on the CHANGE command, the value supplied at logon takes precedence.

LOGMODE(modename)

(Optional) Defines the name of the entry in the VTAM logmode table to be used when this virtual terminal is logged on. This entry should describe an SLU2 type virtual terminal used by IBM 3278 terminal models 2, 3, or 4.

If neither your CHANGE command or the LOGON command you issue for this terminal specifies a logmode, EPI uses the default logmode table entry (as defined by VTAM for your system) for this virtual terminal.

LOGONPARM('parmstring')

(Optional) The character string, enclosed in quotation marks, that EPI passes to an external product when this virtual terminal logs on to that product. Supplying a parmstring on your CHANGE command or when you log the virtual terminal on to an external product is optional.

ACCEPT or REJECT

(Optional) These mutually exclusive keywords determine whether EPI accepts requests from external products to acquire this virtual terminal. VTAM does not allow disabled virtual terminals to be acquired.

NORETRY

(Optional) Overrides a previously issued EPI CHANGE or LOGON command for this virtual terminal that specified RETRY. When you specify NORETRY, EPI does not allow retrying of LOGON commands and does not try to reestablish a session that fails after logon.

RETRY(seconds retries)

(Optional) Overrides a previously issued EPI CHANGE or LOGON command for this virtual terminal that specified NORETRY. The seconds value specifies how many seconds EPI waits between attempts to log on to a virtual terminal or to reestablish a failed session. Use a value from 1 through 86400 (the number of seconds in 24 hours). The default value is 30 seconds. The retries value specifies how many times EPI can try to log on to a virtual terminal or to reestablish a failed session. The default value is 0, which allows only one retry attempt; if that attempt fails, EPI places the virtual terminal in NORETRY mode. You can specify any number of retries up to 65535.

EPI DEFINE Sample Coding Statements

The following sample coding statement names the virtual terminal TERM1, associates it with the application OMVTAM, and specifies the logmode as T3278M2:

DEFINE TERM1 APPLID(OMVTAM) LOGMODE(T3278M2)