View source for SoftSpy installation guide

==Introduction==

<p >This page provides installation instructions for the
following products: </p>
<ul>
<li>SoftSpy for <var class="product">Model&#160;204</var>, Version 7, Release 5.0 or Release 4.0</li>
<li>MUSE for <var class="product">Model&#160;204</var>, Version 7, Release 5.0 or Release 4.0</li>
</ul>
Version 7 Release 5.0 of these products supports <var class="product">Model 204</var> Version 7 Release 5.0 and Model 204 Version 7 Release 4.0.<br />
Version 7 Release 4.0 of these products supports <var class="product">Model 204</var> Version 7 Release 4.0.

<p>SoftSpy provides debugging features to help you develop, test, and maintain User Language applications. Add-on features include interactive debugging, performance tuning, quality assurance testing, and error audit options.</p>

<p>MUSE is a multi-use facility based on the <var class="product">Model&#160;204</var> USE
command.</p>

<p>Installation of SoftSpy should be done by the organization responsible for the installation and maintenance of <var class="product">Model&#160;204</var>.  When performing the installation, you should have a copy of the Rocket <var class="product">Model&#160;204</var> Installation Guide for your operating system. You should review all relevant sections of these pages before proceeding with the installation.</p>

<p>When you have completed the installation instructions detailed in this document, SoftSpy and MUSE will be installed. To install SoftSpy and MUSE in additional ONLINE or BATCH204 jobs, refer to [[#Additional_Installations|Additional Installations.]]</p>

===Overview of Installation===

<p>SoftSpy consists of <var class="product">Model&#160;204</var> nucleus extensions and Model
204 User Language procedures.  The SoftSpy installation process installs the
User Language procedures, and it modifies your <var class="product">Model&#160;204</var> systems to make SoftSpy available for use.</p>

<p>This installation guide is organized into sections that provide instructions for each operating system, followed by sections that provide instructions common to all operating systems. </p>

<p>The operating-system-specific topics (z/OS, z/VM, or z/VSE) describe:</p>

<ul>
	<li>Prerequisite <var class="product">Model&#160;204</var> installation steps</li>
	<li>Allocation of SoftSpy files</li>
	<li>Required DD/DLBL/FILEDEF statements for SoftSpy files</li>
	</ul>

<p>Common installation sections are:</p>
<ul>
<ul><li>[[#Updating_CCAIN|Updating CCAIN]]</li>
<li>[[#Online_Installation_Steps Online|Installation Steps]]</li>
<li>[[#Verify_the_Installation|Verify the Installation]] </li></ul>
</ul>
<div></div>

===Downloading and installing SoftSpy version 7.4 files===
It is recommended that you install SoftSpy version 7.5, because it is more robust than 7.4. 

SoftSpy 7.5 is compatible with Model 204 versions 7.4 and 7.5. 

However, you can install SoftSpy version 7.4 if you are using Model 204 version 7.4. 
Moreover, if you are running Model 204 version 7.4 and have never installed SoftSpy before, you must install SoftSpy 7.4 files before upgrading to SoftSpy 7.5.

For details on how to download the SoftSpy version 7.4 files, see [[SoftSpy version 7.4 installation files]].

==Installation on IBM z/OS==

This section describes the SoftSpy installation steps that are specific to the IBM z/OS operating system.  

Complete the z/OS-specific part of the installation process before performing the installation steps in the following sections, which apply to all operating system environments:
<ul>
	<li>Update CCAIN</li>
	<li>Online Installation Steps</li>
	<li>Verify the Installation</li>
</ul>
===Prerequisite: Installing Model&#160;204===

<p >Before installing this version of SoftSpy, you must have completed these <var class="product">Model&#160;204</var> installation steps:</p>

<ul>
	<li>Install <var class="product">Model&#160;204</var> nucleus</li>
	<li>Install Dictionary/204</li></ul>

For details about Model 204 version 7.5, see [[Upgrading to Model 204 version 7.5 on IBM z/OS]].

For details about Model 204 version 7.4, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/d/de/M204_V7R4_zOS_Install.pdf Rocket Model 204 Installation Guide for IBM z/OS, version 7.4]</var>. 

<p class="Note"><b>Notes:</b> 
<ul><li>When you link-edit the Model 204 nucleus, ensure that the SSPY and MUSE text decks/CSECTs are linked in.</li>
<li>If you are running Model 204 version 7.4 and you have never installed SoftSpy before, you must [[SoftSpy version 7.4 installation files|install SoftSpy version 7.4]] before upgrading to SoftSpy version 7.5.</li>
</ul></p>

===Backing up data===

If you are upgrading from a previous version of SoftSpy, it is strongly recommended that you make a backup copy of your existing SPYPROC and SPYDATA files before proceeding. The upgrade process modifies these files, so a backup copy is required if you need to revert to the previous version.

===Downloading and installing SoftSpy files===

<p class="note"><b>Note:</b> For information on SoftSpy version 7.4 files, see [[#Downloading and installing SoftSpy version 7.4 files|Downloading and installing SoftSpy version 7.4 files]].</p>

To install the SoftSpy 7.5 files:
<ol>
<li>If you have not previously installed SoftSpy, modify and submit the SPYALOC JCL job. This job allocates the <var class="product">Model&#160;204</var> SoftSpy data sets SPYPROC, SPYDATA, and SPYTEMP. The following table shows space requirements for SPYPROC, SPYDATA, and SPYTEMP:
  <table>
   <tr>
    <td><b>Database Name</b></td>
    <td><b>Number of 6184-byte pages</b></td>
   </tr>
   <tr>
    <td>SPYPROC</td>
    <td>400</td>
   </tr>
   <tr>
    <td>SPYDATA</td>
    <td >150</td>
   </tr>
   <tr>
    <td>SPYTEMP</td>
    <td>112</td>
   </tr>
  </table>
</li>
<li>SPYPROC, the SoftSpy procedure file, is distributed in a dump format. Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>

===Installation next steps===
The steps in this section apply to both version 7.4 and version 7.5 of SoftSpy. 
<p>Once you have uploaded the files into the allocated data sets and converted them to z/OS standard format, continue the installation as follows.</p>
<ol>


<li>Modify the ONLINE startup JCL.
        <ul>
	<li>If you are installing SoftSpy for the first time, add DD statements for the SPYDUMP, SPYPROC, SPYDATA, and SPYTEMP data sets to your ONLINE startup JCL. 
<p>Following are samples of these statements:</p>
<p span class="code">//SPYDUMP DD DSN=SYSM.M204.V<i>rrr</i>.SPYPROC.DUMP,DISP=SHR
//SPYPROC DD DSN=SYSM.M204.V<i>rrr</i>.SPYPROC.M204,DISP=SHR
//SPYDATA DD DSN=SYSM.M204.SPYDATA.M204,DISP=SHR
//SPYTEMP DD DSN=SYSM.M204.SPYTEMP.M204,DISP=SHR</p>

where <var class="term">rrr</var> is the current release level, such as 750 or 740.</li>

For SoftSpy version 7.4, you will also need to add a DD statement for the ITSAUTH data set:
<p span class="code">//ITSAUTH DD DSN=SYSM.M204.ITSAUTH.M204,DISP=SHR</p>

       <li>If you are upgrading from a previous version of SoftSpy, you only need to add DD statements for SPYDUMP and SPYPROC.  The DD statements for SPYDATA, SPYTEMP, and ITSAUTH should already be present.</li>
       </ul>

<p class="note"><b>Notes:</b> The SPYDUMP DD is only necessary to perform the installation and can be removed afterward. <br />For 7.5, the ITSAUTH DD can be removed.</p></li>

<li>Make sure that the SYSOPT (system options) X'04' bit is off. This setting indicates that <var class="product">Model&#160;204</var> data definition commands can only be executed from within the File Management Facility of Dictionary/204. (This facility is not used to
create and format the SPYDATA and SPYTEMP files and their fields as documented in [[#Online_Installation_Steps|Online Installation Steps]].) Normal SoftSpy
operation is not affected by the SYSOPT X'04' bit setting.</li>

<li>Continue the installation as described in [[#Updating CCAIN|Updating CCAIN.]]</li>
</ol>

==Installation on IBM z/VM==

This section describes the SoftSpy installation steps that are specific to the z/VM operating system. 

Complete this part of the installation process before performing the installation steps in these sections, which apply to all operating system environments:
<ul>
<li>Updating CCAIN</li> 
<li>Online Installation Steps</li>
<li>Verify the Installation</li>
</ul>

===Prerequisite: Installing Model&#160;204===

<p >Before installing this version of SoftSpy, you must have completed these <var class="product">Model&#160;204</var> installation steps:</p>
<ul>
	<li>Install the <var class="product">Model&#160;204</var> nucleus. </li>
	<li>Install Dictionary/204.</li>
	</ul>

For details about Model 204 version 7.5, see the Model 204 z/VM installation instructions in [[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]].

For details about Model 204 version 7.4, see the <var class="book">[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvm_v74.pdf Rocket Model 204 Installation Guide for IBM z/VM, version 7.4]</var>

<p class="Note"><b>Notes:</b> 
<ul><li>When you link-edit the Model 204 nucleus, ensure that the SSPY and MUSE text decks/CSECTs are linked in.</li>
<li>If you are running Model 204 version 7.4 and you have never installed SoftSpy before, you must [[SoftSpy version 7.4 installation files|install SoftSpy version 7.4]] before upgrading to SoftSpy version 7.5.</li>
</ul></p>

===Backing up data===
If you are upgrading from a previous version of SoftSpy, it is strongly recommended that you make a backup copy of your existing SPYPROC and SPYDATA files before proceeding. The upgrade process modifies these files, so a backup copy is required if you need to revert to the previous version.
===Downloading the SoftSpy version 7.5 installation files===
<p class="note"><b>Note:</b> For information on version 7.4 files, see [[#Downloading and installing SoftSpy version 7.4 files|Downloading and installing SoftSpy version 7.4 files]].</p>
<p>To install the SoftSpy version 7.5 files:</p>
<ol>
<li>If you have not previously installed SoftSpy, modify and submit the SPYALOC JCL job. This job allocates the <var class="product">Model&#160;204</var> SoftSpy data sets SPYPROC, SPYDATA, and SPYTEMP.</li>
<li>SPYPROC, the SoftSpy procedure file, is distributed in a dump format. Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/VSE system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>

===Installation next steps===
The steps in this section apply to both version 7.4 and version 7.5 of SoftSpy.
  <ol>
     <li>Run M204GEN to generate modules and saved segments, as you did when installing the <var class="product">Model&#160;204</var> nucleus. For information, syntax, and rules for M204GEN, see the “M204GEN Command” section in the <var class="book">[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvm_v74.pdf Rocket Model 204 Installation Guide for IBM z/VM, version 7.4]</var>.</li>
     <li>Reapply all early warnings. For information, see the “Applying early warnings” section in the <var class="book">Rocket Model 204 Installation Guide for IBM z/VM, version 7.4</var>.</li>
     <li>If the SPYPROC, SPYTEMP, and SPYDATA database files will reside on an OS format disk, allocate them at this time.  If you are upgrading from a previous version of SoftSpy, you only need to allocate the SPYPROC database file.
         <ol style="list-style-type:lower-alpha">
	   <li>[[#SSPYFDEF EXEC|SSPYFDEF]] is an executable that defines SoftSpy database files. SSPYFDEF resides on the MAINT204 193 disk. Edit SSPYFDEF to conform to your disk naming and file placement conventions. The following table shows space requirements:</li>
  <table>
 <tr>
  <td><b>Database Name</b></td>
  <td><b>Number of 6184 byte pages</b></td>
  <td><b>Number of blocks on FBA devices</b></td>
 </tr>
 <tr>
  <td>SPYPROC</td>
  <td>400</td>
  <td>5000</td>
 </tr>
 <tr>
  <td>SPYDATA</td>
  <td>150</td>
  <td>2000</td>
 </tr>
 <tr>
  <td>SPYTEMP</td>
  <td>112</td>
  <td>1500</td>
 </tr>
</table>
     <li>To allocate SoftSpy files on OS format disks, type:
	<p class="code">EXEC SSPYFDEF ALOCSSPY</p></li>
     </ol>
   </li>
     <li><b>7.4 only:</b> If the ITSAUTH data set will reside on an OS format minidisk, allocate it at this time.
        <p>ITSAUTH is a sequential file that contains authorization data and must be allocated to any job that uses SoftSpy with a DD name of ITSAUTH.  ITSAUTH is 1 track in size and consists of fixed length 256 byte records.  If the ITSAUTH stream will be on a CMS mini-disk, it does not have to be preallocated. On an OS format minidisk, allocate 8 blocks on FBA devices.</p>
	</li>
     <li>Modify the ONLINE Startup EXEC. <b>Note:</b> ITSAUTH applies to version 7.4 only.
	<ul>
	  <li>If you are installing SoftSpy for the first time, add FILEDEFs for the SPYDUMP, SPYPROC, SPYDATA, SPYTEMP, and ITSAUTH data sets to your
ONLINE startup JCL.  Samples of these FILEDEFs are:
<p class="code">FILEDEF SPYPROC DISK SPYPROC DBV<i>rrr</i> <i>filemode</i>
FILEDEF SPYDUMP DISK SPYPROC DUMP *
FILEDEF SPYDATA DISK SPYDATA DATABASE <i>filemode</i>
FILEDEF SPYTEMP DISK SPYTEMP DATABASE <i>filemode</i>
FILEDEF ITSAUTH DISK ITSAUTH DATA <i>filemode</i></p>

<p >where <var class="term">rrr</var> is the current release level, such as 750 or 740.</p>

<p>If the SoftSpy files are on OS format disks, use FILEDEFs of the following format:</p>
<p class="code">FILEDEF SPYPROC <var class="term">filemode</var> DSN SPYPROC DBV<var class="term">rrr</var> M204
FILEDEF SPYDUMP DISK SPYPROC DUMP *
FILEDEF SPYDATA <var class="term">filemode</var> DSN SPYDATA M204
FILEDEF SPYTEMP <var class="term">filemode</var> DSN SPYTEMP M204
FILEDEF ITSAUTH <var class="term">filemode</var> DSN ITSAUTH DATA</p>
<p>where <var class="term">rrr</var> is the current release level, such as 750 or 740.</p>
</li>
<li>The installation process placed SPYDUMP on the MAINT204 200 disk. Use this dump of SPYPROC for the restore during the installation
process.</li>
<li>If you are upgrading from a previous version of SoftSpy, you only need to add FILEDEFs for SPYDUMP and SPYPROC.  The FILEDEFs for SPYDATA,
SPYTEMP, and ITSAUTH should already be present.</li>
</ul>
<p class="note"><b>Note:</b> The SPYDUMP FILEDEF is only necessary to perform the installation and can be removed afterward.</p>	
</li>
<li>Make sure that the SYSOPT (system options) X'04' bit is off.</li>
<p>This setting indicates that <var class="product">Model&#160;204</var> data definition commands can only be executed from within the File Management Facility of Dictionary/204. (This facility is not used to create and format the SPYDATA and SPYTEMP files and their fields as documented in [[#Online Installation Steps|Online Installation Steps]].) Normal SoftSpy operation is not affected by the SYSOPT X'04' bit setting.</p>
<li>Continue the installation as described in [[#Updating_CCAIN|Updating CCAIN.]]</li>
</ol>

==Installation on IBM z/VSE==

This section describes the SoftSpy installation steps that are specific to the z/VSE operating system. 

Complete this part of the installation process before performing the installation steps in the following sections, which apply to all operating system environments:
<ul><li>Updating CCAIN</li>
<li>Online Installation Steps</li>
<li>Verify the Installation</li></ul>

===Prerequisite: Installing Model&#160;204===

<p>Before installing this version of SoftSpy, you must have completed these <var class="product">Model&#160;204</var> installation steps:</p>
<ul>
<li>Install <var class="product">Model&#160;204</var> nucleus</li>
<li>Install Dictionary/204</li></ul>

For details about Model 204 version 7.5, see [[Upgrading to Model 204 version 7.5 on IBM z/VSE]].

For details about Model 204 version 7.4, refer to the <var class="book">[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</var>
<p class="Note"><b>Notes:</b> 
<ul><li>When you link-edit the Model 204 nucleus, ensure that the SSPY and MUSE text decks/CSECTs are linked in.</li>
<li>If you are running Model 204 version 7.4 and you have never installed SoftSpy before, you must [[SoftSpy version 7.4 installation files|install SoftSpy version 7.4]] before upgrading to SoftSpy version 7.5.</li>
</ul></p>

===Backing up data===
If you are upgrading from a previous version of SoftSpy, it is strongly recommended that you make a backup copy of your existing SPYPROC and SPYDATA files before proceeding. The upgrade process modifies these files, so a backup copy is required if you need to revert to the previous version.

===Installing SoftSpy===

<p>This section describes how to install SoftSpy version 7.5.</p>

<p class="note"><b>Note:</b> For information on SoftSpy version 7.4 files, see [[#Downloading and installing SoftSpy version 7.4 files|Downloading and installing SoftSpy version 7.4 files]].</p>

<ol>
<li>If you have not previously installed SoftSpy, modify and submit the SPYALOC JCL job. This job allocates the <var class="product">Model&#160;204</var> SoftSpy data sets SPYPROC, SPYDATA, and SPYTEMP.</li>
<li>SPYPROC, the SoftSpy procedure file, is distributed in a dump format. Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.<p>For detailed instructions, see [http://m204wiki.rocketsoftware.com/index.php?title=Web_help_download_SOUL_files#How_can_the_dump_file_be_uploaded_to_the_mainframe.3F Downloading and restoring SOUL files].</p></li>
<li>Use the information in SPYPROC to determine size requirements for the dump file.
<br>Rocket Software provides an optional sample batch job, FTPSSPY, to assist in this transfer. FTPSSPY, cataloged in the JCL library in step 4, defines the file names and data set names used in subsequent installation jobs. If you choose to use FTPSSPY, modify this job as noted in its comments and submit it.
<br><b>Note:</b> If you make changes to the names in FTPSSPY, you must use those names for all subsequent installation jobs; otherwise those jobs will fail.</li>
<li>Modify and submit LINKONLN and LINKB204 to relink your BATCH204 and ONLINE phases.</li>
<li>Complete the installation process as described in the following section.</li>
</ol>

===Installation next steps===
The steps in this section apply to both version 7.4 and version 7.5 of SoftSpy.
<ol>
<li>Allocate the SoftSpy databases and ITSAUTH data set. <b>Note:</b> ITSAUTH applies to version 7.4 only.
  <ul>
<li>If upgrading from a prior version of SoftSpy, execute the
SPYRINST job from the JCL library. This job will allocate the new SPYPROC
file.</li>
<li>
If performing a SoftSpy installation for the first time,
execute the SPYINST job from the JCL library.  This job will allocate SPYPROC,
SPYDATA, SPYTEMP, and ITSAUTH files.</li>
</ul>
<table>
<tr><th>Database Name</th><th>Number of 6184 byte pages</th><th>Number of blocks on FBA devices</th></tr>
<tr><td>SPYPROC</td><td>400</td><td>5000</td></tr>
<tr><td>SPYDATA</td><td>150</td><td>2000</td></tr>
<tr><td>SPYTEMP</td><td>112</td><td>1500</td></tr>
</table>
</li>
<li>Modify ONLINE Startup JCL.
<ul>
<li>If you are installing SoftSpy for the first time, add DLBL, EXTENT and ASSGN statements for the SPYDUMP, SPYPROC, SPYDATA, SPYTEMP, and ITSAUTH data sets to your ONLINE startup JCL. Following are samples of these statements:
<br>
<p class="code">// DLBL SPYPROC,'M204.SPYPROC',,DA
// EXTENT SYS021,volser
// ASSGN SYS021,DISK,VOL=volser,SHR
// DLBL SPYDATA,'M204.SPYDATA',,DA
// EXTENT SYS021,volser
// ASSGN SYS021,DISK,VOL=volser,SHR
// DLBL SPYTEMP,'M204.SPYTEMP',,DA
// EXTENT SYS021,volser
// ASSGN SYS021,DISK,VOL=volser,SHR
// DLBL SPYDUMP,'M204.SPYPROC.DUMP',,DA
// EXTENT SYS021,volser
// ASSGN SYS021,DISK,VOL=volser,SHR
// DLBL ITSAUTH,'M204.ITSAUTH',,SD
// EXTENT SYS021,volser
// ASSGN SYS021,DISK,VOL=volser,SHR
</p>
</li>
<li>If you are upgrading from a previous version of SoftSpy, then you only need to add DLBL, EXTENT and ASSGN statements for SPYDUMP and SPYPROC. 
The DLBL, EXTENT and ASSGN statements for SPYDATA, SPYTEMP, and ITSAUTH should already be present.</li>
<p class="note"><b>Note:</b> The SPYDUMP DD is only necessary to perform the installation and can be removed afterward.</p></ul>
<li>Make sure that the SYSOPT (system options) X'04' bit is off.
<br>
The SYSOPT X'04' bit setting indicates that Model 204 data definition commands can only be executed from within the File Management Facility of Dictionary/204. (This facility is not used to create and format the SPYDATA and SPYTEMP files and their fields as documented in [[#Online_Installation_Steps|Online Installation Steps]].) Normal SoftSpy operation is not affected by the SYSOPT X'04' bit setting.</li>
</ol>

==Updating CCAIN==

<p  >This section describes the changes required to the CCAIN
input stream to install and use SoftSpy. Depending on your situation, the
following changes might be needed, as described in this section:</p>
<ul>
<li>Adding IODEV=55 threads</li>
<li>Adjusting the NUSERS parameter</li>
<li>Ensuring that a large enough server is available</li>
<li>Adjusting the LENQTBL parameter</li>
<li>Adjusting the SPCORE parameter for SoftSpy operation</li>
<li>Adjusting the SPCORE parameter for MUSE operation</li>
</ul>
===Adding IODEV=55 threads===
<p  >Every concurrent end user SoftSpy session requires a
separate SoftSpy server thread. Each IODEV=55 statement that you add to the
CCAIN input stream will create a distinct SoftSpy server thread. The following
example illustrates the lines to be added to the CCAIN stream to create three
SoftSpy servers.</p>

<p class="code" ><nowiki>IODEV=55,AUTOSYS=C'',LIBUFF=255,LOBUFF=255,NORQS=5
IODEV=55,AUTOSYS=C'',LIBUFF=255,LOBUFF=255,NORQS=5
IODEV=55,AUTOSYS=C'',LIBUFF=255,LOBUFF=255,NORQS=5
</nowiki></p>
<p  >The settings shown for the AUTOSYS and NORQS parameter are
required for SoftSpy to work properly. The settings shown for LIBUFF and
LOBUFF are necessary to minimize SoftSpy server table usage.</p>

<p  >In order to use SoftSpy from a particular full screen
thread, the size of the output page buffer (LOUTPB) must match the size of the
output page buffer of an available SoftSpy server thread. If you use different
values for LOUTPB for different full screen threads, then you should create
SoftSpy servers for each distinct value of LOUTPB.</p>

===Adjusting the NUSERS parameter===

<p>The NUSERS parameter needs to be increased by the number of IODEV=55 threads you have added to run SoftSpy servers. An increase in the NUSERS parameter might require a change to the size of the server data set. See the <var class="book">Rocket Model 204 System Manager's Guide</var> for a complete discussion of server data sets.</p>

===Ensuring that a large enough server is available===
<p  >SoftSpy servers normally use a <var class="product">Model&#160;204</var> SERVSIZE of
280,000. However, there are cases where a larger server is required. This is
because certain server tables whose sizes cannot be reset by SoftSpy contribute
to overall server size requirements. If the sum of the size of RTBL, LOUTPB,
and LFTBL exceeds 8,000 then a larger server will be required. The server size
requirement is increased beyond 280,000 by the amount that the specified sum
exceeds 8,000. Make sure that at least one in-core server is large enough to
support this requirement.</p>

<p>Information about setting LOUTPB is contained in [[#Adding_IODEV.3D55_threads|Adding
IODEV=55 threads]]. SoftSpy automatically sets LFTBL
to NGROUP*4 for each of the IODEV=55 threads.  The size of RTBL depends on the
values of the NGROUP, NFILES, and NRMTFILE parameters.  The size of RTBL is
usually the most important influence on increased server size requirements.</p>

<p  >If the parallel query option of <var class="product">Model&#160;204</var> is being used then
the size of RTBL is:</p>

<p   style='text-indent:.5in'><span style='font-size:10.0pt;
line-height:115%;font-family:"Courier New"'>( NGROUP + 12 ) * ( NFILES +
NRMTFILE + 3 ) + NRMTFILE + 1 </span></p>

<p  >Otherwise, the size of RTBL is:</p>

<p   style='text-indent:.5in'><span style='font-size:10.0pt;
line-height:115%;font-family:"Courier New"'>( NGROUP + 12 ) * ( NFILES + 3 ) </span></p>

<p  >In either case, the size of RTBL is rounded up to the next
higher multiple of eight.</p>

<p  >In addition, two of the DBCS environments require an even
larger server size:
<ul>
	<li>
		DBCSENV=3 requires a 286,000-byte server</li>
		<li>
			DBCSENV=4 requires a 294,000-byte server</li></ul></p>

===Adjusting the LENQTBL parameter===

<p  >When SoftSpy servers are run, the LENQTBL parameter might need
to be increased. The size of the enqueue table is based on the product of
NUSERS and LENQTBL. When NUSERS is small, the value of LENQTBL might need to
be set to at least 500.</p>

===Adjusting the SPCORE parameter for SoftSpy operation===

<p  >The SPCORE parameter specifies the amount of storage to be
set aside above and below the 16Mb line for operating system and run-time
dynamic storage requests.  The value of this parameter might need to be
increased to accommodate the run-time requirements of SoftSpy.  The storage
required can be calculated with the formulas:</p>

[[File:SoftSpy_install_SPCORE_formula.jpg|250 px]]

<p  >where <i>n</i> is the number of threads running a SoftSpy
Server, and LOUTPB<i><sub>i</sub></i> is the size of the output page buffer for
the given server thread.</p>

<p  >The additional SPCORE requirement is <i>a</i>.  The value
derived for <i>b</i> represents the amount of storage that is allocated above
the 16M line and does not impact SPCORE.</p>

<p  >To maintain the number of disk buffers, an increase in MVS
region size, CMS virtual machine size, or VSE partition size might be
necessary.  If increasing the region size is not viable, you can reduce either the
number of disk buffers or the number of in-memory servers.</p>

===Adjusting the SPCORE parameter for MUSE operation===

<p  >When MUSE is in use, additional storage is required.  Although
SPCORE is not affected, region (or virtual machine) size could be impacted.</p>

<p  >The amount of storage needed for MUSE is computed by summing
the storage requirements of each simultaneous user of MUSE. For each user, the
amount of storage needed by MUSE is:</p>

<p   style='text-indent:.5in'><i><span style='font-size:10.0pt;
line-height:115%;font-family:"Courier New"'>muse_storage</span></i><span
style='font-size:10.0pt;line-height:115%;font-family:"Courier New"'> = <i>header_storage</i>
+ <i>max_muse_streams</i> * ( <i>header_storage</i> + 1088 )</span></p>

<p  >where</p>

<p   style='text-indent:.5in'><i><span style='font-size:10.0pt;
line-height:115%;font-family:"Courier New"'>header_storage</span></i><span
style='font-size:10.0pt;line-height:115%;font-family:"Courier New"'> = 110 + (
MAXHDR + MAXTRL ) * ( HTLEN + 5 )</span></p>

<p  >and <i>max_muse_streams</i> is the maximum number of MUSE
output streams (created by MUSE OPEN(C) or USE) that will be open at any given
time. For example, if</p>

<p   style='text-indent:.5in'><i><span style='font-size:10.0pt;
font-family:"Courier New"'>max_muse_streams</span></i><span style='font-size:
10.0pt;font-family:"Courier New"'> = 2</span></p>

<p   style='text-indent:.5in'><span style='font-size:10.0pt;
font-family:"Courier New"'>MAXHDR = MAXTRL = 5</span></p>

<p   style='text-indent:.5in'><span style='font-size:10.0pt;
font-family:"Courier New"'>HTLEN = 132</span></p>

<p  >then</p>

<p   style='text-indent:.5in'><i><span style='font-size:10.0pt;
font-family:"Courier New"'>header_storage</span></i><span style='font-size:
10.0pt;font-family:"Courier New"'> = 110 + ( 5 + 5 ) * ( 132 + 5 ) = 1480</span></p>

<p   style='text-indent:.5in'><i><span style='font-size:10.0pt;
font-family:"Courier New"'>muse_storage</span></i><span style='font-size:10.0pt;
font-family:"Courier New"'> = 1480 + 2 * ( 1480 + 1088 ) = 6616</span></p>

==Online Installation Steps==

This section describes SoftSpy installation steps that are
performed online from within <var class="product">Model&#160;204</var>. 

<b>Requirement:</b> These steps must be performed using a
<var class="product">Model&#160;204</var> ONLINE that includes the SPYDUMP, SPYPROC, SPYDATA, SPYTEMP, and ITSAUTH data sets described in the installation section for each operating system. 

<b>Prerequisite:</b> The CCAIN input stream for the ONLINE must have been updated as described in [[#Updating_CCAIN| Updating CCAIN]].

Perform the following steps, as described in this section:
<ol>
<li>Log on to <var class="product">Model&#160;204</var>.</li>
<li>Stop the SoftSpy subsystem.</li>
<li>Create and restore the SPYPROC file.</li>
<li>Run the INSTALL.SOFTSPY procedure.</li>
<li>Set passwords for the SPYPROC and SPYDATA files</li>
<li>Set the authorized product configuration.</li>
</ol>

===Logging on to Model&#160;204===

<p>Log on to <var class="product">Model&#160;204</var> using an account with system manager privileges.</p>

<p class="code">LOGON <i>accountname
password</i></p>

===Temporarily removing IODEV=55 threads===

<p>If SoftSpy has been previously installed, comment out the
IODEV=55 threads and reduce NUSERS by the number of threads that were commented
out.</p>

<p>Add these threads back in and change NUSERS accordingly
before attempting to run SOFTSPY.</p>

===Stopping the SoftSpy subsystem===

<p>If SoftSpy has been previously installed, all use of SoftSpy
must be terminated before you proceed.  To terminate SoftSpy, issue the Model
204 command:</p>

<p class="code">STOP SUBSYSTEM SOFTSPY</p>

===Creating and restoring the SPYPROC file===

<p>Create and restore the SPYPROC file using the commands
below:</p>

<p class="code">CREATE FILE SPYPROC
END
OPEN FILE SPYPROC
IN SPYPROC INITIALIZE
RESTORE 128 FROM SPYDUMP</p>

===Running the INSTALL.SOFTSPY procedure===
<p  >The creation of the SoftSpy subsystem and the formatting of SPYTEMP and SPYDATA is performed by the INSTALL.SOFTSPY procedure. </p>
<ol>
<li>To begin the process, enter the following commands:
<p class="code">OPEN SPYPROC
INCLUDE INSTALL.SOFTSPY</p>
This procedure will prompt you for the information it needs to create the subsystem and to initialize or upgrade the SPYDATA file.</li>
<li>
The following prompt appears:

<p class="code">$$Is SOFTSPY currently installed on this ONLINE (Y/N)?</p>
  <ul>
    <li>If SoftSpy has previously been installed, and you want to perform an upgrade style installation of the new version, respond Y. This will cause access control lists and macros from the previous version contained in the SPYDATA file to be preserved.
    </li>
    <li>Otherwise, respond N.
    </li>
  </ul>
</li>
<li>
If you are performing an upgrade style installation, the following prompt appears:
<p class="code">$$Enter READ password for SPYDATA:</p>

Enter a read password (one with at least X'8041' privdef privileges) for the SPYDATA file. If the SPYDATA file cannot be opened with read access using the specified password, the installation process will terminate with an error message.</li>

<li>The following prompt appears:
<p class="code">$$Enter READ/WRITE password for CCASYS:</p>

Enter a read/write password (one with at least X'00C1' privdef privileges) for the CCASYS file. This allows the procedure to perform all required subsystem management for the SoftSpy subsystem. If the CCASYS file cannot be opened with read/write access, the installation process will terminate with an error message.</li>

<li>If a subsystem with the name SOFTSPY is defined that is not the SoftSpy subsystem, the following prompt appears:
<p class="code">$$A subsystem named SOFTSPY already exists.  Replace (Y/N)?</p>
  <ul>
    <li>If you want to replace the existing SoftSpy subsystem with the new
SoftSpy subsystem, respond Y.</li>
    <li>If not, respond N.  A response of N will terminate the installation process.</li>
  </ul>
</li>
<li>The following prompt appears:
<p  class="code">$$Enter an Administrator User ID. Press &lt;ENTER&gt; when finished.</p>
Enter the <var class="product">Model&#160;204</var> account of anyone who is to be given <var class="product">Model&#160;204</var> ADMIN SCLASS privileges for the SoftSpy subsystem. Users added will supplement those added by previous installations of SoftSpy. The users in this SCLASS will be able to use the SoftSpy EDIT CONFIG command. Refer to the <var class="book">Rocket SoftSpy Reference Manual</var> for a discussion of EDIT CONFIG.

Subsequent changes to the list of users with ADMIN privileges for the subsystem must be made using the <var class="product">Model&#160;204</var>
Subsystem Management Facility. Refer to the <var class="book">Rocket Model 204 System Manager's Guide</var> for more information.
	
The user id will be checked for compliance with <var class="product">Model&#160;204</var> conventions but will not be validated for existence in the CCASTAT file. The User ID prompt will appear repeatedly until you respond by pressing the Enter key without entering a User ID. The Model 204 account of the user who is running this procedure is included in the list automatically.</li>
<li>If you are performing an upgrade style installation, you might receive the prompt: 
<p class="code">Macro <var class="term">macro_identifier</var> already exists.

1. Replace with NEW version.
2. Discard NEW version.
3. Rename NEW version.
4. Rename OLD version.

$$Please choose an option:</p>

<p>This prompt is issued when a SoftSpy macro being installed has the same name as an existing macro and the new macro is different from the
existing macro.
  <ul>
   <li>Enter 1 if you want the new version to replace the existing version.</li>
   <li>Enter 2 if you want to discard the new version.</li>
   <li>Enter 3 to save the new version under a different name.</li>
   <li>Enter 4 to rename the existing macro and save the new version with the name displayed.</li>
  </ul> 

An invalid response will cause the prompt to be redisplayed.

The following prompt appears:</p>
<p class="code">$$Please enter new name or press &lt;ENTER&gt; to accept: &quot;<var class="term">macro_identifier</var>_BAK&quot;</p>

If you select option 3 or 4, you will be prompted for a new name for the new or old version of the macro, respectively. You can respond
with any valid SoftSpy macro name or press ENTER to accept the suggested name <var class="term">macro_identifier</var>_BAK. If <var class="term">macro_identifier</var>_BAK exists, the suggested name will have additional _BAK strings appended to it until a unique name can be presented.
</li>
</ol>

===Set Passwords for the SPYPROC and SPYDATA Files===
<p>
The SPYPROC, SPYDATA, and SPYTEMP files are set to private at the end of the successful execution of the INSTALL.SOFTSPY procedure. A read password for the SPYDATA file will be required to install future upgrades to SoftSpy, and a procedure execution password for the SPYPROC file will be required if you need to reinitialize the SPYTEMP file. It is recommended that you assign passwords for these files. The <var class="product">Model&#160;204</var> <var>LOGCTL</var> command is used to add passwords to CCASTAT, as shown in the following example:</p>

<p class="code">LOGCTL A :SPYDATA
READ,X'8441'
&lt;ENTER&gt;
LOGCTL A :SPYPROC
EXECUTE,X'8021'
&lt;ENTER&gt;</p>

<p>
In the above example, the password <code>READ</code> is
assigned as the read password for the SPYDATA file, and the password
<code>EXECUTE</code> is assigned as the procedure execution password for the
SPYPROC file. The <code>&lt;ENTER&gt;</code> notation indicates that the command expects
further input, and the enter key is pressed to take the default. See [[LOGCTL command: Modifying file entries in the password table]] for a complete discussion of the <var>LOGCTL</var> syntax and parameters.</p>

===Set the Authorized Product Configuration===

<ol>
<li>Enter the following command to invoke the SoftSpy configuration editor:
<p class="code">SPY EDIT CONFIG</p>

<p>The editor displays a screen similar to the following figure.</p>

<p class="caption">EDIT CONFIG Definition Screen</p>

[[File:SoftSpy_EDIT_CONFIG1.JPG|450 px]]
</li>
<li><p>Press the FORWARD PF key (PF8) to display the authorization entry screen.</p> 
<p>This screen is used to authorize your use of SoftSpy.</p>

<p class="caption">EDIT CONFIG Authorization Entry Screen</p>
[[File:SoftSpy_EDIT_CONFIG2.JPG|450 px]]
</li>
<li>Update this screen with any new configuration information, expiration date, and authorization key provided with your installation materials. If your authorization key is for an expiration date that has passed, you must contact Technical Support to obtain a new authorization key. </li>
<li>Once you have made any required changes, press the SAVE PF key (PF6) to save the configuration. Saving the configuration information will write it out to the ITSAUTH file. It will also activate SoftSpy servers running in IODEV=55 threads.</li>
<li>Press the QUIT PF key (PF3) to exit the SoftSpy configuration editor. All authorized products should now be ready for use.</li>
</ol>

==Verify the Installation==

<p  >This section describes the process of verifying that SoftSpy
and MUSE are correctly installed and available for general use. </p>

===Verify SoftSpy operation===

<ol>
<li>
To test that SoftSpy server(s) are enabled issue the command:

<p class="code">SPY ON</p>

When SoftSpy has been successfully
turned on, the following message will be displayed prior to the <var class="product">Model&#160;204</var>
command prompt. (There will be a short delay prior to the message while the
SoftSpy User Language code precompiles.)

<p class="code">SPY ON
SPY.021: For the exclusive use of SoftSpy Trial
&gt;&nbsp;
</p>		
</li>
<li>Create an ad hoc procedure like the one shown below or include any
existing procedure that you have available.

<p class="code">BEGIN
FOR %I FROM 1 TO 5
    %J = %I * %I
    PRINT %I AND 'SQUARED IS' AND %J
END FOR
END</p>
</li>

The SoftSpy interactive evaluation screen will now be displayed on your terminal: 
<p class="caption">SoftSpy Interactive Evaluation Screen</p>
[[File:SoftSpy_Interactive_Evaluation_screen.jpg|450 px]]
<li>Type the command:
	<p class="code">WATCH %I, %J</p>
so that you can monitor the values of the percent variables as they change during evaluation.  Use PF4 to single step through the procedure or PF5 to run the procedure to its end.  You can also refer to the <var class="book">Rocket SoftSpy Reference Manual</var> to try some of the other features of SoftSpy.</li>
<li>At the completion of this test, turn off SoftSpy by issuing the command:
<p class="code">SPY OFF</p>

You can issue the SPY OFF command from
either the <var class="product">Model&#160;204</var> command prompt or from the command area just above the PF key labels on the SoftSpy screen.
</li></ol>

<p>If you experience any difficulties, contact [[Contacting_Rocket_Software_Technical_Support|Technical Support]].</p>

===Verify MUSE operation===

<p>You can run two simple tests to verify that MUSE is
available for use: </p>

<ol>
<li>To verify command-level MUSE, enter the following command at the Model
204 command prompt:
<p class="code">MUSE CLOSE *</p>
If no errors are issued, then command-level MUSE is active, and ready for use.</li>
<li>To verify statement-level MUSE, enter and run the following request:

<p class="code">BEGIN
MUSE CLOSE *
END</p>

If this simple request compiles and evaluates without errors, then statement-level MUSE is active and ready for use.</li>
</ol>
<p>If you experience any difficulties, contact [[Contacting_Rocket_Software_Technical_Support|Technical Support]].</p>

==Customizing SoftSpy==

<p >This section describes the process of customizing SoftSpy
for site-specific needs.</p>

===Customize the SoftSpy configuration===

<p>SoftSpy uses configuration information to determine the
access authority of end users during SoftSpy sessions. The configuration can
be modified only by those <var class="product">Model&#160;204</var> users whose user identifiers have been
included in the SoftSpy ADMIN SCLASS through subsystem management. The initial
installation process will prompt you for a list of those user identifiers and
perform the required subsystem management tasks. If you want to modify the
list of users who are authorized to perform configuration changes, you must use
<var class="product">Model&#160;204</var> Subsystem Management.</p>

<p>The SoftSpy configuration lets you limit end user access to
certain SoftSpy features. This is done by associating an Access Control List
(ACL) with a SoftSpy privilege through the EDIT CONFIG command. An ACL is a
list of <var class="product">Model&#160;204</var> users who are to be granted privileges. The following table
shows which privileges can be limited and the name of the ACL associated with
each at the completion of an initial installation.</p>

<table>
 <tr>
  <td><b>Privilege Name</b></td>
  <td><b>Associated ACL</b></td>
  <td><b>Meaning</b></td>
 </tr>
 <tr>
  <td>M204 Ad Hoc</td>
  <td>ADMIN</td>
  <td>User can issue M204 command from SoftSpy command line or user macro.</td>
 </tr>
 <tr>
  <td>M204 Macro</td>
  <td>null</td>
  <td>User can issue M204 command from system macros.</td>
 </tr>
 <tr>
  <td>Read ACL</td>
  <td>ADMIN</td>
  <td>User can read access control lists.</td>
 </tr>
 <tr>
  <td>Read MACRO</td>
  <td>null</td>
  <td>User can read system macros.</td>
 </tr>
 <tr>
  <td>SoftSpy Server</td>
  <td>ADMIN</td>
  <td>User can issue the SPY SERVER command.</td>
 </tr>
 <tr>
  <td>Spy ON</td>
  <td>null</td>
  <td>User can issue the SPY ON command.</td>
 </tr>
 <tr>
  <td>Update ACL</td>
  <td>ADMIN</td>
  <td>User can update access control lists.</td>
 </tr>
 <tr>
  <td>Update MACRO</td>
  <td>ADMIN</td>
  <td>User can update system macros.</td>
 </tr>
</table>
<p><var class="product">Model&#160;204</var> users who are in the ADMIN SCLASS can use the
SoftSpy EDIT CONFIG command to change the name of the ACL associated with any of the commands listed above. When an end user attempts to use the command, the newly associated ACL will be checked. A null ACL name indicates that all end users may use the command.</p>

<p>ACLs are constructed and maintained using the EDIT ACL
command. Initially, the only users who can perform this function are those
that were entered during the installation process. The ADMIN ACL is
constructed during an initial installation with the same user identifiers that
are put into the SoftSpy Subsystem ADMIN SCLASS.</p>
<h3>Customize SoftSpy Environments</h3>

<p>The <i>Rocket SoftSpy Reference Manual</i> provides
instructions for customizing SoftSpy environments to meet local needs. You can
change the following environments:</p>
<ul>
	<li>
	Base environment	</li>
	<li>Interactive Debug environment</li>
	<li>Interactive Performance Tuning environment</li>
	<li>Interactive Quality Assurance Testing environment</li>
	</ul>

<p>Each of these environments can be customized at two levels:
	<ul><li>For all users of SoftSpy, or,</li>
		<li>For individual users (by <var class="product">Model&#160;204</var> User ID).</li>
		</ul></p>

<p>You can customize items such as PFKEY settings and data
display columns.</p>

<p>The <var class="book">Rocket SoftSpy Reference Manual</var> also
describes how to make SoftSpy skip over the interactive execution of selected
subsystems that are used as tools (such as SSTEST).  You can customize SoftSpy to
skip over any number of selected subsystems.</p>

<p>Additionally, the <var class="book">Rocket SoftSpy Reference Manual</var>
provides a complete listing of the SoftSpy macros, which you can customize as
needed.</p>

==System Manager Considerations==
<p>SoftSpy uses background tasks called <var class="term">SoftSpy servers</var> that normally run in IODEV=55 threads to assist in program monitoring. When a User Language program is being executed under the control of SoftSpy, the program is
run in the user's normal server, and one of the server threads is used by SoftSpy to control and monitor the execution of the program. There must be one server thread for each simultaneous user of SoftSpy.</p>

===SoftSpy and the MONITOR Command===

<p>SoftSpy uses two wait type codes displayed by using the MONITOR command. The codes appear in the WT column that contains the wait type for a user.</p>

<p>The wait code values are: </p>
<table class="noBorder">
<tr>
<th>38</th> <td>Execution is suspended and the SoftSpy server is awaiting a request from a user.</td></tr>
<tr>
<th>39</th> <td>A user is suspended while a SoftSpy server is performing operations for the user.</td></tr>
</table>

<p>Both of these wait type codes are swappable but not bumpable.</p>

===SoftSpy files===

<p>SoftSpy uses four different files. The usage of each file
is summarized below.</p>

<table>
 <tr><th>File</th> <th>Description</th></tr>
 <tr>
  <td>SPYPROC</td>
  <td>This file contains procedures and help information used by SoftSpy. It is never updated, and it can be shared between several different online systems. If this file is corrupted it can be restored from the installation materials.</td>
 </tr>
 <tr>
  <td>SPYDATA</td>
  <td>This file contains various types of data that must be retained. This includes configuration information, Access Control Lists (ACLs) and copies of all SoftSpy macros. A base version of this file is created by the installation process, but the information in this file is modified when configuration, ACL, or macro changes are made. Periodic backups of this file should be made for recovery purposes. A separate instance of this file is required for each online system.</td>
 </tr>
 <tr>
  <td>SPYTEMP</td>
  <td>This file serves as a scratch pad for information during the execution of SoftSpy. Currently defined window descriptions, copies of macros being edited, and PF key settings are examples of the information saved in SPYTEMP. The CREATE.SPYTEMP procedure in SPYPROC can be used to recreate this file if necessary. A separate instance of this file is required for each online system.</td>
 </tr>
 <tr>
  <td>ITSAUTH</td>
  <td>This file contains authorization data. It is a simple sequential file containing 256 byte fixed length records. It is refreshed when the SoftSpy
  configuration is saved using the SPY EDIT CONFIG command. If SoftSpy will be used in multiple online and batch systems, ITSAUTH should be shared among them.</td>
 </tr>
</table>

==Additional Installations==
<p>This section discusses the procedures to follow when you
have already installed the current version of SoftSpy and MUSE successfully,
and you wish to install them again in different ONLINE or BATCH204 jobs. These
procedures are designed to speed up the process for a system manager who is
very familiar with SoftSpy and MUSE installation and wants to save time. However,
it is never a problem to perform the entire installation process again.</p>

===Install SoftSpy in additional ONLINE jobs===

<p>If you are installing SoftSpy in additional ONLINEs under the same operating system and <var class="product">Model&#160;204</var> release after an initial installation, you can use an abbreviated procedure.</p>

<p>The SPYPROC file is never updated and can be shared by multiple ONLINEs running SoftSpy. Therefore, you can omit the [[#Creating and restoring the SPYPROC file|Creating and restoring the SPYPROC file]] step on subsequent ONLINEs.</p>

<p>The DDs/DLBLs/ FILEDEFs for SPYPROC and ITSAUTH for each ONLINE can point to the same data set.</p>

<p>Each ONLINE must have its own SPYTEMP and SPYDATA files.</p>

<p>The INSTALL.SOFTSPY procedure must be run in each ONLINE to add the subsystem definition to CCASYS and to create and initialize SPYTEMP and SPYDATA.</p>

===Install MUSE in additional ONLINE and BATCH204 jobs===

<p>You might want to use MUSE in <var class="product">Model&#160;204</var> ONLINE or
BATCH204 jobs in addition to the job where SoftSpy was initially installed. 
For these additional job streams, add a DD/FILEDEF/DLBL for the previously
created ITSAUTH data set to the job stream.</p>

==CMS EXECs==
SSPYFDEF is an executable that defines SoftSpy database files. Edit SSPYFDEF to conform to your disk naming and file placement conventions. SSPYFDEF resides on the MAINT204 193 disk. See [[#Backing up data and installing SoftSpy|Backing up data and installing SoftSpy]] for space requirements.

===SSPYFDEF EXEC===
<p class="code"><nowiki>&CONTROL CMS
&ERROR &EXIT &RETCODE
*
*
* DEFINE THE SOFTSPY DATABASE FILES ACCORDING TO AN OPERAND
* PASSED ALONG WITH COMMAND
* UPDATE mode AND n CYL BEFORE RUNNING
*
    &IF /&1 EQ / &GOTO NOARG
    &IF &1 EQ ALOCSSPY &GOTO ALOCSSPY
    &IF &1 EQ CCASYS &GOTO CSYS
    &IF &1 EQ COMMON &GOTO COMMON
    &IF &1 EQ SPYPDMP &GOTO SPYPDMP
    &IF &1 EQ ITSAUTH &GOTO ITSAUTH
    &IF &1 EQ SPYDATA &GOTO SPYDATA
    &IF &1 EQ SPYPROC &GOTO SPYPROC
    &IF &1 EQ SPYTEMP &GOTO SPYTEMP
&EXIT

-NOARG
&BEGTYPE

THE SSPYFDEF COMMAND ARGUMENT WAS NOT RECOGNIZED

&END
&EXIT

-SPYPROC
    FILEDEF SPYPROC mode DSN M204 SPYPROC
&EXIT

-SPYDATA
    FILEDEF SPYDATA mode DSN M204 SPYDATA
&EXIT

-SPYTEMP
    FILEDEF SPYTEMP mode DSN M204 SPYTEMP
&EXIT

-ITSAUTH
    FILEDEF ITSAUTH mode DSN M204 ITSAUTH (BLOCK 2560 LRECL 256 RECFM FB
&EXIT

-ALOCSSPY
    M204UTIL ALLOC M204 SPYPROC mode (PRIMARY n CYL)
    M204UTIL ALLOC M204 SPYDATA mode (PRIMARY n CYL)
    M204UTIL ALLOC M204 SPYTEMP mode (PRIMARY n CYL)
    M204UTIL ALLOC M204 ITSAUTH mode (PRIMARY n CYL)
&EXIT

-CSYS
    FILEDEF CCASYS mode DSN M204 CCASYS
&EXIT

-COMMON
    FILEDEF CCAPRINT DISK SPYINST CCAPRINT A
    FILEDEF CCAAUDIT DISK SPYINST CCAAUDIT A
    FILEDEF CCASNAP DUMMY
    FILEDEF CCATEMP mode DSN M204 CCATEMP
    FILEDEF CCASTAT mode DSN M204 CCASTAT
&EXIT</nowiki></p>

==VSE JCL==
The following JCL files are used for SoftSpy installation on z/VSE systems:
<table class="noBorder">
<tr><th>SPYINST</th> <td>allocates SoftSpy system files</td></tr>
<tr><th>SPYRINST</th> <td>allocates SPYPROC and SPYDUMP files</td></tr>
</table>
In the JCL files below, the variable xxx has been substituted for the release number; for example:
<p class="syntax">// LIBDEF PROC,SEARCH=M204LIB.V<I>xxx</I></p>
Replace <var class="term">xxx</var> with 750 or 740, as applicable; for example:
<p class="syntax">// LIBDEF PROC,SEARCH=M204LIB.V740</p>
===SPYINST JCL===
<p class="code">// JOB SPYINST
 * ********************************************************************
 *                           Rocket Model 204
 *                                
 * ********************************************************************
 /* SPYINST allocates SoftSpy system files.
 /* Note that in the allocate step the DLBL and EXTENTs are
 /* stated explicitly for each SoftSpy system file, while in
 /* the create step the SoftSpy proc is used. The allocate
 /* step cannot have the direct access (DA) code present on
 /* the DLBL statements, and the create step (and the online
 /* job) must have the (DA) code present.
 /* *
 /* Make sure that the explicit DLBL and EXTENT statements in
 /* the allocate step match the proc in all aspects except
 /* the DA codes.
 /*
 /* ***************************************************************
 /* ***************************************************************
 /*
 /* Add assign statements as needed:
 /* *
 /* // ASSGN SYS000,X'CUU'
 /*
 /* The JCL as it is provided assumes you have made
 /* standard assignments for the logical units (SYS000)
 /* you reference in your EXTENT statements.
 /* *
 /* ***************************************************************
 /* To adapt this stream to your particular installation the
 /* following changes should be made:
 /*
 /* (1) Modify the job statement to conform to your standards.
 /*
 /* (2) Change the DLBL and EXTENT to reflect your dataset
 /* names and locations as in other MODEL 204 jobs.
 /* assign SYS008 to a printer for the audit trail, or
 /* add DLBL and EXTENT statements for ccaaudit.
 /*
 /* ***************************************************************
 /*
 /* ***************************************************************
 /* step alloc: MODEL204 allocate of all SoftSpy system files *
 /* ************************************************************** *
 /*
 // EXEC PROC=M204JCL      DLBL for JCL sublibrary
 // LIBDEF PROC,SEARCH=M204LIB.<var class="term">xxx</var>
 // EXEC PROC=M204V<var class="term">xxx</var>    DLBL for V<var class="term">xxx</var> M204 library
 // EXEC PROC=M204SYS    DLBLS FOR CCASTAT, CCATEMP
 // LIBDEF PHASE,SEARCH=M204LIB.V<var class="term">xxx</var>
 // DLBL SPYPROC,'M204.SPYPROC',99/366,SD
 // EXTENT SYS000,volser,,,0000,000 (AT LEAST 400 PAGES)
 // DLBL SPYDATA,'M204.SPYDATA',99/366,SD
 // EXTENT SYS000,volser,,,0000,000 (AT LEAST 150 PAGES)
 // DLBL SPYTEMP,'M204.SPYTEMP',99/366,SD
 // EXTENT SYS000,volser,,,0000,000 (AT LEAST 100 PAGES)
 // DLBL ITSAUTH,'M204.ITSAUTH',99/366,SD
 // EXTENT SYS000,volser,,,0000,000 (AT LEAST 7 PAGES)
 // ASSGN SYS000,DISK,VOL=volser,SHR
 // ASSGN SYS008,PRINTER
 // EXEC ALLOCATE,SIZE=AUTO
 ALLOCATE FILE(SPYPROC,SPYDATA,SPYTEMP,ITSAUTH)
 /*
 // EXEC PROC=M204JCL      DLBL for JCL sublibrary
 // LIBDEF PROC,SEARCH=M204LIB.V<var class="term">xxx</var>
 // EXEC LIBR
         ACCESS S=M204LIB.V<var class="term">xxx</var>
         CATALOG SFTSPY.PROC REPLACE=YES
 // DLBL SPYDUMP,'M204.SPYPROC.DUMP',,SD
 // EXTENT SYS000,volser
 // DLBL SPYPROC,'M204.SPYPROC',,DA
 // EXTENT SYS000,volser
 // DLBL SPYDATA,'M204.SPYDATA',,DA
 // EXTENT SYS000,volser
 // DLBL SPYTEMP,'M204.SPYTEMP',,DA
 // EXTENT SYS000,volser
 // DLBL ITSAUTH,'M204.ITSAUTH',,DA
 // EXTENT SYS000,volser
 /+
 /*
 /& </p>

===SPYRINST JCL===
<p class="code">// JOB SPYRINST
 * ********************************************************************
 *                           Rocket Model 204
 *                               
 * ********************************************************************
 /* SPYRINST allocates SPYPROC and SPYDUMP files.
 /* *
 /* Note that in the allocate step the DLBL and EXTENTs are
 /* stated explicitly for each SoftSpy system file, while in
 /* the create step the SoftSpy proc is used. The allocate
 /* step cannot have the direct access (DA) code present on
 /* the DLBL statements, and the create step (and the online
 /* job) must have the (DA) code present.
 /*
 /* Make sure that the explicit DLBL and EXTENT statements in
 /* the allocate step match the proc in all aspects except
 /* the DA codes.
 /*
 /* ***************************************************************
 /* ***************************************************************
 /* *
 /* Add assign statements as needed:
 /*
 /* // ASSGN SYS000,X'CUU'
 /*
 /* The jcl as it is provided assumes you have made
 /* standard assignments for the logical units (SYS000)
 /* you reference in your EXTENT statements.
 /*
 /* ***************************************************************
 /* To adapt this stream to your particular installation the
 /* following changes should be made:
 /*
 /* (1) Modify the job statement to conform to your standards.
 /*
 /* (2) Change the DLBL and EXTENT to reflect your dataset
 /* names and locations as in other MODEL 204 jobs.
 /* Assign SYS008 to a printer for the audit trail, or
 /* add DLBL and EXTENT statements for ccaaudit.
 /*
 /* ***************************************************************
 /*
 /* ***************************************************************
 /* step alloc: MODEL204 allocate of all SoftSpy system files
 /* ***************************************************************
 /*
 // EXEC PROC=M204JCL      DLBL for JCL sublibrary
 // LIBDEF PROC,SEARCH=M204LIB.V<var class="term">xxx</var>
 // EXEC PROC=M204V<var class="term">xxx</var>    DLBL for V<var class="term">xxx</var> M204 library
 // EXEC PROC=M204SYS    DLBLS FOR CCASTAT, CCATEMP
 // LIBDEF PHASE,SEARCH=M204LIB.V<var class="term">xxx</var>
 // DLBL SPYPROC,'M204.SPYPROC',exp date,SD
 // EXTENT SYS000,volser,,,0000,000 (AT LEAST 400 PAGES)
 // ASSGN SYS008,PRINTER
 // EXEC ALLOCATE,SIZE=AUTO
 ALLOCATE FILE(SPYPROC)
 /*
 // EXEC PROC=M204JCL      DLBL for JCL sublibrary
 // LIBDEF PROC,SEARCH=M204LIB.V<var class="term">xxx</var>
 // EXEC LIBR
         ACCESS S=M204LIB.V<var class="term">xxx</var>
         CATALOG SFTSPY.PROC REPLACE=YES
 // DLBL SPYDUMP,'M204.SPYPROC.DUMP',,SD
 // EXTENT SYS000,volser
 // DLBL SPYPROC,'M204.SPYPROC',,DA
 // EXTENT SYS000,volser
 // DLBL SPYDATA,'M204.SPYDATA',,DA
 // EXTENT SYS000,volser
 // DLBL SPYTEMP,'M204.SPYTEMP',,DA
 // EXTENT SYS000,volser
 // DLBL ITSAUTH,'M204.ITSAUTH',,DA
 // EXTENT SYS000,volser
 /+
 /*
 /&
</p>

[[Category:SoftSpy]]