Workspace panel definitions

Workspaces panel definitions consist of an opening and closing stanza tag and a set of keywords that specify the global properties and content of the workspace. A workspace panel definition can contain up to 15 subpanel definitions. Subpanel definitions specify navigation and display options for the subpanel and the data query. Subpanels can be linked to other workspace panels using links, so that the data displayed in the target workspace reflects values in the linked-from workspace.

A workspace panel definition begins with a <WORKSPACE> tag as the first noncomment line and ends with a <WORKSPACEEND> tag. In addition to a set of supported keywords that specify global settings for the workspace, a workspace definition can contain the following stanzas:

ALIASCOMMANDS

In an ALIASCOMMANDS stanza, the aliases for workspace panel IDs to be used in fastpath navigation are defined with SET statements. By default, alias commands apply only to the current panel. For the aliases to persist, the scope must be set to GLOBAL. If the scope is global, after an alias has been set, it is available to every subsequent panel until the alias is either updated or deleted. The SET statement for the alias can also specify whether the resulting workspace is always presented in realtime mode, even if the user is in history mode when issuing the alias command.

The use of <ALIASEND> it prevents subsequent SET statements from generating alias variables instead of normal variables.

For example:


<ALIASCOMMANDS>
SET HEALTH=KPPASTO SCOPE=LOCAL REALTIME
<ALIASEND>

ONENTRY

An ONENTRY stanza contains SET statements that are executed only once, when the workspace is loaded during "forward" navigation. This prevents the statements from being redriven, for example, when a filter is invoked.

SUBPANEL

Subpanel definitions are introduced by a <SUBPANEL> statement. Subpanels do not require a corresponding <SUBPANELEND> statement. The occurrence of a new <SUBPANEL> tag or a <WORKSPACEEND> tag functions as an indication of the end of the preceding subpanel.

In each subpanel, you can control the type of subpanel (summary, detail, text, action), the number of lines and rows that are displayed, the data that is queried, and the columns that are displayed. You can specify what controls are available (such as scrolling and minimizing and maximizing subpanels) and define navigation options for drilldown to other workspace or popup panels. The order of some keywords is restricted.

Subpanels may contain several types of stanzas:

ISPF

<ISPFPANEL><ISPFPANELEND>

ISPF stanzas support a subset of the standard ISPF statements. See Supported ISPF statements.

PROLOG and EPILOG

<PROLOG><PROLOGEND> and <EPILOG><EPILOGEND>

PROLOG and EPILOG stanzas optionally bracket a QUERY keyword and allow for the definition of local variables and for pre- and post-processing of the queried data using REXX EXECs. PROLOG and EPILOG stanzas can contain the following elements:

SET commands
REXX EXEC commands
ZOOMCOLS=&varname statements

ONACTION

<ONACTION><ONACTIONEND>

This stanza is executed once when the workspace is first displayed during forward navigation. ONACTION stanzas can contain the following elements:

SET commands.
SET commands coded in an ONACTION stanza are executed directly after key column assignment when an action is driven from the subpanel (see KEYCOLS).
Used with the system variable ZFILTERnn, SET commands in the ONACTION stanza can be used to created filters for columns that have been designated as eligible using the FILTERCOLS keyword. For example:
```
<ONACTION>
SET ZFILTER01=CICSNAME=C*                               
SET ZFILTER02=SOS=1
SET ZFILTER03=TASKS>100
<ONACTIONEND>
```
REXX exec calls. For example:
```
<ONACTION>
CALL MYREXX
<ONACTIONEND>
```

Example

Here is an example of a simple workspace panel definition:

<WORKSPACE>
HEADER='Address Spaces for Service Class'
NAV1TEXT='Plex ID'
NAV2TEXT='SMF ID'
SET ZOMEGNAV2=''
SET ZOMEGLOCK1=NO
SET ZOMEGLOCK2=YES
IMBED=KM5NAV1

/********************************************************************/
/*                                                                  */
/*  SUBPANEL 1 - Address Spaces for Service Class                   */
/*                                                                  */
/********************************************************************/

<SUBPANEL>
HEADER='Service Class &CLSNAME' 
TYPE=SUMMARY  
/********************************************************************/ 
/*                       Data Query                                 */ 
/********************************************************************/  
QUERYTYPE=ROUTER 
QUERYMODE=LIVE 
QUERYREGTYPE=DRA  
QUERY='SELECT MADDSPC.ORIGINNODE,MADDSPC.ASNAME, 
MADDSPC.VSYSTEMNAM,MADDSPC.ASID,MADDSPC.ASRCNAME, 
MADDSPC.VELOCITY,MADDSPC.PAGERATE,MADDSPC.ASCSTOR, 
MADDSPC.ASESTOR,MADDSPC.IORATE,MADDSPC.CPUPCNT, 
MADDSPC.IFAPCNT,MADDSPC.IFCPCNT,MADDSPC.SUPPCNT, 
MADDSPC.SUCPCNT,MADDSPC.CLSNAME, 
FROM KM5.MADDSPC, 
WHERE ORIGINNODE='&PLEXORIG', 
AND MADDSPC.CLSNAME='&CLSNAME', 
ORDER BY VELOCITY DESC;'  
/********************************************************************/ 
/*                  Data Status                                     */ 
/********************************************************************/  
/********************************************************************/ 
/*                  Session Data Row Key Fields                     */ 
/********************************************************************/  
/********************************************************************/ 
/*                  Default list of fields to display               */ 
/********************************************************************/ 
STATICCOLS=2  
SORTCOLS='ASNAME,ASID,PAGERATE,ASCSTOR,ASESTOR,IORATE,CPUPCNT, 
IFAPCNT,IFCPCNT,SUPPCNT,SUCPCNT,VELOCITY'  

DISPLAYCOLS='ASNAME,ASID(HEXDISP),VSYSTEMNAM(W=4), 
ASRCNAME,CPUPCNT,VELOCITY,ASCSTOR,ASESTOR,IORATE, 
PAGERATE,IFAPCNT,IFCPCNT,SUPPCNT,SUCPCNT'  
/********************************************************************/ 
/*                  Navigation Options                              */ 
/********************************************************************/  
/* ACTION=ASNAME(?,"Help Assistance",KOCHELP1)  
/********************************************************************/ 
/*  SUBPANEL 1 END                                                  */ 
/********************************************************************/ 
<WORKSPACEEND>