Variables Summary
This chapter summarizes the predefined variables supplied with CL/SuperSession.
Predefined variables are grouped into the categories shown below.
- SYSccccc
- Dialog Manager variables, available to all SSPL users. The variables
have these characteristics:
- Dialog Manager variables cannot be modified by panel input.
You can modify SYSCSR in the PROLOGUE section of a dialog to position the cursor.
- An attempt to set a Dialog Manager variable, except SYSCSR, is ineffective and generates no error message.
- Setting variable SYSKEY is possible, but not recommended.
- Dialog Manager variables cannot be modified by panel input.
- ZTBccccc
- Table services variables.
The following tables list the predefined variables. The column headings use the following abbreviations:
- LEN
- Specifies the length of the variable in bytes. A LEN of VAR indicates a variable length. Fixed-length variables are left-justified and blank-padded.
- R/W
- Indicates whether IBM® recommends that the variable be set (W), used (R), or both (R/W).
| Table 19. Dialog Manager Variables | |||
|---|---|---|---|
| VARIABLE | LEN | R/W | DESCRIPTION |
| SYSAPPL | 8 | R | ACB name of the current dialog process. |
| SYSCPUID | 208 | R | CPU ID(s), taken from the z/OS® PCCACPID field(s). Expressed as 16 12-character fields, separated by a blank. If a CPU is not present, its field is blanks. |
| SYSCSR | 8 | R/W | Cursor position, specified by the actual name of an input variable. CL/SuperSession positions the cursor at the start of the input field (in the body of the dialog) associated with that variable. An alias name cannot be used. The field must be modifiable. |
| SYSCVTFX | 256 | R | The 256-byte z/OS CVT prefix. |
| SYSDATE | 8 | R | System date in the format defined by the DATEFMT function. |
| SYSFDATE | 8 | R | System date containing a 4-digit year in the format defined by the DATEFMT function. |
| SYSDLG | 8 | R | The name of the currently executing dialog. Note: The
CSTACK dialog function may be used instead of the SYSDLG variable.
|
| SYSDOW | 1 | R | The day of the week, expressed as a number. 0 is Sunday, 1 is Monday, and so forth. |
| SYSJDATE | 8 | R | The current date, expressed as an IBM-format
Julian date, yyyy.ddd, where "£yyyy"
is the 4-character year, and "ddd" is the 3-character day of the year
with leading zeros as needed. For example, 2018.015. |
| SYSJOB | 8 | R | CL/SuperSession jobname. |
| SYSKEY | 5 | R | The Attention Identifier (AID) key used to complete
the last panel input, or the trigger AID key used to invoke the current
dialog.
|
| SYSLMODE | 8 | R | VTAM® logmode entry name in effect for the users physical terminal session. |
| SYSPARM | VAR | R | The main cases are:
|
| SYSPROC | 8 | R | CL/SuperSession PROC stepname. |
| SYSPRSVC | 12 | R | Presentation services field (from the BIND image) for the physical terminal session. This field is in binary format. See "Logical Unit Presentation Services" in IBM's :citACF/VTAM Programming manual. |
| SYSNET | 8 | R | VTAM SLU Network Name of the users terminal. If the name is less than 8 characters, it is left-justified, blank-padded. |
| SYSRC | VAR | R/W | The string, typically a return code, set by RETURN (when used to return from a dialog) or EXIT. |
| SYSSEED | 4 | R/W | The seed used by the RANDOM dialog function. |
| SYSSMFID | 4 | R | SMF system ID of the host processor on which the CL/SuperSession address space is running. |
| SYSSTEP | 8 | R | CL/SuperSession JOB stepname. |
| SYSTERM | 8 | R | VTAM logical unit name of the users terminal. If the name is less than 8 characters, it is left-justified, blank-padded. |
| SYSTIME | 8 | R | System time in 24-hour format (hh:mm:ss). |
| SYSTIMEO | N/A | R | Indicates whether (null) or not (not null) the executing dialog has been given control by ON ' TIMEOUT' . |
| SYSTRIG | VAR | R | The trigger phrase, if any, used to invoke the current dialog. |
| SYSTRPM | VAR | R | The default parameter, if any, defined with VSSTRIG for the currently executing trigger. |
| SYSVAR | 8 | R | The name of the panel input field the cursor was in when the user pressed an AID key. |
| SYSDDLD | VAR | R | Load library DDNAME. |
| SYSDDPRM | VAR | R | Initialization library DDNAME. |
| SYSDDCMD | VAR | R | Command list library DDNAME. |
| SYSDDPNL | VAR | R | Panel library DDNAME. |
| SYSDDHLP | VAR | R | Help library DDNAME. |
| SYSDDLOG | VAR | R | Log dataset DDNAME. |
| SYSDDSNP | VAR | R | Snap dump dataset DDNAME. |
| SYSDDIN | VAR | R | Startup parameters dataset DDNAME. |
| Table 20. Product Variables for CL/SuperSession | |||
|---|---|---|---|
| VARIABLE | LEN | S/U | DESCRIPTION |
| VIGACCT | 40 | U | Specifies the users site account number. VIGACCT is the default variable name for the ACCOUNT data element. |
| VIGALT | 8 | U | Contains the ALTDEST returned by VIGGAP. This name is a default and can be overridden. |
| VIGALTST | 8 | U | Contains the alternate destination status returned by VIGGW. This name is a default and can be overridden. |
| VIGAPDnn | 32 | U | Describes the application defined in the DESC= operand of the APPLDEF command, nn = 1 to n, where n=the value specified in the MENUSIZE initialization parameter. |
| VIGAPLST | 8 | U | Specifies the authorized application list name currently assigned to the user. |
| VIGAPMnn | 20 | U | Contains an availability or outage message for application nn, nn = 1 to n, where n=the value specified in the MENUSIZE initialization parameter. Initially specified by the MESSAGE= operand of the APPLDEF command. |
| VIGAPSnn | 4 | U | Contains the status of application nn, nn =
1 to (MENUSIZE initialization parameter), as determined by the VTAM INQUIRE facility:
|
| VIGAPTnn | 8 | U | Contains the tokens of application nn, nn = 1 to n, where n=the value specified in the MENUSIZE initialization parameter as specified in the tokenid operand of the APPLDEF command. |
| VIGBRn | 0 -72 | U | Contains line n (n = 1 to 6) of the active messages for the users broadcast group. When displayed, the message is truncated to the capacity of the panel field. |
| VIGCMD | 8 | S/U | Specifies the gateway dialog command that executes
when control passes from a panel to the session:
Note: Set VIGCMD in the PROLOGUE or EPILOGUE. It cannot
be set by panel input.
|
| VIGCOMP | 8 | U | After the VIGGAP function executes, VIGCOMP contains the compression parameter supplied by the APPLDEF command (COMPRESS). The APPLDEF IGNORE option sets VIGCOMP to nulls. |
| VIGDATA | 0-255 | U | Contains the VTAM user data string created by the CL/SuperSession and presented to the destination application when a passed session or a virtual session is established. VIGDATA is the default variable name for the USERDATA data element. |
| VIGDESC | VAR | U | After the VIGGAP function executes, VIGDESC contains the description supplied by the APPLDEF command (DESC). |
| VIGDEST | 8 | U | Contains the tokenid of the destination application (after a VIGGAP function), or the applid (when starting an application session). (VIGDEST is the default variable name for the DEST data element.) |
| VIGGRNUM | 8 | U | Contains the group number ID returned by the VIGGAP function. |
| VIGGROUP | 8 | U | Specifies the users connect group. This can be used for security validation. VIGGROUP is the default variable name for the GROUP data element. |
| VIGHELP | 8 | U | Contains the HELP parameter returned by VIGGAP. This name is a default and can be overridden. |
| VIGIMSNM | 8 | U | Contains the IMS name parameter returned by VIGGAP. This corresponds to the DEST parameter for IMS applications. This name is a default and can be overridden. |
| VIGIMSTY | 8 | U | Contains the IMS type
returned by VIGGAP:
This name is a default and can be overridden. |
| VIGINDLG | 8 | U | After the VIGGAP function executes, VIGINDLG contains the name of the initial dialog specified by the APPLDEF command (INITDLG). |
| VIGLMODE | 8 | U | Contains the VTAM logmode table entry used to establish a terminal session. VIGLMODE is the default variable name for the LOGMODE data element. |
| VIGLOGON | 8 | U | Contains the LOGON parameter returned by VIGGAP. This name is a default and can be overridden. |
| VIGLTERM | 8 | U | Specifies the IMS/DC logical terminal (LTERM) name. This name is associated with the user requesting access to IMS/DC. VIGLTERM is the default variable name for the LTERM data element. This variable is for CL/SuperSession for IMS only. |
| VIGMESS | 8 | U | Contains the MESSAGE parameter returned by VIGGAP. This name is a default and can be overridden. |
| VIGMSG | 0-255 | U | Contains error, prompt, or informational messages generated by CL/SuperSession. |
| VIGMULT | 3 | U | Contains Yes or No to indicate multisession. |
| VIGNPSWD | 8 | U | Specifies the encrypted value of the users new password. This variable contains a value only for the time period necessary to validate the new password. Refer to the ENCDEC function for more information about password encryption. |
| VIGORDER | 8 | U | Contains the ORDER parameter returned by VIGGAP. This name is a default and can be overridden. |
| VIGPLTRM | 8 | U | Specifies the printer terminal LTERM, which IMS/DC associates with the users CRT LTERM. VIGPLTRM is the default variable name for the PRTLTERM data element. This variable is for CL/SuperSession for IMS only. |
| VIGPNODE | 8 | U | Specifies the name of the printer terminal logical unit associated with the user by the destination application. VIGPNODE is the default variable name for the PRTNODE data element. |
| VIGPOOL | 8 | U | Specifies the virtual terminal pool. CL/SuperSession uses the pool to form a passthru virtual session between the gateway and the destination application selected by the user. VIGPOOL is the default variable name for the POOL data element obtained via the VIGGAP function. |
| VIGPRINT | 8 | U | Contains the PRINTER parameter returned by VIGGAP:
This name is a default and can be overridden. |
| VIGPRIST | 8 | U | Contains the primary destination status returned by VIGGAP. |
| VIGPROC | 8 | U | Contains the name of the TSO logon procedure. VIGPROC is the default variable name for the PROC data element. |
| VIGPRTPL | 8 | U | Specifies the virtual terminal printer pool name. CL/SuperSession uses the pool to form an associated passthru virtual session between the gateway and the destination application selected by the user. VIGPOOL is valid only when PRTPOOL=* is specified in the APPLDEF command, allowing the pool name to be dynamically assigned. It is obtained from the PRTPOOL parameter of the APPLDEF command. VIGPRTPL is the default variable name for the PRTPOOL data element. VIGGAP retrieves this value. |
| VIGPSWD | 8 | U | Specifies the encrypted value of the users password. VIGPSWD is the default variable name for the PASSWORD data element. Refer to the ENCDEC function for more information about password encryption. |
| VIGSDATA | VAR | U | VIGSDATA specifies the user data supplied by the APPLDEF statement. It is obtained from the VIGGAP function. |
| VIGSIMSP | 8 | U | After the VIGGAP function executes, VIGISMP specifies the IMS parameter supplied by the APPLDEF command (DEST). |
| VIGSINAM | 8 | U | After the VIGGAP function executes, VIGSINAM contains the IMS name supplied by the APPLDEF command (DEST), if the IMS command was also used. Specifies the IMS definition name. |
| VIGSNETA | 8 | U | After the VIGGAP function executes, VIGSNETA contains the alternate net name supplied by the APPLDEF command (ALTDEST). It is obtained from the ALTDEST parameter. |
| VIGSNETP | 8 | U | After the VIGGAP function executes, VIGSNETP contains the primary net name supplied by the APPLDEF command (DEST). It is obtained from the DEST parameter of the VIGDR function. |
| VIGSPRT | 8 | U | After the VIGGAP function executes, VIGSPRT contains the printer parameter. It is the same as the APPLDEF command PRINTER parameter. |
| VIGTOKEN | 8 | U | Contains the token ID returned by VIGGAP. This name is a default and can be overridden. |
| VIGTRDLG | 8 | U | Contains the name of a termination dialog returned by the VIGGAP function. |
| VIGTYPE | 8 | U | Contains the name of the data element that the gateway attempts to acquire (for example, VIGTYPE = USERID if the gateway attempts to acquire the data element USERID). |
| VIGUSER | 8 | U | Contains the users ID. VIGUSER is the default variable name for the USERID data element. |
| VIGVSMP | 8 | U | Contains the VTAM printer logical unit name assigned to a virtual session. VIGVSMP is valid only if the APPLDEF command parameter PRTPOOL is specified for the application selected by the DEST data element. |
| VIGVSMT | 8 | U | Contains the VTAM terminal logical unit name assigned to a virtual session. VIGVSMT is valid only if the APPLDEF command parameter POOL is specified for the application selected by the DEST data element. |
| Table 21. CL/SuperSession Session Profile Variables | |||
|---|---|---|---|
| VARIABLE | LEN | S/U | DESCRIPTION |
| VSPAPPL | 8 | U | Specifies the application ID for the session. |
| VSPDATA | 32 | U | Contains user data for the session. |
| VSPDESC | 32 | U | Contains a description of the session. |
| VSPGRNUM | 4 | U | Specifies the group number. |
| VSPID | 8 | U | Specifies the session ID. |
| VSPINIT | 8 | U | Contains the name of the initialization dialog for the session. |
| VSPISTAT | 1 | U | Specifies the initial status of the application:
|
| VSPLOGMD | 8 | U | Specifies the virtual terminal logmode for the session. |
| VSPOPTS | 10 | U | Specifies the virtual session options. |
| VSPORDER | 4 | U | Specifies the sessions order number. |
| VSPORIGN | 1 | U | Specifies the origin of the session (session or group). |
| VSPPOOL | 8 | U | Specifies the virtual terminal pool for the session. |
| VSPSDLTA | 108 | U | Specifies Session Table Suffix names for any
modified Session Table variable, or indicates one of the following:
|
| VSPSOURC | 7 | U | Contains the source of the sessions definition (User, Administrator, or APPLDEF). |
| VSPSUPDT | 8 | U | Contains the user ID of the last person to update a record. |
| VSPTERM | 8 | U | Contains the name of the termination dialog for the session. |
| VSPTYPE | 1 | U | Specifies the session type (Multi, Single, or Pass). |
| Table 22 . CL/SuperSession Common Profile Variables | |||
|---|---|---|---|
| VARIABLE | LEN | S/U | DESCRIPTION |
| VSPADMIN | 1 | U | Contains the administrator authority flag. |
| VSPAPLST | 8 | U | Specifies the application list name. |
| VSPAUTHC | 1 | U | Contains the customized menu authority flag. |
| VSPAUTHD | 1 | U | Specifies whether to preserve sessions when the user exits. |
| VSPAUTHP | 1 | U | Specifies whether the user can switch terminals. |
| VSPAUTHR | 1 | U | Specifies whether the user can print screens. |
| VSPAUTHS | 1 | U | Specifies whether the user can add sessions. |
| VSPAUTHT | 1 | U | Specifies whether the user can maintain triggers. |
| VSPAUTHU | 1 | U | Specifies that the user has Add Trigger authority. |
| VSPBEEP | 1 | U | Contains the beep-on-error flag. |
| VSPBYGRP | 1 | U | Specifies that session selection menu is displayed by group. |
| VSPCDLTA | 480 | U | Specifies Common Table Suffix names for any modified Common Table variable. |
| VSPCNFRM | 1 | U | Specifies confirm delete. |
| VSPCOMPR | 1 | U | Specifies data compression authority. |
| VSPCURSR | 1 | U | Specifies cursor selection. |
| VSPDFLT | 8 | U | Contains the group profile name. |
| VSPEAB | 1 | U | Specifies that the terminal will use extended attribute blocks (EAB) if the terminal supports EAB. |
| VSPFEATR | 36 | U | Specifies product features. |
| VSPCUPDT | 8 | U | Contains the user ID of the last user to update this profile. |
| VSPINITD | 8 | U | Specifies the initial dialog executed once the user accesses CL/SuperSession. |
| VSPLANG | 2 | U | Specifies the default national language. |
| VSPLIMIT | 4 | U | Specifies the session limit. |
| VSPMAXDF | 1 | U | Specifies that the dialog will use maximum screen size. |
| VSPMSGID | 1 | U | Specifies whether the message ID will display. |
| VSPNAME | 8 | U | Contains the user ID. |
| VSPNEAB | 1 | U | Specifies that the terminal will never use extended attribute blocks (EAB). |
| VSPPANID | 1 | U | Specifies whether the panel ID will display. |
| VSPPRT | 6 | U | Specifies the default printer. |
| VSPRSVAL | 1 | U | Specifies resource validation. |
| VSPRTM | 1 | U | Specifies RTM interface is used. |
| VSPSS | 1 | U | Specifies that the user has authority to access CL/SuperSession. |
| VSPTODLG | 8 | U | Contains the name of the timeout dialog. |
| VSPTOINT | 8 | U | Contains the timeout interval. |
| VSPTRIGM | 1 | U | Specifies whether the user has modify trigger authority. |
| VSPUNAME | 26 | U | Contains the user name. |
| VSPUDATA | 38 | U | Contains user data. |
| VSPVERS | 4 | U | Contains the product version number. |
| VSPWSDEL | 4 | U | Specifies the window delete key. |
| VSPWSHSP | 4 | U | Specifies the window horizontal split key. |
| VSPWSJMP | 4 | U | Specifies the window jump key. |
| VSPWSKEY | 4 | U | Specifies the window control key. |
| VSPWSOPT | 4 | U | Specifies whether or not a window will display. |
| VSPWSSDN | 4 | U | Specifies the window scroll down key. |
| VSPWSSLT | 4 | U | Specifies the window scroll left key. |
| VSPWSSRT | 4 | U | Specifies the window scroll right key. |
| VSPWSSUP | 4 | U | Specifies the window scroll up key. |
| VSPWSVSP | 4 | U | Specifies the window vertical split key. |
| VSPWSZUP | 4 | U | Specifies the window zoom/unzoom key. |
| Table 23. CL/SuperSession Trigger Profile Variables | |||
|---|---|---|---|
| VARIABLE | LEN | S/U | DESCRIPTION |
| VSPTDDG | 8 | U | Specifies the trigger dialog. |
| VSPTDKY | 8 | U | Specifies the trigger key. |
| VSPTDLTA | 24 | U | Specifies Trigger Table Suffix names for any modified Trigger Table variable. |
| VSPTDPH | 8 | U | Contains the trigger phrase. |
| VSPTDPR | 24 | U | Contains the trigger parameters. |
| VSPTUPDT | 8 | U | Contains the user ID of the last user to update this profile. |
| Table 24. Product Variables for CL/SuperSession | |||
|---|---|---|---|
| VARIABLE | LEN | S/U | DESCRIPTION |
| VSSACCT | 144 | U | Specifies the users site account number. |
| VSSAPnnn | 8 | U | Specifies a logical unit name (applid). This is the applid of the SYS1.VTAMLST APPL statement for the application program in session. |
| VSSAPPL | 8 | U | Specifies the application with which CL/SuperSession requested a session. |
| VSSDATA | 32 | U | Contains user data. |
| VSSDEnnn | VAR | U | Specifies the descriptive name of the application. |
| VSSDESC | 32 | U | Specifies the application description. |
| VSSDGnnn | 8 | U | Specifies the dialog invoked when CL/SuperSession detects trigger nnn. |
| VSSGRNUM | 4 | U | Specifies the group number. |
| VSSGROUP | 8 | U | Specifies the users connect group; acquired at signon. Used for security validation. |
| VSSIDnnn | 1 - 8 | U | Specifies the session ID of session nnn+1. |
| VSSINDLG | 8 | U | Specifies the initial dialog. |
| VSSKY | 8 | U | Specifies the trigger key. Only available during administrative updating or displaying of triggers. Not available to other dialogs. |
| VSSKYnnn | 8 | U | Specifies the trigger key of trigger nnn. Same constraints as in VSSKEY (see above). |
| VSSMSG | 0-255 | S/U | Contains error, prompt, and informational messages. |
| VSSNPSWD | 1 - 8 | S/U | Specifies the encrypted value of the users new password. This variable contains a value only for the time period necessary to validate the new password. Refer to the ENCDEC function for more information about password encryption. |
| VSSPH | 8 | U | Specifies the trigger phrase. Same constraints as in VSSKEY (see above). |
| VSSPHnnn | VAR | U | Specifies the trigger phrase of trigger nnn. Same constraints as in VSSKEY (see above). |
| VSSPLU | 8 | U | Specifies the current application ID. |
| VSSPOOL | 8 | U | Specifies the virtual terminal pool. |
| VSSPRnnn | 8 | U | Specifies the parameter passed to the dialog of trigger nnn. |
| VSSPROC | 8 | U | Specifies the TSO logon procedure; acquired at signon. |
| VSSPSWD | 1 - 8 | S/U | Specifies the encrypted value of the users current password. Refer to the ENCDEC function for more information about password encryption. |
| VSSSLnnn | 1 | U | Specifies the selection code for the selected dialog of trigger nnn. |
| VSSSLU | 8 | U | Specifies the virtual terminal ID. |
| VSSSTAT | 1 - 4 | U | Indicates the current status of the application,
depending on the function used. If function is VSSVINFO:
|
| VSSSTnnn | 1 | U | Contains the session status as returned from
the VSSVLIST function:
|
| VSSTRLDG | 8 | U | Specifies the termination dialog name. |
| VSSTRnnn | 8 | U | Specifies a logical unit name (applid). This is the applid of the SYS1.VTAMLST APPL statement for the virtual terminal in session. |
| VSSUSER | 1 - 8 | S/U | Specifies the users ID; acquired at signon. |
| Table 25. Table Services Variables | |||
|---|---|---|---|
| VARIABLE | LEN | R/W | DESCRIPTION |
| ZTBCSFLD | 8 | R/W | Specifies the field name in the model set where the Dialog Manager places the cursor. If this variable is specified, ZTBCSROW must also be specified. If no field name is supplied, the Dialog Manager uses the first field in the model set. (A model set is a template used by TBDISPL for displaying rows.) |
| ZTBCSOFF | 8 | R/W | Specifies the offset within the field where the Dialog Manager places the cursor. |
| ZTBCSROW | 8 | R/W | Specifies the table row number that the cursor will be placed in. If no row is specified or the row is not in the current display, the Dialog Manager places the cursor in the first row on the display. |
| ZTBHAND | 8 | R | Contains the handle of the table used with the TBDISPL function. Used from within the dialog executed by TBDISPL. (Not available in the dialog INIT section.) |
| ZTBMARK | VAR | R/W | Specifies the string that is to appear at the end of a TBDISPL display. When ZTBMARK is null, a standard message is displayed at the bottom of a table: ** BOTTOM OF DATA ** |
| ZTBMARKA | VAR | R/W | Controls whether an attribute is placed before the ZTBMARK line on the TBDISPL. If ZTBMARKA is null, an attribute of HIGHLIGHT PROTECTED is used; any other value causes no attribute to be placed on the field. |
| ZTBROWS | 8 | R | Contains the number of rows on the most recent TBDISPL display. |
| ZTBSEL | 8 | R | Specifies the number of rows pending to be processed. |
| ZTBSIZE | 8 | R/W | Specifies the maximum number of model sets on
the most recent display. (A model set is a template that TBDISPL uses
to display rows.) This variable limits the number of rows displayed,
excluding titles and blank lines. If it is zero, the Dialog Manager
displays as many rows as possible and sets ZTBSIZE to that value. Note: If
a TBDISPL dialog invokes another TBDISPL dialog, there may be interference
between the two and the display could be truncated. To eliminate
the problem, explicitly code SCOPE(LOCAL) for ZTBSIZE.
|
| ZTBTROW | 8 | R | Contains the top row number of the most recent TBDISPL display. |
| ZTBXRC | 8 | R | Contains extended return code information when some Table Services dialog functions fail. See Table Services Extended Return Codes (ZTBXRC) for more information. |
Note: See TBDISPL Usage Notes® for additional information
on Table Services Variables.
|
|||