home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / s / s_trak10.zip / S_TRACK.DOC < prev    next >
Text File  |  1993-03-15  |  22KB  |  433 lines

  1.                           THE SERVICE TRACKER
  2.                              Clark Systems
  3.  
  4.                            Documentation File
  5.  
  6. INTRODUCTION
  7. ============
  8.  
  9.     Welcome to The SERVICE TRACKER, by Clark Systems. The purpose of The
  10. SERVICE TRACKER is to provide you with a simple, easy to use method of
  11. tracking customers, work orders, and invoices. This is accomplished in
  12. an easy to follow format of Lotus-like menu bars, highly intuitive
  13. screens and on-line help. The SERVICE TRACKER includes multiple print
  14. options, including Work Orders suitable for use by a field technician,
  15. and Invoices designed to be used for billing.
  16.  
  17.  
  18. QUICK START
  19. ===========
  20.  
  21.     Be sure that your CONFIG.SYS file includes sufficient FILES and
  22. BUFFERS. Files should equal at least 30 and Buffers should equal at
  23. least 20.
  24.  
  25.     Simply type GO (and press <Enter>) to start The SERVICE TRACKER. The
  26. first time the program starts it will generate it's own index files, and
  27. the sign-on screen will indicate this on the bottom line.
  28.  
  29.         After an introductory or sign on screen the operator will be
  30. presented with the initial screen, CUSTOMER INFORMATION. Menu options
  31. are fairly self explanatory and are explained in detail below. Use the
  32. arrow keys to move to a menu option, and <Enter> to select it (or press
  33. the first letter of the menu option). The <Esc> key is used to return
  34. you to a previous level, and, when at the CUSTOMER INFORMATION screen,
  35. will allow you to QUIT the program (as will the QUIT command).
  36.  
  37.     For a quick run through of the series of screens & operations in The
  38. SERVICE TRACKER review the following outline:
  39.  
  40.     CUSTOMER INFORMATION Screen: Maintain basic customer date
  41.  
  42.       - select ORDERS from the CUSTOMER INFORMATION menu and jump to the
  43.  
  44.           WORK ORDERS Screen: generate and Print Work Orders
  45.  
  46.             - select COMPLETED from the WORK ORDERS menu and jump to the
  47.  
  48.                 COMPLETED WORK ORDERS screen: enter information about
  49.                   work completed off a Work Order, including Parts
  50.  
  51.                   - select PARTS from the COMPLETED WORK ORDERS menu and
  52.                     jump to the
  53.  
  54.                       PARTS SCREEN: enter parts used on a Work Order
  55.  
  56.                   - select INVOICES from the menu and jump to the
  57.  
  58.                       INVOICE SCREEN: shows the results of a Completed
  59.                       Work Order, including any Parts Used, and from
  60.                       this screen you may Print Invoices.
  61.  
  62.     You can see that navigation is comparable to walking down, then back
  63. up a ladder. Each menu includes a QUIT command, which allows you to exit
  64. The Service Tracker.
  65.  
  66.  
  67. DISCLAIMER
  68. ==========
  69.  
  70.     Clark Systems and its agents make no claim of any kind, express or
  71. implied, including without limitation, any warranties of merchantability
  72. and/or fitness for a particular purpose. Clark Systems and its' agents
  73. shall not be liable for any damages, whether direct or indirect, special
  74. or consequential arising from a failure of this program.
  75.  
  76.     In no event shall Clark Systems or its' agents be liable to you for
  77. any damages, including lost profits, lost savings or other incidental or
  78. consequential damages arising from use or inability to use this product
  79. or any claim by any other party.
  80.  
  81.  
  82. SHAREWARE and REGISTRATION
  83. ==========================
  84.  
  85.     The SERVICE TRACKER is Shareware, meaning that it is not free but is
  86. being made available to you on a trial basis. If you use The SERVICE
  87. TRACKER beyond a reasonable trial period you are requested to register
  88. your copy with Clark Systems for the minimal fee of $29.00. In return
  89. you will receive one free update as the next one becomes available,
  90. access to low-cost future updates, the ability to disable the closing
  91. commercial, information on other Clark Systems database products and our
  92. eternal gratitude which, along with $.75 might buy you a cup of coffee.
  93.  
  94.     To register your copy of The SERVICE TRACKER send your check or
  95.  money order along with your name, address and preferred diskette size
  96.  to:
  97.  
  98.                         Clark Systems
  99.                         The SERVICE TRACKER
  100.                         129 Pitney Road
  101.                         Absecon, N.J.  08201
  102.  
  103.     You may do this most easily by letting the program print out an
  104. invoice for you. At the closing commercial (after quitting the program)
  105. be sure that your printer is on and ready and simply press 'P'. Complete
  106. the invoice, enclose your check and send it off!
  107.  
  108.     Clark Systems and the SERVICE TRACKER are not associated in any way
  109. with any Shareware distributor, and any fee paid to any such distributor
  110. does not constitute registration of The SERVICE TRACKER. Only payment
  111. made directly to Clark Systems constitutes registration as discussed
  112. above.
  113.  
  114.     The SERVICE TRACKER may be copied and distributed so long as no fee
  115. is charged beyond minimal shipping and handling costs, and provided that
  116. all files listed below are included.
  117.  
  118.  
  119. FILES YOU SHOULD HAVE
  120. =====================
  121.  
  122.     The files you should have recieved with the S_TRACK.ZIP file are:
  123.  
  124.                  ST.EXE             IN_HELP.DBF
  125.                  R_TRACK.DOC        IN_HELP.DBT
  126.                  IN_CUST.DBF        IN_HELP.TBK
  127.                  IN_JOBS.DBF        CUSTOMER.FRM
  128.                  IN_PARTS.DBF       INCONFIG.MEM
  129.                  GO.BAT
  130.  
  131.  
  132. ON LINE HELP
  133. ============
  134.  
  135.     Service Tracker On-Line Help is available at any time by pressing
  136. the 'F1' key. Navigate through On Line Help by using the <PgUp>, <PgDn>
  137. and arrow keys.
  138.  
  139.     On-Line Help can be modified by the user. Add to, erase or correct
  140. the help screens as you would if you were using any basic word
  141. processor, using navigation keys, backspace, <Ins>, <Del> and so forth.
  142. IMPORTANT. You must save any changes in the help screens by pressing
  143. both the <Ctrl> and 'W' keys simultaneously. Try it out! It's a simple
  144. way of making Help more effective for you and your operators.
  145.  
  146.  
  147. BASIC SYSTEM INFORMATION
  148. ========================
  149.                                                                          
  150.     All screens in The SERVICE TRACKER operate similarly. Each includes
  151. common features:
  152.                                                                          
  153.               - Horizontal Bounce Bar Menu on line one                   
  154.               - Active Screen Section Highlight Boxes                    
  155.                                                                          
  156.  
  157.     A. HORIZONTAL BOUNCE BAR MENUS
  158.                                                                          
  159.     The Lotus-like bounce bar menus incorporate highlighted menu options
  160. which are selected by either of two ways. The operator may:              
  161.                                                                          
  162.     1. use the arrow keys to move the cursor bar (the highlighted
  163. section over one of the menu-bar choices) horizontally along the top
  164. line of the screen to the function of choice, then select/activate that
  165. function by pressing the <Enter> key, or
  166.                                                                          
  167.     2. simply press the first letter of the function desired (if the
  168. menu bar has two selections starting with the same letter, the first
  169. selection from the left will be activated).
  170.                                                                          
  171.     In addition, the operator may return to the previous level in the
  172. system, or exit the system from the Customer Information screen by
  173. pressing the <Esc> key. Think of navigation through the system as a
  174. series of steps up and down a ladder: each step taken down the ladder by
  175. selecting a command requires a return step back up by pressing the <Esc>
  176. key.
  177.                                                                          
  178.  
  179.     B. ACTIVE SCREEN SECTION HIGHLIGHT BOXES
  180.                                                                          
  181.     Each screen beyond the Customer Information screen contains multiple
  182. information sections. Each of these sections is outlined with a box. The
  183. active section of the screen, that is, the section currently controlled
  184. by the menu, is that section which is surrounded by a dominent, thick
  185. gray line. The inactive sections are surrounded by a thin gray line.
  186.                                                                          
  187.     The purpose of this is to provide you with as much on-screen
  188. information as possible, while making the active section of the screen
  189. immediately apparent. For example, when you log onto the program the
  190. first screen you see is the CUSTOMER INFORMATION screen, which is
  191. surrounded by a thick grey box. If you then select ORDERS from the
  192. CUSTOMER INFORMATION screen the ORDER fields are added to the existing
  193. screen and the ACTIVE box now surrounds the ORDERS fields. You can still
  194. view the basic CUSTOMER INFORMATION data on screen, but may operate only
  195. within the fields surrounded by the Active Screen Section Highlight Box.
  196.                                                                          
  197.  
  198.     C. NAVIGATION
  199.                                                                          
  200.     You may move through the active database by utilizing the Up and
  201. Down arrow keys, PgUp and PgDn keys. This will step you 'up' or 'down'
  202. through your customer records, accordingly.
  203.                                                                          
  204.     When you are adding a new or updating an existing record you move
  205. through the on-screen fields by utilizing the arrow and <Enter> keys.
  206. Backspace may also be used but is not advised since this is a
  207. destructive key which will erase data as it moves over it.
  208.                                                                          
  209.  
  210.     D. CONFIGURATION SETUP
  211.  
  212.     The Configuration Setup Screen is available at any time after the
  213. sign-on message clears off the screen. The Configuration Setup is
  214. designed to allow you to personalize your invoices and enter a sales tax
  215. figure as may be necessary.
  216.  
  217.     This is a fairly straight forward operation. Press the 'F10' key to
  218. call the Configuration Setup screen. A simple two option menu in the
  219. center, lower half of the screen actives the configuration fields or
  220. returns you to the SERVICE TRACKER screen which you were on (as does the
  221. <Esc> key. Simply type in new or modify the existing information as
  222. appropriate, then select OK or Cancel from the confirmation pop-up
  223. screen.
  224.  
  225.  
  226.     E. MENU OPTIONS EXPLAINED
  227.  
  228.     Basic Menu Options or COMMANDS for the most part are the same from
  229. screen to screen with some screens having more options and some less.
  230.  
  231.     - Search (and set Index Order)
  232.                                                                          
  233.     The Search function allows you to quickly find important information
  234. in several ways. From the Customer Information Screen, for example, you
  235. may search for a customer by Customer Name or by Customer Number. From
  236. the Work Orders screen, you may search for a customer's Work Order by
  237. Work Order Number, or by the Date Ordered (date the work was ordered).
  238. The Customer Name and Customer Number are also know as search 'Keys'.
  239.                                                                          
  240.     Secondarily, searching resets the order of the database (the Index)
  241. to the order by which you searched. When you started up The Service
  242. Tracker it was sorted or indexed on the customer's name. If you then
  243. decided to search for a customer by customer number, the customer data
  244. would thereafter be sorted or indexed by customer number.
  245.                                                                          
  246.     This can be used simply to reset the order of the database to a
  247. preferred sorting scheme, in the event that you have a need or interest
  248. in viewing information in a particular order.
  249.                                                                          
  250.     When Search is selected, a drop down menu appears. Move the
  251. Cursor-bar to your choice and press <Enter>. A box will appear into
  252. which you must enter the appropriate information, such as a
  253. customer's name. If the program cannot find the name, another box will
  254. appear and tell you. If this is the case, recheck your typing, spelling,
  255. etc. If the search is successful, the new information will appear on
  256. screen.
  257.                                                                          
  258.     You will notice in all but the Customer Information screen that when
  259. the Search function is selected four options appear. Of these four, two
  260. appear in bright white type and two in grey type. Those appearing in
  261. grey are not available as search keys from that screen, and the cursor
  262. will simply skip over those choices.
  263.                                                                          
  264.     - Add                                                                
  265.                                                                          
  266.     Use this function to add a new record to the active screen's
  267. database. In the Customer screen, this adds new customers. When you
  268. select add, you will be presented with blank data 'fields' on screen
  269. into which you enter the new data. When the information in a field is
  270. complete, press <Enter> to move to the next field. After leaving the
  271. last field, a box will pop up asking you if you want to write the new
  272. information to disk, or save the data - this is known as a verification.
  273. Respond accordingly. Press <Esc> at any time to cancel the operation, no
  274. harm done.
  275.                                                                          
  276.     - Update                                                             
  277.                                                                          
  278.     The Update function allows you to modify existing information. When
  279. selected, the fields are activated much like they are in the Add
  280. function (except the existing information is presented for
  281. modification). Again, a verification is required to make sure you want
  282. to save the changes, and pressing <Esc> at any time cancels the
  283. operation, no harm done.
  284.                                                                          
  285.     Note that when the cursor is on the first letter of a field under
  286. Update and you press a key to modify the field, the field will blank
  287. out, saving you from having to type over or delete existing information
  288. in the field.
  289.                                                                          
  290.     - Number                                                             
  291.  
  292.     Number counts the number of records in the current database. In
  293. combination with the Query function, this can provide you with some
  294. interesting views of your data. For example, how many of my customers
  295. live in a certain town? How many have a certain zip code?
  296.                                                                          
  297.     - Query                                                              
  298.                                                                          
  299.     The Query function is very powerful. It allows you to establish
  300. 'conditions' under which only specified data may be viewed and utilized,
  301. and is best explained by example. Let's say you want to know how many
  302. customers you have in New Jersey.
  303.                                                                          
  304.         1. Select Query
  305.         2. From the Drop Down Menu select 'Create a New Query'.
  306.         3. Move the cursor-bar and select 'STATE'.
  307.         4. Select 'Equals' (this box is loaded with 'Operators'. These
  308.            may vary according to what you're trying to do.
  309.         5. The 'Enter the Target Value...' box appears. In this example
  310.            enter 'NJ'. Capitalization counts! Be careful.
  311.         6. The next box contains the 'Logical Connectors' 'AND', 'OR'
  312.            and 'DONE'. Select 'DONE'.
  313.                                                                          
  314.     The Query is set. If the record on screen is not a New Jersey
  315. customer the program will tell you so then, with your approval, go to
  316. the first record meeting your specification. If no records match the
  317. specification, in this example STATE = "NJ", the Query is cancelled.
  318.                                                                          
  319.     Existing Querys can be modified, added to (with the 'AND' logical
  320. connector) and cancelled.
  321.                                                                          
  322.     - Print                                                              
  323.                                                                          
  324.     Print options are available on most menus. When you select the Print
  325. function you will be presented with a drop-down menu indictating the
  326. available reports. Select the report of your choice.
  327.                                                                          
  328.     You should always be sure that your printer is ready to print before
  329. activating a print option. However, should you forget or should there be
  330. some unknown problem with the printer, the program will complain and ask
  331. you to correct it. Also, before beginning the actual print process the
  332. operator will be asked to verify that he/she wishes to proceed with
  333. printing the selected report.
  334.                                                                          
  335.     - Delete                                                             
  336.                                                                          
  337.     The Delete function is fairly self explanatory: erase the record,
  338. work order, invoice, etc. IMPORTANT! The erasure doesn't actually occur
  339. at the point when the operator selects 'Delete'. Instead the program
  340. marks the record for deletion later, when exiting the particular
  341. function, and even then the operator is given a chance to cancel the
  342. erasure.
  343.                                                                          
  344.     When a record is marked for deletion, a <Deleted> indicator appears
  345. on the status line (line 24, bottom of screen). To UNmark a record from
  346. deletion simple select 'Delete' from the menu once again. The <Deleted>
  347. indicator will disappear. If, after doing so you still are asked if you
  348. want to remove all records marked for deletion, simply respond with
  349. 'Cancel'.
  350.  
  351.     - Quit
  352.  
  353.     Selecting this option will always be followed by a verification
  354. request 'QUIT The SERVICE TRACKER?' to which you must respond 'OK' if
  355. you really want to quit, or 'CANCEL' if you change your mind or if
  356. you've hit the QUIT key accidentally.
  357.  
  358.     You may also QUIT from the CUSTOMER INFORMATION screen by pressing
  359. <Esc>. You'll still be asked for the verification to continue with the
  360. QUIT.
  361.  
  362.     - Other Options
  363.                                                                          
  364.     Each menu throughout The SERVICE TRACKER is somewhat unique,
  365. containing menu options not appearing on any other menu. Select F1 for
  366. Help at these screens for more detailed information.
  367.  
  368.  
  369. SYSTEM ERRORS
  370. =============
  371.  
  372.     The Service Tracker includes two error trapping mechanisms which
  373. will either control or record all system errors which might cause the
  374. program to 'crash'.
  375.  
  376.     In the case of print operations, the system will flash an error
  377. message on screen if the printer is not ready. For all other errors,
  378. hardware or software, the error system will sound a series of tones, pop
  379. a message up on screen reporting that an error has occurred and write
  380. the specifics of the error to an ACSII file titled 'ERROR.TXT'. This
  381. file, incidentally, doesn't come with the SERVICE TRACKER - it is
  382. created by the program when needed.
  383.  
  384.     You may review the ERROR.TXT file with any word processor or editor
  385. capable of opening an ASCII file. Each time such an error occurs it is
  386. added to the ERROR.TXT file. Errors include time and date, and are
  387. separated from other errors by a dashed line. Should you need to contact
  388. us about a recurring system crash which you cannot resolve yourself,
  389. have this information available.
  390.  
  391.  
  392. OTHER PROBLEMS
  393. ==============
  394.  
  395.     LOST DATA
  396.  
  397.     In all cases you should periodically back up your files to avoid
  398. loss of data due to unexpected problems like electrical outages, spilled
  399. coffee, etc. Simply keep a copy of all original files in a safe place
  400. and periodically copy (ie: backup) all (and only) the .DBF, .DBT, and
  401. .TBK files to a separate diskette. Do this by using either the DOS copy
  402. or xcopy commands, or a reasonably good commercial or shareware backup
  403. program. If your files do get clobbered, simply erase all files with the
  404. extension .NTX (the index files) and copy the backed up files over the
  405. existing ones. When you restart the program, new index files will be
  406. created automatically.
  407.  
  408.     This should help you avoid having to re-enter a lot of data should a
  409. problem arise.
  410.  
  411.     CORRUPTED INDEXES
  412.  
  413.     The only other serious problem might result from corruption of the
  414. indexes. Symptoms of such corruption are the inability to find items
  415. (which you KNOW are there somewhere) through the SEARCH function,
  416. failure of the program to display or print items which you KNOW should
  417. be there, Help screens that don't correspond to the appropriate area,
  418. etc.
  419.  
  420.      If you suspect such a problem you may correct it easily by
  421. (CAREFULLY) erasing all index files, ie: those with the extension .NTX.
  422. Do this either individually or with the DOS command 'ERASE *.NTX'
  423. (without the quotes). The next time the program starts up it will
  424. automatically create the needed index files and the data files will once
  425. again be properly indexed.
  426.  
  427. ===========================================================================
  428.  
  429.     IN CLOSING...
  430.  
  431.     Again, thanks for trying The Service Tracker. We hope you find it
  432. useful and that your business prospers.
  433.