*** This package provides a sample OCI client to communicate with BroadWorks 
      Application server

SYSTEM REQUIREMENTS:
   BroadWorks release 13

DESCRIPTION:
   The ASOCISoapClient is a sample Java client that can be used to communicate 
   with the Application Server using the OCI protocol over SOAP.
   OCI requests and responses are encoded in XML in accordance with the 
   Broadsoft provided Schema.
   
   This client automatically substitutes a session id in each transaction 
   it sends.


RUNNING THE OCI CLIENT WITH THE CONFIG FILE
   cd d:\ASOCISoapClient
   startociclient.bat ociclient.config

   Refer to the ociclient.config for a description of every field that can be configured.
   In particular note the use of the "url" parameter.


RUNNING THE CLIENT WITHOUT THE CONFIG FILE
   cd d:\ASOCISoapClient
   startociclient.bat userId password [options]

   USAGE:
     startociclient loginId password [-i inputXMLFile] [-o outputXMLFile] [-u url]
 
       where  loginId        - User's Login 
              password       - Password 
              inputXMLFile   - File containing the XML request (optional)
                               (eg -i testdata/oci/SystemOutgoingCallingPlanGetRequest.xml)
              outputXMLFile  - File to write the XML response (optional)
                               (If not provided defaults to: inputXMLFile_response.xml)
              url            - Web service url 
                               (eg -u http://1.2.3.4/webservice/services/ProvisioningService)
 
    The ociclient automatically sends the "AuthenticationRequest" and "LoginRequest" commands at startup.  
    At program exit the "LogoutRequest" command is sent.

    The ociclient operates in two modes: 

    1) COMMAND MODE
 
     If the inputXMLFile name has been provided, the ociclient runs the command 
     from the inputXMLFile.  
     If your command doesn't run, make sure you have a line feed at the end of the 
     file that you are feeding in. 
     If the outputXMLFile has been provided, the XML response is written to that file.  
     If it is not provided, then the client uses the inputXMLFile name to generate an 
     output filename.
     e.g.  If your inputXMLFile name is: add_sp.xml, then the response will be put in 
             the file: add_sp.reponse.xml.
     The ociclient exits after the request in the inputXMLFile has been executed.
 
     2) INTERACTIVE MODE
 
     If you do not provide the inputXMLFile name, the ociclient works in an interactive 
     mode.  In this mode you can feed multiple input files containing the XML requests.  
     In this mode the argument -o outputXMLFile provided at program startup is ignored.
 
       >>> help
       r[ead] inputXMLFile [outputXMLFile]
       q[uit]
       >>> 
 
       Use the r[read] command to read a request from the inputXMLFile.
       If the outputXMLFile name is not provided, the client uses the inputXMLFile name 
       to generate an output filename.
       e.g.  If your inputXMLFile name is: add_sp.xml, then the response will be put in 
       the file: add_sp.reponse.xml.
       Use the q[uit] command to exit the interactive mode and the ociclient.
 
    The XML request and response are always displayed.  The XML response is 
    formatted with tabs and newlines.  The XML request that is read from the 
    inputXMLFile is not formatted.  It is just displayed the way it is in the file.
    The ociclient also displays the name of the output file to which the XML response 
    is written.

INCLUDED FILES:
   -------------------------
   d:\ASOCISoapClient/            *.bat, *.config, build.xml, README's
     classes/                     generated
       com/
         broadsoft/
           clients/
             cap/                 cap client code
             oci/                 oci client code
             oss/                 oss client code
     src/
       com/
         broadsoft/
           clients/
             cap/                 cap client code
             oci/                 oci client code
             oss/                 oss client code
     testdata/
       oci/                       oci test xml transactions
       oss/                       oss test xml transactions
     lib/                         required jar files

NOTES:
-----
1. You will need to define the JAVA_HOME environment variable to point to the directory 
	where you installed jdk (eg JAVA_HOME=D:\jdk1.5.0).  Alternatively you can edit the 
	startossclient.bat file to change the %JAVA_PATH% by the Java bin directory path 
	(e.g. D:\jdk\bin) in the following line -

%JAVA_PATH%\java com.broadsoft.clients.oci.OCIClient %0 %1 %2 %3 %4 %5 %6 %7 %8 %9

After the change it will look something like
D:\jdk1.5.0\bin\java com.broadsoft.clients.oci.OCIClient %0 %1 %2 %3 %4 %5 %6 %7 %8 %9


