ÛÛÛ ÛÛÛ ÛÛ ÜÜÜ ÜÜÜ ÜÜÜ ÜÜ Ü ÜÜÜ ÛÛÛ ÛÛ Þ Û ÛÜ ÛÜ ÛÞ Û Û Û ÛÛÛ ÛÛ Þ Û Û Û Û ÝÛ ÛßÛ ÞÛÛÛÝ ÛÛ ßßß ßßß ßßß ß ßß ß ß ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ CORPORATION ßßßßßßßßßß ÛÛÛÛÛÛÛÛÛÛÛßßßßßßßßÛÛÝ ÛÛÛÛÛ ÞÛÛ ÛÛÛÛÛ ÛÛÝ ÛÛÛÛÛ ÞÛÛ A C I D ADEENA Corporate Information Development System Version [Pre-Release] Report Title ±±±±±±±±±±±±±±±±±±±±±±±± ± SYSTEM USER'S MANUAL ± ±±±±±±±±±±±±±±±±±±±±±±±± This Report Was Produced For: PAULK Date Produced: 10/07/90 At: 08:58 Page No. 1 Date: 10/07/90 Time: 08:58:46 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±± Report Parameters ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͵ Index Criteria ÆÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ» º Data Base Records Sequence Is Based On The Following Key º º Fields: User Manual Formatting Sequence No. º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͵ View Criteria ÆÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ» º Data View Criteria Is Set To Include All Records In The Data º º Base -- No View/Filter Criteria Is Installed º º 367 Of 367 Records Match View Criteria º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͵ Report Features Selected ÆÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ» º The Following Features Were Selected For This Report º º  This Is A Summary Of Key Features Only º ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ ÛÛÛ ÛÛÛ ÛÛ ÜÜÜ ÜÜÜ ÜÜÜ ÜÜ Ü ÜÜÜ ÛÛÛ ÛÛ Þ Û ÛÜ ÛÜ ÛÞ Û Û Û ÛÛÛ ÛÛ Þ Û Û Û Û ÝÛ ÛßÛ ÞÛÛÛÝ ÛÛ ßßß ßßß ßßß ß ßß ß ß ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ CORPORATION ßßßßßßßßßß ÛÛÛÛÛÛÛÛÛÛÛßßßßßßßßÛÛÝ ÛÛÛÛÛ ÞÛÛ ÛÛÛÛÛ ÛÛÝ ÛÛÛÛÛ ÞÛÛ A C I D ADEENA Corporate Information Development System Version [Pre-Release] ±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± ± ± ± U S E R ' S M A N U A L K E Y F E A T U R E S ± ± ± ±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± 10/07/90/08:58 Copyright (C) 1989-1990 ADEENA Corporation All Rights Reserved A C I D is user supported software. It is not free, and it is not in the public domain. You are granted a limited license to use A C I D for a trial period. If you decide to continue using A C I D, you must register by sending $99 for registration, source code templates, complete User and Technical Manuals, and disks to the address below. ADEENA Corp., 1111 Evans Street, Bainbridge, GA 31745 Telephone: (912)246-6022 Non-registered users are granted a limited license to use this product on a trial basis, and to copy the package for trial use by others subject to the following limitations: The A C I D package must be distributed in unmodified form, complete with all files and documentation. No fee, charge or other consideration may be requested or accepted for program distribution with one exception. PC software libraries are entitled to charge a maxi- mum of $10 per distribution diskette to defray costs of copying and mailing. A registration form is included on the following page for your convenience. If you intend to use The A C I D System after an evaluation period, you must register the package. To do otherwise is a vio- lation of the distribution license and United States Copyright laws. REGISTRATION The "ShareWare" Version of A C I D will be released in mid to late October. In the meantime, this "Pre-Release" Version is offered for your review and comments, and as an opportunity for you to register at a cost significantly less than that which will be required after release of the ShareWare version. Registration at this time will entitle you to receive the full featured regis- tered version, technical support for six months, and automatic upgrade to any new versions released within that six months. If you have questions or comments about the ACID System please feel free to call the author, Riley Paulk, at (912)246-6022 any time. ============================================================ REGISTRATION FORM Total: $99.00 Payment by: ( ) Check () Money Order Name: _________________________________________________ Company: _________________________________________________ Address: _________________________________________________ _________________________________________________ City: _________________________________________________ State: ____________________ Zip Code: ________________ Telephone: (______)______-________ Make Check or Money Order Payable To ADEENA Corporation and mail this registration form to: ADEENA Corporation 1111 Evans Street Bainbridge, GA 31717 Attn: Riley Paulk Page No. 2 Date: 10/07/90 Time: 08:58:50 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±± 1. INTRODUCTION ADEENA's Corporate Information Development System [ACID System] is an Application Software Design, Development, Implementation, and Maintenance System. ACID was designed primarily for use in building and maintaining Applications Software Packages written in compiled Clipper/dBase programming languages. It is used throughout all phases of Applications Software Life Cycles. During the preparation of a System's Functional Requirements Specifications it is an invaluable tool in defining the new Sys- tem's requirements for Data Elements; Data Bases; data entry, storage, manipulation, and retrieval; and system documentation. Development of a Prototype of the New System during this Phase becomes a matter of days rather than weeks or months since the ACID System transfers to the New System a virtually complete op- erating environment based on infrastructure variables rather than hard coded source code. Transition from Requirements Analysis and Prototype Development to System Design using the ACID System is simply a matter of us- ing the next higher level of ACID tools. Since all data, speci- fications, and requirements germane to the New System are already in the ACID System the Design process begins immediately. In fact, with a properly developed Data Encyclopedia including Data Element Definitions and Relationships much of the New Systems Design is accomplished automatically by ACID. Unit and Integration Test Procedures development is largely an automated process in the ACID System. Test Procedures for the New System are largely a restatement of Functional Requirements Specifications entered during the Requirements Phase and need only be expanded on to create specific Unit Tests. System and Integration Tests are generated automatically by ACID based on machine analysis of the New System's source code. During the programming phase of New System production ACID really begins to shine. If the New System is based on the ACID System Shell it inherits more than 22,000 lines of source code that pro- vides more than three hundred data management processes. All of which has been thoroughly tested, is completely documented, and is accompanied by comprehensive Unit and Integration Tests. The writing of source code to accommodate those requirements that are specific to the New System is further enhanced by ACID's produc- Page No. 3 Date: 10/07/90 Time: 08:58:52 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±± 1. INTRODUCTION - Continued tion of Source Code Templates and the availability of an exten- sive Library of functions and procedures that may be called from within the custom code. In the Acceptance Phase of New System production ACID serves as a completely integrated point of reference for all system require- ments, design details, unit and integration testing, and final system operability. Beyond final product acceptance ACID provides a base from which maintenance of the New Application Software System may readily be accomplished. Without ACID, two extremely troublesome areas in the design and development of Applications Software Packages are matching fin- ished product to System Design and producing accurate, relevant System Documentation. With ACID, since the Finished Product is a direct result of information input and updated throughout all phases and since virtually all human intervention in the process is constantly cross referenced to existing System Parameters, the Finished Product can hardly be different from the design. When it is different it is by deliberate modification and not by chance. System Documentation, with ACID, is a directly derivable product of all phases of producing the Finished Product; is started when the name of the New System is entered into ACID; expands as the New System is defined, designed, and created; and changes in response to even the slightest modification to the New System. Key Features of the ACID System are listed below and are expanded on throughout the User and Technical Manuals. All features, functions, and procedures as well as all Data Elements used in the ACID System are provided for on-line reference through ACID's comprehensive, context sensitive Help System. When using the ACID System, the entire contents of its User and Technical Manu- als are no further away than pressing the F1 Function Key. 1.1. KEY FEATURES A unique, and very beneficial, feature of the ACID System is that virtually all of the Key Features of this System transfer, with very little editing, to any Application Software Package developed using this System. The majority of the features, functions, and procedures covered herein are made available to Page No. 4 Date: 10/07/90 Time: 08:58:54 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±± 1.1. KEY FEATURES - Continued Applications Packages developed using ACID and are contained in an Application System Shell -- that is they are essentially generic and apply equally to any Data Management Software Application. Features contained in the Applications System Shell are called from custom applications code by passing parameters to them that tailor their functions to the specific application requirements. An example of this methodology is the generation of Pick Lists or Look-Up Tables. Rather than writing new code for each Pick List or Look-Up table in an application the System Shell contains code that accepts parameters such as the Data Base to use, what Data Elements should be presented to choose from, whether or not editing of the List or Table is allowed, etc. The System Shell working in conjunction with the System's Data Encyclopedia then formats the screen, presents the list or table, and returns the User's choice or choices to the calling program. Those features that are not readily generic and must therefore be custom edited for the specific application are also made available to the target application through the use of Source Code Templates. Examples of this type include Screens, Reports, and Query functions.  SYSTEM REQUIREMENTS The ACID System Requires The Following For Dependable Operation: DOS Version 3.2 or Better 640K Of RAM Approximately 2M Bytes Of Hard Disk Space Preferred But Not Strictly Required: A Minimum Of 1M Bytes Of Free Hard Disk Space -- Data Base Management Systems require disk space to do Sorts, Packs, Indexing, etc. ACID will operate with less than this but there is no guarntee of dependability when its not available. A clean Operating Environment -- NO TSR's -- That is no Terminate and Stay Resident software installed. It will coexist with many but since there are so many and they change so often it has to be User Beware when Page No. 5 Date: 10/07/90 Time: 08:58:55 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  SYSTEM REQUIREMENTS - Continued it comes to TSR's.  INSTALLATION PROCEDURES: For a quick evaluation of the ACID System Pre-Release Version, simply unzip the two files ACID-PR2.ZIP AND ACID-PR3.ZIP in any drive and directory then type ACID. ACID will then do the rest. However, if you intend to do a thorough evaluation of ACID you might want to install it in the manner described following this paragraph. Then, when you register your package and receive the full featured ACID System, any work already done in ACID will be picked up by the upgraded version. The ACID System Pre-Release Version is designed to operate out of a primary subdirectory with one subordinate subdirectory. They are as follows: ACID Primary ACID System Subdirectory AC-DBFS ACID Data Bases and Related Indexes To install the ACID System: 1- Select the hard disk on which the ACID System is to be installed using DOS commands. 2- Create the two directories listed above using the DOS Make Directory Command. Type: MD \ACID [Enter] MD \ACID\AC-DBFS [Enter] 3- Move or Copy ACID-PR2.ZIP into the ACID Directory and "Un-Zip" it. Move or Copy ACID-PR3.ZIP into the AC-DBFS Subdirectory and "Un-Zip" it. 4- Change Directory to the Primary ACID subdirectory and Type: ACID [Enter] Page No. 6 Date: 10/07/90 Time: 08:58:56 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  ACID APPLICATIONS SYSTEMS INDEX: The ACID System tracks and processes the Design, Development, Implementation, and Life Cycle Maintenance of a virtually unlimited number of Application Software Packages.  CREATE NEW APPLICATION: Create a new Application by adding a record to the ACID Applications Systems Index file. ACID will prompt you for required information such as the new application's name, acronym, and other particulars and ask that you select the appropriate drive and path information. ACID will then create the new application's System Shell, Data Bases, and Data Encyclopedia. It will also transfer source code such as a working pull-down menu system, logo and system memory variables, and source code templates for data entry screens and reports. With minimal skills in dBase/Clipper programming languages, a working copy of Clipper S87 or better (dBase is handy but not necessary), the ability to read completely annotated source code and the ACID Technical Manual, and a reasonably good editor you will be able to produce custom Applications Software that includes virtually all of the features available in ACID itself.  AUTO UPDATE OF SELECTED APPLICATION: The ACID System is not only downward compatible with earlier versions, it automatically upgrades any Application Software developed with an earlier version of ACID to the level of the latest version of ACID in use. New features, improvements, and corrections are automatically incorporated into packages developed using earlier versions. After updating from ACID, recompile the Application and it is completely upgraded to the latest ACID standards.  APPLICATION USERS ACCESS MANAGEMENT: The ACID System includes a comprehensive User Access Control System which, when engaged, provides the System Administrator with the ability to restrict individual's access to only those applications necessary and within a particular Application provides multiple levels of access from Read-Only through total System Administrator access. Any Application developed with the ACID System inherits this full featured User Access Control System. Page No. 7 Date: 10/07/90 Time: 08:58:58 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  DATA ENCYCLOPEDIA: The heart of the ACID System is the Data Encyclopedia. The Data Encyclopedia includes specifics covering every Data Element within the Selected Application Package, the Data Bases in which they are maintained, their Points-Of-Origin, and a number of other factors germane to the management of information stored in and processed by the selected Application. When a new application is entered into the ACID System, ACID transfers to it all Data Encyclopedia information required by the System Shell. Ah Haa, within minutes of beginning development on a completely new application you now have around three hundred and fifty Data Elements defined, tested, and, most importantly, documented. Along with over 22,000 lines of Source Code to support it, also tested and documented. No longer a need to design the heck out of something for months on end and still not have anything that will run on a machine. On the serious side, it should be noted that when using the ACID System, one only has to have defined a single Data Base with one Data Element to begin creating a custom Application Package. Select "Ency/Incorporate Change" and ACID will create the Data Base, validate it and its Data Element(s), and begin the Documentation Process. On the other hand, when the Application has grown to enormous proportions, with hundreds of Data Bases and thousands of Data Elements, ACID never looses the "Bible" sheet that defines a critical Data Base, never forgets to include it in System Documentation, never forgets to generate Unit and Integration Tests to validate it and the functions that process it, and, in fact, will not even allow you to defile its Data Integrity by re-using System Names or redefining Data Element parameters in another Data Bases even though the attempt to corrupt (inadvertent of course) takes place months after the first Data Element was defined.  DATA ELEMENT VALIDATION: Data integrity within ACID based Applications is of preeminent concern throughout the ACID System. ACID begins its interminable quest for data integrity with the definition of each new Data Element by thoroughly validating the Data Element itself. Validation extends far beyond such mundane features as insuring that dBase and Clipper programming conventions are adhered to. With the exception of Data Elements designated System or Global every Data Element used in an ACID based application has a single point-of-origin and input. Once data is typed in it virtually never has to be re-entered which significantly reduces data entry time and, more importantly, assures system wide data integrity. Page No. 8 Date: 10/07/90 Time: 08:58:59 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  DATA ELEMENT VALIDATION: - Continued Additional advantages of such extensive management of Data Elements include the ability to query an entire system by manipulating a single Data Element at its point-of-origin; perform global updates and corrections; and realize significant reductions in disk space requirements and system processing time through the use of SRNs (System Reference Numbers) rather than actual data items.  DATA RELATIONSHIPS: Data Element Relationships are used extensively throughout ACID to aid in normalizing Data Bases, defining Functional Requirements Specifications, developing Unit and Integration Test Procedures, and for cross referencing system documentation and context sensitive help screens. If a Data Element has a one-to-many relationship to another Data Element they should obviously be in two separate Data Bases -- right? How many times has one seen attendee1, attendee2, attendee3, ....... ad infinitum in Data Bases designed by less than fully astute analysts and programmers. If a Data Element relationship is "Calculated From" or "Concantenated From" other Data Elements there should be a Unit or Integration Test Procedure for assuring that that actually happens in the completed Application. ACID doesn't let one forget to do so.  SYSTEM DATA BASES MASTER LIST: ACID based applications maintain a master list of all Data Bases used by the Application. This Master List is used throughout system operations as well as the primary point of reference for the System Data Encyclopedia and System Documentation. One use of the Master List of Data Bases during system operation is to return Users to the point at which they left off when last using an individual Data Base -- the last record viewed, index used, and view criteria engaged. Data entry typists no longer have to search through hundreds, or thousands, of records or play with different indexes and view criteria to resume their work after a lunch break. ACID remembers the status quo for every Data Base in the System. It is normally desirable to sort Data Bases periodically and, with Data Bases in which memo fields are used extensively, it is paramount that they be periodically copied, with deleted set on, Page No. 9 Date: 10/07/90 Time: 08:59:01 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  SYSTEM DATA BASES MASTER LIST: - Continued in order to control run-away growth of their associated .DBT file. However, how many of us want to sit and watch a flashing sort message while the Application performs these mundane tasks. ACID based Applications accomplish these tasks in a most unobtrusive fashion. The Master Data Bases List is used to store a need to do sorts, packs, re-indexes, etc. If the User leaves the keyboard idle for ten minutes (adjustable) ACID based systems switch to "Auto Pilot" mode and begin performing these, among other, tasks. Leave the system loaded while you go to lunch and when you return its squeaky clean with all system housekeeping chores completed.  DATA BASE VALIDATION & MANAGEMENT: ACID based applications include Data Base Validation and Management routines that insure that all Data Bases used by the Application System are in complete compliance with the System's Master List of Data Bases and the System's Data Encyclopedia. New Data Bases are created based on parameters input into the Data Base Master List and their associated Data Elements in the System Data Encyclopedia and existing Data Bases are modified to comply with changes to their Data Elements without any loss of data they contain. Data Elements that are already referenced in source code may be only be changed by designated programmers.  INVENTORY DBFS DIRECTORY: During Data Base Validation any Data Bases found in the Application's Dbf Directory are noted by the System with options to ignore, erase, convert to back-up, or include as a valid part of the System. This feature is also very useful when using ACID to document or upgrade an existing Application. All Data Bases in a selected directory may be automatically inventoried and added to the Application's Master Data Base List and Data Encyclopedia. Page No. 10 Date: 10/07/90 Time: 08:59:02 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  DOCUMENTATION & CONTEXT SENSITIVE HELP: The ability to document Software Applications during the Design, Development, and Implementation Phases is, without a doubt, the most tedious task in the process. The ACID System is designed extensively around solving this problem. System documentation such as User's Manuals; Technical Manuals; System Unit and Integration Test Procedures, Plans, and Schedules; Data Encyclopedia including what Data Elements are included in the System, where they are located, and how to retrieve them; Index and View Criteria; Context Sensitive Help Screens; and virtually all other Systems type documentation needs are tied directly to the Source Code for the Application System and to the Data Bases and Data Elements actually used by the System. Imagine being able to provide a complete and functional User's and Technical Manual and a complete Data Encyclopedia at the first Project Team Meeting after starting a new Application Project. With ACID this is more reality than dream. Since new applications inherit ACID's System Shell, which includes Data Encyclopedia, User, and Technical Manual much of the new application's documentation is already a done deed.  AUTO DOCUMENTATION FEATURES: As new source code is added to an Application System its contents are automatically added to System Documentation during system clean-up. Document elements are added for all new programs, procedures, functions, menus, menu prompts, and embedded help topic variables found in the source code during analysis. As the programmer, analyst, or writer reviews these new elements and assigns sequence numbers several automatic formatting features are used to facilitate the process. When a sequence number is added to any document element from the new source code an option is provided to drag all unassigned document elements from the same program file. Menu prompts are automatically sequenced by the system based on progressive numbering from the first prompt in the series. When moving a document element to a new sequence location an option to move all subordinate elements is provided. As source code is modified, subsequent analysis will caused document elements that have been edited but are no longer applicable to be flagged with an asterisk signifying that they are candidates for deletion. Document elements that have not been edited and are no longer applicable due to changes in the Page No. 11 Date: 10/07/90 Time: 08:59:04 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  AUTO DOCUMENTATION FEATURES: - Continued source code are purged by ACID.  CONTEXT SENSITIVE HELP: ACID based Applications inherit extensive Context Sensitive Help features. The System's entire User and Technical Manual as well as its Data Encyclopedia are incorporated into an on-line, context sensitive, help system. When editing a Data Element the ACID Help System will provide the User with an explanation of the data that should be entered, any restrictions that may apply to that data, possible or intended sources of the desired data, cross references to other data, and any other factors affecting its integrity. While viewing the help screen provided, the User may browse through other adjacent data elements in the Data Encyclopedia. If the F1 function key is pressed while not editing a Data Element the ACID Help System will display that section of the User's Manual most closely related to the current point in system operations. Pressing the ^PgDn/^PgUp key combinations will cause the next/previous topics in the User's Manual to be displayed. If the User is still not clear on what to do, pressing the F1 Key again will cause ACID Help to display the entire User's Manual/Help System Table Of Contents for the User to select from.  WIP [WORK-IN-PROGRESS] NOTES: Work-In-Progress Notes -- WIP Notes are used to enhance communications between Analysts, Programmers, and other Design, Development, and Implementation Team Members. These notes may be included in User's and Technical Manuals during Design, Development, and Implementation Phases or they may be omitted by not selecting the WIP feature when printing these manuals. These notes are not necessarily intended to become a part of Final versions of the User's and Technical Manuals. However, they should prove useful as information sources for Analysts and Writers in developing and refining these manuals and especially useful to Programmers and Analysts in developing Unit and Integration Test Procedures, Plans, and Schedules since it is anticipated that they will be used largely to address problems and solutions to problems encountered during development. Prior to delivery of the final version of an application system to End User's all WIP Notes should have been removed from the Page No. 12 Date: 10/07/90 Time: 08:59:05 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  WIP [WORK-IN-PROGRESS] NOTES: - Continued System. Either having been incorporated into the Manuals by being edited appropriately and changing their "Include In" Code from "W" to "U" - User's Manual Only, "T" - Technical Manual Only, or "B" - Both User's and Technical Manuals or by being deleted.  UNIT, INTEGRATION & OPERATIONS TESTING: As with System Documentation, System Unit, Integration, and Operations Testing is linked directly to System Source Code and the System Data Encyclopedia. During the Analysis of the System's Source Code every Program, Procedure, Function, and Process used in the System is identified and locked into System Documentation and Testing. If it shouldn't be Documented and Tested, it shouldn't be in the Source Code. Users Do Not Have the option of deleting functions defined in Source Code and detected during the analysis of that Source Code. They may call it anything they like but they can't make it go away. This might even encourage Programmers that write code by the pound to be a bit more careful about how they structure their code -- after all, it is well known that the very last thing any programmer wants to do is document anything. Better Structure -- Less Code. Less Code -- Less Documenting. Less Code -- Better Application. Remember the days when MainFrame Programmers were paid bonuses based on how many lines of code they wrote. But, then, MainFrame Programmers didn't have to live in a little box called 640K of RAM did they. There are several steps involved in developing, implementing, and managing the ACID approach to Unit, Integration, and Operations Testing of Applications Packages. The ACID approach is essentially based on common sense, that is, take care of all the little things and the big thing will be OK. The ACID Test Process begins with the definition and quantification of individual tests for every identifiable function in the System. If the function is to draw a box, then the expected result of the test would be that a box gets drawn somewhere. Now, that's simple enough isn't it. on the other hand, try quantifying whether or not the Application system effectively schedules 8,000 events, during the next two years, at five different locations, using 24,198.5 individual work days (one person quit after half a day), and did so with minimal complaints, and maximum utilization of resources. OK, extremes in both directions, but maybe it illustrates the ACID approach. Test procedures with anticipated results, and a method of quantifying those results are defined for individual functions. That's logical functions folks, has very little to do Page No. 13 Date: 10/07/90 Time: 08:59:07 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  UNIT, INTEGRATION & OPERATIONS TESTING: - Continued with files, programs, procedures, functions, etc. One Program might be included that accomplishes dozens of functions in the Application, ergo dozens of tests; while another much larger program only accomplishes on function - one test. Nothing gets missed with ACID since it generates at least one test -- it must do something or we are back to programming by the pound -- for every definable function found during Source Code Analysis. Like the rain ADEENA's ACID covers all. Once again, based on Source Code Analysis and something called Programs Called/Called By, the ACID System generates an Integration Test Guide. Distinguish Guide from Plan in that the Guide is roughly put together by the System for human editing into what is defined herein as an System Performance/Integration Test Plan. Plug in people and time and the Plan become a Schedule with assignments, and you have accomplished and documented the Application System's Operations Test and/or Software Quality Assurance.  SCENARIO TESTS: Since Scenarios are most commonly the way in which an Application Software Package takes shape, one of the final steps in operations testing of an ACID based system is to do scenario tests. During the requirements analysis and requirements specifications phase of development; End Users, Analysts, and others describe what the system should do by describing a series of events and what they would expect the system to do under such circumstances. With ACID this series of events is entered as steps in a Scenario Test. What the End User or Analyst expects the system to do in each case is entered as test results. During the Requirements Analysis/Requirements Specifications Phase in developing an Application System the events and desired results described by End Users and Analysts in the form of scenarios are entered as tests and the desired results of those tests. During System Design and Programming, Programmers match process steps to tests and refine those processes to achieve desired results. ACID requires that at least one reference be made to the appropriate section in the User's Manual for each step in testing. Therefore, this approach should force Programmers to develop system documentation concurrently with system design and programming. All of these processes are accomplished from within Page No. 14 Date: 10/07/90 Time: 08:59:09 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  SCENARIO TESTS: - Continued ACID and many are automated functions.  SOURCE CODE ANALYSIS: This feature of the ACID System insures that User's Manuals, Technical Manuals and Context Sensitive Help Screens accurately reflect what the software is actually written to do. By analyzing the Source Code from which the working System Modules are derived these manuals and Help Screens will, at a minimum include comments covering every Program, Procedure, Function, and Menu in the System. In addition, this analysis detects a variable called "helptopic" which may be included at any point in the system's source code and creates a record for explanatory text or Context Sensitive Help information to be entered. This information will subsequently be available for inclusion in User's and Technical Manuals as well as being on-call by User's during system operations.  SYSTEM SHELL FUNCTIONAL AREAS The ACID System Shell consists of Data and System Management programs, procedures, and functions that are generic to any Application Software System. It serves as the System Shell for the ACID System itself and it transfers, without editing, to any ACID based Application System. This System Shell is provided to Application Systems produced with ACID through the use of a series of Object Files provided with registered ACID packages. The System Shell Object Files are then linked with custom application source code using Clipper Compiler batch files and link files which are also provided. Functions, procedures, and features in the System Shell are thoroughly documented in the System User's Manual with technical specifics on how to incorporate them into custom software provided in the System Technical Manual. Page No. 15 Date: 10/07/90 Time: 08:59:10 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  PULL-DOWN MENU SYSTEM: ACID employs a "Pull-Down" Menu System for all of its major functions and procedures. The complete source code for this menu system is provided with registered ACID packages as is all source code with file names like APP_????.PRG. When developing new Applications Systems this source code is edited to reflect the requirements of that Application. The first five Pull-Downs are application specific and may be used or omitted as required. The four remaining Pull-Downs encompass all System Shell specific functions and are intended to remain as provided but could be edited if desired.  SYSTEM DATA MANAGEMENT FUNCTIONS: The ACID Shell includes Data Management Functions such as adding, editing, and deleting records and sort/pack routines. Source Code Templates provided with registered ACID packages include all requirements for these functions and require very little editing -- usually limited to screen layout or report formatting.  INDEX CRITERIA DEFINITION: Users may define and modify as many as fifteen indexes for each data base used in an ACID based application. Index Criteria definition by Users is accomplished by selecting Data Elements from pick-lists which display Data Element's descriptive names as well as there system names. Programming conventions such converting numeric or date type data elements to character strings are accomplished automatically by the system. Index criteria statements are presented for User's review in English terms which means that virtually no knowledge of the programming language is required by Users when adding or modifying Index criteria statements. Technically oriented User's have the option of editing technical Index statements in order to create more complex criteria such as indexing in descending order, or removing case sensitivity. Indexes that are required for system operations (called for by system source code) are locked by the system precluding modification or deletion. Page No. 16 Date: 10/07/90 Time: 08:59:11 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  INDEX CRITERIA SELECTION: During system operations, such as browse/edit or report generation routines, User's may select indexes from a pick-list of those available and appropriate for use with the current function. After the desired index is selected the system will redisplay data in accordance with its criteria statement.  VIEW CRITERIA SELECTION: View criteria selection is based on selecting items from pick-lists that are presented in English rather than programming language. Several individual view criteria sets may be linked to create complex statements.  KEY WORD/TEXT STRING SEARCHES: ACID based Applications provide Users with the ability to search for Key Words and/or Text Strings in any one or any combination of Data Elements in the currently active Data Base. Data Elements to be included in the search are selected from pick lists with the selected combination being retained by the System for future use (may be changed when desired). A virtually unlimited number of Key Words and/or Text Strings may be entered to search for. While using this data location feature one might simply review information on screen, tag or untag records for further processing, ignore records that do not really apply to current needs, or pause the search temporarily to perform related tasks on records near those located.  RECORD LOCATOR FUNCTION: Individual records may be located by selecting the Data Element for which desired information is known and entering that information. As soon as the first character is entered the System begins searching. Searches are based on a unique algorythm that is significantly faster than normal data base location routines. The System will terminate the search and the need for additional input as soon as it determines that enough has been entered to locate the specific item being entered or the User can terminate the search upon reaching the general area of data desired. Page No. 17 Date: 10/07/90 Time: 08:59:13 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  RECORD TAGGING/UNTAGGING: Record Tagging and Untagging functions in ACID based Systems combine with other features such as View Criteria, Record Location, and Key Word/Text String Searches to create a uniquely powerful Data Management environment. Record tags are useful for producing selective queries and reports, data edting, and batch processing. By seting different view criteria and tagging all records in the, then, current view; by tagging records located during Key Word/Text String Searches; and by selectively tagging and untagging records during review, one is able to produce precisely the view of information desired. Once established this view can be used for on-screen queries, reports generation, and batch editing or other processing. Any view of this type can then be saved as a custom Query and recalled at a future time for use.  CONTEXT SENSITIVE HELP: Context Sensitive Help is available throughout this System. It includes direct, on-line access to the System's entire Data Encyclopedia, User's Manual, and Technical Manual. When editing a Data Element the System will provide the User with an explanation of the data that should be entered, any validation or other restrictions that may apply to that data, possible or intended sources of the desired data, cross references to other data, and any other factors affecting its integrity. While viewing the help screen provided, the User may browse through other adjacent (in fact, all) data elements in the Data Encyclopedia. If the F1 function key is pressed while not editing a Data Element the System will display that section of the User's or Technical Manual most closely related to the current point in system operations. Pressing the ^PgDn/^PgUp key combinations will cause the next/previous topics in the User's and/or Technical Manual to be displayed. If the User is still not clear on what to do, pressing the F1 Key again will cause the Help System to display the entire User's Manual/Help System Table Of Contents for the User to select from. Page No. 18 Date: 10/07/90 Time: 08:59:15 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  TEXT EDITING: Extensive Text or Memo editing features are incorporated to make this System a truly powerful data management tool. Complete Import and Export capabilities are included. Ever wish you could manage all those memos, letters, notes, and electronic mail even though they were produced on every conceivable type of Word Processing Package, Spreadsheet System, or network editor? Now you can! Create a simple Data Base Application into which you import them as text files. You can then sort or index them in any manner desired and even search through them for that one particular phrase that comes to mind;+ but, that you can not remeber when it was written or to whom it was addressed. You might even create topic sets based on Key Words or phrases and recall for review or printing every memo, note, letter, or piece of electronic mail related to the information desired -- how sweet it is.  AUTO PILOT/SYSTEM HOUSEKEEPING: Tired of waiting while your current data management application sorts or indexes your data bases. This System does it while you take a coffee break, go to lunch, or even while you sleep. It even remembers to do this when you forget to tell it to. Leave the System loaded on your computer while you answer that interminable telephone call and, after a time-out period you set, it will switch to System Auto Pilot and proceed to complete all system housekeeping chores that have been postponed while you were using the System. If you return before it is finished, escape and you are back at the point you were before you left. If you are gone long enough, you return to sorted, packed (where appropriate) and completely clean data. Which means faster access times, better overall operations, and more compact files. One problem dBase is notorious for is creeping, uncontrolled growth of text/memo files, this System's Pack routines compensate for that and keep such files trimed appropriately.  USER LOG-ON & ACCESS LEVELS: When implemented by the System Administrator, this System features complete User Access Control. Individual User's are assigned access levels -- Read Only, Selected Read/Write, Read/Write, etc -- appropriate to their needs. Once assigned access, User's input their own personal password which is encrypted by the System to protect against even the most determined hacker. Page No. 19 Date: 10/07/90 Time: 08:59:17 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  REPORTS MANAGEMENT & GENERATION Any Data Management System is only as good as the information it can provide and how readily it can be provided. Report Generation in this system is designed entirley around flexibility. A given report is actually numerous report formats combined in such a fashion as to allow individual User's the ability to produce an output of just the information they desire and not one phrase or data item more. User's select the index, view criteria, and features they desire before producing any report. Once a report is constructed it can be recalled and run at any time.  DATA ENCYCLOPEDIA - SYSTEM DATA BASES: This Report is designed to be an extremely flexible source of information for Analysts, Programmers, and other Design and Development Team members to use in designing, coding, testing, and documenting Application Software Systems. It makes available reports ranging from a bare minimum summary of information about the Data Bases used in an Application System to a massive amount of analytical data about those Data Bases. The Summary version is for those individuals who are already suffering from information overload or who only require a bare minimum of information to accomplish their task at hand. The full featured report is for those who feel a need to document everything or who simply want to put more paper on their desk to enhance their business quotient. Upon selecting this report the User is provided the opportunity to limit the amount of information included by establishing View/Filter Criteria. This View might include a single Data Base, several individully selected Data Bases, group(s) of Data Bases, or all that are used by this Application System. The View might be set similarly or concurrently for Data Elements. Having determined what data the report should process, the User is then provided with a selection of Features to include in the report. The two most prominent being, "Include All Features" and "Summary Report Only". Page No. 20 Date: 10/07/90 Time: 08:59:18 A C I D ADEENA Corporate Information Development System ±±±±±±±±±±±±±±±±±±±±±±±± ± System User's Manual ± ±±±±±±±±±±±±±±±±±±±±±±±±  SYSTEM USER'S MANUAL: The System User's Manual is available for printing, on-screen viewing, or output to a disk file to any User of this System. It includes explanations of System Functions, Features, and Processes. In many cases these items are explained in the form of scenarios -- how to accomplished a common data management or analytical task. One does not really need a printed User's Manual for this System since it is available in its entirety through the System's Context Sensitive Help functions, but is is avialble just in case.