home *** CD-ROM | disk | FTP | other *** search
/ Jason Aller Floppy Collection / 199.img / HYPE4.ZIP / SCRIPTS.DOC < prev    next >
Text File  |  1990-05-08  |  10KB  |  184 lines
  1.    -------------------------- HyperPilot Scripts  ---------------------------
  2.  
  3.    This file contains information not found in the manual about the 
  4.    HyperPilot scripts included with HyperACCESS/5.  This information 
  5.    includes:
  6.  
  7.       o   About HyperPilot Scripts
  8.       o   A note about logon scripts
  9.       o   Scripts supplied with HyperACCESS/5
  10.       o   Example logon scripts learned by HyperACCESS/5
  11.       o   Additions to HyperPilot
  12.  
  13.    ------------------------ About HyperPilot Scripts -----------------------
  14.  
  15.    HyperPilot scripts are procedures written in the HyperPilot language 
  16.    that can be run from within HyperACCESS/5 to perform a series of 
  17.    communications steps that you would otherwise have to perform manually. 
  18.    HyperACCESS/5 includes an assortment of scripts that perform useful 
  19.    functions.
  20.  
  21.    The supplied scripts can be used as is, or you can modify them to meet
  22.    your needs.  They also provide you with a good reference as you write
  23.    scripts of your own.  To learn how to use, modify, and write scripts,
  24.    read Chapters 11 and 12 in your HyperACCESS/5 manual. Before using the
  25.    supplied scripts, you may wish to examine them using the HyperACCESS/5
  26.    editor or a word processing program of your own.
  27.  
  28.    --------------------- A note about logon scripts -------------------------
  29.    
  30.    Logon scripts are HyperPilot scripts that can automate the process of 
  31.    logging on to a remote system.  In the past, a number of these scripts 
  32.    were provided to automate the logon procedure for such systems as Dow 
  33.    Jones, Compuserve, BIX, MCI Mail, and others.  HyperACCESS/5 eliminates 
  34.    the need for such scripts to be supplied.  With powerful learning 
  35.    features only a keystroke away, you can now "Learn" logon scripts to 
  36.    any remote system. When HyperACCESS/5 learns a logon, the script (a 
  37.    file with a .hp extension) is generated for you.  You can edit this 
  38.    script if you need to, but in almost all cases you will be able to use 
  39.    the script as is. For details on "Learning" logon scripts or automating 
  40.    other procedures, refer to Chapter 7 in your HyperACCESS/5 manual.  For 
  41.    a demonstration of learning a logon script, see Chapter 1, section 6 on 
  42.    calling A fake remote system.
  43.  
  44.    ------------------- Scripts supplied with HyperACCESS/5 ------------------
  45.  
  46.    ANSWER.HP - The HyperACCESS/5 answer script
  47.    CALL.HP   - The HyperACCESS/5 call script
  48.  
  49.    These two scripts are closely integrated with the program. When you 
  50.    select "Wait for data calls" from the Answer menu, or "Call a system" 
  51.    from the Main menu, you are actually starting the answer and call 
  52.    scripts, respectively. These two scripts contain the support for 
  53.    various modems and other communication devices.  Modifying these 
  54.    scripts is not recommended.  They do, however, use a great number of 
  55.    HyperPilot functions, providing a detailed reference of function usage.
  56.  
  57.    WELCOME.HP - The HyperACCESS/5 Host welcome message
  58.    
  59.    This script can be specified on the Answer/Privileges menu to send the 
  60.    calling computer a welcome message. The message can be defined within 
  61.    the script as this example demonstrates, or it can be an external file 
  62.    having the name WELCOME.TXT.  This script also demonstrates how the 
  63.    caller's name can be passed as an argument to the script so the welcome 
  64.    message can display that name. WELCOME.HP can easily be modified to 
  65.    suit your needs, or used as it is supplied.  See Chapter 8 for details 
  66.    on Remote use of scripts and programs.
  67.  
  68.    SET3101.HP - IBM 3101 terminal emulation setup
  69.  
  70.    This setup script for the IBM 3101 terminal emulator lets you set 
  71.    certain settings that correspond to hardware switches on real 3101 
  72.    terminals.  For details on using this script, see Appendix F regarding 
  73.    the IBM3101 emulator.
  74.  
  75.    SETVT.HP - VT terminal emulation setup
  76.       
  77.    This setup script for VT52, VT100, VT220, or VT320 terminal emulators 
  78.    lets you set terminal characteristics that correspond to certain 
  79.    hardware switches on real VT terminals. For details on using this 
  80.    script, see Appendix F regarding the VT52, VT100, VT102, VT220, or 
  81.    VT320 emulators.
  82.  
  83.    SPLITSCR.HP - An example of terminal emulation features
  84.    
  85.    This script can be run at any time from the communications screen. It 
  86.    divides the screen display in half, showing received text in one half 
  87.    and sending text in the other.  SPLITSCR.RDY achieves this split screen 
  88.    display by using HyperACCESS/5's VT100 emulator, and can only be used 
  89.    when the remote system expects to communicate with a TTY terminal.
  90.  
  91.    DEBUG.HP - A script writing tool
  92.   
  93.    This is a script writing tool.  When a HyperPilot script fails, 
  94.    DEBUG.RDY can be run to load the failed script into the keys editor and 
  95.    position the cursor on the offending line.  DEBUG.RDY is most 
  96.    effectively used when it is assigned to a function key or some other 
  97.    key combination that is convenient for you to use.
  98.    
  99.    MAIL.HP, CHKMAIL.HP, LOCAL.HP, ADDMAIL.HP,
  100.    SENDMAIL.HP, READMAIL.HP, MAINTAIN.HP - HyperACCESS/5's E-mail scripts
  101.    
  102.    These scripts can be used to add E-mail to HyperACCESS/5's host.  See 
  103.    the file EMAIL.DOC for a complete description on using these scripts.
  104.  
  105.    ------------ Example logon scripts learned by HyperACCESS/5 -------------
  106.    
  107.    Below are three example logon scripts for BIX, Compuserve, and MCI 
  108.    Mail. These scripts are provided as an example of what HyperACCESS/5 
  109.    generates as it learns logon scripts for you.  Although it is possible 
  110.    to edit these scripts by substituting your own user name and password, 
  111.    it is usually easier and more effective to learn new scripts.
  112.  
  113.    Logon scripts, one of the simplest applications for HyperPilot, can be 
  114.    written or learned.  Logon scripts typically use no more than 3 or 4 of 
  115.    HyperPilot's 150 functions, though some logons use as few as 2. The 
  116.    functions most often used are type(), wait prompt(), wait tenths(), and 
  117.    occasionally, wait seconds().
  118.  
  119.    type(), the most-used HyperPilot function simulates pressing keys on 
  120.    your PC's keyboard.  The keys may be responses to a remote system or 
  121.    keys that operate HyperACCESS/5 itself.  To include a special key or 
  122.    key combination in a type function, you must enclose it in angle 
  123.    brackets (i.e. type("<ENTER>") ).  Normal alphanumeric keys can be 
  124.    included as is (i.e. type("The quick brown fox") ).  See Chapter 12, 
  125.    page 245 for more details on the type() command.
  126.  
  127.    The wait prompt() function is one of several functions used to wait for 
  128.    responses from remote systems.  wait prompt() looks for a specific set 
  129.    of characters or hexadecimal values, followed by at least a 0.3 second 
  130.    delay. Thus this function can distinguish between a true prompt and a 
  131.    similar pattern of characters which may occur within bodies of text 
  132.    received from a remote system.  See Chapter 12, page 249 for more 
  133.    details on wait prompt().
  134.  
  135.    The wait tenths() function is used only when wait prompt is unsuitable.  
  136.    See Chapter 12, page 250 for more details.
  137.  
  138.    This first script was learned while connecting to BIX:
  139.  
  140.       type("<ALT-M><ALT-C>ba")        ;From the Main menu, go to the comm
  141.                                       ;screen and press any two keys
  142.       wait prompt("in: ", 30)         ;Wait for the "Login: " prompt
  143.       type("bix<ENTER>")              ;Respond to the prompt above
  144.       wait prompt("me? ", 30)         ;Wait for the "Name? " prompt
  145.       type("DN42690<ENTER>")          ;Respond to the name prompt
  146.       wait prompt("rd: ", 30)         ;Wait for the "Password: " prompt
  147.       type("CANOLI<ENTER><ALT-L>SS")  ;Respond to the password prompt and
  148.       end()                           ;End the script
  149.  
  150.    This second script was learned while connecting to Compuserve:
  151.  
  152.       type("<ALT-M><ALT-C>")          ;From the Main menu, go to the
  153.                                       ;Comm screen
  154.       wait tenths(36)                 ;Wait 3.6 seconds
  155.       type("<ENTER>")                 ;Press the ENTER key
  156.       wait prompt("ID: ", 30)         ;Wait for the "USER ID: " prompt
  157.       type("12345,6789<ENTER>")       ;Respond with a user id
  158.       wait prompt("rd: ", 30)         ;Wait for the "Password: " prompt
  159.       type("CANOLI<ENTER><ALT-L>SS")  ;Enter the password and
  160.       end()                           ;End the script
  161.  
  162.    This third script was learned while connecting to MCI Mail:
  163.  
  164.       type("<ALT-M><ALT-C>")          ;From the Main menu, go to the Comm
  165.       wait tenths(29)                 ;screen and wait 2.9 seconds
  166.       type("<ENTER>")                 ;Press the ENTER key
  167.       wait prompt("e:  ", 30)         ;Wait for the "Name:  " prompt
  168.       type("DN42690<ENTER>")          ;Enter the name
  169.       wait prompt("d:  ", 30)         ;Wait for the "Password:  " prompt
  170.       type("CANOLI<ENTER><ALT-L>SS")  ;Enter the password and
  171.       end()                           ;End the script
  172.  
  173.    ---------------------- Additions to HyperPilot ---------------------------
  174.  
  175.    fetch character(string variable, {timeout})
  176.     Purpose: To accept a single key from the remote user.
  177.     Action:  Stores the key pressed by the remote user into the
  178.       string variable.
  179.  
  180.     T/F result: FLASE if the remote user fails to press a key within
  181.       the timeout (seconds) period.
  182.  
  183.    -------------------------- End of file -----------------------------------
  184.