home *** CD-ROM | disk | FTP | other *** search
/ Intermedia 1998 January / inter1_98.iso / internet / jwda01aa / readme.txt < prev    next >
Text File  |  1997-08-19  |  8KB  |  212 lines
  1.                       jWWWData
  2.               Vers. 0.1-aa / July 1997
  3.                Copyright (C) 1997 SW Wings
  4.  
  5. DESCRIPTION
  6.  
  7. jWWWData is JDBC Data Base Client specifically designed to be accessed
  8. and used on the World Wide Web.  jWWWData targets all the application
  9. domains in which it is required to make data available to a large forum
  10. of users, across the Web.  With jWWWData the end users interact with the
  11. data base, enter their queries (without having to know "SQL") and obtain
  12. their results directly at their location. The jWWWData Man Machine
  13. Interface gives the end users the feeling they are interacting with a
  14. local application and not with a remote data base system.  The same
  15. level of usability is offered to the people who want to publish their
  16. data. They only need to specify in a simple data definition language the
  17. data they want to publish and which end users (on the Web) are allowed
  18. to access and manipulate these data. jWWWData uses this specification to
  19. automatically create the data base, the required HTML form, the JDBC
  20. based CGI application as well as a set of tools to initially populate
  21. and maintain the data base. In other words people who want to publish
  22. their data on the Web do not need to know how to write HTML pages/forms,
  23. how to implement CGI applications or JDBC clients in Java and so on;
  24. everything is done for them by jWWWData. 
  25.  
  26.  
  27. INSTALLATION
  28.  
  29.  
  30. 1. Requirements
  31.  
  32. jWWWData is a Java application using the JDBC SQL API. Before
  33. downloading jWWWData you need first to download/purchase and install:
  34.  
  35. Case 1: ODBC Compliant Database
  36.  
  37.      Java JDK 1.1.2 and above; 
  38.      a ODBC compliant Data Base Management System; e.g. Microsoft's Access; 
  39.  
  40. The Java JDK 1.1.2 already contains the JavaSoft JDBC-ODBC Bridge Driver
  41. able interface to all ODBC compliant Data Base Management Systems. 
  42.  
  43. Case 2: JDBC Compliant Database
  44.  
  45.      Java JDK 1.1.2 and above; 
  46.      a JDBC compliant Data Base Management System; e.g. NCSA's Decibel; 
  47.      the related JDBC Driver. 
  48.  
  49. In some cases (e.g. Decibel) the Data Base management Systems is
  50. provided together with the JDBC Driver. 
  51.  
  52. NOTE: the proper installation and configuration of these Data Base
  53. Management Systems and their related JDBC/ODBC drivers is responsibility
  54. of the end users and is not described in this document. 
  55.  
  56. 2. Decompress jWWWData Distribution Files
  57.  
  58.  
  59. jWWWData distribution contains the following files:
  60.         htm_w32.zip  - jWWWData HTML documentation 
  61.         jwww_w32.zip - jWWWData class files 
  62.         readme.txt   - this file 
  63.  
  64. Supposing that the files set has been downloaded in the directory
  65.  
  66. c:\tmp
  67.  
  68. these are the commands that have to be executed:
  69.  
  70. c:                              (the actual target disk must be put
  71.                                  here, so instead of c: we could
  72.                                  have d:, e: and so on)
  73. cd \                            (to go to the root)
  74. pkunzip -d c:\tmp\htm_w32.zip   (to decompress the HTML files)
  75. pkunzip -d c:\tmp\jwww_w32.zip  (to decompress jWWWData files)
  76.  
  77. When using a Windows version on "pkunzip" care must be taken so that the
  78. original directories/files names are kept. 
  79.  
  80.  
  81. 3. Setting the WWW Server
  82.  
  83. The World Wide Web Server has to be set up in such a way that the
  84. jWWWData CGI can access all the relevant HTML files. Supposing that the
  85. server is similar to the NCSA one, hereafter are listed the required
  86. changes. 
  87.  
  88. 3.1 "access.conf"
  89.  
  90. In the file "access.conf" an entry similar to the following has to be
  91. inserted. This change will make the SWWINGS directory visible to the WWW
  92. Server. The actual syntax of the SWWINGS directory name depends on the
  93. operating system. In this example the Windows syntax has been used. 
  94.  
  95. <Directory C:/SWWINGS/>
  96. </Directory>
  97.  
  98. 3.2 "srm.conf"
  99.  
  100. In the file "srm.conf", and namely in the "alias" section, an entry
  101. similar to the following has to be inserted. This change will allow the
  102. hyper-links in the jWWWData HTML pages to work properly. The actual
  103. syntax of the SWWINGS directory name depends on the operating system. In
  104. this example the Windows syntax has been used. 
  105.  
  106. Alias /swwings/ C:/SWWINGS/
  107.  
  108. 4. Preparing for the first run
  109.  
  110. The environment variable CLASSPATH, which specifies where Java has to
  111. look for the class files, has to be modified so that it contains the
  112. location of the jWWWData class files. 
  113.  
  114. Supposing that jWWWData files have been put under "C:\SWWINGS" the file
  115. AUTOEXEC.BAT must contain an additional line like the following:
  116.  
  117. set CLASSPATH=....   (Your Previous CLASSPATH)
  118. set CLASSPATH=C:\SWWING\CLASSES;%CLASSPATH% 
  119.  
  120. In the same way the environment variable "PATH" must be updated so that
  121. it contains the C:\SWWINGS\BIN (or ~/swwings/bin) directory. 
  122.  
  123. It is now possible to create the first schema as described in the
  124. Detailed Description. 
  125.  
  126. When the schema is ready, users can ran the schema compiler
  127. (swwings.jWWWData.jDComp), using the script (jdcomp.bat or jdcomp.sh)
  128. provided in the C:\SWWINGS\BIN (or ~/swwings/bin) directory. 
  129.  
  130. This script will generate the Java module jDSchema.java and a set of
  131. scripts files (*.BAT and *.sh) and the starting HTML page. 
  132.  
  133. The Java module has to be compiled with the JDK compiler, using the
  134. following command:
  135.  
  136. javac jDSchema.java
  137.  
  138. The resulting class file jDSChema.class has to be put in the directory
  139. specified with the clause #schema-path in the schema itself (see the
  140. Detailed Description). 
  141.  
  142. The generated script files can be put, for convenience, in the
  143. C:\SWWINGS\BIN (or ~/swwings/bin) directory. The <output
  144. name>-cgi.(bat|sh) script needs to be copied in the directory where the
  145. WWW Server keeps the CGI scripts. 
  146.  
  147. The generated HTML page needs to be put in the directory, visible to the
  148. WWW Server, selected by the users as starting place for accessing the
  149. jWWWData system. 
  150.  
  151. The utility <output name>init.(bat|sh) and <output name>-load.(bat|sh)
  152. can now be used to initialise and populate the database. 
  153.  
  154. If everything went fine it is now possible to start jWWWData by opening
  155. with a WWW Browser the starting HTML page and clicking on the Start
  156. button. 
  157.  
  158.  
  159. REGISTRATION
  160.  
  161. jWWWData is shareware (and not freeware). If you find jWWWData valuable
  162. you should register it. 
  163.  
  164. The unregistered copy of jWWWData can only handle up to 50 records per
  165. data file. This constraint only applies to jWWWData CGI (i.e. all the
  166. other tools needed to locally create, populate and mantain the data base
  167. work normally).  Moreover the text "unregistered copy" is printed in the
  168. title of every single form used by jWWWData CGI and on a "Javascript
  169. scroller" in the status line of the browser. The registered copy does
  170. not have these limitations. 
  171.  
  172. To register check out the relevant HTML pages in the distributed
  173. documentation. 
  174.  
  175.  
  176. COPYRIGHT AND DISCLAIM
  177.  
  178. 1. Copyright
  179.  
  180. Copyright (c) 1996,1997 SW Wings.
  181.  
  182. Permission to copy, distribute and use the unregistered version of
  183. jWWWData and its documentation is hereby granted without fee, provided that
  184. the above copyright notice and this permission notice appear in all
  185. copies of this software and related documentation. 
  186.  
  187.  
  188. 2. Disclaim
  189.  
  190. jWWWData is provided "as-is" and without warranty of any kind, express,
  191. implied or otherwise, including without limitation, any warranty of
  192. merchantability or fitness for a particular purpose. 
  193.  
  194. In no event shall SW Wings be liable for any special, incidental,
  195. indirect or consequential damages of any kind, or any damages whatsoever
  196. resulting from loss of use, data or profits, whether or not advised of
  197. the possibility of damage, and on any theory of liability, arising out
  198. or in connection with the use or performance of this software. 
  199.  
  200.  
  201. PROBLEMS AND FEEDBACKS
  202.  
  203. Installation/usage problems, feedbacks and so on can be reported to
  204. SW WINGS. 
  205.  
  206. Alessandra Scarpari
  207. SW WINGS
  208. Van der Weijdenlaan 26
  209. 2211 JM Noordwijkerhout
  210. The Netherlands
  211. swwings@swwings.com
  212.