Downloading and restoring SOUL files: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Document the process of restoring DISTDUMP to DISTPROC and copying procs from DISTPROC to M204PROC)
m (add category)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==What is UL/SPF?==                                                                                                                 
This page provides help for downloading SOUL files.  
<i>UL/SPF</i> is a family of tools that enhance programmer-productivity and                                                         
enable performance monitoring, sophisticated journal querying and other                                                             
programmer, DBA and system administrator                                                                                           
activities inside a Model 204 online.  <i>UL/SPF</i> is implemented as a                                                           
set of <i>APSYs</i>, written in <i>User Language</i>.  <i>UL/SPF</i> must                                                           
be installed in each online where its features are needed.  Installation                                                           
requires Rocket M204 SOUL code, some files                                                                                         
that must be allocated locally, and the creation of the necessary APSYs.                                                           
The source code for all <i>UL/SPF</i> subsystems is in the <i>SIRIUS</i> procedure file,                                           
which must be physically allocated to the online for the installation process.                                                     
The <i>Sirius Mods</i> must also be installed in the target online prior to                                                         
the installation of <i>UL/SPF</i>.                                                                                                 
                                                                                                                                   
==How do I get the UL/SPF installation file?==                                                                                     
SOUL code for the <i>UL/SPF</i> product is distributed in the form of a dump of the                                                 
<i>SIRIUS</i> file from the Rocket M204 support site.                                                                               
On most browsers a fly-out menu will provide options to                                                                             
<i>Save Link As...</i> or <i>Save Target As...</i> or something similar.                                                           
After selecting a target directory, the file will download in <strong>binary</strong>                                               
format.                                                                                                                             
                                                                                                                                   
Alternatively, the <b>left</b> mouse button can be clicked on                                                                       
the link for a dump file. This will usually result in the browser                                                                   
prompting the user whether the file should be saved, where it                                                                       
should be saved and under what name.                                                                                               
                                                                                                                                   
Download times depend on the speed of your connection.                                                                             
                                                                                                                                   
Aternatively, the dump file can be e-mailed as an attachment by clicking                                                           
on the <i>e-mail</i> link above.  The attached <strong>binary</strong> should                                                       
be saved to a local file and then uploaded to the mainframe exactly as                                                             
if it had been downloaded directly.  E-mail delivery can be useful if your                                                         
firewall disallows web downloads.                                                                                                   
                                                                                                                                   
==How can the dump file be uploaded to the mainframe?==                                                                             
The <i>Sirius</i> dump file must then be uploaded to your MVS, VM or                                                               
VSE system on your mainframe.                                                                                                       
Any file transfer mechanism can be used including FTP and IND$FILE,                                                                 
but regardless of the transfer mechanism some rules must be observed.                                                               
                                                                                                                                   
First, the dump files contain binary data, and so <b>must</b>                                                                       
be transferred as binary. That is, no translation from ASCII to                                                                     
EBCDIC must occur as a result of the upload.                                                                                       
                                                                                                                                   
Second, the format and LRECL of the file must be specified during                                                                   
the upload. This is because most workstation systems (including                                                                     
Windows, Mac OS and Unix) do not have a concept of file formats                                                                     
and LRECL's.  The format of the uploaded file must be <i>F</i> and                                                                 
the <i>LRECL</i> must be 6184.  Under MVS and VSE the blocksize must be 6184.                                                       
                                                                                                                                   
When using FTP, the characteristics (RECFM, LRECL and BLOCKSIZE) of                                                                 
the uploaded file can be set with the <i>SITE</i> and <i>LOCSITE</i>                                                               
FTP commands. The SITE command should be used if the FTP client                                                                     
is on the workstation and the server is on the mainframe. In this case                                                             
the SITE command might have to be sent as a "quote" to the mainframe.                                                               
How this is done, depends on your workstation's FTP client.                                                                         
The LOCSITE command should be used if the FTP client is on the                                                                     
mainframe and the server is on the workstation.                                                                                     
                                                                                                                                   
==How can the uploaded files be installed on the mainframe?==                                                                       
Once uploaded to your mainframe, use the standard <i>Model 204</i> RESTORE                                                         
command to restore the dump file to a Model 204 file with a DDNAME of SIRIUS.                                                       
                                                                                                                                   
'''''File Size:''''' The ''SIRIUS'' file must be allocated with at least                                                           
4200 <i>Model 204</i> pages.                                                                                                       
                                                                                                                                   
The rest of the installation process for the Sirius Software User                                                                   
Language products is described in the [[UL/SPF installation guide |             
UL/SPF Installation and Maintenance Guide]], including ancilliary files that must be allocated.


==Applying Maintenance==                                                                                                           
To access the files to download, go to the Rocket website [http://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, and click the "Download SOUL files" link to bring up the "SOUL files for Rocket Software" page.
The uploaded files will contain all the latest maintenance.                                                                         
As such, no maintenance need be applied to the uploaded file.                                                                      
Subsequent fixes can be applied by downloading User Language                                                                       
fixes, loading them into the SIRFIXES file and applying them                                                                       
to the appropriate Model 204 file with SIRFIX. Most sites find it easier                                                           
to return to this page and re-download a new copy of the <strong>SIRIUS</strong>                                                   
file, as the downloadable copy always has the latest maintenance applied.


==DISTPROC and M204PROC==
==Changes for RKTools version 7.7==
DISTPROC contains all of the subsystem procedures for the standard Rocket subsystems - SUBSYSMGMT, FILEMGMT, DICTIONARY, DOCUMENT, DICTADMIN, DICTREPORT, XREF and others. DISTPROC is downloaded, in binary, from the Rocket-M204 web site as a dump file, uploaded to your z/OS system and then used to RESTORE the DISTPROC file.  Upload the DISTPROC dump file into a z/OS dataset (DSN=your.V750.DISTPROC.DUMP.M204) which you have previously allocated with LRECL=6184,BLKSIZE=6184,RECFM=FB,SPACE=(6184,2000) then run the following job:
As of [[RKTools]] version 7.7 (mid-2017), all code for all Rocket-provided, SOUL-based products resides in the <code>M204PROC</code> file. This includes all the Dictionary/204 components (Subsysmgmt, Filemgmt, etc.), all the SQL support code, and all code for the former [[UL/SPF]] products like SirPro, SirMon and SirScan.
===DDPRCLOD job===
 
  //DDPRCLOD EXEC PGM=BATCH204,REGION=0M,PARM='SYSOPT=176'                                               
As of RKTools 7.7, the files <code>SIRIUS</code>, <code>TSFPROC</code>, <code>CATPROC</code>, and <code>DICDIST</code> are no longer needed. There is no harm in leaving them online, but all supported code for V7.7 and higher is in <code>M204PROC</code>.
   //STEPLIB DD DISP=SHR,DSN=your.V750.LOADLIB                       
 
  //CCASTAT DD DISP=SHR,DSN=your.CCASTAT                       
Older versions of the former UL/SPF products are still available on the download page in the <code>SIRIUS</code> file, but any site running Model&nbsp;204 V7.6 or higher should use the version in <code>M204PROC</code>.
  //CCAPRINT DD SYSOUT=A                                                 
 
  //CCAAUDIT DD SYSOUT=A                                                 
Because <code>M204PROC</code> holds considerably more code, it probably requires resizing: A minimum of 75 3390 cylinders is required (the equivalent of 9000 Model&nbsp;204 pages).
  //CCASNAP DD SYSOUT=A                                                 
 
  //SYSUDUMP DD SYSOUT=A                                                 
<p class="note"><b>Note:</b> Many sites are accustomed to simply downloading a new <code>SIRIUS</code> file and installing it over the top of their old one in order to get updated code. But for the latest RKTools version <strong>a full installation must be performed at least once</strong>, because there are some new files, and because the application subsystem definitions need to be changed to point to the new procedure file. </p>
  //M204PROC DD DISP=SHR,DSN=your.M204PROC.M204                 
 
  //DISTPROC DD DISP=(NEW,CATLG,DELETE),DSN=your.V750.DISTPROC.M204,
==What is RKTools?==                                               
  //         DD SPACE=(6184,2000),UNIT=3390,VOL=SER=yourvol
Formerly known as UL/SPF, RKTools is a family of tools that enhance programmer-productivity and 
  //DISTDUMP DD DISP=SHR,DSN=your.V750.DISTPROC.DUMP.M204
enable performance monitoring, sophisticated journal querying and other 
  //CCAIN    DD *                                                       
programmer, DBA and system administrator               
  LITBL=3000,LFSCB=7000,NFILES=10,LSTBL=10000,TEMPPAGE=1000               
activities inside a Model 204 onlineRKTools is implemented as a  
  LOGON SUPERKLUGE                                                       
set of application subsystems (APSYs), written in [[SOUL]]. RKTools must
  PIGFLOUR                                                               
be installed in each Online where its features are needed. Installation 
  CREATE FILE DISTPROC                                                   
requires Rocket M204 SOUL code, some files
  PARAMETER BSIZE=1,CSIZE=1,DSIZE=1                                     
that must be allocated locally, and the creation of the necessary APSYs.
  END                                                                   
 
  OPEN DISTPROC                                                         
As of Mid-2017, the file labeled "Model 204 V7.7" is the most up-to-date version. It is designed for use in Model&nbsp;204 V7.7 but is backward compatible to V7.6.
  RESTORE 192 FROM DISTDUMP                                             
 
  OPEN DISTPROC                                                         
==How do I get the RKTools installation file?==  
  pw                                                                     
SOUL code for the RKTools product is distributed in the form of a dump of the <code>M204PROC</code> file from the Rocket M204 support site.
  OPEN M204PROC                                                          
On most browsers a fly-out menu will provide options to    
  pw                                                 
<i>Save Link As...</i> or <i>Save Target As...</i> or something similar.  
  IN FILE DISTPROC COPY PROC ALL TO FILE M204PROC OLDDATE REPLACE       
After selecting a target directory, the file will download in <strong>binary</strong> format.  
  IN M204PROC DISPLAY LIST                                             
 
  CLOSE ALL                                                             
Alternatively, the <b>left</b> mouse button can be clicked on   
  LOGOUT                                                                 
the link for a dump file. This will usually result in the browser  
  EOJ                                                                   
prompting the user whether the file should be saved, where it       
  //                                                                    
should be saved and under what name. Download times depend on the speed of your connection.            
  /*  End of DDPRCLOD *******
 
Aternatively, the dump file can be e-mailed as an attachment by clicking
on the <i>e-mail</i> link above.  The attached <strong>binary</strong> should be saved to a local file and then uploaded to the mainframe exactly as if it had been downloaded directly. E-mail delivery can be useful if your firewall disallows web downloads.
 
==How can the dump file be uploaded to the mainframe?==
The <code>M204PROC</code> dump file must then be uploaded to your MVS, VM, or VSE system on your mainframe.  
Any file transfer mechanism can be used including FTP and IND$FILE, 
but regardless of the transfer mechanism some rules must be observed.                            
                           
First, the dump files contain binary data, and so <b>must</b>         
be transferred as binary. That is, no translation from ASCII to
EBCDIC must occur as a result of the upload.
   
Second, the format and LRECL of the file must be specified during 
the upload. This is because most workstation systems (including
Windows, Mac OS, and Unix) do not have a concept of file formats
and LRECLs.  The format of the uploaded file must be <code>F</code> and
the <code>LRECL</code> must be 6184.  Under MVS and VSE the blocksize must be 6184.
 
When using FTP, the characteristics (RECFM, LRECL, and BLOCKSIZE) of
the uploaded file can be set with the <code>SITE</code> and <code>LOCSITE</code> 
FTP commands. The SITE command should be used if the FTP client
is on the workstation and the server is on the mainframe. In this case
the SITE command might have to be sent as a "quote" to the mainframe.    
How this is done, depends on your workstation's FTP client.  
 
The LOCSITE command should be used if the FTP client is on the 
mainframe and the server is on the workstation.  
   
==How can the uploaded files be installed on the mainframe?==  
Once the dump file is uploaded to your mainframe, use the standard <var class="product">Model&nbsp;204</var> <var>[[RESTORE command|RESTORE]]</var> command to restore the dump file to a Model&nbsp;204 file with a DDNAME of M204PROC
 
'''''File Size:''''' The <code>M204PROC</code> file must be allocated with at least 9000 <var class="product">Model 204</var> pages.
 
The rest of the installation process is described on the [[RKTools installation]] page, including ancillary files that must be allocated.
 
==Applying maintenance==   
To refresh your copy of any Rocket SOUL code, re-downloading and installing a new copy of the <strong>M204PROC</strong> file is all that is needed. The Download page shows the date/time the file was last updated, and an "info" link next to the file lets you view a list of all changes applied to that file (by project identifier). Rocket Support can verify which project(s) provide the updates you are looking for if the help text doesn't provide enough detail.
 
[[Category: RKTools]]

Latest revision as of 20:07, 20 April 2018

This page provides help for downloading SOUL files.

To access the files to download, go to the Rocket website Rocket M204 Customer Care page, and click the "Download SOUL files" link to bring up the "SOUL files for Rocket Software" page.

Changes for RKTools version 7.7

As of RKTools version 7.7 (mid-2017), all code for all Rocket-provided, SOUL-based products resides in the M204PROC file. This includes all the Dictionary/204 components (Subsysmgmt, Filemgmt, etc.), all the SQL support code, and all code for the former UL/SPF products like SirPro, SirMon and SirScan.

As of RKTools 7.7, the files SIRIUS, TSFPROC, CATPROC, and DICDIST are no longer needed. There is no harm in leaving them online, but all supported code for V7.7 and higher is in M204PROC.

Older versions of the former UL/SPF products are still available on the download page in the SIRIUS file, but any site running Model 204 V7.6 or higher should use the version in M204PROC.

Because M204PROC holds considerably more code, it probably requires resizing: A minimum of 75 3390 cylinders is required (the equivalent of 9000 Model 204 pages).

Note: Many sites are accustomed to simply downloading a new SIRIUS file and installing it over the top of their old one in order to get updated code. But for the latest RKTools version a full installation must be performed at least once, because there are some new files, and because the application subsystem definitions need to be changed to point to the new procedure file.

What is RKTools?

Formerly known as UL/SPF, RKTools is a family of tools that enhance programmer-productivity and enable performance monitoring, sophisticated journal querying and other programmer, DBA and system administrator activities inside a Model 204 online. RKTools is implemented as a set of application subsystems (APSYs), written in SOUL. RKTools must be installed in each Online where its features are needed. Installation requires Rocket M204 SOUL code, some files that must be allocated locally, and the creation of the necessary APSYs.

As of Mid-2017, the file labeled "Model 204 V7.7" is the most up-to-date version. It is designed for use in Model 204 V7.7 but is backward compatible to V7.6.

How do I get the RKTools installation file?

SOUL code for the RKTools product is distributed in the form of a dump of the M204PROC file from the Rocket M204 support site. On most browsers a fly-out menu will provide options to Save Link As... or Save Target As... or something similar. After selecting a target directory, the file will download in binary format.

Alternatively, the left mouse button can be clicked on the link for a dump file. This will usually result in the browser prompting the user whether the file should be saved, where it should be saved and under what name. Download times depend on the speed of your connection.

Aternatively, the dump file can be e-mailed as an attachment by clicking on the e-mail link above. The attached binary should be saved to a local file and then uploaded to the mainframe exactly as if it had been downloaded directly. E-mail delivery can be useful if your firewall disallows web downloads.

How can the dump file be uploaded to the mainframe?

The M204PROC dump file must then be uploaded to your MVS, VM, or VSE system on your mainframe. Any file transfer mechanism can be used including FTP and IND$FILE, but regardless of the transfer mechanism some rules must be observed.

First, the dump files contain binary data, and so must be transferred as binary. That is, no translation from ASCII to EBCDIC must occur as a result of the upload.

Second, the format and LRECL of the file must be specified during the upload. This is because most workstation systems (including Windows, Mac OS, and Unix) do not have a concept of file formats and LRECLs. The format of the uploaded file must be F and the LRECL must be 6184. Under MVS and VSE the blocksize must be 6184.

When using FTP, the characteristics (RECFM, LRECL, and BLOCKSIZE) of the uploaded file can be set with the SITE and LOCSITE FTP commands. The SITE command should be used if the FTP client is on the workstation and the server is on the mainframe. In this case the SITE command might have to be sent as a "quote" to the mainframe. How this is done, depends on your workstation's FTP client.

The LOCSITE command should be used if the FTP client is on the mainframe and the server is on the workstation.

How can the uploaded files be installed on the mainframe?

Once the dump file is uploaded to your mainframe, use the standard Model 204 RESTORE command to restore the dump file to a Model 204 file with a DDNAME of M204PROC.

File Size: The M204PROC file must be allocated with at least 9000 Model 204 pages.

The rest of the installation process is described on the RKTools installation page, including ancillary files that must be allocated.

Applying maintenance

To refresh your copy of any Rocket SOUL code, re-downloading and installing a new copy of the M204PROC file is all that is needed. The Download page shows the date/time the file was last updated, and an "info" link next to the file lets you view a list of all changes applied to that file (by project identifier). Rocket Support can verify which project(s) provide the updates you are looking for if the help text doesn't provide enough detail.