------------------------------------------------------------------------------- IntraBuilder Prebuilt Business Solutions Client/Server Version 1.01 README.TXT Updated 2:00 PM 10/30/96 This file contains information about the prebuilt business solution applications that come with IntraBuilder Client/Server. For general information about IntraBuilder see the README.TXT file in the main program directory (by default this is C:\Program Files\Borland\IntraBuilder). Server installation issues are addressed in the file SERVER.HLP, which is also located in the main program directory. General installation and uninstallation issues are addressed in the file INSTALL.TXT, which remains on your installation disk. This version includes eight prebuilt business solutions: - Knowledge Base for local .DB tables - Knowledge Base for InterBase tables - Web Utilities - Guest Book - Mail Server - Security Administrator (described in readme2.txt) - Contact Manager (described in readme2.txt) - Phone Book (described in readme2.txt) These applications are not just samples of the products capabilities. They are designed to be reused by you to meet specific intranet needs. In the sections below, you'll learn how to setup and run these applications. NOTE: The two versions of the Knowledge Base are not designed to be run at the same time. Attempting to run both of these at the same time will produce error messages. ------------------------------------------------------------------------------- INTRABUILDER PREBUILT BUSINESS SOLUTION SETUP ------------------------------------------------------------------------------- To run the prebuilt business solutions using your favorite web browser, the web server needs to be able to communicate with the IntraBuilder server and the IntraBuilder Server needs to be able to find the solution data. The installation program will take care of all configuration items so that your web server can communicate with the IntraBuilder server. The exception to this is when your web server is Microsoft's IIS. To run IntraBuilder applications with IIS, you need to make sure that your system login name matches the Anonymous Connections username in your IIS Manager setup. This is described in the SERVER.HLP file in your main program directory. If you encounter any problems getting the solution applications to run, see the SERVER.HLP file to make sure that the web server has been configured correctly to interact with the IntraBuilder server. After installing IntraBuilder, you can follow these steps to run the prebuilt business solutions. 1. Make sure that your web server is running. 2. Load the IntraBuilder Server on the same machine as the web server. 3. Load this page in the browser: http://servername/ibapps/index.htm 4. From this IntraBuilder Solutions Home Page, you will find links to each of the individual prebuilt business solutions. Just click on the link of your choice. The installation program will also take care of the configuration issues involved in connecting to the solution application data with the exception of the Contact Manager data. The Contact Manager application uses Access data and requires an ODBC Access driver. The ODBC and BDE setup is described in the Contact Manager section below. The other solution applications use Paradox tables and require only a BDE alias to connect to the data. This alias is automatically created for you by the installation program. If you ever need to recreate this alias, run the BDE Configuration program. This is in the IntraBuilder program group or Start Menu. Use the Alias page to define an alias named IBAPPS. The directory setting should match the full name of the Apps\Data directory; by default this is C:\Program Files\Borland\IntraBuilder\Apps\Data. ------------------------------------------------------------------------------- USING THE KNOWLEDGE BASE BUSINESS SOLUTION (Local .DB Version) ------------------------------------------------------------------------------- The Knowledge Base application allows you store information and then retrieve it through the use of a search form. The application includes an administration form that can be used to manage the Knowledge Base data (add, modify, delete) as well as a form for searching the Knowledge Base. To search for data, run the form KBSEARCH.JFM. There is a link to this form available from the INDEX.HTM page. The search form allows you to select a a product and/or category. Each of these lists include an "all" option. Note that this version of the Knowledge Base only includes a few sample entries for IntraBuilder itself. You can search for other products, but you won't find anything. You can narrow the search further by entering a single keyword. The search form looks for the keyword in the title of the documents as well as in the keyword list for each document. Optionally, you can have the search form search the body of the document as well. The keyword search is not case sensitive when searching the title and keyword list; however, it is case sensitive while searching the document itself. Once you have entered the search condition, click the Search button to get a list of documents that match your search condition. For those of you who like to look under the hood, look in the KBSEARCH.JFM file to see how the search is done. A select statement is created in KBSEARCH.JFM and is then passed as a parameter to KBRESULT.JRP. The Knowledge Base Results report lists each of the documents that match your search condition. The title of each document is a link to the document itself. You can simply click on the document title to see the full document. Also at the bottom of the report, there are links to the home page as well as a link to the search form. The documents in the Knowledge Base can be updated by using the KBUPDATE.JFM form. You can get to a link for this form from the INDEX.HTM page. The administration form is password protected so that only authorized users may update the data. This authorization can be granted using the Security Administration solution application described below. The Security Administration system was also used to create a resource named KBUPDATE. The Knowledge Base update page insures that only users with access to the resource are permitted to update data. For demonstration purposed, members of a fictional Customer Service department (see the Phone Book application to view the employees in various fictional departments) have been granted access to this resource. Two members of this department are Mark and José. Their passwords match their names. Once you have logged in, you can update the Knowledge Base documents. You can enter a title of up to 80 characters. You can select a product and/or category for this document. If you select the "all" option for product or category, the document will only show up if you query for "all." Use the keyword field to enter words that are related to the document subject. Keyword searches will search both the title and keywords field, so it is not necessary to list key words that are also in the title. The document itself can be entered into the TextArea box or you can copy and paste from existing documents. The administration form has an option labeled "Allow HTML formatting of this document." If you check this box, the document will simply be streamed to the web browser as normal text. This means that extra spaces and carriage returns will be stripped from the text. It also means that you can include HTML tags in the documents. If you do not check this box, the document will be sent to the browser as pre-formatted text (using the 
 and
tags). If you do not check the box, be sure to include carriage returns in your document. The administration form includes standard navigation buttons to move between documents. In addition there are buttons to add and delete records. When you add a record, be sure to Save or Abandon your changes when done. The Save and Abandon buttons can also be used while editing existing records. The New Filter button (on the far right) can be used to limit the number of documents that can be viewed. After you click New Filter, you can enter the filter conditions and press the Apply Filter button. To abandon the filter mode and return to the editing mode, select Abandon Filter. You can also use the Abandon Filter button to clear a previously set filter. The filter is not case sensitive. It will include partial matches from the left of a field, but it does not allow for matches in the middle or right of a field. The New Query button (second from the right) can be used to locate the next document that matches the query criteria. Once you enter the Query criteria and press Apply Query, you will be taken to the next record that meets the criteria. You are still free to navigate to other records after this. In addition to the Document Administration page, there is also a Lookup Administration page. This lets you update the two lookup tables that are used by the Knowledge Base solution. Load the KBLOOKUP.JFM page or select the Lookup Administration link on the INDEX.HTM page. This is password protected just like the Document Administration form described above. It allows you to add or delete items from the products and categories lookup tables. ------------------------------------------------------------------------------- USING THE KNOWLEDGE BASE BUSINESS SOLUTION (InterBase Version) ------------------------------------------------------------------------------- The InterBase version of the Knowledge Base works exactly the same as the local table version. See the section above for general usage information. The InterBase version has some subtle differences in the underlying code. This code is designed to interact with the InterBase server and to take advantage of such features as column constraints and stored procedures. Before running the InterBase version, you will need a copy of Borland's InterBase product. You can use either the Local InterBase product that is included with this copy of IntraBuilder Client/Server or the actual remote InterBase product (available separately). Once you have InterBase installed, you can follow these steps to prepare the data for use with the IntraBuilder application. 1. Copy the InterBase database file, KBASE_IB.GDB, to the InterBase server machine. Place the file in any directory on that machine. 2. Click the BDE Configuration icon in the IntraBuilder program group. 3. Click the New Alias button on the Alias tab. 4. Name the alias KBASE_IB. 5. The alias type should be INTRBASE. 6. The SERVER NAME Parameter should be the path to the database file. For instance: c:\intrbase\kbase_ib.gdb If you placed the .GDB on a remote InterBase server, then the SERVER NAME Parameter should also include the server name, such as: myserver:c:\intrbase\kbase_ib.gdb The actual format of the server name may vary depending on the network protocol used. See your InterBase documentation for more information. 7. Select File|Save and then File|Exit. 8. Load the IntraBuilder designer. 9. Set the IntraBuilder Explorer to Look In the Apps\KBase_IB directory. 10. Click on the Custom tab in the IntraBuilder Explorer. 11. Right click the Database.cc file and select the Edit as Script option. 12. The loginString parameter is currently set to the SYSDBA user with the default password of masterkey. If the SYSDBA user has a different password on your system, you will need to change the password here as well. If you do not want to use the SYSDBA user to login, you will need to create a user on the server with full rights to the KBase_IB database and then provide their user name and password here in the login string. 13. Select File|Save and then File|Close. After following these steps the InterBase version of the Knowledge Base will be able to access the database on the InterBase server. For the most part the application is the exact same as the local table version. The following files have been changed as indicated: *.JFM, *.JRP - The Database object has been replaced with a KbaseDatabase object. This class is defined in DATABASE.CC. KBRESULT.JRP - The HTML links have been changed to reflect the KBase_IB directory. KBDOC.JFM - In addition to the HTML links, the onServerLoad creates field level events for the Reformat field. InterBase does not have a boolean data type, so the field events convert the numeric field type to boolean so that the field can be data linked to the checkbox control. KBUPDATE.JFM - In addition to the HTML links and the field events for the Reformat field, the Rowset_onAppend() method was added to simulate the autoincrement field used in the local table version. This uses a stored procedure on the server to access an InterBase generator. The generated value is stored in the DocumentID field before the record is appended. The navigation and rowset events catch and report server errors. KBLOOKUP.JFM - The add methods have been modified to use stored procedures to simulate autoincrement fields. The delete methods use exception handling to catch server errors that might result from violation of foreign key constraints when deleting products or categories that are still present in the KBASE table. If you choose to use the Knowledge Base with a different data source altogether, you will need to update the files listed above to remove any of the InterBase specific dependencies. ------------------------------------------------------------------------------- USING THE WEB UTILITIES BUSINESS SOLUTION ------------------------------------------------------------------------------- There are two utilites for use by Intranet administrators. These are the IntraBot and the Crawler. There are links to both of these utilities on the INDEX.HTM page. To run the IntraBot, run the INTRABOT.JFM file, or select the appropriate link on the INDEX.HTM page. The IntraBot searches for HTTP (web) servers on an IntraNet. You provide a range of IP addresses and the IntraBot checks each machine in that range for an HTTP server. If a server responds, then the IntraBot requests the name of the web server software. The IntraBot only checks for HTTP servers on the port that you provide. Most HTTP servers are on port 80, but may be configured to use other ports. After the IntraBot has searched all of the IP addresses in the range, a report listing the HTTP servers is generated. This report shows the IP address, server name, web server software name for each server. The report contains a link to the Crawler form as well. Selecting the Crawl link next to a server will load the Crawler utility to search that site. After the IntraBot has identified the HTTP servers running on an Intranet, the Crawler can be used to inventory the documents that are available on any one of those servers. To run the Crawler, run the CRAWLER.JFM file, or select the appropriate link on the INDEX.HTM page. The Crawler can also be launched by selecting one of the Crawl links on the report generated by the IntraBot. The Crawler parses the home page on the specified site looking for links to other documents on the IntraNet. Each linked document is then searched for additional links and so on. You provide the name or IP address of the server, as well as the boundary IP addresses of the IntraNet. Only links to documents within this range are searched for additional links. Used in combination, the IntraBot and the Crawler allow you to identify web servers on the IntraNet and catalog the documents available on those servers. This powerful combination is intended for use by system administrators only. ------------------------------------------------------------------------------- USING THE GUEST BOOK BUSINESS SOLUTION ------------------------------------------------------------------------------- The Guest Book application allows you to enter a record of your visit to the site along with comments. You can then view the comments of others who have visited the site. Immediately after you enter your comments they are seen along with all the others. You will find a link to the Guest Book from the INDEX.HTM page. On the Guest Book Entry form, you have a link to the Entries page that lists all of the other entries. You can view the entries right away or wait until you have entered a record of your own. You can enter your name, email address, and location. The location can be any type of description such as your city, state, province or country. You can also check the box to indicate that this is your first visit. Then enter any comments in the box. When you are done, you can click the submit button to permanently record the entry. After submitting your entry, you will have the option of returning to the home page or of viewing the entries. When you view the entries, they will be presented in order by the date and time of the visit. The most recent entries are shown first, so your entry should be right there at the top. There is another link on the INDEX.HTM page to the Guest Book Administration page. This page allows you to view the guest book entries one by one. You can then edit the entries, search for entries, or even delete them. The administration form is password protected, so that only the web site administrators can update the entries. (See the Security Administration prebuilt business solution for more information on setting up this type of security.) The administration form is identified in the security system as the GUESTBOOK resource. Only members of the WEBMASTERS group have access to this resource. For demonstration purposes you can use any of these user names to access the update form: Eugenia, Luke, or Richard (passwords match the user names). ------------------------------------------------------------------------------- USING THE MAIL SERVER BUSINESS SOLUTION ------------------------------------------------------------------------------- The Mail Server Business Solution allows you to send Internet mail using an SMTP mail server. The solution application sends mail to the addresses that are stored in the Guest Book table. See the Guest Book solution described above for more information about the Guest Book. The INDEX.HTM page has a link to the Guest Book Mail Server page. This page allows you to enter your own email address (as the sender), a title and then the text of a message. This page sends mail to each address in the Guest Book, so there is no need to enter the recipients address. The Send Message button will begin the process of sending the mail to each recipient. The Guest Book Mail Server page also has a button for configuring the SMTP outgoing mail server. The Mail Server Configuration page allows you to enter the name of your SMTP mail server. Check with your system administrator for your server's name. The submit button will store the server name in the system registry at the IntraBuilder server machine. The setting is stored in HKEY_LOCAL_MACHINE\SOFTWARE\Borland\IntraBuilder\1.0\Guest Book\SMTP Server. You must specify the name of a mail server, before you can send mail. To integrate mail into your own applications, use the MAILSOCK.DLL file. The Apps\GuestBk\GBMail.jfm file demonstrates the use of this DLL to send mail. The DLL contains a function called sendMail. To use this function you must prototype it in your own IntraBuilder application. The prototype is: extern boolean sendMail(char* /*address*/, char* /*sender*/, char* /*subject*/, char* /*body*/ ) "mailSock.dll" Once the sendMail function has been prototyped, you can use it just like any built in JavaScript function. Assuming that there are already variables that contain the addresses, subject and body, you can send mail with this call: result=sendMail(address, sender, subject, body); The value returned from sendMail is a logical true or false. If true, the mail was sent, otherwise there was some sort of error communicating with the SMTP server. See the GBMail.jfm file for a working example. ------------------------------------------------------------------------------- (This document is continued in README2.TXT.) ------------------------------------------------------------------------------- Copyright (c) 1996 Borland International, Inc. All rights reserved.