Customizing z/OS Workload Interaction Navigator

Edit online

The config file INSTANCE-DIR/zwin-app/config/zwin.conf is generated when you run config.sh, and you can customize the parameters in zwin.conf according to your needs.

About this task

To customize zwin.conf and make the customization take effect, complete the following steps.

Procedure

  1. Customize the following parameters in zwin.conf.
    Here is an example of zwin.conf.
    #/**********************************************************************/
#/*  Licensed Materials - Property of IBM                              */
#/*                                                                    */
#/*  5698-WKN                                                          */
#/*                                                                    */
#/*  Copyright IBM Corp. 2020,  2022                                   */
#/**********************************************************************/

# Java home
javaHome=/java/current8

# NodeJS home
nodeHome=/nodejs/V12.16.1.smpe

# SMF Directory where the SMF files are stored.
smfDirectory=/zwicdata

# Directory schema of how the members of sysplex store their SMF files by IBM z/OS Workload Interaction Correlator.
#
# The possible value can be:
#
#   ALL_IN_ONE: [Default] The SMF files from the different sysplex members are stored in the same directory on zFS.
#
#   PER_SYSTEM: The SMF files from the different sysplex members are stored in their own directory on zFS.
#                 <SOME_DIR>/
#                      +- <NAME_OF_SYSTEM_1>/
#                              +- SMF files of system 1
#                              +- ...
#                      +- <NAME_OF_SYSTEM_2>/
#                              +- SMF files of system 2
#                              +- ...
#                      +- ...
smfDirectory.directorySchema=ALL_IN_ONE

# Where IBM z/OS Workload Interaction Navigator is installed
zwinHome=/global/zowe-instance/zwin-app

# Where the diagnosis data is stored
diagnosisDirectory=/global/zowe-instance/zwin-app

# Custom macro directory of SMF 98 exploiter subtype X. This directory contains sub-directory "awi" in first or secondary level.
# If the subtype number is 2, replace "subtypeX" with "subtype2".
# exploiters.subtypeX.customMacroPath=/custom/macro_dir

# Custom macro directory of SMF exploiter type Y. This directory contains sub-directory "awi" in first or secondary level.
# If the type number is 100, replace "typeY" with "type100".
# exploiters.typeY.customMacroPath=/custom/macro_dir

# Zowe version v1.x or v2.x. The possible value can be "v1" or "v2".
zowe.version=v1

# Zowe API Mediation Layer gateway settings
zowe.gateway.host=localhost
zowe.gateway.port=7554
zowe.gateway.rejectUnauthorized=False
zowe.gateway.ca=/global/zowe/keystore/local_ca/localca.cer
# Use z/OSMF service from Zowe API Mediation Layer. Change to ZOWE_V1_USS_JES to use Zowe V1 USS Files and Jobs service.
zowe.gateway.service=ZOSMF

# BInsight jar file and its location
binsight.path=/global/zowe-instance/zwin-app
binsight.file=binsight-1.0.13-20201104122610.jar


# JCL settings
jcl.ACCT_INFO=
jcl.PROGRAMMER_NAME=
jcl.NOTIFY=&SYSUID
jcl.JOBNAME=BINSIGHT
jcl.JOBNAME_PACKAGE=INSPACK
jcl.JOBCLASS=A
jcl.MSGCLASS=H
jcl.MSGLEVEL=(1,1)
jcl.PROCLIB=
jcl.JVMPRC=JVMPRC86
jcl.MEMLIMIT=NOLIMIT
jcl.TIME=NOLIMIT
jcl.HEAP_XMX=1800m 

# How many different job names will be used. The maximum number is 16.
# 
# The hex sequence number is appended to the job name or replaces the last 
# character of job name. So if jcl.JOBNAME is BINSIGHT, the job name could be
# BINSIGH0, BINSIGH1, to BINSIGHF. In the case of jcl.MAX_JOB_SEQUENCE_NUMBER
# is 4, BINSIGH0, BINSIGH1, BINSIGH2, and BINSIGH3 will be used.
jcl.MAX_JOB_SEQUENCE_NUMBER=4

# Use Zowe Single-Sign-On or not
sso=True
    javaHome
    Specifies the full path of the home directory of IBM® SDK for z/OS®, Java™ Technology Edition, Version 8. The path name must not include the subdirectory of bin.
    nodeHome
    Specifies the home directory of IBM Open Enterprise SDK for Node.js.
    smfDirectory
    The default SMF directory where the SMF files are stored.
    smfDirectory.directorySchema
    Specifies the directory schema of how the members of sysplex store SMF files. There are two schemas:
    ALL_IN_ONE
    The default schema. In this schema, SMF files from the single system are stored in one directory on zFS, or the SMF files from different sysplex members are stored in the same directory on zFS.
    PER_SYSTEM
    In this schema, the SMF files from different sysplex members are stored in their own directories on zFS directory under the same parent directory. The system names are used as the directories names, for example, /global/wic/SYS1 and /global/wic/SYS2. The SMF directory of one system is specified as the default SMF directory. Initially, the files of the default SMF directory are shown, and you can switch to the SMF directories of other systems.
    zwinHome
    Specifies the directory where IBM z/OS Workload Interaction Navigator is installed.
    diagnosisDirectory
    Specifies the full path of the directory where the diagnosis zip file of IBM z/OS Workload Interaction Navigator is stored. The path is used when you collect diagnosis data from z/OS Workload Interaction Navigator application interface in IBM Z® Distribution for Zowe Desktop to report problems.
    exploiters.subtypeX.customMacroPath
    Specifies the full path of the directory where the macro files are installed. Each IBM z/OS Workload Interaction Correlator data generation participant like z/OS Supervisor or CICS® has its own SMF 98 subtype and annotated macro files, which instruct z/OS Workload Interaction Navigator how to parse and analyze the data. If the macro files are not installed under the default location, you can specify the path of the files.
    Table 1 lists the default macro search path of some subtypes.
    Table 1. The default macro search path of subtypes
    Subtype Default path
    z/OS Supervisor (SMF 98 subtype 1) /usr/lpp/bcp
    z/OS I/O Supervisor – Asynchronous I/O (SMF 98 subtype 3) /usr/lpp/bcp
    z/OS I/O Supervisor – Synchronous I/O (SMF 98 subtype 4) /usr/lpp/bcp
    CICS (SMF 98 subtype 1024) /usr/lpp/cicsts
    IMS (SMF 98 subtype 1025) /usr/lpp/ims
    For example, if CICS Transaction Server for z/OS 5.5 is installed under /global/cicsts/cicsts55, the macro search path is /global/cicsts/. If more than one CICS Transaction Server for z/OS versions are installed under /global/cicsts, the files with the latest macro version are used by z/OS Workload Interaction Navigator. For example, to set a custom path for CICS which uses SMF 98 subtype 1024, specify the custom macro search path.
    exploiters.subtype1024.customMacroPath=/global/cicsts/
    You can define multiple custom macro search paths for different subtypes, but only one search path is allowed for one subtype.
    exploiters.typeY.customMacroPath
    Specifies the full path of the directory where the macro files of SMF type Y are installed. If the macro files are not installed under the default location, you can specify the path of the files.
    Table 2 lists the default macro search path of a type.
    Table 2. The default macro search path of a type
    Type Default path
    Db2® (SMF 100) /usr/lpp/db2
    For example, if Db2 for z/OS 12 is installed under /global/db2/db2v12, the macro search path is /global/db2/. If more than one Db2 for z/OS versions are installed under /global/db2, the files in the directory with the later alphabetic order are used by z/OS Workload Interaction Navigator. For example, to set a custom path for Db2 which uses SMF 100, specify the custom macro search path.
    exploiters.type100.customMacroPath=/global/db2/
    zowe.version
    Specifies the version of IBM Z Distribution for Zowe. This value can be v1 or v2.
    zowe.gateway.*
    Specifies the settings of IBM Z Distribution for Zowe API gateway.
    zowe.gateway.host
    Host name of IBM Z Distribution for Zowe API Gateway. If the external certificate is configured on IBM Z Distribution for Zowe API Gateway, the host name must match with DSN name in the certificate. If the self-signed certificate is configured on IBM Z Distribution for Zowe API Gateway, the host name is localhost.
    zowe.gateway.port
    The port number of IBM Z Distribution for Zowe API Gateway on the target system.
    zowe.gateway.rejectUnauthorized
    Specifies whether to reject the certificate that is not verified successfully. If the external certificate is configured on IBM Z Distribution for Zowe API Gateway for security, set the value to True. If the self-signed certificate is configured on IBM Z Distribution for Zowe API Gateway, set the value to False.
    zowe.gateway.ca
    The full path of IBM Z Distribution for Zowe API Gateway CA file. If the external certificate is configured on IBM Z Distribution for Zowe API Gateway, the path must be in PEM format, including the intermediate certificate and root certificate. If the self-signed certificate is configured on IBM Z Distribution for Zowe API Gateway, the path is where the local CA file is, for example, /global/zowe/keystore/local_ca/localca.cer.
    zowe.gateway.service
    By default, the value is ZOSMF, and z/OSMF service from Zowe™ API Mediation Layer is used. If you want to use Zowe V1 USS Files service and Jobs service, change the value to ZOWE_V1_USS_JES.
    binsight.*
    Specifies the BInsight Java file and its path.
    jcl.*
    Specifies the JES job settings for BInsight job, which runs the BInsight Java program. It might need to be modified to comply with the JES convention of the target system.
    jcl.ACCT_INFO
    Specifies the account number and any other accounting information that is required for z/OS installation. This value is optional and the maximum length is 48 characters.
    jcl.PROGRAMMER_NAME
    Specifies the name parameter of the programmer to identify the person or group that is responsible for BInsight job. This value is optional.
    jcl.NOTIFY
    Specifies who receives the message when BInsight job completes processing. The default value is &SYSUID.
    jcl.JOBNAME
    Specifies the BInsight Job name that is defined in the JCL. The BInsight job processes IBM z/OS Workload Interaction Correlator files and outputs Insights JSON file. The default value is BINSIGHT.
    jcl.JOBNAME_PACKAGE
    Specifies the INSPECT PACKAGE Job name that is defined in the JCL. The Inspect Package job packages Navigator Weekly JSON files and at most 3 SMF files into a zip file for anomaly inspecting by IBM. The default value is INSPACK.
    jcl.JOBCLASS
    Specifies the class of JES job initiator. The default value is A.
    jcl.MSGCLASS
    Specifies the job log output class. The default value is H.
    jcl.MSGLEVEL
    Specifies how to control the listing of the JCL output for the job. The default value is (1,1).
    jcl.PROCLIB
    Specifies the PROCLIB dataset if JVMPRC86 is not in the default PROCLIB.
    jcl.JVMPRC
    Specifies JVM PROC provided by JZOS. The default value is JVMPRC86.
    jcl.MEMLIMIT
    Specifies the limit on the total size of usable virtual storage above the bar in a single address space. The default value is NOLIMIT.
    jcl.TIME
    Specifies the maximum amount of time that BInsight job step can use the processor. The default value is NOLIMIT.
    jcl.HEAP_XMX
    Specifies the maximum Java heap for BInsight job. The default value is 1800m.
    jcl.MAX_JOB_SEQUENCE_NUMBER
    Specifies the maximum hex sequence number that can be appended to the job name. The default value is 4, and the maximum value to 16.
    sso
    Specifies whether z/OS Workload Interaction Navigator uses the authentication token provided by IBM Z Distribution for Zowe with Single Sign-On configured. When z/OS Workload Interaction Navigator invokes IBM Z Distribution for Zowe API, z/OS Workload Interaction Navigator sends user authentication token. If IBM Z Distribution for Zowe is not configured with Single Sign-On, z/OS Workload Interaction Navigator uses HTTP Basic Authentication for IBM Z Distribution for Zowe API requests, whether sso is defined with True or not. If you want z/OS Workload Interaction Navigator to always use HTTP Basic Authentication, set sso=False.

    If you encounter an error about certificate, refer to Certificate error when using both an external certificate and Single Sign-On to deploy Zowe.

  2. After you customize zwin.conf, you must restart IBM Z Distribution for Zowe for the customization to take effect.