TK5 Introduction and User Manual
TK5 Introduction and User Manual
TK5 Introduction
and User Manual
Enjoy your private mainframe
Update 4
The update of RPF to RPF Version 2.0.0 has introduced some major changes for RPF
users.
• The VSAM profile cluster (RPFPROF.CLUSTER) has been removed and
replaced by 3 members in the ISPPROF partitioned data set.
• RPF Version 2 now adopts the standard TSO data set naming conventions. A
data set name entered that is not enclosed within single quotation marks will
be prefixed with the TSO data set prefix. The TSO data set prefix defaults to
the TSO UserID however it can be changed by use of the PROFILE PREFIX
command.
Data set names that are entered enclosed between single quotation marks
(the ending quote is optional) are treated as fully qualified data set names.
• After installing Update 4, please review the RPF defaults with RPF option 0.
New
• A friend and fellow retired colleague of mine, Rob Kemme, has contributed
Skybird Test Facility (STF) Version 5.0.0 to assist in monitoring and testing an
SNA network. Running as a VTAM application STF has many functions from
validating 3270 emulator software to analyzing network performance.
Originally, STF was designed for the ACF/VTAM environment. Rob Kemme
has now retrofitted STF to use the limited functionality provided by the
VTAM2 component of MVS 3.8.
• Ed Liss has developed a new component named SLIM (Source Library
Manager). SLIM integrates with Archiver to manage source code, listings and
load modules in Archiver.
• Archiver has been enhanced by Ed Liss with the new Archiver Extensions
contribution. These Archiver Extensions facilitate Archiver Dump and Restore
and other functional enhancements.
• Mike Rayborn has developed and now released LUA370. LUA370 is based on
the LUA programming language (). LUA370 is integrated into the HTTPD
server, which was also developed by Mike Rayborn.
• Component VSI (VSAM data set Information), created by Larry Belmontes,
has been installed and can be accessed via the ISPF VTOC dialog (option
3.7).
TK5 is unique in that for the first time in any MVS 3.8 environment, the systems
residence volume can be cloned with a new volume serial and IPLed without impact
on catalog entries and configuration specifications in PARMLIB members. This
functionality has only previously been available in Operating Systems that
superseded MVS 3.8. Users who prefer to install their own usermods will find the
new DASD volume allocations and systems residence data set cataloging
convention are of real benefit to them.
In the TK5 system all data sets on the system’s residence volume are cataloged
with a volume serial of ******. Usermods installed in the TK5 MVS 3.8 system
dynamically replace the ****** specification within MVS with the volume serial and
the device type of the current systems residence volume. Additional usermods
installed in TK5 implement the ****** notation for the systems residence volume in
SYS1.PARMLIB members where the volume serial for data sets on the systems
residence volume must be specified. Masking is now implemented in the VATLSTxx
and IEAAPFxx PARMLIB entries allowing only the partial specification of a volume
serial to set usage, allocation attributes and APF authorization. The document TK5
Usermod Directory contains further information describing the usermods
implementing the ****** systems residence volume notation.
The Master Catalog listing will show a number of ALIAS entries and a large number
of non VSAM data set entries. There may also be additional User Catalogs listed
other than SYS1.UCAT.MVS and SYS1.UCAT.TSO. The non VSAM entries for data
sets with HLQs of SYS1 and SYS2 do not need to be migrated as these entries, and
their data sets, will be present in the TK5 Master Catalog and the TK5 systems
volumes. Data sets cataloged in the Master Catalog with a HLQ other than SYS1 or
SYS2 will need to be migrated to the TK5 system and preferably not cataloged in
the TK5 Master Catalog.
It is specifically the ALIAS entries, listed in the Master Catalog, that need attention
as they identify data sets that, potentially, will require migration to TK5 Catalogs
and volumes. Again, much of the work required to achieve this has already been
done. The TK5 system already has pre-installed all popular and well-known user
contributed software enhancements. These software enhancements have their own
unique ALIAS to identify their cataloged data sets. ALIAS entries for system support
data sets relating to EREP and SMF have already been setup in the TK5 system. The
table below lists the ALIAS entries for the associated data sets that have been
included in the TK5 system.
Additionally, ALIAS entries for TSO UserIDs HERC01, HERC02, HERC03 and
HERC04 have been provided in the TK5 system. However, the data sets associated
with these TSO UserIDs are resident on the current system and therefore will need
migration to the TK5 system. This equally applies to any other TSO UserIDs, and
their associated data sets, that may have been created in the current system.
Catalog listings for SYS1.UCAT.MVS and SYS1.UCAT.TSO will contain many non
VSAM data set entries with HLQs matching the ALIAS entries listed in the above
table. The data sets associated with these ALIAS entries, listed above in Figure 2,
1. All TSO UserIDs in the system including HERC01, HERC02, HERC03 and
HERC04
2. All HLQs, identifying data sets, not listed in the above table of TK5 ALIAS
entries or not prefixed with a TSO UserID.
3. All application VSAM data sets that require migration.
4. All additional DASD volumes.
5. All ALIAS entries relating to any additional User Catalogs and the name of
these User Catalogs (if present).
The data sets associated with the TSO UserIDs and the HLQs unique to the current
system will require migration to the TK5 system. Additional volumes will need to be
brought online to the TK5 system with their User Catalogs imported and their
related ALIAS entries defined in the TK5 Master Catalog.
Migrating datasets from pre-TK5 systems
There are many techniques available to migrate data sets from the current MVS 3.8
system, whether it is an MVS Turnkey system, or a user-built RYO MVS system. The
most appropriate technique is the one that requires the least amount of preparation
and also less likely to fail to migrate all the required data sets. The technique
recommended therefore is to use the DSSDUMP utility program, contributed by
Gerhard Postpischil, to dump all the data sets that need to be migrated to a tape
volume. Then use the DSSREST utility program, contributed by Charlie Brint, to
restore the data sets from the dump tape volume into the TK5 system. These utility
programs are already installed in TK4- and TK4 DASD Rollup systems. For other
systems, where DSSDUMP is not installed, an aws file, dss001.aws, is provided in
the tape directory to install DSSDUMP in the current system to implement the
migration process. An example jobstream to install the DSSDUMP utility program is
provided in Appendix 1.
The TEMPORARY parameter must be specified otherwise the VSAM data set will be
deleted from the current system. Select a HLQ for the sequential exported data set
that will be specified in the DSSDUMP control statements. A TSO UserID HLQ such
as HERC01 is ideal for this purpose. Allocating the sequential export data set on an
existing 3390 volume will provide optimum performance.
Step 2 SYS1.UADS Migration for TSO UserIDs.
To migrate all TSO UserIDs in the current system, with their configuration settings,
across to the TK5 system the SYS1.UADS data set will need to be brought across to
the TK5 system. Use IEBCOPY to copy the SYS1.UADS data set to a data set that
will be selected for dumping by DSSDUMP. Select a HLQ for the data set that will be
specified in the DSSDUMP control statements. A TSO UserID HLQ such as HERC01
is ideal for this purpose. Example JCL is provided below.
Before submitting the job create a new tape volume using the HercGUI utility
HETINIT or identify a PC file to be mounted on a Hercules tape drive when
requested by the system. This tape volume will contain the output from the dump
process later needed in the restore steps.
Submit the job and review the resulting output. DSSDUMP will list each data set
found with the specified HLQ and report on the success of the dumping operation.
Running DSSDUMP does not change any data on the current running system.
Therefore, DSSDUMP can be run multiple times if a particular HLQ has been missed
or should not have been included in the DSSDUMP control statements.
Refer to the document Guide to Using DSSDUMP and DSSREST for further
information if specific data set filtering is required to exclude some data sets.
Now it is time to shut down the current system.
Step 5 Start TK5.
Start TK5. See the Section Running the TK5 Environment for startup instructions. At
this stage none of the data sets associated with each TSO UserID are available in
the TK5 system. A data set named TK5MIG.CNTL has been allocated on TK5001
and is available for use in the data set restoration process.
The restoration process is a multi-step process.
Step 6 Define ALIAS Entries.
If there were any TSO UserIDs other than HERC01 through HERC04 included in the
dump process or if there were any other HLQs included in the dump process, then
ALIAS entries must be defined the TK5 Master Catalog for those TSO UserIDs and
data set HLQs before the restoration steps are run. Either issue DEFINE commands
in a TSO session or submit a IDCAMS job to update the TK5 Master Catalog. An
example is provided below.
Step 10 (Only for users migrating from a system with RAKF installed).
For RAKF users, the SYS1.SECURE.CNTL data set from the previous system needs
to be brought into the TK5 system.
The TSO UserID HERC01 must be used to submit this job as RAKF requires the user
to have the RAKFADM Profile to update the SYS1.SECURE.CNTL data set. Complete
the migration process for RAKF by issuing the command S RAKFUSER on the MVS
TK5 Master Console to update the running RAKF system. Acknowledgement
messages of the update should appear on the Master Console. Example JCL is
provided in TK5MIG.CNTL($RSTRAKF).
Step 11 Import User Catalogs.
For those users who have additional volumes of data sets such as MVS source data
sets or CBT data sets the migration process is very easy. Update the Hercules
configuration file used for TK5 to bring these volumes online to the TK5 system. If
the volumes contain their own User Catalogs, then run an IMPORT CONNECT
OBJECTS command, either in batch or via TSO to connect the User Catalog to the
TK5 Master Catalog. After the User Catalog has been connected to the TK5 Master
Catalog then DEFINE the relevant ALIAS entries to the connected User Catalogs. An
example of this for the CBT data sets is provided below.
If the data sets on the additional volumes do not have their own Catalog, then they
will need to be individually re-cataloged in the TK5 system using RFE or RPF.
Step 12 (Optional for VSAM Data Set Migration).
If there were any VSAM data sets that were exported to sequential export data sets,
as identified in Step 1, then they need to be imported into the TK5 system. A
sample job is provided below. This job will IMPORT a VSAM data set by dynamically
Column Description
1-8 TSO UserID
10-17 User group (installation defined)
18 Asterisk '*' multiple user groups exist for this userid.
19-26 Password
28 Operations Authority (Y or N). Always allow access 1)
31-50 Comment field (used by "IBM RACF").
The only Catalog that will be replaced with future TK5 updates is SYS1.UCAT.TK5.
None of the other three Catalogs will be replaced by TK5 updates so any entries
placed in these Catalogs will not be impacted by future TK5 updates.
Only the highlighted volumes will be replaced when an update release is provided
for TK5. To minimize any disruption or loss of data when installing a future TK5
update users should avoid allocating any data sets on the TK5RES volume.
The TK5DLB volume is a one-time replacement requirement for TK5 Update-2.
• Download the complete distribution from the website listed above, preferably
into the root directory of a disk in Windows or the root directory of /home/userid
in Linux.
• For Linux: add the execute attribute with the command chmod +x mvs-tk5.zip.
• Unzip the file, creating a directory with the name of mvs-tk5.
• Select the newly created directory mvs-tk5.
• For Linux: set the permissions to execute with the command chmod -R +x *.
• Select the unattended directory in the mvs-tk5 directory.
• Run the script ./set_console_mode for Linux or set_console_mode.bat in
Windows.
In this case the IPL message IEA101A will be replied with R 00,CMD=02. TCAM
(jobname TP), MF1, JRP and SNASOL won’t start and the NCP’s won’t be loaded.
If you want to go back to the normal configuration, just delete tk5.parm in mvs-
tk5/local_conf. or set the variable REP101A to the value default with
export REP101A=default for Linux or set REP101A=default for Windows.
Logon to TSO
TK5, like the predecessor Turnkey 3 and Turnkey 4- systems, has four predefined
TSO users, in addition to IBMUSER, which is the system’s initial user.
TK5 however, has resource access control (RAC) implemented by the installation of
RAKF, a user provided contribution providing similar functionality to IBM’s RACF
Program Product. TK3 users and RYO users migrating from systems where RAKF
was not installed will have slightly different TSO UserId definitions in the TK5
environment:
See the RAKF User’s Guide in the “doc” directory for more information about RAKF.
From this menu the main TSO applications can be accessed by entering the
appropriate item number in the Option field. Pressing PF3 will result in an exit to the
TSO READY prompt, allowing full TSO functionality.
Archiver
Archiver is a component written by Rick Fochtman and now maintained by Rob
Prins. It provides the facility to archive different types of data into a single VSAM
cluster.
For more information refer to the manual “ARCHIVER User's Guide”
Sample jobs are present in SYS2.JCLLIB with members starting with ARCH.
BREXX/370
This enhancement is contributed by Mike Großmann and Peter Jacob. BREXX is a
nearly fully compatible clone of IBM’s REXX. It’s a little more basic but have many
functionalities compared with REXX.
BREXX/370 uses the same syntax and the same DD Names. If you create a
partitioned dataset with RECFM=VB and LRECL=255 and allocate DD Names
SYSEXEC and SYSUEXEC and allocate the BREXX dataset BREXX.VxRyMz.RXLIB to
DD Name RXLIB, you have a valid (B)REXX environment.
BREXX comes with many examples collected in BREXX.VxRyMz.SAMPLES.
EDIT
If ETPS is not available or the preference is for another method to make emergency
changes then subsystem EDIT is available. Like ETPS, being a subsystem, EDIT
does not need JES2.
EDIT uses the MVS Master Console for input and output. EDIT is a line-editor that
interacts using WTO’s and WTOR’s to communicate via the MVS Master Console.
Similar to ETPS, EDIT requests an authorized user and password. Use the same
logon credentials as for TSO UserID HERC01.
The document, EDIT User’s Guide in the doc directory, provides further information
on the operation of EDIT.
ETPS
The worst nightmare of every systems programmer becomes a reality when JES2,
VTAM or TSO fail to start because of some JCL error or missing APF authorization.
Emergency Tele Processing System (ETPS) is here to save the day by providing an
edit facility to quickly correct the error. The component is installed as a subsystem
so JES2 is not needed.
ETPS is a full screen stand-alone application that can be used to edit libraries. The
only resource needed is a 3270 model 2, 3 or 4 terminal. As a stand-alone
application ETPS does not use VTAM. However, it is recommended to shut down
VTAM, if it was running, to avoid any clash with 3270 device allocations. The default
terminal used by ETPS is unit address 0C0, configured as a 3270 model 4. The
model and the unit address can be overridden in the start command. An example of
the start command is below:
Or
HTTPD
HTTPD is a basic webserver running on MVS 3.8J. This component can be started
with
S HTTPD on the MVS Operator console. The default port, where HTTPD listens is
8080.
Intercomm
TK5 provides a 3380 volume with volume serial of INT001 dedicated to the
component Intercomm. This is a CICS-like application, that provides an online
interactive environment to run transactions written in COBOL or Assembler.
Unlike applications like CICS or IMS, Intercomm is started by submission of a job
and is not run as a started task. See member RUNICOM in SYS2.JCLLIB.
Stop Intercomm by replying ‘NRCD’ to the outstanding WTOR message:
00 INTVT034R INTERCOM ENTER INTERCOMM MESSAGES USING THIS ID
For more information refer to the Intercomm manuals listed in the Related
Documents Section.
ISPF
ISPF is the TSO dialog manager. IBM’s ISPF is a licensed Program Product. To
provide similar functionality for MVS 3.8 users Wally Mclaughlin developed his own
version of ISPF with compatible functionality.
Wally’s ISPF is a dialog manager providing table services, panel functions (such as
creating user panels), and integrated CLIST support. It does not have PDF
functionality such as EDIT, Browse, DSLIST and OUTPUT functions. The PDF
functionality is fulfilled by REVIEW/RFE and RPF.
LUA370
LUA370 is an installed component of the HTTPD server. LUA370 is based on the
programming language LUA. Documentation for LUA370 can be found by starting
the HTTPD server and retrieving the documentation pages with
http://localhost:8080.
More information about LUA can be found on https://www.lua.org/.
RAKF
RAKF is a security component providing functionality similar to IBM’s RACF or CA-
ACF2. RAKF is a basic security product and is controlled by 2 members in
SYS1.SECURE.CNTL, and member RAKFINIT in SYS1.PARMLIB.
Member USERS identified the users that can be either a TSO UserID or a started
task. Member PROFILES contains the access rights for datasets and other
resources.
Both members can be updated by TSO user HERC01. TSO UserIDs HERC01 and
HERC02 have all rights (like SPECIAL in RACF or SECURITY in ACF2).
Macro driven programming interfaces to RACF such as RACINIT and RACHECK are
compatible with RAKF. For more information concerning RAKF, refer to the RAKF
User’s Guide in the directory “doc”.
REVIEW/RFE
Greg Price develops and maintains REVIEW/RFE to provide most of the PDF
functionality like EDIT (ISPF option 2), Browse (ISPF option 1), Library (ISPF option
3.0), Move/Copy (ISPF option 3.3), DSLIST (ISPF option 3.4), Reset (ISPF option
3.6) and OUTLIST (ISPF option 3.8).
REVIEW can be started with the command RFE in the TSO READY mode which
launches the Review Front End (RFE).
RPF
Rob’s Programming Facility (RPF) is developed and maintained by Rob Prins. RPF
has a similar user interface to RFE and provides PDF functionality including EDIT,
Browse, RESET, Library, Move/Copy, DSLIST and OUTLIST functions. Additionally,
RPF provides the SEARCH function to search for strings in sequential or partitioned
datasets and an interface to ARCHIVER.
RPF is available in ISPF option R (for EDIT, Browse, Library and RESET) and in ISPF
option 3.4R for the DSLIST function.
RPF can also be started in TSO READY mode with the command RPF.
SLIM
Source Library Manager (SLIM) was developed by Ed Liss. SLIM integrates with
Archiver to store source code, load modules and listings into Archiver and provides
commands to administer these archived items.
The functionality provided by SLIM can be regarded as a ‘Poor man’s Panvalet.
The SLIM User’s Manual in the .doc directory provides additional information.
STF
Skybird Test Facility (STF) is developed and maintained by Rob Kemme. Originally
STF was written to assist in monitoring and testing in an ACF/VTAM SNA network. It
has now been retrofitted to use the limited functionality provided by the VTAM2
component of MVS-TK5. STF provides many functions including analyzing network
performance, perform 3270 emulator compatibility tests and as an aid to VTAM
programming. A software implementation of DES (Data Encryption Standard) is
provided for testing purposes. It also has a built-in Editor for small text files. As STF
is a VTAM application, users can log on to STF through VTAM or interact with STF
through an MVS operator console.
STF can execute as a TSO foreground application, MVS batch Job or MVS Started
Task.
//********************************************************************
//*
//* NAME: TK5.ASM($$$INDEX)
//*
//* Desc: Short index of members in this PDS with sources
//* The jobs for assembly and link are in TK5.CNTL
//* The member names can be recognized with the name
//* of the source member in this library suffixed with '$'
//*
//* Last Update: 2024/11/25 16:57
//*
//********************************************************************
//*
=======================================================================
Membername Short description |Remarks |
---------- ------------------------------------------------------------
$$$INDEX THIS member, you are reading it | |
AFPCNTRL Switch additional floating point (AFP) | |
registers on or off. | |
AUTO This routine provides for job submission and | |
automatic commands in an MVS/JES2 environment. | |
AUPGM AUPGM, authorized version of DOPROG/DOPGM TSO | |
command | |
AUPGMUPD IEBUPDTE input to add RAKF support in AUPGM | |
BLKDISK Calculate optimal blksize for different DASD |BLKdev e.g|
devices: 2314,3330,3330-1,3340,3350,3380, | BLK3390 |
3390 and 9345 | |
BLKSPTRK Physical blocks per DASD track calculator | |
BYPASCRN SVC Screening routine | |
BYPASSNQ SCRATCH/RENAME a data set without ENQ |+BYPASUPD |
CBMACSMV Mapping macros control blocks for LOOKMVS | LOOKMVS |
CDSCB Alters the contents of a Format 1 DSCB |APF with |
in a VTOC. APF authorization and OPER privilege |TSOEXEC |
for the TSO user are required. | |
CHECKMOD Check for presence of a load module | |
CLEANPDS Make a PDS empty and/or add directory blocks | |
without need to re-allocate and compress. | |
CLRSCRN Clear TSO screen for all screen sizes | |
COMPRESS TSO command to compress a partitioned data set | |
COPYPDS This TSO command copies a partitioned data set, | |
using the IEBCOPY utility program. | |
Figure 19, TK5 TSO Command Processors and Utilities source modules.
All usermods installed on the TK5 system are resident in separate PDS data sets
where the contributor assigned usermod name is prefixed with the HLQ of
USERMOD followed by usermodname, eg USERMOD.usermodname. For example:
the usermod RP00001 is resident in the data set USERMOD.RP00001.
Usermods, either inherited or developed specifically for TK5, have been repackaged
into a standardized format where the jobstream to install the usermod is provided
in member $INSTALL and the SMP4 control statements and description of the
usermod is provided in member @CVRLET of the PDS. Additional source code
members and macros can also be present in the PDS if the usermod installation
requires the assembly of a module. This TK5 packaging concept provides for the
easy distribution of usermods via XMIT files and avoids previous problems where
source code has been corrupted by EBCDIC-ASCII-EBCDIC translation issues.
All usermods (except the dynamic proclib and 3375/3380/3390 usermods) are not
ACCEPTed (i.e. not installed in the distribution libraries).
This provides the ability to RESTORE the usermods from the TK5 system if this is
desired. Restoration is necessary if a complete system generation (SYSGEN) is
requested.
SYS2.JCLLIB
In every MVS system there are housekeeping tasks that need to be performed to
keep the system running. These tasks include backing up and clearing the SMF and
EREP data sets, adding or deleting TSO UserIDs and running utilities. JCL is also
provided for many of the programs mentioned in the previous chapter.
Examples are validation jobs for the installed language processors, IBM utilities,
service aids and TSO batch utilities.
These jobs are collected in SYS2.JCLLIB and documented in member $$$INDEX.
The jobs marked with ‘NO RAKF’ are provided for information purposes only and
should not be run in the TK5 system unless RAKF has not been started. This is not
recommended.
The recommended way to use these jobs is to copy the JCL to your own data set
and then customize the JCL to your requirements. Any changes made to
SYS2.JCLLIB will be lost when a new TK5 update is installed as SYS2.JCLLIB will be
replaced by the TK5 update.
TK5.INSTALL.CNTL
This library is resident on TK5001 and contains the installation jobs for the
packages that have been installed on the TK5001 and TK5002 volumes.
These jobs are provided for information purposes only and do not need to be run
because these jobs have already been run during the creation of TK5 and updates
on TK5.