Installation Instructions for Hot Fix J56007

Windows for x64

Hot fix J56007 addresses the issue(s) in Forecast Analyst Work Bench 5.1_M1 as documented in the Issue(s) Addressed section of the hot fix download page:

https://tshf.sas.com/techsup/download/hotfix/HF2/J56.html#J56007

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

J57006  updates  SAS Forecast Analyst Workbench Mid-Tier 5.1_M1
J58005  updates  SAS Forecast Analyst Workbench Server 5.1_M1

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

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

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 J56007pt.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

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

Click the link to be redirected to post-installation instructions:

J58005  updates  SAS Forecast Analyst Workbench Server 5.1_M1
J57006  updates  SAS Forecast Analyst Workbench Mid-Tier 5.1_M1
Clearing Cache

J58005  updates  SAS Forecast Analyst Workbench Server 5.1_M1

Prerequisite:

Note: If you have already installed the hotfix J56004, you would have already performed steps 1 to 2 as part of J56004 installation. You may skip step 1 to 2 below when installing J56007 or higher.

1. The SAS services must be running while you are executing this macro.
2. Please ensure that you have executed the one-time DI jobs execution before running the code mentioned below.
   
   Note: You must execute the macro only once.

%ddcf_f1ddf51_updates(library=uiart);

• The following UIART tables are added:
  • plan_hier_node_tmp1
  • plan_hier_leaf_members
  • plan_hier_node_successor_tmp1
  • plan_hier_node_successor_tmp2
  • plan_hier_node_substitute_tmp1
  • plan_hier_node_substitute_tmp2

• The following UIART tables are modified for change in the column data type and length (data type of few columns are changed to bigint):
  • fs_proj_dtls
  • plan_analysis_var
  • plan_dimensions
  • plan_events
  • plan_hier_attrib
  • plan_hierarchy
  • plan_hierarchy_node
  • plan_hierarchy_node_substitute
  • plan_hierarchy_node_successor
  • plan_rerun_forecast
  • plan_scenario_node

• The following plan-specific UIART tables are modified for change in the column data type and length (data type of few columns are changed to bigint):
  • fcst_mdl_rslt_event_summary<plan_ID>
  • fcst_mdl_rslt_iv_summary<plan_ID>
  • fcst_mdl_rslt_summary<plan_ID>
  • fcst_model_dtls<plan_ID>
  • fs_mdl_rslt_event_summary<plan_ID>
  • fs_mdl_rslt_iv_summary<plan_ID>
  • fs_mdl_rslt_summary<plan_ID>
  • fs_mixed_dim_hierarchy<plan_ID>
  • fs_proj_model_dtls<plan_ID>
  • mixed_dim_hierarchy<plan_ID>

• The following configuration parameters are added to the SAS Management Console:

  Parameter	Description	Example of the Parameter Value
  GL_INCLUDE_STAKEHOLDER_DIM_IND	Specifies whether the stakeholder dimension should be added while initiating the consensus planning process. The values are 1 or 0. The value 1 indicates to include stakeholder dimension while the value 0 indicates not to include stakeholder dimension. Note: If the customer is already using the Stakeholder dimension and after applying this hotfix the customer does not want to use the Stakeholder dimension, then perform the following steps: Set the value of this parameter to 0. Delete the following information that is related to SAS Forecast Analyst Workbench: Cycles of SAS Financial Management that are related to SAS Forecast Analyst Workbench Dimensions of SAS Financial Management that are related to SAS Forecast Analyst Workbench Dimension types of SAS Financial Management that are related to SAS Forecast Analyst Workbench Run the SAS Financial Management integration ETL jobs of SAS Forecast Analyst Workbench through SAS Data Integration Studio. For more information about SAS Financial Management, see SAS Financial Management: Data Administrator's Guide. For more information about SAS Forecast Analyst Workbench, see SAS Forecast Analyst Workbench: Data Administration Guide and SAS Forecast Analyst Workbench: System Administration Guide.	1
  GL_DDF_ARCHIVE_DIR_PATH	Specifies the path where the archive tables should be created and data should be archived.	<SAS configuration directory>\Lev1\AppData\SASForecastAnalystWorkbench\Archive

  SAS Consultants or system administrators must specify the values of these parameters according to the implementation.

• The default value for configuration parameter GL_OPT_FLAG is set to N. For this hotfix, change the value of this parameter to Y.

• The following table values are updated correctly as specified below.

  Table name	config.forecast_interval, uiart.forecast_interval
  Column name	LOW_HISTORY_THRESHOLD
  Value after update	1

• The following new HPF parameters are added in config.hpf_preferences master table.

  Table name	config.hpf_preferences
  Column names	Option	Value
  	hpfengine_input_required	YES
  	hpfengine_input_trimmiss	RIGHT
  	hpf_exceptions	CATCH
  	diag_arimax_outlier_filter	SUBSET

• The following new HPF parameters are added in plan-specific hpf_preferences config table.

  Table Name	Config.hpf_preferences<Plan_ID>
  Column names	Plan_ID	Option	Value	Edit_From
  	<Plan_ID>	hpfengine_input_required	YES	BACK
  	<Plan_ID>	hpfengine_input_trimmiss	RIGHT	BACK
  	<Plan_ID>	hpf_exceptions	CATCH	BACK
  	<Plan_ID>	diag_arimax_outlier_filter	SUBSET	BACK

  If independent variables are selected for a plan, then these options are also added for independent variables. For example, hpfengine_input_required1, hpfengine_input_required2, hpfengine_input_requiredn

  Similar options are added for the hpfengine_input_trimmiss. For example, hpfengine_input_trimmiss1, hpfengine_input_trimmiss2, hpfengine_input_trimmissn

• The plan-specific tables in the control library with names like control.plan_valid_data_flg<plan_id> are appended with an additional column named plan_edit_start_date and have data type num.
  

  The plan-specific tables in the planexpl library with names like planexpl.plan_forecast_fact<plan_id> are appended with two additional columns named fs_override and override. Both these additional columns have data type num.
  
  

This hot fix requires post-installation steps that will update the web application deployed to your application server.

Step 1: Re-build Web Applications

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

1.1 Delete the cache file com.sas.app.launcher.cache, for example

$ cd <!SASHOME>\SASVersionedJarRepository\eclipse
$ del com.sas.app.launcher.cache

From the SASDeploymentManager directory launch sasdm.exe. The default installation path for the SAS Deployment Manager is

C:\Program Files\SAS\SASDeploymentManager\9.3

1.3 Select a language in the Choose Language box

1.4 Select Rebuild Web Applications

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

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

1.7 Select Forecast Analyst 5.1 as the Web Application to Rebuild

1.8 Verify the information on the Summary screen and select Start

1.9 Select Finish when the deployment is complete

This process will update the SAS Forecast Analyst Work Bench ears in <CONFIGDIR>\Lev1\Web\Staging and place the updated exploded ear in <CONFIGDIR>\Lev1\Web\Staging\exploded. The SAS Forecast Analyst Work Bench ear includes:

• sas.forecastanalystworkbench.ear

Step 2: Re-deploy Web Applications

2.1 Re-deploy the updated ear listed above to the web application server you are using based on the instructions appropriate for your web application server. See SAS(R) 9.3 Intelligence Platform: Middle-Tier Administration Guide, Third Edition for more details.

Clearing Cache

What is Cache?
Basically, all the web-tier related files (.jsp .class, JSPCompiled files etc.,) get stored in the <app_your_application> directory. This is treated as cache whenever there is a restart of a Web Application Server instance. When this happens, the WebApp server will look for the last serviced object status stored in the cache for service for any pending requests.

Why do we need to remove Cache?
Whenever your application is accessed for the first time for a fresh deployment of a new version, WebApp server does a lookup in this directory to see if any older objects persist that will be a conflict with new code objects. This is where the need for removal of cache arises.

Clearing Cache for Web Logic instance
For WebLogic 9.x onwards, removal of cache means deleting each server instance's tmp folder that contains cache and stage folders. You can simply remove tmp folder provided there are no configuration changes to the server.

For Web-Logic, delete the tmp folder located at

SASConfig\Lev1\Web\SASDomain\servers\SASServer1\tmp

Clearing Cache for Web Sphere instance
Clear WebSphere cache every time you rebuild and redeploy the ear files.

From the file structure, delete the following folders/files:

ibm\websphere\appserver\profiles\<app server profile>\temp\<node>\<app server> folder
ibm\websphere\appserver\profiles\<app server profile>\wstemp, delete files in this folder

IBM Support may ask you to clear the class cache. There are several reasons for this. After an upgrade, it is possible that the class caches are still holding onto previous versions of classes. It is also possible that the caches became corrupted.

Please remember there are two caches that will need to be cleared, the JVM's cache and the OSGi cache. The server has to be stopped before clearing the cache.

To clear the OSGi class cache:
For UNIX platforms, run the following script in each profile:
/profiles/profile_name/bin/osgiCfgInit.sh

For Windows platforms, run the following script in each profile:
\profiles\profile_name\bin\osgiCfgInit.bat

To clear the JVM's class cache (Windows, Linux and AIX only):
For UNIX platforms, run the following script:
<WebSphere_HOME>/bin/clearClassCache.sh

For Windows platforms, run the following script:
<WebSphere_HOME>\bin\clearClassCache.bat

And clear the following directory contents:
C:\Documents and Settings\DefaultUser\Local Settings\ApplicationData\javasharedresources\

Clearing Cache for JBoss instance
Delete the contents under
<JBossHome>/server/SASServer8/tmp
and
<JBossHome>/server/SASServer8/work

These folders are created dynamically when we start the Server.

This completes the installation of hot fix J56007 on Windows for x64.