Space announcement This documentation space provides the same content as before, but the organization of the content has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

Setting up the HOTKEY command

This procedure creates a site command that your Abend-AID users can specify to access Abend-AID reports from anywhere in ISPF. The command is added to the ISPF Site Command Table.

Note

  • Because the one-key access program, #XAAHTKY, is accessed via ISPF dialog management, in order to ensure TSO user access to Abend-AID reports from anywhere within ISPF, we recommend that you place #XAAHTKY in a Link Pack Area (LPA) library.
  • Use of this function is restricted by default in the viewing server parameters. To remove this restriction, change HOT_KEY_ACCESS_RESTRICTED to NO, as described in HOT_KEY_ACCESS_RESTRICTED=NO.

This section provides information about the following tasks:

Task 1: Define the HOTKEY command and action

This site-defined command invokes the specified Abend-AID HOTKEY action. The default command is AAHOTKEY. However, your TSO/ISPF systems programmer can use AAHOTKEY as the HOTKEY command or some other character string that conforms to ISPF site command naming requirements.

Note

If your site also has Code Debug TSO installed, do not define the HOTKEY command as only the two characters AA. Doing so may interfere with the execution of the Code Debug TSO AA SNAP command.

The Abend-AID HOTKEY action can be set up at your site using one of the two following formats:

Format 1: SELECT CMD(%AAVIEW)
Format 2: SELECT CMD(EX 'VIEWER.INSTALLATION.FDBDCLST(AAVIEW)')

The first format requires that the AAVIEW exec be available to the //SYSPROC DD concatenation. The second format specifies the data set where the AAVIEW EXEC resides. Consult with your TSO/ISPF systems programmer as to the format that is to be used at your site.

Task 2: Identify the ISPF site command table prefix

The ISPF site command table prefix is the prefix to which the characters CMDS are appended to form the name of the ISPF site command table that contains the Abend-AID HOTKEY command and its associated HOTKEY action.

For example, if the name of your ISPF Site Command Table prefix is ABCD, then the name of the ISPF site command table is ABCDCMDS. This is the ISPF site command table where the Abend-AID HOTKEY command information is stored. The ISPF Site Command Table is stored in a data set contained in the ISPTLIB DD concatenation.

Task 3: Identify the location of the site command table

The location of the ISPF site command table is the data set that contains the ISPF site command table and that is currently allocated to your ISPTLIB DD concatenation.

Task 4: Update the ISPF site command table

Coordinate with your TSO/ISPF system programmer the modification of the ISPF site command table to include the Abend-AID HOTKEY command and action.

Task 5: Determine HOTKEY pop-up action

Consult with your TSO/ISPF systems programmer as to the format of the HOTKEY pop-up action that is correct for your site. See Optional HOTKEY Pop-Up Window Support Initialization below.

Optional HOTKEY Pop-Up Window Support Initialization

Note

HOTKEY processing requires the installation of Abend-AID Common Components and the use of an Abend-AID subsystem. HOTKEY and URLPUB support should use the same Abend-AID subsystem that is used by the BDCAS and/or TDCAS jobs on this MVS image. HOTKEY and URLPUB support share the address space created during HOTKEY and/or URLPUB initialization. See Installing-VS-FORTRAN-support.

Enabling HOTKEY Processing

To start the HOTKEY/URLPUB address space and/or enable HOTKEY processing:

  1. Ensure CWASACTL is available on the system. CWASACTL must be loaded into the LPA or it must reside in an APF-authorized library on the link list. To dynamically add CWASACTL to the LPA, issue the following MVS command, substituting the installed authorized data set name for SYS1.ABENDAID.SPAAAUTH:

    SETPROG LPA,ADD,MODNAME=CWASACTL,DSNAME=sys1.abendaid.spaaauth

  2. To use a specific job name to refer to the address space created for HOTKEY processing, create a member named jobname in SYS1.PROCLIB, or an equivalent system procedure library, with this line of JCL:

    //STEPNAME EXEC PGM=CWASCTL
  3. Set OKPARM to ‘REQ=STARTS,JOBNAME=jobname’in the JCLONEKY job described in the next step.
  4. Review the comments in the Abend-AID installation library (hlq.CTL) member JCLONEKY. These comments describe the processing options and sub-parameters for implementing the HOTKEY pop-up window support at your site. Modify the JCL as needed.
  5. Submit the JCL in member JCLONEKY. This job contains two steps: the first starts an Abend-AID subsystem, the second creates and initialize the address space for HOTKEY pop-up window processing. Only one Abend-AID subsystem is required for each MVS image (LPAR). Therefore, if an Abend-AID subsystem is already active in your environment, you do not need to run this first step.
  6. Ensure that the OKPARM is set to 'REQ=START'.

If problems occur, resolve issues and resubmit JCLONEKY. No special processing is necessary for a resubmit.

Stopping HOTKEY Processing

If you need to stop HOTKEY processing only:

  1. Execute only the first step of sample JCL in installation sample library (CTL) member JCLASCNL.
  2. Ensure that the OKPARM is set to 'REQ=STOP'.

If you need to stop both the HOTKEY and URLPUB functions and bring down the HOTKEY/URLPUB address space:

  1. Execute both steps of sample JCL in JCLASCNL.
  2. Ensure that the OKPARM is set to 'REQ=STOP'.
  3. Ensure that the UPPARM is set to 'REQ=STOP'.

Note

This job stops the HOTKEY/URLPUB address space only. See Controlling the Abend-AID Subsystem for more information about the Abend-AID subsystem.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*