SAS Hot Fix Analysis, Download and Deployment Tool
SASHFADD Ver 2.0
Usage Guide

What's New in SASHFADD 2.0?
  1. Introduction
  2. System Requirements
  3. Important information regarding tool usage
  4. Preparing to Run the Hot Fix Analysis, Download and Deployment Tool
  5. Download the Hot Fix Analysis, Download and Deployment Tool
  6. SASHFADD Configuration (SASHFADD.cfg)
  7. Run the Hot Fix Analysis, Download and Deployment Tool
  8. Review the Hot Fix Report
  9. Review and run the hot fix download script
  10. Run the SAS Deployment Manager (SAS 9.3 only)
  11. Review, move and run the hot fix install script (SAS 9.2 only)
  12. Verification
  13. Troubleshooting

  1. Introduction

    The SAS Hot Fix Analysis, Download and Deployment Tool (SASHFADD):


    NOTE: Hot fixes for SAS 9.3 are installed with the SAS Deployment Manager (SDM), thus eliminating the need for scripting. See Run the SAS Deployment Manager for information on using the SDM to deploy SAS 9.3 hot fixes

    WINDOWS and UNIX versions of SASHFADD are available. SASHFADD installed on a Windows or UNIX machine can be used to analyze SAS deployments for Windows, UNIX, z/OS and OpenVMS Itanium systems.

    Important message about file transfers:
    SASHFADD generates scripts which execute anonymous FTP commands to download data files and hot fixes from SAS. If your site does not allow FTP, there are publically available 3rd party utilities designed to transfer files via HTTP. The download scripts generated by SASHFADD can be converted for use by these utilities.

    If your site does not allow FTP or the use of a 3rd party utility, see Troubleshooting for instructions on manually downloading the hot fix data file required by SASHFADD. The Download links in the Hot Fix Analysis report generated by SASHFADD can be individually clicked to download the hot fixes.

    NOTE: Neither FTP nor any 3rd party file transfer utilities are supported by SAS Technical Support. For file transfer issues at your site, please contact your system administrator.

     

  2. System Requirements

    WINDOWS
    There are no special system requirements for Windows platforms
    UNIX
    SASHFADD requires Perl 5 on UNIX platforms.

    SASHFADD is not currently compatible with PERL for z/OS (OS390) on UNIX System Services (USS). For this reason, SAS Technical Support recommends that z/OS users run the WINDOWS version of SASHFADD.

     

  3. Important information regarding tool usage

    Carefully read this Usage Guide and review the Hot Fix Report generated by SASHFADD prior to using the generated scripts to download and deploy hot fixes. The Hot Fix Report contains critical information regarding hot fix dependencies that may affect your decision to use the download and deployment scripts as generated versus modifying them for your site-specific needs.

    Important note concerning "ALERT" issues: New for SASHFADD Ver 1.1 is the reporting of, and separate script generation for, hot fixes that address "ALERT" issues. This feature is provided to support customers who wish to apply hot fixes only for critical issues as determined by SAS Technical Support consultants.

    Hot fixes that address ALERT issues are identified in the Hot Fix report with [A]. Scripts designated "ALERT_ONLY" contain just hot fixes for ALERT issues. Scripts NOT specifically designated "ALERT_ONLY" contain ALL hot fixes which are eligible for download and installation via scripting, including hot fixes for "ALERT" issues.

     

  4. Preparing to run the Hot Fix Analysis, Download and Deployment Tool

    Run the ViewRegistry tool (See SAS Note 35968) to create a DeploymentRegistry.txt file containing the latest information regarding your SAS installation.

    SASHFADD run on WINDOWS or UNIX can analyze the DeploymentRegistry.txt file generated from a SAS installation on a different host operating system. For example, you can generate a DeploymentRegistry.txt for your SAS installation on z/OS or OpenVMS Itanium, then copy the DeploymentRegistry.txt into the directory on a WINDOWS or UNIX machine where SASHFADD is installed.

     

  5. Download the Hot Fix Analysis, Download and Deployment Tool

    WINDOWS
      1. Download SASHFADDwn.exe
      2. Choose "Run". This will launch the WinZip Self-Extractor to unzip the download.
      3. Click "Unzip" to extract the contents. The following steps assume you extracted the files to the default location "C:\Program Files\SAS\SASHFADD".
      4. Copy the DeploymentRegistry.txt file created in Step 4 to the C:\Program Files\SAS\SASHFADD directory.

      The C:\Program Files\SAS\SASHFADD directory should now contain the following files:

      • DeploymentRegistry.txt
      • SASHFADD.cfg
      • SASHFADD.exe
    UNIX
      1. Create a directory on your UNIX system where the SASHFADD will reside.
      2. Download SASHFADDux.tar to the directory you created and 'cd' to that directory.
      3. Untar SASHFADDux.tar using the command:
            tar -xvf SASHFADDux.tar
      4. Copy the DeploymentRegistry.txt file created in Step 4 to your current directory

      Your current directory should now contain the following files:

      • DeploymentRegistry.txt
      • SASHFADD.cfg
      • SASHFADD.pl
      • SASHFADDux.tar *
      * You may choose to delete "SASHFADDux.tar" since it is no longer needed.

     
  6. SASHFADD Configuration (SASHFADD.cfg)

    New in SASHFADD 2.0: The SASHFADD.cfg file can be used to:
    If you do not make any changes to SASHFADD.cfg, SASHFADD 2.0 will generate output comparable to the previous release of the tool (SAS92HFADD 1.1).

    Instructions for making configuration changes are included within the installed SASHFADD.cfg file, and can also be viewed in the Default SASHFADD.cfg. Confirmed SASHFADD configuration settings will appear at the bottom of the Hot Fix Report and in the SASHFADD Log file.

    ** Note about the SAS Release being analyzed: You are not required to specify in SASHFADD.cfg whether SASHFADD is analyzing a SAS 9.2 or a SAS 9.3 deployment. SASHFADD should be able to make that determination by looking for key products in DeploymentRegistry.txt. However, in the event of an unusual SAS deployment where that determination can not be made, you should "uncomment" either "-SAS 9.2" or "-SAS 9.3" to explicitly specify the release of SAS. If you accidentally uncomment both releases, SASHFADD will report a failure and will not proceed with the hot fix analysis.
     

  7. Run the Hot Fix Analysis, Download and Deployment Tool

    WINDOWS
    Double-click the SASHFADD.exe file to execute the tool.
    UNIX
    Execute the command: perl SASHFADD.pl
    Your system settings may require you to enter a fully qualified path to the PERL 5 executable. If PERL 5 is not installed on your system, you will need to either install it or use the Windows version of SASHFADD.

    If you did not select the "-SILENT" option in SASHFADD.cfg, you will be prompted to enter a descriptive name for the machine that contains the SAS deployment being analyzed. This name will be used for the creation of the output directory containing the SASHFADD report and scripts. Only alphanumeric characters and underscores '_' are allowed in the name. (Examples: "My_PC", "ALECs_pc", "server4321", "Test_Machine_5")

    During SASHFADD processing, scripts are generated and executed that download a required data file from the SAS Technical Support Hot Fix site. The file is download via FTP and will be either "SAS92_hot_fix_data.xml" or "SAS93_hot_fix_data.xml" depending on whether SASHFADD is analyzing a SAS 9.2 or a SAS 9.3 deployment. If you do not see either of these files in your current directory after running SASHFADD, refer to Troubleshooting for more information.

    SASHFADD will also create a new directory. If you entered a descriptive name when prompted by SASHFADD, the new directory will be called:

    If you ran SASHFADD with the "-SILENT" option, or you did not enter a name when prompted, the new directory will be called: The directory will contain the following subdirectories:
    • ANALYSIS_
    • DEPLOY_
    • DOWNLOAD_
    • LOG_
    * <name_you_entered>_<timestamp> is used so that a unique directory name is created each time SASHFADD is run. The timestamp is in DayMonthYear_Hour.Minute.Second format. For example, "My_PC_17Feb2011_13.24.33".
     
  8. Review the Hot Fix Report

    IMPORTANT!   Carefully review the SAS_Hot_Fix_Report documented in this section prior to downloading and deploying hot fixes!
    It is especially important that you carefully follow any pre/post installation instructions in Documentation designated by a [ D ] in the report

    The Hot Fix Report can be found in the ANALYSIS_ directory. The report lists the hot fixes that are available for your installed SAS products based on the DeploymentRegistry.txt file.

    The Hot Fix Report may contain up to three sections:

    • Hot fixes that may be downloaded and installed individually or by using the generated scripts
      This section will always appear in the Hot Fix Report and will list hot fixes that can be downloaded and installed individually, or by using the generated ftp_scripts (step 9), SAS Deployment Manager for SAS 9.3 (step 10) or install_scripts for SAS 9.2 (step 11).

      Successful installation of these hot fixes will be recorded in the deployment registry. If your system is up-to-date with these hot fixes, then an appropriate message will appear.

    • Hot fixes that are available only by clicking the Download link and following installation instructions
      This section may appear in the Hot Fix Report, and will list hot fixes which must be downloaded and installed individually by closely following the instructions in the documentation.

      Successful installation of these hot fixes may be recorded in the SAS Deployment Registry depending on the unique properties of the hot fix. It is possible that you will continue to see these hot fixes in the report even if they have been successfully installed. If you have already applied these hot fixes by following the installation instructions, then you can safely ignore their reappearance in the report.
       

    • Hot fixes containing updates only to non-English software components
      This section may appear in the Hot Fix Report and will list hot fixes which can be applied only to systems where the languages listed with the hot fix are installed for the specific SAS product.

      Successful installation of these hot fixes will be recorded in the SAS Deployment Registry. If you are ineligible to install these hot fixes because you have not installed the SAS product for the languages listed, then you can safely ignore the appearance of these hot fixes in the report.

      If you do not wish to see these hot fixes in the report, select "-ENGLISH_ONLY" in the SASHFADD.cfg.
       

    Each section of the report includes a list of available hot fixes and links to review Issue(s) Addressed, Documentation, and to Download the hot fix.
     


     
  9. Review and run a hot fix download script

    IMPORTANT (1):   In the following sections, files designated "_ALERT_ONLY" include just hot fixes that address ALERT issues as indicated by [A] on the Hot Fix Report. Files NOT designated _ALERT_ONLY include all hot fixes eligible for scripted download and silent installation, including hot fixes that address ALERT issues.

    IMPORTANT (2):  The instructions in the following sections assume that you have NOT selected in SASHFADD.cfg one specific type of scripting that you want SASHFADD to generate.

    WINDOWS

    In the DOWNLOAD_ directory, you will find the following files:

    ALERT_ONLY_README.txt *
    ftp_script.bat
    ftp_script_ALERT_ONLY.bat *
    ftp_script.txt
    ftp_script_ALERT_ONLY.txt *
    MD5_checksums.txt
    MD5_checksums_ALERT_ONLY.txt *
    * Files will appear only if there are hot fixes for "ALERT" issues.

    The ftp_script.txt and ftp_script_ALERT_ONLY.txt files can be modified as needed to exclude hot fixes from download or to change the transfer protocol as required by your site.

    If you are satisfied with the list of hot fixes to be downloaded based on the Hot Fix Report, double-click ftp_script.bat or ftp_script_ALERT_ONLY.bat to begin downloading the hot fixes. A window will appear showing the progress of the downloads.

    These .bat files MUST be run from within the DOWNLOAD_ directory.

    It may take several minutes to complete the download process.

    Hot fix download files will be placed in the DEPLOY_ directory.

    UNIX

    In the DOWNLOAD_ directory, you will find the following files:

    ALERT_ONLY_README.txt *
    ftp_script.sh
    ftp_script_ALERT_ONLY.sh *
    MD5_checksums.txt
    MD5_checksums_ALERT_ONLY.txt *
    * Files will appear only if there are hot fixes for "ALERT" issues.

    The ftp_script.sh and ftp_script_ALERT_ONLY.sh files can be modified as needed to exclude hot fixes from download or to change the transfer protocol as required by your site.

    If you are satisfied with the list of hot fixes to be downloaded based on the Hot Fix Report, then execute one of the following commands:
        ./ftp_script.sh
        ./ftp_script_ALERT_ONLY.sh

    These scripts MUST be run from within the DOWNLOAD_ directory.

    It may take several minutes to complete the download process.

    Hot fix download files will be placed in the DEPLOY_ directory.

    NOTE: The MD5_checksums files contain MD5 checksum values for each hot fix download available for your installed SAS products. This file can be useful should you wish to validate the integrity of the downloaded hot fix files. Tools used for performing MD5 validation are not available from SAS and are not supported by SAS Technical Support.
     

  10. Run the SAS Deployment Manager (SAS 9.3)

    This step is applicable for SAS 9.3 deployments only.

    In the DEPLOY_ directory, you will find the hot fixes downloaded by the download script.

    The SAS Deployment Manager (SDM) is used to apply SAS 9.3 hot fixes. Information on using the SDM is available in the
    SAS Deployment Wizard/SAS Deployment Manager 9.3: User’s Guide.
    http://support.sas.com/documentation/installcenter/en/ikdeploywizug/64204/PDF/default/user.pdf
    See the Apply Hot Fixes section in Chapter 5 -- SAS Deployment Manager Tasks

    By default, the SDM will search in the ' <SASHOME>/InstallMisc/HotFixes/New ' directory for hot fixes to be applied. To complete the installation of the hot fixes you may either:


    Since the SDM will NOT remove the hot fix downloads from the "New" directory after they have been applied, it may be a "best practice" to point the SDM to the "DEPLOY_" directory. If SASHFADD is not installed on the same machine as the SAS 9.3 deployment, you can copy the entire "DEPLOY_" directory to the machine where SAS 9.3 is installed before launching the SDM.
     
  11. Review, move and run the install script (SAS 9.2)

    This step is applicable for SAS 9.2 deployments only.
    This step is not applicable for SAS installations on z/OS.

    Before running the install script:

    In the DEPLOY_ directory, you will find the hot fixes downloaded by the download script, and for WINDOWS and UNIX systems, host-specific installation scripts that can be used to silently install all of the hot fixes.

    IMPORTANT!   In the following sections, files designated "_ALERT_ONLY" include just hot fixes that address ALERT issues as indicated by [A] on the Hot Fix Report. Files NOT designated _ALERT_ONLY include all hot fixes eligible for scripted download and silent installation, including hot fixes that address ALERT issues.

    SASHFADD run on WINDOWS or UNIX to analyze a WINDOWS SAS 9.2 deployment

    In the DEPLOY_ directory, you will find the following files:

    ALERT_ONLY_README.txt *
    install_script.bat
    install_script_ALERT_ONLY.bat *
    * Files will appear only if there are hot fixes for "ALERT" issues.

    To install the downloaded hot fixes "silently" on your Windows system:

    1. Move the entire "DEPLOY_" directory to the Windows system from where the DeploymentRegistry.txt file used in this process was generated.
    2. On the Windows system, double click either install_script.bat or install_script_ALERT_ONLY.bat *

      * If you chose to download the hot fixes using ftp_script_ALERT_ONLY.bat in step 9, then you should run install_script_ALERT_ONLY.bat.
    It may take several minutes to complete the installation process.

    NOTE: If you ran SASHFADD on a UNIX system to analyze a WINDOWS SAS deployment, you will need to use a 3rd party "unix2dos" utility to convert install_script.bat or install_script_ALERT_ONLY.bat to DOS format.

    SASHFADD run on WINDOWS or UNIX to analyze a UNIX SAS 9.2 deployment

    In the DEPLOY_ directory, you will find the following files:

    ALERT_ONLY_README.txt *
    install_script.sh
    install_script_ALERT_ONLY.sh *
    * Files will appear only if there are hot fixes for "ALERT" issues.

    To install the downloaded hot fixes "silently" on your UNIX system:

    1. Move the entire "DEPLOY_" directory to the UNIX system from where the DeploymentRegistry.txt file used in this process was generated.
    2. On the UNIX system, execute either install_script.sh or install_script_ALERT_ONLY.sh *, providing the SASHOME location from where the DeploymentRegistry.txt file used in this process was generated. For example:
      ./install_script.sh /installs/SAS92_M3
      * If you chose to download the hot fixes using ftp_script_ALERT_ONLY.sh in step 9, then you should execute install_script_ALERT_ONLY.sh.
    It may take several minutes to complete the installation process.

    NOTE: If you ran SASHFADD on a WINDOWS system to analyze a UNIX SAS deployment, you will need to make the script executable by adding "execute" permission. For example:

    chmod u+x install_script.sh
    SASHFADD run on UNIX or WINDOWS to analyze a z/OS SAS 9.2 deployment
    The installation script used to silently install all of the hot fixes is not available at this time for z/OS. However, you can still use the FTP download script to download hot fixes. Once downloaded, the hot fixes will need to be applied individually by following the instructions provided in the documentation links in the Hot Fix Report.
    SASHFADD run on UNIX or WINDOWS to analyze an OpenVMS Itanium SAS 9.2 deployment
    The installation script used to silently install all of the hot fixes is not available at this time for OpenVMS Itanium. However, you can still use the FTP download script to download hot fixes. Once downloaded, you can apply the hot fixes individually by following the instructions provided in the documentation links in the Hot Fix Report, or you can create a script to apply the hot fixes "silently" (without the GUI interface).

    To apply multiple hot fixes silently, create a script with symbols to sequentially run the hot fix executables in silent mode. For example, if you wish to install hot fixes B25118vi.exe and B25121vi.exe silently, the script could look like:

    $ hotfix == "$ $disk:[hfdir]B25118vi.exe"
    $ hotfix -silent
    $ hotfix == "$ $disk:[hfdir]B25121vi.exe"
    $ hotfix -silent

     

  12. Verification of hot fix installation

    To verify that all hot fixes have been installed:

    1. After installation of all hot fixes, rerun the deployment registry tool to create a new DeploymentRegistry.txt. (See Step 4)
    2. Copy the updated DeploymentRegistry.txt to the directory where SASHFADD is located.
    3. Run SASHFADD to create a new directory containing a new ANALYSIS_ subdirectory.
    4. Review the Hot Fix Report as outlined in Step 8 and, if necessary, compare the Hot Fix Report with the report generated in the previous execution of SASHFADD.

    New in SASHFADD 2.0: Reports listing all of the installed hot fixes that appear in DeploymentRegistry.txt are now generated by SASHFADD. These reports appear in the LOG_ directory and are in HTML and XML formats.

     

  13. Troubleshooting

    Each execution of SASHFADD creates a SASHFADD_LOG_ file in the "LOG_" subdirectory. The log traces the execution of SASHFADD and can be used to troubleshoot any problems with report, directory, or script generation.

    When the installation scripts are run for SAS 9.2, the logs pertaining to installation are MIT logs. If problems are encountered with installation of the hot fixes, please refer to the:
    Using the Maintenance Installation Tool to Install SAS® Hot Fixes - Usage and Troubleshooting Guide

    Common Problems and Solutions
     


      If you are unable to determine the cause of problems encountered with this tool, contact SAS Technical Support.

 

Contact Us | Sitemap | www.sas.com | Terms of Use & Legal Information | Privacy Statement
Copyright © 2011 SAS Institute Inc. All Rights Reserved.