==============================================================================
Author: Carl Nagle
Since: JUN 29, 2005
Copyright (2005) SAS Institute
http://www.sas.com
General Public License (GPL):
http://www.opensource.org/licenses/gpl-license.php
==============================================================================
This document attempts to provide a single location for information regarding the setup and use of SAFSDRIVER -- the SAFS TID (Tool-Independent Driver). This document assumes the user has already successfully installed the latest SAFS Framework release.
From any command-prompt the user should be able to invoke the SAFS TID to run a simple sanity test. (All examples will assume the framework has been installed in the default location.)
SAFS setup sanity test:
java -Dsafs.project.config="C:\safs\project\TIDTest.ini" org.safs.tools.drivers.SAFSDRIVER
Javadoc for SAFSDRIVER contains info on command-line options and config file options.
SAFSDRIVER Command-Line Options ("-Dsafs.project.config=" above is an example of a command-line option.)
SAFSDRIVER Config-File Options (The specified "TIDTest.ini" file is an example of a config file.)
Without any additional work, the use of the TID by itself can only support "TID" and "SDC" commands shown in the SAFS Reference. These are generally only a subset of the known Driver Commands. To be able to actually test some application, we need to enable one or more SAFS Engines in the config file.
To tell the TID to use an engine, you generally tell it the classname of each engine that must be initialized. Currently all supported SAFS Engines exist in the org.safs.tools.engines package. You specify one or more engine classnames in the [SAFS_ENGINES] section of the config file as shown in the SAFSDRIVER Config-File Options linked above and subset below:
[SAFS_ENGINES] First=org.safs.tools.engines.SAFSROBOTJ Second=org.safs.tools.engines.SAFSABBOTNote, that each engine class will generally specify an additional config-file section and options that are needed in the INI file. View the SAFSROBOTJ and SAFSABBOT links above and you will see examples of this. For example, SAFSROBOTJ wants a [SAFS_ROBOTJ] section and SAFSABBOT wants a [SAFS_ABBOT] section in the test configuration file.
NOTE: As of this date the SAFSABBOT engine is not actually released for production. There are additional setup requirements to enable the use of the SAFSABBOT engine that are subject to change until such time as the engine is ready for production. At that time, the documentation for the SAFSABBOT engine should specify this information.