SAFS Framework Release Notes
2010.09.16

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


Definitions:

SAFS Software Automation Framework Support
SAFS Driver The tool that initializes, opens, parses, and routes SAFS test records to available SAFS Engines.
SAFS Engine A keyword-driven automation tool capable of interpreting and executing SAFS test records.
SAFS/DriverCommands A SAFS Engine for tool-independent Driver Commands
SAFS/RobotJ (RFT) A SAFS Engine for testing using Functional Tester by IBM Rational.
SAFS/TC (TCAFS) A SAFS Engine for testing using TestComplete by AutomatedQA.
SAFS IBT (Pat.Pend.) An embedded SAFS Engine for Image-Based Testing. (Patent Pending)
JSAFS (New!) The Java API for embedding SAFS in custom frameworks and SAFS Advanced Runtime Development.

Back2Top, Definitions, SAFS Tools, Install Instructions, Setup Notes, New Stuff

CRITICAL REMINDERS

This release, along with all future releases, provides a simplified install process that supports STAF 3.X installing with Java 1.6.  All the latest functionality of SAFS, JSAFS, and supported tools like IBM Rational Functional Tester, AutomatedQA TestComplete, and Image-Based Testing are included in this release.  This release also supports installing SAFS on 64-Bit Windows Operating Systems.

Affected customizations from previous releases:

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 directory 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:

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.3.X and JAVA 1.6

SAFS can be installed to work with either STAF 2.6.11, or STAF 3.3.3 and above. However, note the following installation limitations below:


Back2Top, Definitions, Critical Reminders, Install Instructions, Setup Notes, New Stuff

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 .


Back2Top, Definitions, Critical Reminders, SAFS Tools, Setup Notes, New Stuff

Installation Instructions

If you have not done so, review the Critical Reminders above concerning backups of locally modified or customized files from previous releases.
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. Refer to SetupSAFS.README in the Java Runtime and Windows Scripting Host sections for more details and install information for those tools.

  1. Extract the SAFSFramework 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 the SAFS Framework 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. Setup SAFS and (optionally) Rational Functional Tester per SetupSAFS.README
    Verify/Complete any setup per that doc.

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.


Back2Top, Definitions, Critical Reminders, SAFS Tools, Install Instructions, New Stuff

Additional Setup Notes and Information

Additional notes and instructions for this release can be found via the links below. These are generally reviewed in the listed order. The files are contained in the downloaded installation ZIP file and available once all contents of the ZIP file are extracted into the install directory. (The links to these will work once unzipped locally.)

SetupSAFS.README Install STAF and SAFS Services
SetupRuntime.README Runtime Setup for Testing
SetupRobotJ.README Optionally, setup Rational Functional Tester to use STAF and SAFS Services.


Back2Top, Definitions, Critical Reminders, SAFS Tools, Install Instructions, Setup Notes,

New, Fixed, or Enhanced Stuff


Back2Top, Definitions, Critical Reminders, SAFS Tools, Install Instructions, Setup Notes
Carl Nagle, SAS
Project Manager, SAFSDEV
Subscribe to appropriate Support Forums to review support archives and ask questons.