home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1998 April A / Pcwk4a98.iso / Lotus / Notes46 / LOTUS027.DSK / MODEMS / COMSERV.SCR < prev    next >
Text File  |  1993-03-26  |  7KB  |  203 lines
  1. ;       -A COMMENTED ACQUIRE SCRIPT-
  2.  
  3. ; Last revision date 03/26/93 (update this each time 
  4. ; you edit, and save the edited file under another
  5. ; name to keep this one intact).
  6.  
  7. ; This script is provided to show how an administrator
  8. ; might create a virtual circuit between a PC and
  9. ; a modem which are connected by communications
  10. ; servers.
  11.  
  12. ; This script file is an editable example provided to 
  13. ; help explain the contents and uses of a Notes 
  14. ; Acquire script (.SCR) file.  It was created for 
  15. ; acquiring use of a pooled modem via a communications 
  16. ; server.  On the proper system, if edited such that 
  17. ; the correct Arguments were supplied, this file could
  18. ; actually be fully functional.  This file may also be
  19. ; used as a starting point for creating new script files 
  20. ; for other communications servers.  
  21.  
  22. ; All non-blank lines not beginning with a semicolon 
  23. ; should be edited for compatibility with commands, 
  24. ; replies, and timeouts specific to the server you 
  25. ; are dialing out from (consult with the appropriate 
  26. ; vendors for further information).  All blank lines 
  27. ; and lines beginning with a semicolon are ignored by 
  28. ; the Notes program; lines beginning with a semicolon 
  29. ; are remarks to the reader.  All other lines are part 
  30. ; of the actual script.
  31.  
  32. ; Note that there is also a sample CONNECT script
  33. ; provided in Notes, which also highlights many of the 
  34. ; features of the scripting language (from the menu, 
  35. ; click Tools, Call, Call Setup, then Edit to view the 
  36. ; CONNECT script sprntpad.scr).
  37.  
  38. ;===============================================
  39.  
  40. ; In Notes' scripting language, the "DESC" parameter
  41. ; controls what is seen in the "Acquire Script" section 
  42. ; of the "Specify Acquire Script Information" 
  43. ; dialog box:
  44.  
  45. DESC Acquire a modem via a communications server.
  46.  
  47. ; The "TYPE" parameter differentiates between a "Connect" 
  48. ; script and an "Acquire" script.  For using a pooled 
  49. ; modem the TYPE must be "ACQUIRE".  An Acquire script 
  50. ; differs from a Connect script in that it is executed 
  51. ; prior to the modem file, and is therefore used to 
  52. ; obtain a connection to the modem.  In this case, the 
  53. ; modem is acquired from a communications server:
  54.  
  55. TYPE ACQUIRE
  56.  
  57. ; You may want to force logging on, so that any errors 
  58. ; will print to the Notes log file (log.nsf):
  59.  
  60. LOG ON
  61.  
  62. ; Issue a 200 millisecond break, followed by a <CR>; this
  63. ; resets the connection between the PC and the server:
  64.  
  65. BREAK 2
  66.  
  67. ; Wait 1 second, then send a Null string, terminated by a
  68. ; carriage return.  In order to send a message that is not
  69. ; terminated by a carriage return, one can terminate the
  70. ; REPLY command with a semicolon.
  71.  
  72. ;     REPLY "Hello";
  73.  
  74. ; for example would send the string "Hello" without a
  75. ; carriage return:
  76.  
  77. WAIT 1
  78. REPLY ""
  79.  
  80. ; Look for the communication server's prompt (this 
  81. ; prompt should be specified to match the prompt used 
  82. ; by your equipment).  This WATCH command (below) has 
  83. ; been set up to simply "fall through" on receipt of the 
  84. ; comm serve prompt, since no explicit command follows the 
  85. ; prompt string.  The ERROR command would not be executed 
  86. ; if the prompt was received, since the matched string 
  87. ; causes successful termination of the WATCH command.
  88.  
  89. ; Retry if a "TIMEOUT" response is received.  If no 
  90. ; response is received within 10 seconds, give up.  
  91. ; Note the distinction here between the comm server 
  92. ; sending the response, "TIMEOUT", and the WATCH 
  93. ; command's 10-second timer elapsing.  If the "TIMEOUT" 
  94. ; response is received, this is a successful termination 
  95. ; of the WATCH command, which results in the GOTO RETRY1 
  96. ; command being executed.  This causes subsequent commands 
  97. ; to be executed starting at the label ":RETRY1", which 
  98. ; re-executes the WATCH command.  By contrast, if neither 
  99. ; the prompt (following WATCH 10 FOR) or the "TIMEOUT" 
  100. ; response is received within 10 seconds, then the WATCH 
  101. ; command will terminate with an error condition, causing 
  102. ; execution of the ERROR NORESPONSE command, which will 
  103. ; go to the label :NORESPONSE, since an error occurred. 
  104. ; (See the Failure section at the end of this script.)
  105.  
  106. :RETRY1
  107. WATCH 10 FOR
  108.    Enter prompt here in quotes: this may be something 
  109.                              like "C/S>" or "CommServ>"
  110.    
  111.    "TIMEOUT" GOTO RETRY1
  112.  
  113. ; The ENDW command marks the end of the WATCH
  114. ; command, and the list of all "valid" responses to be
  115. ; watched for:
  116.  
  117. ENDW
  118.  
  119. ; The ERROR command checks for an error on the last
  120. ; command executed, and goes to the label specified 
  121. ; (listed in the Failure section at the end of the 
  122. ; script) if there was an error:
  123.  
  124. ERROR NORESPONSE
  125.  
  126. ; You should now be connected to the communications server.  
  127.  
  128. ; Issue a "DISC" command (disconnect), to make sure you 
  129. ; are fully cleared from any previous session, wait 4 
  130. ; seconds, and then issue the next command, which in this 
  131. ; case requests a connection to a 9600 bps modem.  A response 
  132. ; with the string "connect" in it usually indicates a 
  133. ; successful connection; anything else is treated as a failure.  
  134. ; (Note that all commands and timeout values used here are 
  135. ; system-specific, and may need modification for your 
  136. ; communications server.)
  137.  
  138. REPLY "DISC"
  139. WAIT 4
  140. REPLY Type modem connection command here in quotes; this 
  141.     might be something like "Connect 9600" or "C 9600"
  142.  
  143. ; The next command is an example of a WAIT FOR command.  
  144. ; Like the WAIT command, above, the number (in the 
  145. ; following case, 15) indicates the length of time in 
  146. ; seconds to WAIT.  In this case, however, as in the 
  147. ; WATCH command, there is also a specified string to 
  148. ; wait for  ("connect").  Successful receipt of this 
  149. ; string within 15 seconds constitutes error-free 
  150. ; termination of the command, while the elapsing of the 
  151. ; timer constitutes an error, which will cause execution 
  152. ; of the ERROR command, below, which branches to the label 
  153. ; NOCONNECT (listed at the end of the script under the 
  154. ; Failure section) if there was an error.
  155.  
  156. WAIT 15 FOR "connect"
  157.  
  158. ; Note that the WAIT command is case-sensitive, so
  159. ; the case of the word "connect" is critical to success.
  160. ; The WATCH command could be used with multiple
  161. ; possible responses, if both upper- and lower-case
  162. ; reponses are valid.
  163.  
  164. ERROR NOCONNECT
  165.  
  166. END
  167.  
  168. ; Failure section: Attempt to clean up the server session
  169. ;===============================================
  170. ; Note concerning LABELS:
  171.  
  172. ; The script author may create as many labels as needed
  173. ; in order to send to the log a report on the point at
  174. ; which the script failed and why.  Two labels were 
  175. ; employed in this script.  The message to the right 
  176. ; of the FAIL command is what will be printed in the
  177. ; log.nsf file.  Note that each label must begin with a 
  178. ; colon.  Both of these labels are also followed by
  179. ; REPLY commands which send a "DISC" command
  180. ; to the server in an attempt to clean things up and
  181. ; relinquish the modem before terminating.
  182.  
  183. :NORESPONSE
  184. REPLY "DISC"
  185. FAIL > Communications server did not respond
  186.  
  187. ;===============================================
  188.  
  189. :NOCONNECT
  190. REPLY "DISC"
  191. FAIL > Could not establish connection with modem pool
  192.  
  193. ;===============================================
  194. ;                <end of script>
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.