Installation Instructions for Hot Fix B1Y004


Hot fix B1Y004 addresses the issue(s) in SAS Enterprise Case Management 6.3_M1 as documented in the Issue(s) Addressed section of the hot fix download page:

http://ftp.sas.com/techsup/download/hotfix/HF2/B1Y.html#B1Y004


B1Y004 is a "container" hot fix that contains the following "member" hot fixes which will update the software components as needed.

Y97006  updates  SAS Enterprise Case Management Mid-Tier 6.3_M1
B1X003  updates  SAS Enterprise Case Management Server 6.3_M1

See What is a container hot fix? in the Hot Fix FAQ for more information about container hot fixes.


Before applying this hot fix, follow the instructions in SAS Note 35968 to generate a SAS Deployment Registry report, then verify that the appropriate product releases are installed on your system. The release number information in the Registry report should match the 'member' release number information provided above for the software components installed on each machine in your deployment.

The hot fix downloaded, B1Y004pt.zip, includes the updates required for all components listed above on all applicable operating systems. To apply this hot fix on multiple machines, you can either save B1Y004pt.zip on each machine or save it in a network location that is accessible to all machines.

Do NOT extract the contents of B1Y004pt.zip. The hot fix installation process will extract the contents as needed.


IMPORTANT NOTES

  1. Files delivered in this hot fix will be backed up during the installation process. However, it is good general practice to back up your system before applying updates to software.

  2. You must have Administrator Privileges on your CLIENT or SERVER machine.

  3. All currently active SAS sessions, daemons, spawners and servers must be terminated before applying this hot fix.

  4. This hot fix should be installed using the same userid who performed the initial software installation.

  5. CONFIGURATION: No automatic configuration scripting is included for this hot fix. If you have previously configured software installed, the SAS Deployment Manager may present a screen where you will see "Apply SAS Hot Fixes" and "Configure SAS Hot Fixes" options. On this screen, you must ensure that the "Configure SAS Hot Fix" option is *not* selected. If this option is automatically selected, please de-select it prior to proceeding with the SAS Deployment Manager Screens. Failure to do so could have unintended consequences when applying this hot fix.


INSTALLATION

Hot Fix B1Y004 must be installed on each machine where the updated components of the product, listed above, are installed. During the installation process you may see references to all operating systems for which updates are provided in the hot fix. The installation process will determine the operating system and which component(s) of SAS Enterprise Case Management 6.3_M1 require updating on the machine. See SAS Note 44810 for more details.

The hot fix will be applied using the SAS Deployment Manager. By default, the SAS Deployment Manager will search in the <SASHOME>/InstallMisc/HotFixes/New directory for hot fixes to be applied, but will also prompt for a location if you have downloaded hot fixes to a different directory.

After downloading B1Y004pt.zip, follow the instructions for applying hot fixes in the SAS Deployment Wizard and SAS Deployment Manager 9.4: User's Guide.

Please review the CONFIGURATION Important Note above concerning proper selection of the "Configure SAS Hot Fix" option in the SAS Deployment Manager.


The hot fix installation process generates the log file

<!SASHOME>/InstallMisc/InstallLogs/IT_date-and-time-stamp.log
for example, IT_2011-10-31-13.18.21.log. Each attempt to apply a hot fix results in the creation of a new log file giving detailed information regarding the installation process.

Postexec log files are created after the installation is completed and identifies the files that were added, backed up, changed and removed. These log files include the ‘member’ hot fix id in the name of the file and are also written to the <!SASHOME>/InstallMisc/InstallLogs directory. There is one postexec log for each ‘member’ hot fix applied (member hot fixes are listed at the top of these instructions).


The content of this hot fix is listed in the hot fix manifest.


POST-INSTALLATION INSTRUCTIONS

For each product installed, click the link to be redirected to post-installation instructions.

Y97006  updates  SAS Enterprise Case Management Mid-Tier 6.3_M1
B1X003  updates  SAS Enterprise Case Management Server 6.3_M1


Y97006  updates  SAS Enterprise Case Management Mid-Tier 6.3_M1

IMPORTANT NOTE: If you have previously installed the B1Y001 hot fix container and executed the steps below related to Solr, please proceed to the "Re-build Web Application" section below.

Update Solr deployment to add solr.PingRequestHandler

This hot fix updates the sample solrconfig.xml file found in <SASHome>/SASEnterpriseCaseManagementMidTier/6.3/deploy/sample/Solr/scripts/prepareSolr/EntCaseMgmtCollection/. This solrconfig.xml file is normally copied to the Solr installation via the “Installing Global Search” steps in the ECM Admin Guide (Chapter 4 Post-installation Requirements and Tasks).

If you have already followed the “Installing Global Search” steps, you will need to manually update the solrconfig.xml file in your Solr installation to add the same changes to it that the hot fix made to the sample. If you followed the suggested Solr installation location in the Admin Guide, the directory where you must make changes to the solrconfig.xml file will be:

Windows: \solr-4.7.2\ecm\solr\EntCaseMgmtCollection\conf
Linux: /usr/local/solr-4.7.2/ecm/solr/EntCaseMgmtCollection/conf
Follow the manual steps below:
  1. Update the solrconfig.xml file in your Solr installation. The exact steps you need to follow depend on whether you have made any customizations to solrconfig.xml in your Solr installation.

    1. If you have not made any changes to solrconfig.xml after following the “Installing Global Search” steps: Copy the updated solrconfig.xml from the <SASHome>/SASEnterpriseCaseManagementMidTier/6.3/deploy/sample/Solr/scripts/prepareSolr/EntCaseMgmtCollection/ directory to the ecm/solr/EntCaseMgmtCollection/conf directory of the Solr installation.

    2. If you made custom changes to the solrconfig.xml file after following the “Installing Global Search” steps:

      Edit solrconfig.xml in the ecm/solr/EntCaseMgmtCollection/conf directory of the Solr installation to add the solr.PingRequestHandler:

      <!-- ping/healthcheck --> <requestHandler name="/admin/ping" class="solr.PingRequestHandler"> <lst name="invariants"> <str name="q">solrpingquery</str> </lst> <lst name="defaults"> <str name="echoParams">all</str> </lst> <!-- An optional feature of the PingRequestHandler is to configure the handler with a "healthcheckFile" which can be used to enable/disable the PingRequestHandler. relative paths are resolved against the data dir --> <!-- <str name="healthcheckFile">server-enabled.txt</str> --> </requestHandler>

      This can appear anywhere in the file between the <config> and </config> tags, as long as it is not embedded in any other tag or comment. The suggested place to put it is with the other “admin” request handlers. While the exact line numbers in your customized solrconfig.xml may be different from the line numbers below, the following is provided to help you locate the suggested location for the new lines. In the original solrconfig.xml file delivered with ECM 6.3_M1, there is a <requestHandler> tag with the name “/admin/” starting at line 937:

      <requestHandler name="/admin/" class="solr.admin.AdminHandlers"/>

      This is followed by several lines of comments, which end at line 959:

      <!-- <requestHandler name="/admin/file" class="solr.admin.ShowFileRequestHandler" > <lst name="invariants"> <str name="hidden">synonyms.txt</str> <str name="hidden">anotherfile.txt</str> </lst> </requestHandler> -->

      Add the new solr.PingRequestHandler XML stanza (above) after these comment lines, at line 961 in the original file.

    3. Follow the Admin Guide steps to restart Solr.

Re-build Web Application

In order for this step to execute correctly, the Metadata Server must be running.

1. Invoke the SAS Deployment Manager 9.4

From the SASDeploymentManager directory launch sasdm.sh.
SAS Deployment Manager is installed in the following default location:

<SASHOME>/SASDeploymentManager/9.4

2. Select a language in the Choose Language box

3. Select Rebuild Web Applications

4. Select Configuration Directory or Enter the Configuration Directory and Level that needs to be updated

5. Specify Connection Information, including the sasadm User ID and Password

6. Select SAS Enterprise Case Management Mid-Tier 6.3 as the Web Application to Rebuild

7. Verify the information on the Summary screen and select Start

8. Select Finish when the deployment is complete

This process will update the SAS Enterprise Case Management Mid-Tier 6.3 ear in

<SASCONFIGDIR>/Web/Staging
A backup of the original ear file will be placed in the directory
<SASCONFIGDIR>/Web/Staging/Backup

9. Exit the SAS Deployment Manager 9.4


Re-deploy Web Application

1. Restart all SAS sessions, daemons, spawners and servers.

2. Invoke the SAS Deployment Manager 9.4

From the SASDeploymentManager directory launch sasdm.sh.
SAS Deployment Manager is installed in the following default location:

<SASHOME>/SASDeploymentManager/9.4

3. Select a language in the Choose Language box

4. Select Deploy Web Applications

5. Select Configuration Directory or Enter the Configuration Directory and Level that needs to be updated

6. Specify Connection Information, including the sasadm User ID and Password

7. Check the Allow the application server to stop checkbox

8. Select SAS Enterprise Case Management Mid-Tier 6.3 as the Web Application to Deploy

9. Verify the information on the Summary screen and select Start

10. Select Finish and exit the SAS Deployment Manager when the deployment is complete

11 Please follow the instructions at the following link to clear your browser cache

http://java.com/en/download/help/webcache.xml

Additional Manual post-installation steps

This hot fix contains fixes that require additional manual post-installation steps. Please see the following SAS Note for instructions.

SAS Note 60609
If you have SAS Compliance Solutions 6.3_M1 installed, after you have installed this hot fix, you should also install the following:
SAS Compliance Solutions 6.3_M1 hot fix A1I003


B1X003  updates  SAS Enterprise Case Management Server 6.3_M1

This hot fix provides new version of form template for regulatory report preview. After you apply the hot fix, perform the steps below:

  1. Locate the new versions of the form_template in the following path:
    • <SASHOME>\SASFoundation\9.4\casemgmtmva\sasmisc\sample\form_template (Windows)
    • <SASHOME>/SASFoundation/9.4/misc/casemgmtmva/sample/form_template (Unix)
  2. Copy all the files located in step 1 to the following location ( where X indicates your Lev number, eg Lev1):
    <SASConfig>/LevX/Applications/SASEnterpriseCaseManagement/Source/form_template

The following instructions update SAS Enterprise Case Management Configuration Directory programs and stored processes related to the new FinCEN CTR for XML (CTRX) reports. If your installation is not filing CTR reports, these post-installation steps are not necessary.

  1. Backup all files under the SAS Enterprise Case Management Configuration Directory Source location.

      An example of the Source location:
      /sas/config/Lev1/Applications/SASEnterpriseCaseManagement/Source

  2. Copy new ucmacros to Configuration Directory.
    Using the example <SASROOT> to reference /sas/SASHome/SASFoundation/9.4 and refers to /sas/config/Lev1/Applications/SASEnterpriseCaseManagement, copy 2 site specific files to Source directory.
    a. Two files to copy:
       i. ecm_global_mvar.sas.orig
       ii. ecmrr_efile_fincen_trnsmttr_var.sas.orig
    b. Windows: Copy files from <SASROOT>\casemgmtmva\ucmacros\ to <ECMConfig>\Source\ucmacros
    Unix: Copy files from <SASROOT>/ucmacros/casemgmtmva to <ECMConfig>/Source/ucmacros

    c. Re-apply customizations to new copied macros in <ECMConfig/Source/ucmacros>: If changes have been made to ecm_global_mvar.sas and ecmrr_efile_fincen_trnsmttr_var.sas, these will need to be reapplied.
    i. Copy ecm_global_mvar.sas to ecm_global_mvar.sas.old
    ii. Rename ecm_global_mvar.sas.orig to ecm_global_mvar.sas
    iii. Apply changes from ecm_global_mvar.sas.old to ecm_global_mvar.sas
    iv. Copy ecmrr_efile_fincen_trnsmttr_var.sas to ecmrr_efile_fincen_trnsmttr_var.sas.old
    v. Rename ecmrr_efile_fincen_trnsmttr_var.sas.orig to ecmrr_efile_fincen_trnsmttr_var.sas
    vi. Apply changes from ecmrr_efile_fincen_trnsmttr_var.sas.old to ecmrr_efile_fincen_trnsmttr_var.sas

    List of files that have been added/modified in <SASRoot>:
    - *_ctrx*
    - ecmrr_efile_fincen_sdtm.sas
    - ecmrr_efile_fincen_trnsmttr_var.sas.orig
    - ecm_global_mvar.sas.orig
    - ecmrr_efile_xml_seqnum.sas
    - ecmrr_fincen_new_sas_format.sas
    - ecmrr_pivot_fincen_data.sas
    - ecmrr_prvw_fincen_webout.sas
    - ecmrr_resp_fincen_report.sas
    - ecmrr_resp_fincen_sdtm.sas
    - ecmrr_resp_fincen_update.sas
    - ecmrr_validate_driver.sas - ecmrr_validate_xml.sas
    Note: If copies of the above list of added/modified files exist in <ECMConfig>/Source/ucmacros directory, the copy in the <ECMConfig> directory should be removed (or renamed).

  3. Copy new form template files to Configuration Directory.

    Using the example <SASROOT> to reference /sas/SASHome/SASFoundation/9.4 and <ECMConfig> refers to /sas/config/Lev1/Applications/SASEnterpriseCaseManagement, copy new or modified files/directories to form_template directory.
    Windows: Copy files in <SASROOT>\casemgmtmva\sasmisc\sample\form_template to <ECMConfig>\Source\form_template. Instead of copying all the files, the new and modified files that must be copied are listed below.
    Unix: Copy files in <SASROOT>/misc/casemgmtmva/sample/form_template to <ECMConfig>/Source/form_template. Instead of copying all the files, the new and modified files that must be copied are listed below.
    Files/Directories that have been added/modified that must be copied from <SASROOT>:
    - ctrx*
    - rr_udf_def_ctrx.csv
    - schema directory
    - state_code_list_us_territories.csv
    - xmlvalidator.jar

  4. Configure CTR for XML (CTRX) using SAS.
    a. Start a BASE SAS Session.
    b. Open and Submit <ECMConfig>/Source/control/ecm_autoexec.sas program.
    c. Execute %ecm_db_connect; to ensure access to ECM database (ECM_DB libref).
    d. Execute the program
    <SASROOT>/casemgmtmva/sasmisc/sample/config/loadrr_config_fincen_ctrx.sas (Windows) or
    <SASROOT>/misc/casemgmtmva/sample/config/loadrr_config_fincen_ctrx.sas (Unix)

    Note: If will be using SASStudio or Enterprise Guide to execute the SAS program, make sure to enable the option “Allow XCMD” for the Workspace Server. The program requires the ability to execute system commands to create directories.
    e. Save the log file for reference.
    This will create fincen-ctrx-v1 subdirectory under the following locations:
    - <ECMConfig>/Source/efiles
    - <ECMConfig>/Source/efiles_responses
    - <ECMConfig>/Source/FINCEN_SDTM_efiles
    - <ECMConfig>/Source/FINCEN_SDTM_efiles_responses
    Ensure the SAS General Servers Account (sassrv) has WRITE capability to these 4 new directories.

  5. Upload CTR for XML UI Definition using ECM web application.
    a. Login to ECM web application as administrator. Run Clear Cache under the Administration tab.
    b. From Administration tab, Select UI Definitions and click on the “Upload UI definition” icon and select the following UI definition file:
    i. <somedir>/SASHome/SASEnterpriseCaseManagementMidTier/6.3/deploy/sample/UIDefiniti ons/rr-fincen-ctrx-01.xml (Windows)
    ii. <somedir>/SASHome/SASEnterpriseCaseManagementMidTier/6.3/deploy/sample/UIDefiniti ons/rr-fincen-ctrx-01.xml (Unix)

  6. Configure XML validator.
    The “Validation for e-file” process will include a new Stored Process that will utilize new macros and XML Schema files that have been copied to the <ECMConfig>/Source/ucmacros directory. To import the new Stored Process:
    a. Using SAS Management Console, log on as administrative user. b. Click on the Folders tab, expand: /System/Applications/SAS Enterprise Case Management/Ent Case Mgmt Server 6.3
    c. Right-click on Application SAS Code, and Select Import SAS Package
    d. For the Enter the Location of input SAS Package, Click Browse
    e. Select the file:
       <SASROOT>/>casemgmtmva/sasmisc/Config/Deployment/Packages/ECMvalidateStoredProcess.spk (Windows)or
       <SASROOT>/misc/casemgmtmva/Config/Deployment/Packages/ECMvalidateStoredProcess.spk (Unix) and click OK.
    f. Follow the Import SAS Package Wizard Prompts:
       i. Select objects to import: All Objects should be selected
       ii. STP ecmrr_validate target folder should be the default for ECM
       iii. Under Metadata Connections, select SASApp and the STP Source repository folder
       iv. Select Next after reviewing the Summary page
       v. Review the Import log for any errors
    g. Copy <SASROOT>/sasstp/casemgmtmva/ecmrr_validate.sas.orig to <ECMConfig>/Source/sasstp/eecmr_validate.sas
    h. Edit ecmrr_validate.sas and update the %inc location for the correct pathname to ecm_autoexec.sas program w hich is in <ECMConfig>/Source/control.
    i. The XML validation will utilize the Java 1.7 JRE that is shipped with SAS in the <SASROOT> location. If another Java 1.7 or 1.8 is needed, that can be provided in the <ECMConfig/Source/ucmacros/ecmrr_validate_driver.sas macro. In the invocation of %ecmrr_validate_xml macro, add an additional parameter:
       i. java_loc=/bin/java
    Note: If a modification to the ecmrr_validate_driver.sas macro is required, a copy should be made in the <ECMConfig>/Source/ucmacros directory instead of the <SASROOT> location.
    j. The XML Validator will utilize a Stored Process and the ability to run system commands. To ensure the functionality, the “Allow XCMD” option should be enabled for the SAS Stored Process Server.

  7. (Optional) Enable SDTM.
    a. Navigate to <ECMConfig>/Source/ucmacros
    b. edit ecm_global_mvar.sas macro
    c. For the following line, set the boolean to Y:
       i. %let ecm_sdtm_YN_ctrx=Y;
    Now, it will generate the XML in <ECMConfig>/Source/FINCEN_SDTM_efiles/fincen-ctrx-v1 following the naming convention for the FINCEN requirement.

This completes the installation of hot fix B1Y004.


Copyright 2018 SAS Institute Inc. All Rights Reserved.