Installation Instructions for Hot Fix I21002

Windows


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

http://ftp.sas.com/techsup/download/hotfix/HF2/I21.html#I21002


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

I20002  updates  SAS Enterprise Case Management Mid-Tier 3.1
I19002  updates  SAS Enterprise Case Management Server 3.1

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, I21002pt.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 I21002pt.zip on each machine or save it in a network location that is accessible to all machines.

Do NOT extract the contents of I21002pt.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.


INSTALLATION

Hot Fix I21002 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 3.1 require updating on the machine. See SAS Note 44810 for more details.

The hot fix will be applied using the SAS Deployment Manager (SDM). By default, the SDM 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 I21002pt.zip, follow the instructions for applying hot fixes in the SAS Deployment Wizard and SAS Deployment Manager 9.3: User’s Guide.


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.

I20001  updates  SAS Enterprise Case Management Mid-Tier 3.1
I19001  updates  SAS Enterprise Case Management Server 3.1


I20001  updates  SAS Enterprise Case Management Mid-Tier 3.1

Step 1: Re-build Web Application

To complete the installation of this hotfix, you must rebuild and redeploy the Enterprise Case Management web application. If you are installing this hotfix along with others, you may need to rebuild several web applications. In order to re-build SAS web applications correctly, the Metadata Server must be running but to simplify the post-installation process you may want to verify that all the standard SAS services are started at this time. If these services are not started, you can start them in the following order:

  1. SAS Metadata Server
  2. SAS OLAP Server
  3. SAS Object Spawner
  4. SAS Share Server (if present)
  5. SAS CONNECT Spawner
  6. SAS Remote Services
  7. SAS Framework Data Server

1.1 Invoke the SAS Deployment Manager 9.3

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

<SASHOME>/SASDeploymentManager/9.3

1.2 Select a language in the Choose Language box

1.3 Select Rebuild Web Applications

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

1.5 Specify Connection Information, including the sasadm User ID and Password

1.6 Select Ent Case Mgmt Mid-Tier 3.1 as the Web Application to Rebuild

1.7 Verify the information on the Summary screen and select Start

1.8 Select Finish when the deployment is complete

This process will update the Enterprise Case Management Mid-Tier 3.1 ear in <SASCONFIGDIR>/Web/Staging.
A backup of the original ear file will be placed in: <SASCONFIGDIR>/Web/Staging/Backup

Step 2: Re-deploy Web Applications

2.1 Re-deploy the sas.solutions.casemgmt.ear web application based on the instructions for the web application server you are using. If your SAS web application servers are not running, start them in the following order:

  1. SASServer1
  2. SASServer2
  3. SASServer8

2.2 Clear your browser cache on all browsers that you use to access SAS Enterprise Case Management.

I19001 Updating SAS Enterprise Case Management Server 3.1


A. Configuring FINCEN SAR Reports

The following instructions update ECM configuration data and stored processes related to the new FinCEN SAR reports. If your installation is not filing SAR reports, these post-installation steps are not necessary. If your installation is already configured for SAR reporting from the previous hotfix, Only step A.7 is necessary.

A.1.       Back up of all files under <ECMconfig>directory.

An example of <ECMconfig> is '/sasinstall/Config/Lev1/Applications/SASCaseManagementServerCfg/3.1'.

A.2.       Customize ".orig" files and copy form_template directory

Copy the files listed in the table below from the source location to the target location. Remove the extension .orig from the target file names. Then edit the target files according to the instructions in the 'Edit' column.

An example of <sashome> and <ECMconfig> are '/sasinstall/SASFoundation/9.3' and '/sasinstall/Config/Lev1/Applications/SASCaseManagementServerCfg/3.1'.

Source File

Target File

Edit

<sashome>/ucmacros/casemgmtmva/ecm_global_mvar.sas.orig (for Unix)

<sashome>/casemgmtmva/ucmacros/ecm_global_mvar.sas.orig (for Windows)

<ECMconfig>/Source/ucmacros/ecm_global_mvar.sas

Specify ecm_webusername, ecm_webuserpass if you want to hard-code the account used to run PROC SOAP and PROC HTTP.

 

Review the other parameters. In particular, if the server tier is a Windows environment notice that the path for winzip is required. Winzip is required to properly generate the SAR efile.

<sashome>/ucmacros/casemgmtmva/ecmrr_efile_fincen_trnsmttr_var.sas.orig (for Unix)

<sashome>/casemgmtmva/ucmacros/ecmrr_efile_fincen_trnsmttr_var.sas.orig (for Windows)

<ECMconfig>/Source/ucmacros/ecmrr_efile_fincen_trnsmttr_var.sas

Provide institutional transmitter information, required by FINCEN, for the SAR reports.

<sashome>/sasstp/casemgmtmva/ecmrr_efile.sas.orig (for Unix)

<sashome>/casemgmtmva/sasstp/ecmrr_efile.sas.orig (for Windows)

<ECMconfig>/Source/sasstp/ecmrr_efile.sas (overwrite existing file)

Replace "@casemgmtmvac.config.control.dir@" with the path of ecm_autoexec.sas

<sashome/sassstp/casemgmtmva/ecmrr_efile_data_loader.sas.orig (for Unix)

<sashome/casemgmtmva/sasstp/ecmrr_efile_data_loader.sas.orig (for Windows)

<ECMconfig>/Source/sasstp/ecmrr_efile_data_loader.sas

Replace "@casemgmtmvac.config.control.dir@" with the path of ecm_autoexec.sas

<sashome>/misc/casemgmtmva/sample/form_template (for Unix)

<sashome>/casemgmtmva/sasmisc/sample/form_template (for Windows)

<ECMconfig>/Source/form_template

Replace all form_template files with the new versions.

 

Review PROC SOAP timeout parameter in ecm_soap_config.xml. The current setting is 1 minute.

A.3.       Import New Stored Process

  1. Using SAS Management Console, log on as an administrative user.
  2. Click on the Folders tab, expand System/Applications/SAS Enterprise Case Management/Ent Case Mgmt Configuration 3.1/Application SAS Code.
  3. Right-click on Application SAS Code, and select Import SAS Package....
  4. Click Browse.
  5. Select the file <sashome>/casemgmtmva/sasmisc/sample/config/ecmrr_efile_data_loader.spk (Windows)
    or <sashome>/misc/casemgmtmva/sample/config/ecmrr_efile_data_loader.spk (Unix), and click OK.
  6. Take the default values in the Import SAS Package Wizard until you get to the SAS Application Servers page.
  7. Select your SASApp application server and click Next.
  8. On the Source Code Repositories page, select <ECMconfig>/Source/sasstp.
  9. Click Next and verify that the Summary information is correct.
  10. Click Next.
  11. When the import process finishes, click Finish.

A.4.        Configure Stored Process Server to Run System Commands

The new FinCEN efile process requires reports to be zipped together. In order to execute the zip command, the XCMD option must be enabled for the SAS Stored Process Server so that the SYSTEM function can be used. To allow the XCMD option:

  1. Using SAS Management Console, log on as an administrative user.
  2. From the Plug-ins tab, select Environment Management -> Server Manager -> SASApp -> SASApp - Logical Stored Process Server -> SASApp - Stored Process Server.
  3. Right-click and select Properties.
  4. On the SASApp - Stored Process Server Properties popup window, select the Options tab and press the Advanced Options... button.
  5. In the Advanced Options popup, select the Launch Properties tab.
  6. Check the Allow XCMD checkbox.
  7. Click OK in Advanced Options and again on the SASApp - Stored Process Server Properties window.
  8. Stop and Restart your SAS 9.3 Object Spawner.

A.5.       Run New SAR Form Configuration Scripts

The next step is to run two SAS scripts that load configuration data for the new FinCEN SAR form. The scripts assume that the original 3.1 form configuration scripts have already been run. If you are uncertain if those scripts have been run, check the results of the PROC SQL query listed below. If the returned value is greater than 0, load_rr_config_fincen_base.sas has already been run. If the returned value is 0, run load_rr_config_fincen_new_base.sas. That file contains the configuration data that is shared by the old SAR-DI and the new SAR forms.

The SAS scripts can be found here on Windows:

and here on Unix:

Here is the PROC SQL code to check if form configuration data has already been loaded:

proc sql;
select count(*) from ecm_db.generic_data_udf_def
where udf_table_nm = 'X_INSTITUTION';
quit;

In summary, the steps to complete are:

  1. Open a Base SAS Session
  2. Open and run the program <ECMConfig>/Source/control/ecm_autoexec.sas.
  3. Open a New Program window.
  4. Run the macro %ecm_db_connect;. Verify in the log window that the ecm_db libname has been defined.
  5. Run the proc sql query to verify whether the original 3.1 form configuration scripts have already been run.
  6. If necessary, run the program load_rr_config_fincen_new_base.sas
  7. Open and run the program loadrr_config_fincen_new.sas
  8. Open and run the program loadrr_config_fincen_sar.sas

A.6.       Clear Cache

Logon to the ECM web application as an administrator. Run Clear Cache under the 'Administration' tab.

A.7.       Upload UI definitions

  1. As an administrative user, logon to the ECM web application.
  2. Go to the Administration tab.
  3. Upload the following UI definition files from <sashome>/casemgmtmva/sasmisc/sample/uidef (Windows) or <sashome>/misc/casemgmtmva/sample/uidef (Unix):

Note: the new version of party-cus-01.xml will overwrite the existing version. If you have customized that UI definition file, you may need to merge your own changes into the new document. In that case, download the file from the server and compare it with the new file before uploading.

A.8.       Upload custom.properties

A new version of custom.properties is included with this hotfix. If your custom.properties has been customized, compare it with the new version of custom.properties in <sashome>/casemgmtmva/sasmisc/sample/properties (Windows) or <sashome>/misc/casemgmtmva/sample/properties (Unix). Incorporate any differences into the new custom.properties.

  1. As an administrative user, logon to the ECM web application.
  2. Go to the Administration tab.
  3. Select the Custom Properties Files tab and upload the new file.

B. Configuring FINCEN CTR Reports

 The following instructions update ECM configuration data and stored processes related to the new FinCEN CTR reports. If your installation is not filing CTR reports, these post-installation steps are not necessary.  Some steps may also be skipped if your installation has already configured SAR for e-filing by following the steps in Section A.

B.1.       Back up of all files under <ECMconfig>directory.

An example of <ECMconfig> is '/sasinstall/Config/Lev1/Applications/SASCaseManagementServerCfg/3.1'.

B.2.       Customize ".orig" files and copy form_template directory

Copy the files listed in the table below from the source location to the target location. Remove the extension .orig from the target file names. Then edit the target files according to the instructions in the 'Edit' column.

An example of <sashome> and <ECMconfig> are '/sasinstall/SASFoundation/9.3' and '/sasinstall/Config/Lev1/Applications/SASCaseManagementServerCfg/3.1'.

Source File

Target File

Edit

<sashome>/ucmacros/casemgmtmva/ecmrr_efile_fincen_trnsmttr_var.sas.orig (for Unix)

<sashome>/casemgmtmva/ucmacros/ecmrr_efile_fincen_trnsmttr_var.sas.orig (for Windows)

<ECMconfig>/Source/ucmacros/ecmrr_efile_fincen_trnsmttr_var.sas

Provide institutional transmitter information, required by FINCEN, for the CTR reports. (This step is needed only if ECM 3.1 has not been configured for SAR e-filing)

<sashome>/misc/casemgmtmva/sample/form_template (for Unix)

<sashome>/casemgmtmva/sasmisc/sample/form_template (for Windows)

<ECMconfig>/Source/form_template

Replace all form_template files with the new versions.

 

B.3.       Import New Stored Process (This step is needed only if ECM 3.1 has not been configured for SAR e-filing)

  1. Using SAS Management Console, log on as an adminstrative user.
  2. Click on the Folders tab, expand System/Applications/SAS Enterprise Case Management/Ent Case Mgmt Configuration 3.1/Application SAS Code.
  3. Right-click on Application SAS Code, and select Import SAS Package....
  4. Click Browse.
  5. Select the file <sashome>/casemgmtmva/sasmisc/sample/config/ecmrr_efile_data_loader.spk (Windows)
    or <sashome>/misc/casemgmtmva/sample/config/ecmrr_efile_data_loader.spk (Unix), and click OK.
  6. Take the default values in the Import SAS Package Wizard until you get to the SAS Application Servers page.
  7. Select your SASApp application server and click Next.
  8. On the Source Code Repositories page, select <ECMconfig>/Source/sasstp.
  9. Click Next and verify that the Summary information is correct.
  10. Click Next.
  11. When the import process finishes, click Finish.

B.4.       Run New CTR Form Configuration Scripts

The next step is to run three SAS scripts that load configuration data for the new FinCEN CTR form. loadrr_config_fincen_new.sas should be run only if ECM 3.1 has not been configured for SAR e-filing. The scripts assume that the original 3.1 form configuration scripts have already been run. If you are uncertain if those scripts have been run, check the results of the PROC SQL query listed below. If the returned value is greater than 0, loadrr_config_fincen_base.sas has already been run. If the returned value is 0, run loadrr_config_fincen_new_base.sas. That file contains the configuration data that is shared by the old SAR-DI and the new CTR forms.

Note: there is a typo in the names of the configuration .csv files. Before running the loadrr_config_fincen_newstr.sas program, please change the file <ECMconfig>/Source/form_template/ newctr-preview_section_configx.csv to newctr-preview_section_config.csv and the file <ECMconfig>/Source/form_template/newctr-preview_field_configx.csv to newctr-preview_field_config.csv (i.e. remove the trailing ‘x’).

The SAS scripts can be found here on Windows:

and here on Unix:

Here is the PROC SQL code to check if form configuration data has already been loaded:

proc sql;
select count(*) from ecm_db.generic_data_udf_def
where udf_table_nm = 'X_INSTITUTION';
quit;

In summary, the steps to complete are:

  1. Open a Base SAS Session
  2. Open and run the program <ECMConfig>/Source/control/ecm_autoexec.sas.
  3. Open a New Program window.
  4. Run the macro %ecm_db_connect;. Verify in the log window that the ecm_db libname has been defined.
  5. Run the proc sql query to verify whether the original 3.1 form configuration scripts have already been run.
  6. If necessary, open and run the program loadrr_config_fincen_new_base.sas
  7. If necessary, open and run the program loadrr_config_fincen_new.sas
  8. Open and run the program loadrr_config_fincen_newctr.sas

B.5.       Clear Cache

Logon to the ECM web application as an administrator. Run Clear Cache under the 'Administration' tab.

B.6.       Upload UI definitions

  1. As an administrative user, logon to the ECM web application.
  2. Go to the Administration tab.
  3. Upload the following UI definition files from <sashome>/casemgmtmva/sasmisc/sample/uidef (Windows) or <sashome>/misc/casemgmtmva/sample/uidef (Unix):

B.7.       Upload custom.properties

A new version of custom.properties is included with this hotfix. If your custom.properties has been customized, compare it with the new version of custom.properties in <sashome>/casemgmtmva/sasmisc/sample/properties (Windows) or <sashome>/misc/casemgmtmva/sample/properties (Unix). Incorporate any differences into the new custom.properties.

  1. As an administrative user, logon to the ECM web application.
  2. Go to the Administration tab.
  3. Select the Custom Properties Files tab and upload the new file.

 

C. Manually apply this change to an existing ECM environment where SAR configuration has been executed under a previous hotfix. Do not run this step if:

·  your site does not file SAR reports.

·  or you have never performed the SAR configuration step from the previous hotfix

·  or your site has already changed how branches are handled for SAR reporting and the branch location code should not be the internal branch identifier (X_BRANCH_RK)

The steps to complete are:

  1. Open a Base SAS Session
  2. Open and run the program <ECMConfig>/Source/control/ecm_autoexec.sas.
  3. Open a New Program window.
  4. Run the macro %ecm_db_connect;. Verify in the log window that the ecm_db libname has been defined.
  5. Run the following SAS code to update ecm_db.form_efile_field_config and rebuild the e-file generation macro code (fincen-sar-v1_efile_macro.sas).

proc sql ;
update ecm_db.form_efile_field_config
set source_field_nm='X_BRANCH_RK'
where form_config_rk=201
and form_efile_record_seq_no in
(select distinct form_efile_record_seq_no
from ecm_db.form_efile_record_config
where form_config_rk=201 and
form_efile_record_id='2C'
)
and target_field_start_pos_no=3
and source_field_nm='ROW_NO'
;
quit;
%ecmrr_efile_pgm_gen( form_config_rk=201);

D.    Manually add these required metadata properties to an existing ECM environment.

The steps to complete are:

1.     Using SAS Management Console, log on as an administrative user.

2.     From the Plug-ins tab, select Application Management -> Configuration Manager -> SAS ApplicationInfrastructure -> Ent Case Mgmt Mid-Tier 3.1.

3.     Right-click and select Properties.

4.     On the Ent Case Mgmt Mid-Tier 3.1 Properties popup window, select the Advanced tab and press the Add button.

5.     In the Define New Property popup provide the following information:

o   Property Name – ECM.Policy.AutoUnlockOnLogout

o   Property Value - true

6.     Click OK in Define New Property window.

7.     Add another property with these values:

o   Property Name – ECM.Policy.AutoUnlockStrategy

o   Property Value - session

8.     Click OK in Define New Property and again on the Ent Case Mgmt Mid-Tier 3.1 Properties window.

9.     Stop and Restart SASServer8 using the instructions for your web application server.

This completes the installation of hot fix I21002 on Windows.