SAFS Release Notes
for Windows

Definitions, Critical Reminders, SAFS Tools, Install Instructions, Setup Notes, New Stuff

CRITICAL REMINDERS

This release supports installing SAFS on 32-Bit and 64-Bit Windows Operating Systems.

This release, along with all future releases, provides a simplified install process that supports STAF 3.X installing with Java 1.5 or greater.  All the latest functionality of SAFS on Windows--including JSAFS, and supported tools like IBM Rational Functional Tester, AutomatedQA TestComplete, Android SDK, Selenium, and Image-Based Testing are included in this release.

This release does NOT support installing SAFS on the Apple Mac for IOS testing, or installing and testing on Linux or Unix.  For SAFS Mac and IOS Support please download SAFS Mac support and consult the SAFS Mac Release Notes.

*** IMPORTANT NOTE ***
While the latest SAFS and RFT support both STAF V2 and V3,
other associated tools like RRAFS using IBM Rational Robot may NOT support STAF V3.

If you are using RRAFS you must continue to use\install STAF V2 unless you have applied RRAFSPatch2010.01.14.  That patch provides STAF V3 support to RRAFS.

If installing STAF V2 you MUST have Java 1.5 as the default JVM--NOT Java 1.6 or later.

Affected customizations from previous releases:

• Custom modifications in your SAFS install directories <C:\SAFS\bin >
• Batch files (*.bat or *.vbs), or any SAFSTID.INI in the root SAFS install directory <C:\SAFS >
• Project config files (*.bat or *.ini) in the SAFS Project directory <C:\SAFS\Project >
• Project test tables (*.cdd, *.std, *.sdd) files in the SAFS Project Datapool directory <C:\SAFS\Project\Datapool >
• Object mapping files (*.dat) in your SAFS lib directory <C:\SAFS\lib >
• Samples config, batch, or test table files of any kind.

If you have taken advantage of any of the customization capabilities of this framework, then you must take some simple precautions prior to installing this new release. Installing a new version of the framework will install new, default versions of customizable files.

SAFSTID.INI
If you have a modified SAFSTID.INI in your install directory, you should make a back-up, then evaluate how and if you want to merge with the new file.

SAFS Batch Files
If you have previously installed the SAFS Framework then you may have manually modified batch files or VBS scripts to handle custom project paths. You will need to backup modified files and evaluate how and if you want to merge such changes with the new files.

In addition, some of the Batch files have been modified to show support for 64-bit Windows systems where Java is being invoked.  These batch files must be properly edited to launch a 32-bit JVM.

SAFS Project Files
If you have previously installed and edited any of the INI or BAT files in the SAFS\Project or SAFS\samples directories then you will need to backup these modified files and evaluate how and if you want to merge such changes with the new files.

SAFS Object Mapping Files
If you have previously installed and edited any of the following files then you will need to backup the modified files and evaluate how and if you want to merge your edits with the new (default) versions of these files:

• JavaObjectsMap.dat
• ObjectTypesMap.dat
• CustomJavaObjectsMap.dat
• CustomObjectTypesMap.dat
• TCAFS\TCAFS\*.dat

Failure to perform any of these prescribed backups may erase your prior customizations. Hopefully, you have backed them up somewhere already as part of your normal ongoing activities... Right?!

STAF 2.6.11 and STAF 3.4.X and JAVA 1.6

• It is highly recommended to install and use STAF 3.4.X for new installations using RFT, Test Complete, the Android SDK, Selenium, or IBT.  Support for STAF 2.X is only provided for scenarios requiring interaction with remote machines having STAF 2.X installed and for users still using IBM Rational Robot (RRAFS) without RRAFSPatch2010.01.14.

• STAF 2.6.11 *REQUIRES* Java 1.5 to install.  STAF 2.6.11 will NOT successfully install using Java 1.6 or later.
  However, STAF 2.6.11 can use Java 1.6 AFTER it has been successfully installed.
  Most machines do NOT have earlier versions of Java installed.  If you intend to install STAF 2.6.11 and do not have Java 1.5 on your machine then you will have to download and install Java 1.5 from the Sun Java 1.5 Archives.

  It is important to note that 64-bit systems might have a 64-bit Java JVM installed.   Testing has shown that we can install 32-bit SAFS and STAF using the 64-bit JVM,   but SAFS and STAF will require a 32-bit Java JVM to use at runtime.   SAFS Batch scripts in the SAFS install directories, including those in the SAFS\Project space may need to be edited to point to the desired 32-bit JRE installed on the 64-bit system.

• STAF 3.4.X can successfully install and run with Java 1.6 as well as earlier and later versions of Java.
  It is highly recommended to install and use STAF 3.4.X for new installations not using IBM Rational Robot.
  Support for STAF 2.X is only provided for scenarios requiring interaction with remote machines having STAF 2.X installed and for users still using IBM Rational Robot (RRAFS) without RRAFSPatch2010.01.14.

Note: STAFWrap.DLL and DDVariableStore.DLL have been refactored in order to support both STAF V2.X and STAF V3.X

STAFWrap.DLL, ComponentFunctions.DLL, DDVariableStore.DLL and associated scripts for registering DVariableStore.DLL are included in the SAFS\bin directory. The SetupSAFS script does register and\or move files to system directories as necessary.

COM classes supporting COM access to STAF for use in VBScript and other COM-related features exist in the latest version of DDVariableStore.DLL. Consult the sourcecode in CVS or any VBA or COM object browser until more proper documentation is made available. A very rudimentary "RUTHere" test script for this COM STAF interface can be found in SAFS\bin\DDVariableStoreTest.VBS.

Installation Instructions

"I'd hate to say, 'I told ya so.'"

Short-N-Sweet install instructions:

A Java Runtime Environment (JRE) and Windows Scripting Host V5.6 or later is required.

1. Extract the SAFSRelease ZIP file into ANY directory.
   Extract all files of the ZIP file into ANY directory.  A good choice might be something like C:\TEMP, or even C:\SAFS.

   RRAFS (Rational Robot) users might do best to extract into their ".\Program Files\Rational\Rational Test\sqabas32" directory. (Although this should not be necessary with a RRAFS release since that includes the SAFS install files already. Only do this if you are upgrading SAFS without upgrading RRAFS.)

   Enable "OVERWRITE Existing Files" if you are overwriting a previous release of SAFS.

2. Run the extracted  SetupSAFS_WIN64.BAT  script.
   On 32-bit systems you can run SetupSAFS.wsf directly.
   On 64-bit systems you MUST run SetupSAFS_WIN64.bat to use 32-bit processes.
   In Windows Explorer, locate "SetupSAFS_WIN64.bat" in that directory and double-click to execute it.

   The installation will prompt to confirm the installation of SAFS and the version of STAF to install, if any.  The user has the option to skip these installations by pressing "No" or "Cancel" when prompted.

   You do not need to reinstall STAF if you already have STAF installed.  However, you can choose to reinstall STAF to overwrite STAF 2.X with the new STAF V3.X version.

3. Verifying a successful SAFS install:
   Following a successful standard install, you should be able to double-click or otherwise execute the program:

       C:\SAFS\Project\runTIDTest.BAT
   

   This should run a simple SAFS Test and generate logs in:

       C:\SAFS\Project\Datapool\Logs
   

The installation will not install any program that will appear in Control Panel's "Add/Remove Program" application. However, depending upon the STAF install scenario, STAF might install "Software Testing Automation Framework" into the Control Panel's "Add/Remove Program" application.

Additional Setup Notes and Information

SetupRRAFS	IBM Rational Robot Setup for SAFS Testing
SetupRobotJ	IBM Rational Functional Tester Setup for SAFS Testing.
SetupTCAFS	AQA TestComplete Setup for SAFS Testing.
SetupAndroid	Android Setup for SAFS Testing.
SetupSelenium	Selenium Quick Start for SAFS Testing.

New, Fixed, or Enhanced Stuff

• See the local Whats New In SAFS doc!
• See the online Whats New In SAFS doc!

Carl Nagle, SAS
Project Manager, SAFSDEV
Subscribe to appropriate Support Forums to review support archives and ask questons.