CD Actual 8

home *** CD-ROM | disk | FTP | other *** search

/ CD Actual 8 / CDACTUAL8.iso / progs / ite / ite10d1.exe / DATA.Z / README.TXT < prev next >

Wrap

Text File | 1996-09-07 | 23.7 KB | 440 lines

------------------------------------------------------------------------------- IntraBuilder Prebuilt Business Solutions Version 1.0 README.TXT Updated 5:00 PM 9/4/96 This file contains information about the prebuilt business solution applications that come with IntraBuilder. 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 six prebuilt business solutions: - Knowledge Base - Guest Book - Mail Server - Phone Book - Security Administrator - Contact Manager 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. ------------------------------------------------------------------------------- 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 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 ------------------------------------------------------------------------------- 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 <pre> and </pre> 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 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. ------------------------------------------------------------------------------- USING THE PHONE BOOK BUSINESS SOLUTION ------------------------------------------------------------------------------- The Phone Book application can be used within a company or department to quickly retrieve information about coworkers, such as their phone number or location. You begin the phone book application by viewing one of the two phone book lists. The phone book can be viewed alphabetically or by department. The alphabetical list is PHONEEMP.JRP and the department list is PHONEDEP.JRP. These lists may contain all the data that you need. But to get more information and a picture of any employee, simply click on the employee's name. The name acts as a link to a document specific to that employee that includes a picture as well as their department and position. In addition to the list and detail views, there is also a Phone Book Administration page for updating the employee data. If you are viewing the detail page for an employee you can use the update link to update that employee. When viewing the reports, the update link takes you to the first employee (by default). The administration form allows you to update employee records as well as do searches, additions and deletions. The administration form is password protected so that only managers may update employee records. Each employee may also update their own record. If an employee (not a manager) loads the administration page, they will only see their own record (even if they tried to update a different employee's record). For demonstration purposes, you may use the first name of any employee shown in the phone list as a user name. The passwords match the user name. When viewing the department list, titles are shown. Use this information to find the user name of any manager. Whenever a user is viewing their own employee record, there is an additional button to update the security profile. This updates information in the security system, not the phone book. Users can use this to update their description or password. When you are logged into the administration form as a manager, you also have the ability to update the department lookup table. The department update form displays a list of departments. You can add or delete department names from the list. See the Security Administration prebuilt business solution for more information about setting up this type of security. ------------------------------------------------------------------------------- USING THE SECURITY ADMINISTRATION BUSINESS SOLUTION ------------------------------------------------------------------------------- The Security Administration prebuilt business solution is used to manage the various aspects of an application security system. You can define users, groups, resources and policies. The security system is used by each of the other solution applications. You will find a link to the Security Administration solution on the INDEX.HTM page. The Security Administration page is password protected. Only members of the Administrators group can access this page. For demonstration purposes you can use the user name "SYSDBA" and the password "masterkey" to access the form. Before deploying your own system with security, be sure to create a new user in the Administrators group and then delete the SYSDBA user (or at least change the password). The security system main page allows you to view a list of users, groups, resources or policies. You can add new items, add a copy of an existing item, update an existing item or delete an existing item. The Policy Administration form lets you update system policies as well as create your own policies. A policy is configuration information that is used throughout the security system, and is not specific to any one user. The system policies have to do with passwords and lock outs. The password policies are called CASE, MINPASS and MAXPASS. The CASE policy determines whether the security system treats passwords as case sensitive or not. Names are never case sensitive. By default the passwords are not case sensitive either. MINPASS and MAXPASS define the minimum and maximum length of a password. This is enforced when creating a new user or when users change their password. The lock out policies are AUTORESET, LOCOUNT and LOMINUTES. A lock out occurs after several failed login attempts in a certain amount of time. This security feature is designed to deter attempts to break into a secure system. The LOCOUNT policy determines the number failed logins that will trigger a lock out. This is set to zero by default, disabling lock out security. The LOMINUTES policy determines the amount of time that must pass before the lock out count for this user is reset. The AUTORESET policy affects what happens after a lock out has occurred. If this is set on, then the locked out account will be cleared after the LOMINUTES period has passed. If this is set off, then only the system administrator can clear the account (this is done using the User Administration form described below). Note that policies may either be set to a boolean value or a numeric value. (System policy types can not be changed.) Because of this there are two places to set the value. Use only the On/Yes/True checkbox when setting boolean policies, and the Numeric Value text control when setting numeric policies. The User Administration form lets you create a new user or update an existing user. You can enter basic information such as name and description. In addition you can make group and resource assignments. You can temporarily disable a user account by checking the Account Disabled option. If a user has been locked out, you can clear the account by unchecking the Account Locked Out option. The Group Administration form lets you create a new group or update an existing group. You can enter the description of a group. In addition, you can designate group members and designate the resources that this group has access to. The Resource Administration form lets you create a new resource or update an existing resource. You can enter the description of a resource as well as designate which groups and users can access this resource. The information defined in the Security Administration pages can be accessed by your own applications through the Security Manager API. This API is defined in the SECURITY.JS file in the Apps\Shared directory. Take a look at this file for more information about using the API. Take a look at the other prebuilt business solutions to see examples of using the API to provide security. ------------------------------------------------------------------------------- USING THE CONTACT MANAGER BUSINESS SOLUTION ------------------------------------------------------------------------------- The Contact Manager prebuilt business solution allows you to keep track of the people you interact with. You can keep personal information for each contact person. In addition you can track specific types of contacts, called events, for each person. The Contact Manager solution uses Access tables. To run this solution, you will need an ODBC Access driver. Once you have installed the ODBC Access driver, create an ODBC data source for the Contact Manager database. 1. Run the 32Bit ODBC Administrator. 2. Select the Add button in the Data Source dialog. 3. Select the Access Driver in the Add Data Source dialog. 4. Enter any Data Source Name, such as ODBC_Contacts. 5. Enter a description, if you wish. 6. Press the Select... button. 7. Use the Select Database dialog to select the Contacts.mdb file in the c:\Program Files\Borland\IntraBuilder\Apps\Contacts directory. 8. Press OK in the Select Database dialog. 9. Press Close in the Data Sources dialog. After creating the ODBC data source, you can create the necessary BDE alias. 1. Run the BDE Configuration program in the IntraBuilder program group. 2. Press the New ODBC Driver button. 3. Give the driver a name, such as ODBC_Contacts. 4. The Default ODBC Driver should be Microsoft Access Driver. 5. Select the Default Data Source Name that you created in step 4 of the ODBC setup above. 6. Press OK. 7. Select the Aliases tab and press the New Alias button. 8. Enter CONTACTS as the alias name. This name is required. 9. The Alias Type should be the ODBC Driver that you created in steps 2 through 6. 10. Press OK. 11. Select Exit from the File menu to close BDE Configuration. Once you have configured the ODBC data source and the BDE alias, you can run the Contact Manager prebuilt business solution. To run the application, select the Contact Manager link in the INDEX.HTM page. This first page allows you to manage events or contacts. The Events page allows you to view and update information about each contact event. An event can be any type of interaction between you and the people that you contact. Each event contains the name of the person making the contact, the person contacted, the start and end time of the event, the type of event and comments about the event. Using the tool bar at the bottom, you can navigate, add or delete records. There are also buttons at the button to generate reports based on the type of contact and the person making the contact. There is also a search button at the button of the page. The People page allows you to view and update the name, address, and phone number of each person that you contact. The toolbar at the bottom of the page allows you to navigate, add or delete records. The type of events displayed in the Events page are contained in a table named Types. To update this list, you can run the IntraBuilder Designer. Then select the Tables tab in the IntraBuilder Explorer. Then select the Contacts database from the Look In combobox. This will display the tables in the Contacts database. Double clicking the Types table will open it for editing. While editing you can use the Table menu to add or delete rows or to search for a particular record. ------------------------------------------------------------------------------- Copyright (c) 1996 Borland International, Inc. All rights reserved.