______________________________________________________________________________

Intranet Database Assistant (IDBA) README FILE
IDBA Version 1.1.
(C) Copyright 1996. Intranet 2001, Inc.
All rights reserved.
______________________________________________________________________________

Thank you for your interest in the Intranet Database Assistant. 
This file includes information on features, known problems, and
how to contact Intranet 2001.

Contents
--------

1. Introducing The Intranet Database Assistant.
2. Getting Started.
3. Basic Intranet Database Assistant Syntax for HTML.
4. KNOWN PROBLEMS.
5. Customer Feedback.



1. Introducing The Intranet Database Assistant
----------------------------------------------

The Intranet Database Assistant allows direct SQL connectivity between your 
HTML files and multiple ODBC (or direct*) data sources, with minimal overhead. 
IDBA is lightweight making it scalable. 

IDBA will fit in comfortably with an environment that scales from a personal 
peer computer that needs to display basic database information, through to a 
large corporate entity that has complex SQL queries.

Here are some the Intranet Database Assistant's powerful features:

1. It Generates HTML objects dynamically (like Tables and Lists) directly 
   from your databases, with minimal HTML maintenance. (No CGI involved !)

2. It allows multiple SQL queries within the same HTML page.

3. It allows HTML forms to store data directly to your databases.

4. It allows you to use the Web internally/externally to display HTML
   content directly from your databases.

5. It has Fax and Email capabilities that tie in with MS-Exchange.

6. Uses simple notation (no programming) to produce powerful results.


2. Getting Started
------------------

[Please ensure that you have ODBC installed on Windows 95. You can verify this by
seeing if there is an ODBC32 icon in your control panel.]

1. Run the executable IDBA.EXE found in the \Program Files\Intranet 2001\idba\program
   using StartMenu->Programs->Intranet 2001->Intranet Database Assistant.

   If IDBA appears in your Win95 ICONTRAY then RightMouseButton click on the icon,
   select "Open" or "Configuration" in the menu, and either the application or the
   configuration dialog will appear.

2. If you have a Web server running on your PC, then its port number address might
   confict with the IDBA's address. If this is the case, then change IDBA's port
   number to another value (e.g. 40) by (menu) selecting;

	View -> Configuration -> Server.
	changing Listen on HTTP Port: default (80) -> 40.
	Selecting Ok when done.

3. If you want to set up a default directory to store your HTML files,
   then (menu) select on 
	View -> Configuration -> HTML Files.
       	change default directory using the Browse button.

   Warning: If you change the default directory, the sample HTML files will
	    not run, unless an absoulte path to them is specified in your
	    browser.

4. To try the samples, you must have MS Access installed on your database.
   Specify a Data Source Name for the NorthWind.mdb sample that comes with 
   MS Access, using:

	Start -> Settings -> Control Panel -> 32 bit ODBC.

   Set the DSN to be "NorthWind".

5. Run your browser and select your localhost address by:

	http://127.0.0.1/

   [Note:	if you change IDBA's port number, then the string becomes;
		http://127.0.0.1:40/
		where 40 species the port number (as in step 2 above)]

   this should load in the QueryForm.htm file.
   At this point you should be able to submit queries, and modify
   the HTML files to see what IDBA can do.


3. Basic Intranet Database Assistant Syntax for HTML:
-----------------------------------------------------

All IDBA Syntax appear as comment tags within HTML pages, so that invalid
database access does not cause URL failures or bad appearances of Information.

An IDBA Query statement in HTML simply looks like this:

 <!Query::DSN=DataSourceName::SQL=SQL statement::TYPE=Output Format::END>

Output Formats supported by this evaluation copy are:
---------------------------------------------------------

1. TYPE=TABLE   - Generates a HTML <TABLE> object filled with data from your query. 
2. TYPE=ULIST   - Generates a HTML <UL> object filled with data from your query.
3. TYPE=OLIST   - Generates a HTML <OL> object filled with data from your query.
4. TYPE=MENU    - Generates a HTML <MENU> object filled with data from your query.
5. TYPE=SELECT  - Generates a HTML <SELECT> object filled with data from your query.
6. TYPE=MSELECT - Generates a HTML <SELECT MULTIPLE> object filled with data from your query.
6. TYPE=SPREAD  - Holds your query results in memory, for future access.
7. TYPE=MODIFY  - Inserts/Updates or Deletes data in your database.

!!! Please consult IDBA's help file for more details on IDBA objects and syntax !!!

More Output formats are supported in the Enterprise Edition.

Other IDBA-Specifiers
=====================

Error Reporting:
----------------

1. OK=XXX:: 	Outputs the user specified message "XXX" in HTML format
            	on success of a database query.

2. FAIL=XXX::	Outputs the user specified message "XXX" in HTML format
		on failure of a database query.

JUMP(vRelPathAndName) allows a jump to another HTML file, using the vRelPathAndName of that file.

e.g. FAIL=JUMP(c:\HTML\error.html):: will display error.html if an error in the query occurs

Accessing data in memory:
-------------------------

1. <!DATA(row,col)> allows you to access data as a result of a query which uses the type SPREAD.

row - zero based index into result table (zero will give column headers).
col - one based index into result table (zero is an illegal value).

e.g. <!DATA(0,1)> will access the header for column one and display it in HTML text.

Substituting Form variables
---------------------------

1. VAR(vName) will substitute the variable name vName with its value, and display it in HTML. 
Where vName=value is received through a POST or GET.

2. VARQ(vName) does the same as 1. In addition, it adds quotes to the substituted value for queries.
e.g.: VARQ(vName) where vName=Fred will result in 'Fred'.


Examples:
=========

(a) To output everything from a "Customers" database table as a HTML table;

<!Query::DSN=NorthWind::SQL=Select * From Customers::TYPE=TABLE::END>

(b) To output the customer name column from a "Customers" database table as a HTML list;

<!Query::DSN=NorthWind::SQL=Select CustomerName From Customers::TYPE=ULIST::END>

(c) To insert data into an "Employees" database table;

	<!Query::DSN=NorthWind
	       ::SQL=Insert into Employees 
			EmployeeID, lastname, firstname 
		     values 
			(25,John,Doe)
	       ::TYPE=MODIFY::
	END>

The above query is not very useful without variables. 

(d) To execute a Stored Procedure (only where supported by the database);

	<!Query::DSN=NorthWind
	       ::SQL=execute AddEmployee (25,John,Doe)
	       ::TYPE=MODIFY::
	END>


Forms And Variables
-------------------

As seen in the above examples, a query (especially where user interaction is involved)
is not very useful without the use of variables. This is where the HTML form
and the IDBA-VAR tag combine to make a powerful combination.

	Form.htm					  Action.htm
	|--------------------------|			 |----------------|
	| 			   | GET/PUT emp_id=2	 |		  |
	| Enter EmployeeID: [ 2 ]  |-------------------->| <!Query::...	  |
	|			   |			 | VAR(emp_id,NUM)|	
	| [Submit][Reset]	   |			 |  ...::END>     |
	|			   |			 |		  |
	|--------------------------|			 |----------------|


In the above diagram, a user inputs the variable 2 and selects "Submit". This
variable is passed through to the action.htm URL which contains an IDBA-Query.
The query is then executed using the variable 2.
 
IDBA-Variable specifiers are of the form:

	VAR(VARIABLE_IDENTIFIER)
	VARQ(VARIABLE_IDENTIFIER)

where VARIABLE_IDENTIFIER is the name of the control on the form page.
	
A Form-Action URL Example using variables:
------------------------------------------

Form HTML Page:

	<form METHOD=GET action = "SalesCategoryResult.htm" >
	<p><select name="CategoryNameX" size=1>
	<option selected>Beverages</option>
	<option>Condiments</option>
	<option>Confections</option>
	<option>Dairy Products</option>
	<option>Grains/Cereals</option>
	<option>Meat/Poultry</option>
	<option>Produce</option>
	<option>Seafood</option>
	</select></p>

	<p><input type=submit> <input type=reset></p>

	</form>

Result Query HTML Page:

	<!QUERY::DSN=NorthWind
		::SQL=SELECT * From [Sales by Category] 
			WHERE CategoryName = VARQ(CategoryNameX)
		::TYPE=TABLE::END>


4. KNOWN PROBLEMS
-----------------

The problems stated below are known and are being addressed for the release
version of IDBA.

1) Queries which generate very large tables do not get displayed at the client end, 
   although the query may succeed.

2) Certain ODBC drivers may cause problems.


5. Customer Feedback
--------------------

Your feedback, or comments concerning any aspect of this product is welcome.
If you have any questions, problems or concerns, please contact us using the 
Information below.

How to contact INTRANET 2001, Inc.
----------------------------------

Please contact us for more information at 

http://www.inet2001.com or
Email : info@inet2001.com 
	sales@inet2001.com

	
------------------------------------------------------------------------------
Intranet Database Assistant is a trademark of Intranet 2001, Inc. All other
product and company names are trademarks or registered trademarks of their
respective companies.
------------------------------------------------------------------------------
