SW Test Automation Framework Files

Readme File for the STAX Service Version 3.5.0 Beta 1 - December 2, 2010
------------------------------------------------------------------------

The purpose of this Beta is to provide support for Jython 2.5.2 (instead
of Jython 2.1 which is what is supported by previous STAX versions).
However, because the final Jython 2.5.2 version has not yet been released
and because we don't have approval to distribute the final Jython 2.5.2
version yet, the STAX service jar file provided, STAX_NoJython.jar, does
not contain Jython 2.5.2.  You need to download the latest version of
Jython 2.5.2 available via the Jython website at http://www.jython.org
and install it and then run the provided STAXJarUpdateForJython252 Java
application to create a STAX.jar file (to use for registering the STAX
service), passing it the directory where you installed Jython 2.5.2.
The instructions for how to do this are provided below.

To install STAX Service Version 3.5.0 Beta 1:

- Make sure you have STAF 3.3.4 or later installed and Java 1.5 or later
  installed on your STAX service machine.
- If on Windows, unzip the STAXV350Beta1.zip file into a directory.
  This readme assumes you specified C:\STAF\services for the directory.
  Note that if you already have an earlier version of STAX installed,
  backup this directory before unzipping the file.  For example,
  rename C:\STAF\services\stax to C:\STAF\services\stax3.4.4 (if you
  currently have STAX V3.4.4 installed in C:\STAF\services\stax).
- If on Unix, untar the STAXV350Beta1.tar file into a directory.
  This readme assumes you specified /usr/local/staf/services for the
  directory.
  Note that if you already have an earlier version of STAX installed,
  backup this directory before unzipping the file.  For example,
  rename /usr/local/staf/services/stax to /usr/local/staf/services/stax3.4.4
  (if you currently have STAX V3.4.4 installed in /usr/local/staf/services/stax).
- Note that the unzip/untar will put all the files into a stax directory
  in the location that you specified.

Note:  We highly recommend that you unzip/untar the STAXV350Beta1.zip/tar
file into a directory directly off the STAF root directory, such as
C:\STAF\services if on Windows or /usr/local/staf/services if on Unix.

You should now have the following files in a newly created stax directory:
- readme.1st (this file)
- History
- STAFEvent.jar
- STAXDoc.jar
- STAXMon.jar
- STAXJarUpdateForJython252.class
- STAX_NoJython.jar
- docs/History
- docs/STAXDoc.pdf
- docs/staxgs.pdf
- docs/staxug.pdf
- ext/stax-extensions.dtd
- libraries/docs/...
- libraries/STAFUpgradeUtil.xml
- libraries/STAXUtil.xml
- libraries/STAXUtil.html
- samples/FunctionList.xsl
- samples/sample1.xml
- samples/UpgradeSTAF.xml

The STAX service jar file provided, STAX_NoJython.jar, does not have
Jython 2.5.2 embedded within it.  You will need to download the latest
version of Jython 2.5.2 available via the Jython website and install it.
Then you'll need to run Java application STAXJarUpdateForJython252 to
create a new STAX.jar file that contains Jython 2.5.2.  The STAX.jar it
creates will be used to register the STAX V3.5.0 Beta 1 service.

Follow the instructions in the "Installation and Configuration" section
of the STAX User's Guide.  

A sample STAX XML file, sample1.xml, is provided which demonstrates some
of the capabilities of STAX.  Try it!

A tool called STAXDoc is also provided to aid in generating documentation
about your STAX Functions.

WARNING:  If you've written a STAX service extension, you may need to make a
modification to your STAX service extension for it to work with STAX V3.3.0
and later.  When submitting a STAX EXECUTE request, if you get RC 4001 and
the result indicates a STAXInvalidXMLAttributeException was caught and the
text includes:
  <Your Extension>: _ln
then you need to modify the parseAction() method in your STAX extension's
ActionFactory Java code to not throw an exception if an extra attribute
named "_ln" is found (as this is used to provide line number information
when an error occurs).  See the STAX Extension Developer's Guide for more
information.

History Log for STAX V3.5.0 Beta 1:
-----------------------------------

  + Changed the default signal handler for the STAXEmptyList signal to do
    nothing so it no longer logs an error in the job log (Feature #3083827)
  + Changed the result from EXECUTE WAIT RETURNRESULT and GET RESULT requests
    to include a list of errors, if any, in the job log (Feature #3082388)
  + Added the ability to import all .xml files from a directory via the import
    element (Feature #3076665)
  + Added the ability to list jobs that are in the process of being submitted
    for execution (that are in a "Pending" state) by assigning a job ID before
    the xml file is parsed (Feature #3032420)
  + Changed the STAX Monitor to display a "Please wait" message while a job is
    being submitted for execution and to display and manipulate jobs in the
    "Active Jobs" list that are in a "Pending" state (Feature #3105346)
  - Fixed an import error if a relative file name is specified and its parent
    file name ends in a file separator (Bug #3111992)
  + Changed to use Jython 2.5.2 instead of Jython 2.1 which provides new
    Python functionality that you can use within STAX jobs (Feature #18678258)
    Notes:
    1) Jython 2.5.2 requires Java 1.5 or later so STAX now requires Java 1.5
       or later.
    2) Since the final version of Jython 2.5.2 has not yet been released and
       because we don't have approval to distribute it, you must download and
       install Jython 2.5.2 RC 2 from http://www.jython.org and use the
       provided STAXJarUpdateForJython252 Java application to embed Jython
       2.5.2 into the STAX.jar file to use when registering the STAX service.
       For more info on this, see the STAX User's Guide or the readme.1st file.
-------------------------------------------------------------------------------