Configuring the ISPF client gateway (ISPZXENV)
ISPZXENV is the ISPF gateway environment file that contains customizable settings for the gateway.
The file is provided as part of z/OS. By default, this file is installed into /usr/lpp/ispf/bin. This environment file is run by the ISPF gateway to get the value of certain environment variables necessary for the ISPF gateway to
run. Default variables include the following:
-
STEPLIBBy default, it is set to
STEPLIB = 'ISP.SISPLPA:ISP.SISPLOAD'Note: You can add more system load libraries to this STEPLIB allocation. For example, DB2.SDSNLOAD, if you have programs or executable files that start Db2® functions such as BIND.
-
CGI_ISPCONFBy default, it is set to
CGI_ISPCONF = '/etc/ispf' -
CGI_ISPWORKBy default, it is set to
CGI_ISPWORK = '/var/ispf' -
CGI_ISPPREFBy default, it is set to
CGI_ISPPREF = '&SYSPREF..ISPF.VCMISPF'
The default directory that contains ISPZXENV (/usr/lpp/ispf/bin) is read-only after installation. To set variables to non-default values, copy ISPZXENV to a writable configuration directory, such as /etc/ispf,
and then set the variables to your required values.
Configure a ISPZXENV file only for DBB
- Copy
ISPZXENVfrom/usr/lpp/ispf/binto the/usr/lpp/IBM/dbb/confDBB_CONFdirectory.
/* REXX */
/****************************************************************/
/* Licensed Materials - Property of IBM */
/* 5650-ZOS */
/* Copyright IBM Corp. 2008, 2017 */
/* */
/* This REXX routine is invoked by the "TSO/ISPF Client */
/* Gateway" XML API ISPZXML to set up values for environment */
/* variables and invoke the interface module ISPZINT. */
/* */
/* The values of the environment variables in this routine */
/* may require customization. */
/* */
/* $01=ZOSV202 2014/07/03 JM: Add CGI_ISPPREF (FIN OA45389) */
/* $02=31942 2015/02/23 AP: Add CGI_CEATSO */
/* $03=OA50812 2016/07/06 AP: Raise length limit on CGI_ISPWORK */
/* (SYSROUTE OA50837) */
/* $04=OA52684 2017/04/10 AP: Add Support for CGI_ISPDEBUG_MIN */
/* (SYSROUTE OA52506) */
/****************************************************************/
/* Customize STEPLIB, CGI_ISPCONF, CGI_ISPWORK, CGI_ISPPREF, */
/* CGI_ISPDEBUG_MIN, and CGI_CEATSO below @01C @02C @04C*/
/*
The STEPLIB should specify the data set(s) containing the load modules for
the "TSO/ISPF Client Gateway".
If these modules reside in the LINKLIST then set STEPLIB to '' .
*/
STEPLIB = 'ISP.SISPLPA:ISP.SISPLOAD'
/*
The CGI_ISPCONF environment variable determines the HOME directory
path where the configuration files reside for the "TSO/ISPF Client Gateway".
This was determined by the install directory specified in the install
job ISPZINS1. By default /etc/ispf .
This environment variable is used only by the Legacy ISPF Gateway.
*/
CGI_ISPCONF = '/etc/ispf'
/*
The Environment variable CGI_ISPWORK specifies the pathname of the
directory where work files for the gateway are stored.
This was determined by the install directory specified in the install
job ISPZINS1. By default /var/ispf .
The value must be no longer than 80 characters.
This environment variable is used only by the Legacy ISPF Gateway.
*/
CGI_ISPWORK = '/var/ispf'
/*
The Environment variable CGI_ISPPREF specifies the prefix to be used to
allocate cataloged z/OS work files for the "TSO/ISPF Client Gateway".
By default &SYSPREF..ISPF.VCMISPF .
This environment variable is used only by the Legacy ISPF Gateway.
*/
CGI_ISPPREF = '&SYSPREF..ISPF.VCMISPF' /* @01A*/
/*
The Environment variable CGI_ISPDEBUG_MIN controls whether the list of
defined environment variables is written to STDOUT by the "TSO/ISPF
Client Gateway". Change the value to TRUE if you do not want the list
of environment variables written to STDOUT. This can result in improved
performance for a client that has many environment variables defined.
This environment variable is used only by the Legacy ISPF Gateway.
*/
CGI_ISPDEBUG_MIN = 'FALSE' /*@04A*/
/*
The Environment variable CGI_CEATSO specifies whether the Legacy ISPF
Gateway or the Interactive ISPF Gateway is invoked.
Specify TRUE for the Interactive ISPF Gateway. Specify a value other
than TRUE for the Legacy ISPF Gateway.
*/
CGI_CEATSO = 'FALSE' /* @02A*/
/* */
/* SAMPLE USEAGE */
/*
Command to invoke the XML API ISPZXML:
cat ispf.input|ISPZXML >ISPF.output
- passes XML input in ispf.input to ISPZXML
- ISPZXML calls ISPZXENV to set up the environment and invoke interface
module ISPZINT
- output from the interface converted to XML which is wriiten to file
ISPF.output
*/
/* DO NOT ALTER BELOW */
CALL ENVIRONMENT 'STEPLIB',STEPLIB
CALL ENVIRONMENT 'CGI_ISPCONF',CGI_ISPCONF
CALL ENVIRONMENT 'CGI_ISPWORK',CGI_ISPWORK
CALL ENVIRONMENT 'CGI_ISPPREF',CGI_ISPPREF /* @01A*/
CALL ENVIRONMENT 'CGI_ISPDEBUG_MIN',CGI_ISPDEBUG_MIN /*@04A*/
CALL ENVIRONMENT 'CGI_CEATSO',CGI_CEATSO /* @02A*/
/* Invoke module ISPZINT */
'ISPZINT'
EXIT
- Change
CGI_CEATSO = 'FALSE'toCGI_CEATSO = 'TRUE'
CGI_CEATSO = 'TRUE' /* activates interactive mode*/
Update PATH in runIspf.sh
If you copied the ISPZXENV file to another directory and edited it, you must then change the PATH environment variable in the DBB runIspf.sh file to point to the file. The PATH variable must
point to the ISPF gateway home directory.
By default the variable is set to export PATH=$PATH:/usr/lpp/ispf/bin.
You might need to set it to the following value:
export PATH=$PATH:/etc/ispf:/usr/lpp/ispf/bin
If necessary, you should also update DBB_CONF or confDir to point to the modified runIspf.sh file.
#! /bin/sh
###################################################################
#
# Licensed materials - Property of IBM
# 5655-AC5 Copyright IBM Corp. 2018
# All rights reserved
# US Government users restricted rights - Use, duplication or
# disclosure restricted by GSA ADP schedule contract with IBM Corp.
#
###################################################################
export PATH="/var/dbb/config:$PATH:/usr/lpp/ispf/bin"
INPUT_FILE=$1
echo 'INPUT_FILE = ' $INPUT_FILE
cat $INPUT_FILE | ISPZXML