*************************************************************************** ** COPYRIGHT (c) 2003 BY TRI-8, INCORPORATED. ** ** A L L R I G H T S R E S E R V E D. ** *************************************************************************** OneStep Charge Installation Information --------------------------------------- Two main steps make up the installation of OneStep Charge: 1) Install and run the OSCBroker (see notes below to skip this step for demo). 2) Unpack and copy the OSC source code into your PROPATH. 1) Installing/running the OneStep Charge Broker (OSCBroker): The OSCBroker must be running at all times in order for OneStep Charge to operate. The OSCBroker facilitates connections among the OneStep Charge Engine processing nodes, providing triple redundancy and 2048-bit encryption for every transaction. It is a Java-based utility and requires the Java Runtime Environment (JRE or JDK/SDK) version 1.4.0 or later. The main Java website, provided by Sun Microsystems, can be found at: http://java.sun.com *** PLEASE NOTE that you may SKIP the OSCBroker Java requirements, installation and execution when you first evaluate and test OneStep Charge. The default OneStep Charge configuration (in $OSC/tri8osc/oscapi) directs OneStep Charge to connect to the publicly-available DEMO OSCBroker at OSCBrokerDemo.OneStepCharge.com. THIS IS FOR DEMONSTRATION/TESTING PURPOSES ONLY AND SHOULD *NEVER* BE DONE IN A LIVE SCENARIO. You must always deploy a local OSCBroker before running live transactions or sending ANY live credit card numbers. To try things out without firing up the OSCBroker, skip to step 2 below and install the OneStep Charge source code. *** It is recommended that you simply run the OSCBroker JAR file from its default location ($OSC/broker/OSCBroker.jar). However, you may certainly copy OSCBroker.jar to another location if you need to. If the operating system of the machine(s) upon which you are running OneStep Charge does not provide a sufficiently modern Java release (1.4.0 or greater), you may copy the OSCBroker.jar file to a host on your local network that does support a modern Java version. OneStep Charge can easily be pointed toward a separate host via the OSCConfig.brokerHost parameter in $OSC/tri8osc/oscapi . By default, the live configuration is recommended to connect to the OSCBroker on "localhost," but you can change this to be any hostname or IP address (hostname is highly recommended) corresponding to the host upon which you have chosen to run the OSCBroker. IMPORTANT: PLEASE BE ADVISED THAT THE TCP/IP COMMUNICATIONS BETWEEN ONESTEP CHARGE ITSELF AND THE OSCBROKER **ARE NOT ENCRYPTED***. Therefore, if you choose to run the OSCBroker on a different host than the OneStep Charge Progress code, such that OSCConfig.brokerHost is not "localhost" but is some other address, you MUST be certain that the network between OSC and the OSCBroker is trusted, private, and free from eavesdropping/network sniffing or other attacks. Run the broker by typing the following at a command prompt (DOS or Unix/Linux command prompt): java -jar OSCBroker.jar & Use the "&" (on Linux, for example) to send the OSCBroker to the background and run it independently from the shell in which you executed the command. You may need to fully-qualify the "java" command or the location of the JAR file, depending upon your PATH environment variable. For example: /path/to/your/jre/bin/java -jar /path/to/OSCBroker.jar & Set your OSCBroker host to run the OSCBroker JAR file upon system startup. This can be done with the command line placed in standard startup scripts specific to your Unix/Linux system, such as /etc/rc.local or in an init script of its own. On Windows, you may create a .bat file that runs the Java command (java -jar OSCBroker.jar), or use other such infrastructure. In all cases, make sure that your startup mechanism has appropriate PATH settings (or fully-qualify the "java" command) and access (permissions, etc.) to the OSCBroker JAR file and the "java" command. Please note that the OSCBroker will, by default, output its standard log to OSCBroker.log in the current working directory in which you issue the "java" command. Be sure that proper permissions exist to write the log file. You may change the log file location using the -l command-line parameter (see below). To STOP the OSCBroker, use the -stop command-line parameter: java -jar OSCBroker.jar -stop If you specified an alternate port number via the -p option, you must specify the same port number when issuing the stop command: java -jar OSCBroker.jar -p portNumYouUsed -stop It is very important to stop the OSCBroker gracefully (using the -stop command instead of merely killing the Java process(es)), as doing so will allow the broker to finish all active transactions before shutting down. Command-Line Parameters Supported by the OSCBroker: -l logFileName (use logFileName instead of default "./OSCBroker.log") -p portNumber (bind to and listen on portNumber instead of default 4888) -v (display version information and then exit) -stop (stop a running OSCBroker) Note that an alternate OSCBroker jar file is provided: OSCBrokerSS.jar. This broker provides a single-settlement model but forfeits the multi-redundant OSC Engine architecture. See the User's Guide for more information. 2) Installing OneStep Charge Progress Code: The OneStep Charge Progress software is located in the "tri8osc" directory. In order to use OSC you will need to place the tri8osc directory somewhere in your PROPATH. This can be done by modifying your PROPATH to include your $OSC/tri8osc directory, or you may copy/move the tri8osc directory into a location already included by your existing PROPATH. This latter method eliminates the need to make changes in startup scenarios and parameters and is generally the easiest approach. In addition, be sure to consult the QuickStart Guide or full User's Guide for information regarding the use of the OneStep Charge configuration file. This file allows you to compile your default OSC configuration settings into your Progress R-Code executables but override some (or virtually all) settings at runtime on an as-needed basis, without the need for recompiling, such as when extra debug/diagnostic information is desired immediately. If you can run only R-Code, even while testing OneStep Charge, and cannot also run compile-on-the-fly source code, then compile the OneStep Charge core run program ($OSC/tri8osc/oscengin.p). This is the only file you need to compile. FOR MORE INFORMATION, please consult the OneStep Charge User's Guide located in the $OSC/doc directory.