CD Shareware Magazine 1997 January

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

/ CD Shareware Magazine 1997 January / CD_shareware_1-97.iso / DOS / COMUNICA / WVTDLX13.ZIP / WVTDLX.DOC < prev next >

Wrap

Text File | 1996-08-23 | 25.9 KB | 516 lines

Who Visited Today Deluxe v1.3 (compiled 08/23/1996) by Gerard Johnson (C) 1995,96 KeySoft, Inc. - All Rights Reserved HOME BOARD: Top Cat BBS! - (813) 886-7177 [16.8k ZyXEL] SUPPORT BOARDS: PC-Help! - (813) 949-4993 [USR 28.8 DS] Dr Jack's Thing - (510) 689-4022 [v.34 28.8k] WVTDLX v1.3 - The ULTIMATE postcall utility for Wildcat! -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- COPYRIGHT ========= Who Visited Today Deluxe (WVTDLX) is NOT in the public domain, but rather is marketed under the shareware concept. It is copyrighted by Gerard C. Johnson and KeySoft, Inc. Wildcat! and WCCODE are trademarks of Mustang Software, Inc. This software may NOT be disassembled, decompiled, or reverse-engineered in ANY way for ANY reason. WHAT IS WVTDLX? =============== Besides being the most flexible Call Tracking/Drop Carrier post call utility, WVTDLX CAN READ **ANY USER ACTIVITY** LOGGED BY WILDCAT IN THE ACTIVITY LOG AND ACT ON IT IN ANY ONE OF 23 DIFFERENT WAYS using the powerful ActionWords internally defined. This product falls into the next generation of "intelligent" utilities for Wildcat!(tm) being released by KeySoft, Inc. WVTDLX is a wcCODE executable (WCX) exclusively for Sysops running Wildcat! ver 4.12 and above. The WCX will run in the "postcall" segment of a user logoff. This utility includes the new WOW (Wildcat! Open-ended WCX) technology from KeySoft in which predefined ActionWords allow the sysop to define what gets done when and under what circumstances (using the KEYWORDS.LST file). Here are just a FEW of the outstanding features: * 23 extremely powerful "ActionWords" puts this in a class by itself! * Bypass calls based on User names, Locations, or Security levels * Maintains drop carrier database and configurable display files * Creates Single call, Combined call and Drop Carrier displays * Ability to run external programs (.WCX and .EXE, .COM, .BAT) * Can Update callers' "Time Remaining" or "Billing Credits" * Send Users that drop carrier "personalized" messages * Grab callers Name, VPhone# or DPhone# to ASCII file * Can automatically create & format users 'Location' * Support for Wildcat! .IMP (import) message files * Use User's alias or real name in display file * Sysop definable colors, headers and footers * Sorts calls by time (in Combined Call list) * Sysop definable color codes for each field * Scans user activity for ANYTHING you want * Optional log editor (registered ver only) * Automatic File Attachements * Showcase registered users REGISTRATION ============ The program costs $10 (US) to register. There are various ways to register the program. You may fill out the REGISTER.TXT form in the archive, enclose $10 in the form of a check or money order made payable to KeySoft, Inc. and mail it to the address in the form. The fastest way to register the program is to call the HOME board or one of the support boards that accept online registrations and charge the registration fee online using a credit card or a checking/savings account. Your registration code will be generated right away and given to you if you use this online payment method. CHECK OUT THE FILE CALLED PROMO.!!! for limited special package pricing. Why should you register? The following are the benefits of registering the program: - UNLIMITED Keywords may be defined in the KEYWORDS.CFG file - Custom Header and Footer files may be incorporated into the display files created - Log editor comes alive - Free upgrades on all future versions (major and minor releases) Please be advised that the following are limitations of the program until it is registered: - Only the first 6 lines in the KEYWORDS.CFG are recognized - "Unregistered" text appended to display file. - Editor for log files is not usable - Custom Header and Footer files will not be recognized SETTING UP WVTDLX ================= WVTDLX is relatively easy to set up. If you have any problems, support is available on the Home board. The following steps should get you up and running in about 5 minutes: 1. Create a Directory ------------------ Create a separate directory for WVTDLX and unzip this archive into it. This is where the support files will be held. 2. Edit the Master Configuration file ---------------------------------- WVTDLX reads most of its settings from a configuration file called WVTDLX.CFG. This is a simple ascii file that must be modified to reflect your personal preferences. The format for each line is in the file itself and is self-explainatory. After you have edited this file, COPY IT INTO YOUR WILDCAT HOME DIRECTORY. So go edit it now! 3. Edit the Keywords configuration ------------------------------- This file determines what WVTDLX looks for in a caller's activity and how react to certain events (Drop Carrier, Uploading, Downloading, etc). The KEYWORDS.CFG file is extremely important so please take your time setting this file up. There are 23 "ActionWords" that are predefined and you may use these to customize how WVTDLX processes a caller. Refer to the section on "ACTIONWORDS EXPLAINED" for a description on all the ActionWords available and what parameters are required. 4. Bypassing Certain Users (based on User Name OR Security Level) -------------------------------------------------------------- There are a few "skip" files that may be set up to contain user names and security levels that are to be bypassed. The SKIPNAME.LST contains user names and SKIPLEVL.LST contains wildcat security levels that WVTDLX skips processing on. SKIPDC.LST contains user names that are not to be considered when creating the "Top Drop Carriers" display file and sending "drop" messages. 5. Skipping Nodes -------------- If you wish WVTDLX to skip ALL users/activity on a particular node, create a file called SKIPNODE.X (where x is the node #) in the directory created in step #1. The contents of the file is not important, just the name. For example, to skip all activity for node 3, you would create a file called SKIPNODE.3. 6. Customizing Display Colors -------------------------- The colors of each field is the display may be customized. Edit the CODES.TXT file to customize your display. Note that you may only change the color code for each field, not the order they appear in or the field names. 7. "Showcasing" Your Registered Users ---------------------------------- WVTDLX looks for an plain ascii file called REGLEVEL.LST. If it does not exist - no problem. If it does, then it should contain the security levels you assign to registered users. These names should be exactly how you have them defined in MAKEWILD and be one per line only. When a user logs off, WVTDLX will search for that particular user's security level in the REGLEVEL.LST file. If a match is found, then a 'R' flag is placed beside the user's name on the display file. If no match is found, the 'R' flag is not written. 8. Creating Header and Footers [Reg Version] --------------------------- If WVTDLX has been registered, you have the ability to add custom header and footer display files into the display file. These file names and paths must be defined in WVTDLX.CFG so WVTDLX can find them. To add a custom header to the drop carrier display file, name your header DROP.HDR and place the file in the directory created in step #1. 9. Setting up the WCX ------------------ To run correctly after a caller logs off, you MUST follow one of the following steps depending on if you *already* have a LOGOUT.WCX in your Wildcat home directory or not: 1) I CURRENTLY HAVE A LOGOUT.WCX: a. Rename that LOGOUT.WCX to LOGOUT1.WCX b. Copy WVTDLX.WCX into your Wildcat home directory c. Rename WVTDLX.WCX to LOGOUT.WCX d. Make sure WVTDLX.CFG is in the Wildcat home directory 2) I CURRENTLY DO NOT HAVE A LOGOUT.WCX: a. Copy WVTDLX.WCX into your Wildcat home directory b. Rename WVTDLX.WCX to LOGOUT.WCX c. Make sure WVTDLX.CFG is in the Wildcat home directory The reason for renaming your LOGOUT.WCX to LOGOUT1.WCX in step (1a) is so you do not lose any postcall processing you run now. WVTDLX looks for LOGOUT1.WCX when terminating and if found, runs it. 10. Relax ----- That's it - you are done. (Remember to log on and test it) SUMMARY OF ACTIONWORDS ====================== Here is a summary of all the ActionWords currently available, and a brief description of what they do. Please refer to the end of this document for a detailed description of what each ActionWord does and if any parameters are required. ActionWord Description ---------- ----------- AddCredits Adds billing credits to user AddTime Add minutes to the user's remaining time for today AddUserNameToFile Adds the user name to the file name specified AddUserVPhoneToFile Adds the user voice tel# to the file name specified AddUserDPhoneToFile Adds the user data tel# to the file name specified AttachFile Attaches a file to a message for the user ChangeSecLevel Sets the user to the new security level ChangeSecondaryLevel1 - Sets the user's secondary level #1 ChangeSecondaryLevel2 - Sets the user's secondary level #2 DoNotSkipUser Does not skip the user (Override "skip" files) FormatLocation Creates "location" based on Street & City info IncDLtot Increment the "Download" counter (for call) IncULTot Increment the "Upload" counter (for call) IncMSGTot Increment the "Message" counter (for call) IncDOORTot Increment the "Door run" counter (for call) LockUser Sets the "Lockout flag" in the user's record to "Y" LookFor Text in activity to look for (case sensitive) RingBell Rings the console bell (if on) for x number of seconds Shell Shells and runs a specified .EXE, .COM or .BAT file RunWcx Runs the specified .WCX pgm SendMsg Sends the contents of the file as a msg to the user SendDCMsg Sends the contents of a file as a msg to a user who DC's SendSysopMsg Sends the contents of the file as a msg to the sysop ACTIONWORDS EXPLAINED ===================== AddUserNameToFile(filename) This allows you to set up a keyword that will automatically add a user's full name to an ascii file. Eg: LookFor(GERARD)=AddUserNameToFile(c:\lists\names.lst) AddUserVPhoneToFile(filename) This allows you to set up a keyword that will automatically add a user's voice phone number to an ascii file. Eg: LookFor(GERARD)=AddUserVPhoneToFile(c:\lists\names.lst) AddUserDPhoneToFile(filename) This allows you to set up a keyword that will automatically add a user's data phone number to an ascii file. Eg: LookFor(GERARD)=AddUserDPhoneToFile(c:\lists\names.lst) AttachFile([message,]filename) This allows you to attach a file directly to a message for the caller. Since it is a "direct" file operation, you are responsible for entering a valid drive/path/filename for the parameter. Notice that this ActionWord can take a "message file name" as the 1st parameter. This is an optional parameter, but if included must be either an '.IMP' filename or the full path and file name to a message that will be incoporated into the message body together with the file attachment. Some example usages: Eg: LookFor(Newuser)=AttachFile(c:\info\register.zip) Eg: LookFor(Newuser)=AttachFile(welcome.imp,c:\info\register.zip) Eg: LookFor(Newuser)=AttachFile(c:\welcome.txt,c:\info\register.zip) ChangeSecLevel(level) This allows you to change the primary security level of a user after they have logged off based on a certain activity. This level name must be a valid Wildcat security level already defined. Eg: LookFor(registered)=ChangeSecLevel(FREE100) ChangeSecondaryLevel1(level) This allows you to change the 1st secondary security level of a user after they have logged off based on a certain activity. This level name must be a valid Wildcat secondary security level already defined. Eg: LookFor(registered)=ChangeSecondaryLevel1(FREE100) ChangeSecondaryLevel2(level) This allows you to change the 2nd secondary security level of a user after they have logged off based on a certain activity. This level name must be a valid Wildcat secondary security level already defined. Eg: LookFor(registered)=ChangeSecondaryLevel2(FREE100) DoNotSkipUser This allows you to override any values that might normally cause this user to be skipped during postcall processing. This KeyWord does not require any parameters. Eg: LookFor(Charge Master)=DoNotSkipUser FormatLocation This allows to you automatically create the users "location" based on City and State info the user entered. The text is neatly formatted and gives a nice uniform look to the contents. This KeyWord does not require any parameters. Eg: LookFor(New user added)=FormatLocation IncDLtot(x) This increments the 'total number of downloads' counter for the user's call by a numeric value of X. Eg: LookFor(] downloaded from (AREA )=IncDLtot(1) IncULtot(x) This increments the 'total number of uploads' counter for the user's call by a numeric value of X. Eg: LookFor(] UPLOADED in (AREA )=IncULtot(1) IncMSGtot(x) This increments the 'total number of messages' counter for the user's call by a numeric value of X. Eg: LookFor(line message left in)=IncMSGtot(1) Eg: LookFor(comment to sysop left)=IncMSGtot(1) IncDOORtot(x) This increments the 'total number of doors run' counter for the user's call by a numeric value of X. Eg: LookFor(* DOOR : )=IncDOORtot(1) LockUser This allows you to set the 'LOCKOUT USER' flag in the user's record. Please, note that once this flag has been set, the user will not be able to log on until the flag has been manually cleared. This ActionWord does not require a parameter. Eg: LookFor(Drop to Dos att)=LockUser LookFor(text to match in log) This is the main ActionWord that instructs WVTDLX *what* text to look for in a users activity. It is the only ActionWord that is placed to the left of the '=' sign and the parameter it takes is the text you want match before you execute the action defined to the right of the '=' sign. The parameter for this ActionWord IS case sensitive. Eg: LookFor(SYSOP)=RingBell(1) RingBell(x) This ActionWord rings the bell on the local console only. The parameter it takes is the number of times to ring the bell. Eg: LookFor([SYSOP])=RingBell(2) RunWCX(filename) This ActionWord shells WCXDLX out and RUNs another wcCODE executable. You are responsible for entering a valid drive/path/filename for the parameter. Care must be taken if you are using this ActionWord. If the program that WVTDLX shells out and runs crashes, then WVTDLX has no way of normally continuing. This ActionWord is provided only for experienced wcCODE programmers. Eg: LookFor(XYZ)=RunWCX(c:\wildcat\keygen\keygen.wcx) Shell(filename) This ActionWord allows the sysop to set up a keyword that when detected by WVTDLX, swaps WVTDLX temporarily out of memory, runs the file and then swaps WVTDLX back in. Due to the obvious power of this ActionWord, you should be aware that once WVTDLX has passed control to the shelled program, it is up to the shelled program to maintain the integrity of the process and hand it back to WVTDLX. Eg: LookFor(Test Test)=Shell(c:\temp\dellog.bat) SendMsg(filename) This allows you to send a message to a user. The message must already exist as a file, as it is this filename that will be passed as the parameter to this ActionWord. The ActionWord recognizes .IMP (import) files and automatically creates a private message to the user with the body of <<filename. Since Wildcat requires import files to reside in the Wildcat message directory, no path is required for .IMP files. Eg: LookFor(Charge Master)=SendMsg(c:\temp\thankyou.txt) Eg: LookFor(Charge Master)=SendMsg(thankyou.imp) SendDCMsg(filename) This is similar to the SendMsg Keyword with the exception that the SKIPDC.LST is checked first to see if the user should NOT be send the message. Eg: LookFor(CARRIER )=SendDCMsg(c:\temp\heyyou.txt) Eg: LookFor(CARRIER )=SendDCMsg(heyyou.imp) SendSysopMsg(filename) This is similar to the SendMsg Keyword with the exception that a private message is sent to the sysop instead of the user. Eg: LookFor(Upgraded)=SendSysopMsg(c:\temp\new.txt) Eg: LookFor(Upgraded)=SendSysopMsg(new.imp) PRACTICAL USES ============== The limitless combination of Actionwords and their uses are only limited by your imagination. Here are a few implementations of ActionWords being used by other systems as a quick glimpse of what WVTDLX can do for you: LookFor(New user questionnaire ans)=AttachFile(c:\texts\register.txt) This scans to see if a new user completed the new user questionnaire sucessfully, and if so attached the bbs registration form to a message. LookFor(QUES3.DAT has been comp)=AttachFile(beta.imp,c:\texts\nda.txt) This attaches the Non-Disclosure Agreement file to a custom message for a user that has applied to be a KeySoft beta tester by completing questionnaire #3. LookFor(did not finish new user qu)=SendSysopMSG(c:\texts\abort.txt) Send a message to the sysop notifying him that a new user did not complete the new user questionnaire. LookFor([CALC)=AddUserNameToFile(c:\lists\calc.lst) Appends the users name to a list of people that downloaded a particular file (in this case CALC12.ZIP). LookFor(wcCODE program: Top Ten executed)=IncDOORTot(1) Treats a user running a wcCODE program like running a regular door, and incrementing the Door counter by 1. LookFor(Charge Master executed)=RingBell(2) Rings the local console bell twice if the caller entered the online registration door during his/her activity online. FREQUENTLY ASKED QUESTIONS (FAQ's) ================================== Q. Why does WVTDLX only run with Wildcat v4.12 and above? A. Due to a bug in how Wildcat processes the LOGOUT.WCX in prior versions, the last line of a callers activity (in the log) is not written to the activity log until *after* the LOGOUT.WCX terminates (go figure). This was fixed in 4.12. Q. Why will WVTDLX v1.2 NOT run with Wildcat v5? Wildcat v5 will only run 32-bit WCX's. We are near release on WVTDLX v5.0st that will run on Wildcat v5. Q. Will my registration number for WVT work with WVTDLX? A. Unfortunately not. WVT was originally released as freeware in 1993 and will no longer be enhanced in any form. WVTDLX was released as shareware in 12/93 and is more than just a replacement. It contains features that no other utility comes close to incorporating. Q. After a caller logs off, I do not see any sign of WVTDLX running. A. Wildcat is quite strict on the name and location of the WCX that runs after a caller logs off. Make sure you have renamed WVTDLX.WCX to LOGOUT.WCX and moved it to your Wildcat home directory (C:\WILDCAT or whatever it might be). Also verify that the WVTDLX.CFG is in your Wildcat home directory. Q. How come no callers show up on the Drop Carrier display file? A. Line #12 in the configuration file (WVTDLX.CFG) contains a value that determines how many times a user must drop carrier before he/she will be placed on the display screen. Note that they must have *more* than this value to be displayed. If you enter a 3 on line #12, then callers that have dropped carrier more than 3 times will be considered for the list. Remember, caller names that are entered in SKIPNAME.LST and SKIPDC.LST and security levels that are entered in SKIPLEVL.LST are not included in the Drop Carrier display file. Q. Can I increase the number of callers on the Drop Carrier display? A. Nope, it is internally coded to show a max of 10 callers (sorted of course). Q. How do I get certain users based on security levels to NOT show up on the displays created? A. Easily. Add the Wildcat security level you want WVTDLX to skip to the SKIPLEVL.LST (one to a line). A good level to add to this list is SYSOP. Q. How do I get certain users to NOT show up on the displays created? A. Just add the user name you want WVTDLX to skip to the SKIPNAME.LST (one to a line). Q. How come a user that drops carrier does not get the message send by the SendDCMsg() ActionWord? A. If the user's security level is in the SKIPLEVL.LST or their name is in the SKIPNAME.LST/SKIPDC.LST a message will not be sent to the caller. Secondly, if the correct path and filename is not entered as the SendDCMsg() parameter, the message will not be sent. Q. How come the totals for the Uploads, Downloads, Messages, and Doors for a caller show as 0 even though Wildcat logs these activities in the ACTIVITY.x log? Remember, YOU have total control as far as what to look for in the log after a caller logs off. The KEYWORDS.LST file tell WVTDLX what to look for and if a match if found, what to do. Q. Why does it seem like WVTDLX takes a long time to run? A. Remember WVTDLX does more than one thing when it runs. It can create up to 2 seperate caller display files (individual and combined calls), and a drop carrier display. In addition, it processes the ActionWords setup in KEYWORDS.LST. On average, WVTDLX takes anywhere from 4 to 11 seconds (avg) on a FULL postcall run. This time may be trimmed by as much as 50%-75% by reducing the number of display files you ask it to create (line #9, #10, #11 in the WVTDLX.CFG file) Q. Can I get the source code? A. Sorry, since other sysops are paying for it, it seems unfair to make the source code available. Q. Why should I register? A. To simply put it - WVTDLX is the most flexible, most powerful, most configurable and most affordable "Swiss army-knife" postcall utility for Wildcat! Registration is unbelievably cheap (even lower if you purchase a "bundled" pack) and all upgrades are FREE! Check out the file PROMO.!!! to see our low package registrations. TECHNICAL SUPPORT ================= Comments and suggestions about WVTDLX are welcome as well as any comments or suggestions that you may have in terms of additional utilities you would like to see written. I can be reached via the support board listed at the beginning of this document, via USNet Mail, or via the Internet at: gerard.johnson@topcatbbs.com The following keywords may be placed in a private internet message (1 to a line) addressed to ftp@topcatbbs.com that achieve certain things: HELP : retrieve list of all Keywords available at topcatbbs.com WVTDLX : retrieve latest version of Who Visited Today Deluxe KEYSOFT_INFO: list of all Keysoft Software, latest versions, etc. DISCLAIMER (Legal mumbo jumbo) ========== KeySoft hereby disclaims all warranties relating to this product, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose. KeySoft cannot and will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason. In no event shall the liability for any damages ever exceed the price paid for the license to use software, regardless of the form and/or extent of the claim. KeySoft owns all title to the software and its copyright, which are protected by copyright law and international treaty provisions. You may not alter, disassemble, decompile, or reverse-engineer the software. The user of this program bears all risk as to the quality and performance of the software. THANKS.. ======== Thanks goes out to ALL my beta testers that, as always, go where no other testers go. A special thanks to Jack Morcom at our West Coast Registration Site [Dr Jack's Thing BBS - (510) 689-4022] for tireless hours of testing & tons of great feedback. If you're out west a call to his excellent board is definitely worth it! To Mustang Software Inc. for Wildcat! and wcCODE, and to everyone who supports the shareware concept.