cleo a+ for windowsportal.cleo.com/support/byproduct/legacy/cleoapluswin... · 2002. 1. 18. ·...

Cleo A+

for Windows

User's Guide

November 2001

Cleo A+ for Windows User's Guide

Version r2.36 - November 2001

RESTRICTED RIGHTS Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013. Manufacturer is: Cleo Communications 4203 Galleria Drive, Rockford IL 61111 USA

Cleo Communications reserves the right to, without notice, modify or revise all or part of this document and/or change product features or specifications and shall not be responsible for any loss, cost or damage, including consequential damage, caused by reliance on these materials.

This document may not be reproduced, stored in a retrieval system or transmitted, in whole or in part, in any form or by any means (electronic, mechanical, photo-copied or otherwise) without the prior written permission of Cleo Communications

1998-2001 Cleo Communications All rights reserved.

Cleo is a registered trademark of Cleo Communications A+ is a trademark of Cleo Communications Windows 95,98,and Windows NT,2000 are trademarks of Microsoft Corporation.

About Cleo Communications

Cleo Communications provides software, hardware, and services to help organizations distribute centralized host-based computing resources to their branch offices, departments, and other remote locations. Customers rely on our products to:

• Provide remote multi-user access to host applications and data.

• Distribute host-based electronic documents throughout the enterprise.

• Print and view host-based documents at remote sites.

• Transfer data between computer systems at all points in the network.

Cleo Communications has been manufacturing high-speed PC-to-mainframe data communications products since 1981. More than 100,000 of our products are installed on systems worldwide. Cleo products combine the most advanced data communications hardware and software with complete documentation and maintenance. In addition, all users get continuing personal support from our technical specialists, and we back all of our products with a 30-day money-back guarantee and a full 12-month warranty. We're committed to providing reliable, cost-effective, high-performance solutions.

Cleo Technical Support Subscription Program

An annual technical support subscription includes the following:

Technical Support via Telephone Technical Support Analysts are available to assist with installation, testing and troubleshooting from M-F from 8am-5pm CST. The technical support area operates on a callback basis. The next available Support Analyst will return Voicemail left on our toll-free automated support line at 866-444-CLEO.

Technical Support via E-mail and Fax Questions and support requests send to [email protected] (e-mail) or 1-815-654-8294 (fax) are entered in the same queue as telephone requests and will be returned by e-mail, fax or telephone per your request.

Free Software Upgrades and Sample Scripts (Available With Subscription) Enjoy 24 hour a day access to upgrades and new versions of your software, or access sample scripts that can simplify your scriptwriting when you have an exclusive, subscriber's area password.

Standard Support Services (Available Without Subscription)

Subscriptions include the standard support services available:

Website Support Cleo's FAQ knowledge base includes detailed answers and technical bulletins on all software and hardware questions and is continually growing.

Automated Test Lines Instructions for testing your Cleo installation using automated test lines are located in the ''Readme.txt' file packaged with your software.

One-Year Hardware Warranty All Cleo hardware is warranted for one year from date of purchase. In addition, users may purchase one additional piece of hardware (without software) for back-up purposes.

Table of Contents

TABLE OF CONTENTS.......................................................................................................................................................... 4

TABLE OF FIGURES ............................................................................................................................................................ 10

GETTING STARTED ............................................................................................................................................................ 11 THE DOCUMENTATION........................................................................................................................................................... 12

User's Guide...................................................................................................................................................................... 12 Installation Guide.............................................................................................................................................................. 12 Application Programmer's Interface Installation.............................................................................................................. 12

DOCUMENTATION CONVENTIONS .......................................................................................................................................... 13 WHAT IS CLEO A+?................................................................................................................................................................ 14

Features............................................................................................................................................................................. 15 Specifications .................................................................................................................................................................... 16

CHAPTER 1. THE CLEO A+ CONFIGURATOR ............................................................................................................. 17 1.1 A+ CONFIGURATOR ........................................................................................................................................................ 18 1.2 CLEO A+ CONFIGURATOR - PORT................................................................................................................................... 20

1.2.1 Device....................................................................................................................................................................... 20 1.2.2 Speed (BPS).............................................................................................................................................................. 21 1.2.3 Parity........................................................................................................................................................................ 21 1.2.4 Data Bits................................................................................................................................................................... 21 1.2.5 Stop Bits.................................................................................................................................................................... 21 1.2.6 Flow Control ............................................................................................................................................................ 21

1.3 A+ CONFIGURATOR - MODEM ........................................................................................................................................ 23 1.3.1 Dial Type ................................................................................................................................................................. 23 1.3.2 Autobaud ................................................................................................................................................................. 24 1.3.3 Wait for Connect ..................................................................................................................................................... 24 1.3.4 Dial Retrys............................................................................................................................................................... 24 1.3.5 Modem Initialization String..................................................................................................................................... 24 1.3.6 Dial Initialization String ......................................................................................................................................... 25

1.4 A+ CONFIGURATOR - TERMINAL .................................................................................................................................... 26 1.4.1 Terminal Type ......................................................................................................................................................... 26 1.4.2 Local Echo............................................................................................................................................................... 26 1.4.3 Remote Echo............................................................................................................................................................ 27 1.4.4 Line Wrap................................................................................................................................................................ 27 1.4.5 Incoming CR Translation ........................................................................................................................................ 27 1.4.6 Enter Key Translation ............................................................................................................................................. 27

1.5 CONFIGURE - FILE TRANSFER ......................................................................................................................................... 28 1.5.1 Protocol................................................................................................................................................................... 28 1.5.2 Upload Directory .................................................................................................................................................... 30 1.5.3 Download Directory................................................................................................................................................ 30 1.5.4 Maximum Errors ..................................................................................................................................................... 30 1.5.5 Maximum Errors/Block ........................................................................................................................................... 30 1.5.6 Receive Timeout ...................................................................................................................................................... 31 1.5.7 Startup Timeout ....................................................................................................................................................... 31 1.5.8 Encryption Method .................................................................................................................................................. 31 1.5.9 Accept Incoming Filenames .................................................................................................................................... 32 1.5.10 Default Send Mode ................................................................................................................................................ 32

1.5.11 Default Receive Mode ............................................................................................................................................32 1.5.12 Compression...........................................................................................................................................................32

1.6 A+ CONFIGURE START UP...............................................................................................................................................33 1.6.1 Log File Name..........................................................................................................................................................33 1.6.2 Log Mode .................................................................................................................................................................34 1.6.3 Monitor File Name...................................................................................................................................................34 1.6.4 Monitor Mode ..........................................................................................................................................................34 1.6.5 Recorder File Name .................................................................................................................................................34 1.6.6 Recorder Mode.........................................................................................................................................................34 1.6.7 Job File Name ..........................................................................................................................................................35 1.6.8 Tokens ......................................................................................................................................................................35 1.6.9 Display Mode ...........................................................................................................................................................36 1.6.10 Monitor Window ....................................................................................................................................................36

1.7 A+ CONFIGURATOR - WAN INFO....................................................................................................................................37 1.7.1 User..........................................................................................................................................................................37 1.7.2 Password..................................................................................................................................................................38 1.7.3 Domain.....................................................................................................................................................................38 1.7.4 Net Protocol .............................................................................................................................................................38 1.7.5 Frame Protocol ........................................................................................................................................................38 1.7.6 Device Type..............................................................................................................................................................38 1.7.7 Device Name ............................................................................................................................................................39 1.7.8 Script ........................................................................................................................................................................39 1.7.9 Host ..........................................................................................................................................................................39 1.7.10 IP Address ..............................................................................................................................................................40 1.7.11 DNS........................................................................................................................................................................40 1.7.12 DNS Alt ..................................................................................................................................................................40 1.7.13 WINS ......................................................................................................................................................................40 1.7.14 WINS Alt.................................................................................................................................................................40

1.8 A+ CONFIGURATOR - WAN OPTION ...............................................................................................................................41 1.8.1 Specific IP Address ..................................................................................................................................................41 1.8.2 Specific Server Address............................................................................................................................................42 1.8.3 Header Compression.................................................................................................................................................42 1.8.4 Remote Gateway .......................................................................................................................................................42 1.8.5 LCP Extensions .........................................................................................................................................................42 1.8.6 Modem Lites..............................................................................................................................................................42 1.8.7 Terminal After Dial ...................................................................................................................................................43 1.8.8 Software Compression ..............................................................................................................................................43 1.8.9 Encrypt Password .....................................................................................................................................................43 1.8.10 MS Encrypt Password .............................................................................................................................................43 1.8.11 Data Encrypt ...........................................................................................................................................................44 1.8.12 Network Logon........................................................................................................................................................44 1.8.13 Use Logon Credentials............................................................................................................................................44

1.9 A+ CONFIGURATOR - ASCII ...........................................................................................................................................45 1.9.1 Block Size .................................................................................................................................................................45 1.9.2 Line Delay................................................................................................................................................................45 1.9.3 EOF Character ........................................................................................................................................................46

1.10 A+ CONFIGURATOR - ANSI...........................................................................................................................................47 1.10.1 Block Size ...............................................................................................................................................................47 1.10.2 Line Delay..............................................................................................................................................................47 The ANSIDELAY=Seconds parameter may also be used to setup the ANSI Clear line delay.1.10.3 EOB Character ...47 1.10.3 EOB Character ......................................................................................................................................................48 1.10.4 ACK Character ......................................................................................................................................................48

1.11 A+ CONFIGURATOR - KERMIT .......................................................................................................................................49 1.11.1 8th bit Prefix Character ..........................................................................................................................................49 1.11.2 Setup Prefix Character............................................................................................................................................50

1.11.3 Maximum Packet Length ........................................................................................................................................ 50 1.11.4 Pad Character ........................................................................................................................................................ 50 1.11.5 Number of Pads ...................................................................................................................................................... 50 1.11.6 Start of Block Character......................................................................................................................................... 50 1.11.7 EOL Character ....................................................................................................................................................... 51 1.11.8 Block Checking Method.......................................................................................................................................... 51

1.12 A+ CONFIGURATOR - ZMODEM..................................................................................................................................... 52 1.12.1 Transmit Frame Size ............................................................................................................................................. 52 1.12.2 Crash Recovery Window Size ................................................................................................................................ 53 1.12.3 Transmit Window Size ........................................................................................................................................... 53 1.12.4 Receive Window Size ............................................................................................................................................. 53

1.13 A+ CONFIGURATOR - FTP ............................................................................................................................................ 54 1.13.1 FTP User Login...................................................................................................................................................... 54 1.13.2 FTP User Password ............................................................................................................................................... 54 1.13.3 FTP Default Directory ........................................................................................................................................... 55 1.13.4 First Local Data Port # .......................................................................................................................................... 55 1.13.5 Last Local Data Port # ........................................................................................................................................... 55

1.14 A+ CONFIGURATOR - OFTP ......................................................................................................................................... 56 1.14.1 CAP INIT................................................................................................................................................................ 56 1.14.2 CAP MODE............................................................................................................................................................ 56 1.14.3 USER DATA ........................................................................................................................................................... 57 1.14.4 PASSWD................................................................................................................................................................. 57 1.14.5 PID ......................................................................................................................................................................... 57 1.14.6 REMOTE ................................................................................................................................................................ 57 1.14.7 SEP......................................................................................................................................................................... 57 1.14.8 DEST ...................................................................................................................................................................... 58 1.14.9 COMP..................................................................................................................................................................... 58 1.14.10 BUFSIZ................................................................................................................................................................. 58 1.14.11 WINDOW ............................................................................................................................................................. 58

CHAPTER 2. OPERATION ................................................................................................................................................. 59 2.1 THE CLEO A+ COMMAND LINE....................................................................................................................................... 60 2.2 STARTING CLEO A+ ........................................................................................................................................................ 63 2.3 THE CLEO A+ WINDOW .................................................................................................................................................. 64

2.3.1 Title Bar.................................................................................................................................................................... 64 2.3.2 Menu Bar.................................................................................................................................................................. 65 2.3.3 Tool Bar Buttons ..................................................................................................................................................... 66 2.3.4 Status Bar ................................................................................................................................................................ 67

2.4 FILE TRANSFER STATUS.................................................................................................................................................. 68 2.5 RUNNING CLEO A+ IN BACKGROUND MODE ................................................................................................................... 70

CHAPTER 3. THE A+ MENUS ........................................................................................................................................... 71 3.1 SYSTEM - RUN JOBS AND PRINT...................................................................................................................................... 72

3.1.1 Run Job - Execute a Job/Script File ........................................................................................................................ 72 3.1.2 Print Current Window - Print the Contents of the Current Window ....................................................................... 74 3.1.3 Printer Setup - Select and Configure the Default Printer ....................................................................................... 74 3.1.4 Information - Current A+ Information.................................................................................................................... 75 3.1.5 Exit - Exit a Cleo A+ Session .................................................................................................................................. 75

3.2 EDIT - CLIPBOARD ACCESS ............................................................................................................................................. 76 3.2.1 Cut ........................................................................................................................................................................... 76 3.2.2 Copy ........................................................................................................................................................................ 76 3.2.3 Paste ........................................................................................................................................................................ 76 3.2.4 Clear All .................................................................................................................................................................. 76

3.3 LINE - CONNECT/DISCONNECT PHONE LINE ................................................................................................................... 77 3.3.1 Dial - Access the Dialing Directory ........................................................................................................................ 77

3.3.2 Hangup - Hangup the Phone Line............................................................................................................................86 3.3.3 Answer - Answer the Phone Line .............................................................................................................................87 3.3.4 Data - Enter Data Mode ..........................................................................................................................................87

3.4 TRANSMIT - SEND TO THE HOST SYSTEM ........................................................................................................................88 3.4.1 Send - Send File(s) in Scanned Mode.......................................................................................................................89 3.4.2 Binary - Send File(s) in Binary Mode ......................................................................................................................90 3.4.3 Text - Send File(s) in Text Mode ..............................................................................................................................90 3.4.4 Key - Send a Message in Text Mode ........................................................................................................................91

3.5 RECEIVE - RECEIVE FILE(S) .............................................................................................................................................93 3.5.1 To File - Receive File(s) to Disk File .......................................................................................................................93 3.5.2 To Printer - Print Received File(s) ..........................................................................................................................95

3.6 CONFIGURATION - DISPLAY OR CHANGE CONFIGURATION..............................................................................................96 3.6.1 Load - Load a Configuration File ............................................................................................................................96 3.6.2 Save - Save the Current Configuration ....................................................................................................................97 3.6.3 Save As - Save Current Configuration under a New Name......................................................................................97 3.6.4 Edit - Edit the Current Configuration ......................................................................................................................97 3.6.5 Translation Tables - Load a Translation Table .......................................................................................................98

3.7 WINDOW - DISPLAY OR CHANGE WINDOWS....................................................................................................................99 3.7.1 Command Window - Toggle the Command Window................................................................................................99 3.7.2 Log Window - Toggle the Log Window....................................................................................................................99 3.7.3 Monitor Window - Toggle the Line Monitor Window ............................................................................................100 3.7.4 Recorder Window - Toggle Command Recorder Window .....................................................................................100 3.7.5 Terminal Window - Toggle the Terminal Emulation Window................................................................................101 3.7.6 Cascade - Cascade All A+ Windows......................................................................................................................101 3.7.7 Tile Vertically - Tile All A+ Windows Vertically ....................................................................................................101 3.7.8 Tile Horizontally - Tile All A+ Windows Horizontally ...........................................................................................101 3.7.9 Arrange Icons - Line Up All A+ Window Icons .....................................................................................................101 3.7.10 Close All - Close All A+ Windows .......................................................................................................................101

3.8 HELP - DISPLAY HELP INFORMATION ............................................................................................................................102 3.8.1 Contents - Online A+ Manual................................................................................................................................102 3.8.2 Using Help - Help Information About Using Help.................................................................................................102

CHAPTER 4. CLEO A+ COMMAND LANGUAGE.........................................................................................................103 4.1 ANSWER - AUTOMATIC ANSWER..................................................................................................................................105 4.2 AT - SEND AN 'AT' STRING TO THE MODEM..................................................................................................................106 4.3 AUTODIAL - AUTOMATIC DIAL .....................................................................................................................................107 4.4 BINARY - TRANSMIT BINARY FILE(S)............................................................................................................................109 4.5 BRANCH - BRANCH IN JOB/SCRIPT FILE BASED ON CONDITION ....................................................................................110

4.5.1 BRanch ON|NOT status TO label......................................................................................................................111 4.5.2 BRanch ON|NOT return_code TO label ...........................................................................................................112 4.5.3 BRanch ON|NOT SIZE [<|=|>] file_size TO label...........................................................................................112 4.5.4 BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label ...........................................................112 4.5.5 BRanch ON|NOT %variable%|$variable <|=|> number TO label...................................................................113 4.5.6 BRanch ON|NOT %variable%|$variable = string TO label.............................................................................115 4.5.7 BRanch ON TRUE TO label...............................................................................................................................115

4.6 CLOSE - CLOSE A READ OR WRITE FILE ..................................................................................................................117 4.7 COMBINE - COMBINE TWO STRINGS...........................................................................................................................118 4.8 COMPARE - COMPARE TWO STRINGS .........................................................................................................................119 4.9 CONFIG - DISPLAY OR CHANGE CONFIGURATION .........................................................................................................120 4.10 CONNECT - CONNECT TO OR DISCONNECT FROM A TELNET, FTP, OR OFTP ...........................................................121 4.11 +COUNTER - INCREMENT COUNTER .........................................................................................................................122 4.12 -COUNTER - DECREMENT COUNTER.........................................................................................................................123 4.13 DATA - DATA MODE ...................................................................................................................................................124 4.14 DIRMATCH � DIRECTORY PATTERN MATCH ............................................................................................................125 4.15 DISPLAY - DISPLAY A MESSAGE ON SCREEN ............................................................................................................126

4.16 ELSE - PERFORM FOLLOWING COMMANDS IF IF CONDITION IS FALSE ...................................................................... 127 4.17 ENDIF - END IF/ELSE CONDITION............................................................................................................................ 128 4.18 EXECUTE - EXECUTE COMMANDS FROM A JOB/SCRIPT FILE ...................................................................................... 129 4.19 EXISTS - CHECK IF FILE EXISTS ................................................................................................................................ 131 4.20 FIND - RECEIVE DATA UNTIL STRING MATCH ............................................................................................................ 132 4.21 GET - GET INFORMATION FROM THE REMOTE USER.................................................................................................. 134 4.22 HANGUP - DISCONNECT PHONE LINE ......................................................................................................................... 135 4.23 IF - PERFORM FOLLOWING COMMANDS IF A CONDITION IS TRUE............................................................................... 136 4.24 JOB - RECORD COMMANDS OR SCRAMBLE A JOB/SCRIPT FILE ................................................................................... 137 4.25 KEY - TRANSMIT A KEYBOARD MESSAGE.................................................................................................................. 139 4.26 LEFT - GET LEFTMOST CHARACTERS OF STRING....................................................................................................... 141 4.27 LENGTH - GET THE LENGTH OF STRING.................................................................................................................... 142 4.28 LET - SET CONFIGURATION PARAMETER OR USER-DEFINED VARIABLE .................................................................... 143 4.29 LINEUP - GET LINE STATUS ........................................................................................................................................ 144 4.30 LOG - OPEN, CLOSE, OR WRITE TO THE LOG FILE ..................................................................................................... 145 4.31 MID - GET MIDDLE CHARACTERS OF STRING ............................................................................................................ 147 4.32 MONITOR - OPEN OR CLOSE A SERIAL LINE MONITOR............................................................................................... 148 4.33 MSEND - MULTIPLE SEND .......................................................................................................................................... 150 4.34 OPEN - OPEN A FILE TO READ OR WRITE............................................................................................................... 151 4.35 PRINT - RECEIVE FILE(S) & SPOOL TO PRINTER ......................................................................................................... 152 4.36 QUIT - EXIT A+ .......................................................................................................................................................... 155 4.37 READ - READ A LINE FROM READ FILE ................................................................................................................... 157 4.38 RECEIVE - RECEIVE FILE(S) ........................................................................................................................................ 158 4.39 RETURN - RETURN TO CALLING JOB FILE ................................................................................................................ 161 4.40 RIGHT - GET RIGHTMOST CHARACTERS OF STRING.................................................................................................. 162 4.41 SAVE - SAVE CURRENT CONFIGURATION ................................................................................................................... 163 4.42 SEARCH - SEARCH STRING FOR A CHARACTER OR A STRING.................................................................................... 164 4.43 SEND - TRANSMIT FILE(S) .......................................................................................................................................... 165 4.44 SLEEP - PAUSE SPECIFIED SECONDS ........................................................................................................................... 167 4.45 START - DISPLAY OR INITIALIZE COUNTER................................................................................................................. 168 4.46 SYSTEM - EXECUTE AN OPERATING SYSTEM COMMAND OR APPLICATION PROGRAM .......................... 170 4.47 TABLE - DISPLAY OR CHANGE TRANSLATION TABLE(S) ............................................................................................ 172 4.48 TEXT - TRANSMIT TEXT FILE(S) ................................................................................................................................. 173 4.49 TOKEN - ENABLE, DISABLE, DISPLAY OR SET TOKEN VARIABLES............................................................................. 174 4.50 VOICE - DISCONNECT PHONE LINE AND DISABLE AUTOANSWER............................................................................... 176 4.51 WAITFOR - WAIT UNTIL SPECIFIED TIME.................................................................................................................... 177 4.52 WANGETENTRY - GET WAN SETTINGS FROM A PHONE BOOK ENTRY.................................................................. 178 4.53 WANSETENTRY - CREATE WAN PHONE BOOK ENTRY ......................................................................................... 179 4.54 WANSHOW - DISPLAY WAN DEVICES AND CONNECTIONS..................................................................................... 180 4.55 WRITE - WRITE A LINE TO A WRITE FILE ................................................................................................................. 181 4.56 XX - POST CURRENT A+ INFORMATION ..................................................................................................................... 182 4.57 ## - JOB/SCRIPT COMMENT LINE ................................................................................................................................ 183

CHAPTER 5. CLEO A+ TUTORIAL.................................................................................................................................. 184 5.1 RETAIL SALES ............................................................................................................................................................... 185 5.2 BULLETIN BOARD ......................................................................................................................................................... 186 5.3 BULLETIN BOARD SERVICE........................................................................................................................................... 187 5.4 FTP FILE TRANSFER ..................................................................................................................................................... 189 5.5 A TELNET SESSION ........................................................................................................................................................ 190 5.6 PEER-TO-PEER CONNECTION ......................................................................................................................................... 191 5.7 OFTP RECEIVING AND SENDING JOB FILES .................................................................................................................. 192

APPENDIX A. FILE FORMATS ....................................................................................................................................... 193 A.1 THE CONFIGURATION FILE........................................................................................................................................... 194 A.2 THE JOB/SCRIPT FILE ................................................................................................................................................... 199

A.3 THE LOG FILE ...............................................................................................................................................................200 A.3.1 The Autodial/Autoanswer Status Line....................................................................................................................200 A.3.2 The Transmit/Receive Status Line..........................................................................................................................201 A.3.3 Status Messages.....................................................................................................................................................203

A.4 THE MONITOR FILE.......................................................................................................................................................211 A.4.1 Terminal Emulation Mode.....................................................................................................................................211 A.4.2 File Transfer Mode ................................................................................................................................................211

A.5 THE RECORDER FILE.....................................................................................................................................................215 A.6 THE CHARACTER TRANSLATION FILES .........................................................................................................................216

A.6.1 XLATOUT.OVR Translation Table........................................................................................................................216 A.6.2 XLATIN.OVR Translation Table............................................................................................................................217

A.7 THE AUTODIAL DIRECTORY FILE..................................................................................................................................218 A.8 THE INITIALIZATION FILE .............................................................................................................................................219

A.8.1 Startup Parameters................................................................................................................................................220 A.8.2 Aserve Startup Settings ..........................................................................................................................................220 A.8.3 Options ..................................................................................................................................................................220

APPENDIX B. MODEM SUPPORT...................................................................................................................................221 B.1 AT COMMAND SET MODEMS ...................................................................................................................................222 B.2 NON-AUTODIAL MODEMS ........................................................................................................................................223 B.3 NULL MODEMS .........................................................................................................................................................224

APPENDIX C. C.1 A+ STATUS ..................................................................................................................................225

Table of Figures

FIGURE 1.1.1 CLEO A+ CONFIGURATOR ICON ........................................................................................................................... 18 FIGURE 1.1.2 CLEO A+ CONFIGURATOR WINDOW .................................................................................................................... 19 FIGURE 1.2 CLEO A+ CONFIGURATOR PORT VIEW.................................................................................................................... 20 FIGURE 1.3 CLEO A+ CONFIGURATOR MODEM VIEW................................................................................................................ 23 FIGURE 1.4 CLEO A+ CONFIGURATOR TERMINAL VIEW............................................................................................................ 26 FIGURE 1.5 CLEO A+ CONFIGURATOR FILE TRANSFER VIEW.................................................................................................... 28 FIGURE 1.6 CLEO A+ CONFIGURATOR STARTUP VIEW ............................................................................................................. 33 FIGURE 1.7 CLEO A+ CONFIGURATOR WAN INFO VIEW .......................................................................................................... 37 FIGURE 1.8 CLEO CONFIGURATOR WAN OPTION VIEW............................................................................................................ 41 FIGURE 1.9 CLEO A+ CONFIGURATOR ASCII PROTOCOL VIEW................................................................................................ 45 FIGURE 1.10 CLEO A+ CONFIGURATOR ANSI PROTOCOL VIEW............................................................................................... 47 FIGURE 1.11 CLEO A+ CONFIGURATOR KERMIT PROTOCOL VIEW............................................................................................ 49 FIGURE 1.12 CLEO A+ CONFIGURATOR ZMODEM PROTOCOL VIEW.......................................................................................... 52 FIGURE 1.13 CLEO A+ CONFIGURATOR FTP PROTOCOL VIEW ................................................................................................. 54 FIGURE 1.14 CLEO A+ CONFIGURATOR OFTP PROTOCOL VIEW............................................................................................... 56 FIGURE 2.1 CLEO A+ COMMAND LINE VIEW............................................................................................................................. 60 FIGURE 2.2 WINDOWS START MENU ......................................................................................................................................... 63 FIGURE 2.3 CLEO A+ WINDOW.................................................................................................................................................. 64 FIGURE 2.3.2 CLEO A+ SYSTEM MENU ..................................................................................................................................... 65 FIGURE 2.3.3 TOOL BAR BUTTONS ............................................................................................................................................ 66 FIGURE 2.4 CLEO A+ FILE TRANSFER WINDOW ........................................................................................................................ 68 FIGURE 3.1 CLEO A+ SYSTEM MENU ITEMS.............................................................................................................................. 72 FIGURE 3.1.2 CLEO A+ RUN JOB|OPEN A JOB FILE DIALOG WINDOW....................................................................................... 73 FIGURE 3.1.3 CLEO A+ SYSTEM|PRINT SETUP ........................................................................................................................... 74 FIGURE 3.1.4 CLEO A+ SYSTEM|INFORMATION WINDOW.......................................................................................................... 75 FIGURE 3.2 CLEO A+ EDIT MENU ITEMS ................................................................................................................................... 76 FIGURE 3.3 CLEO A+|LINE MENU ITEMS ................................................................................................................................... 77 FIGURE 3.3.1 CLEO A+ |LINE |DIAL DIALOG WINDOW .............................................................................................................. 77 FIGURE 3.3.1.1CLEO A+ LINE|DIAL|ADD DIALOG WINDOW ..................................................................................................... 79 FIGURE 3.3.1.4 CLEO A+|LINE|DIAL|MANUAL DIALOG WINDOW ............................................................................................. 86 FIGURE 3.4.1 CLEO A+ TRANSMIT MENU ITEMS ....................................................................................................................... 88 FIGURE 3.4.1 CLEO A+ TRANSMIT MENU ITEMS ....................................................................................................................... 89 FIGURE 3.5 CLEO A+ RECEIVE MENU ITEMS............................................................................................................................. 93 FIGURE 3.6 CLEO A+ CONFIGURATION MENU ITEMS ................................................................................................................ 96 FIGURE 3.6.5 CLEO A+ CONFIGURATION MENU ITEMS|TRANSLATION TABLE MENU ITEM DIALOG WINDOW.......................... 98 FIGURE 3.7 CLEO A+ WINDOW MENU ITEMS ............................................................................................................................ 99 FIGURE 3.8 CLEO A+ HELP MENU ITEMS ................................................................................................................................ 102 FIGURE C.1 THE A+ STATUS ................................................................................................................................................... 225

Getting Started

Before you get started, take a moment to read this section. It provides an overview of the following topics:

The Documentation

Documentation conventions

What is Cleo A+?

The Documentation

The Cleo A+ for Windows manual is comprised of several sections.

User's Guide This Cleo A+ for Windows User's Guide section describes the Cleo A+ for Windows terminal emulation, file transfer, configuration options, job scripting language, diagnostic tools, and terms used throughout the manual.

Installation Guide The Cleo A+ for Windows Installation Guide section provides instructions on installing A+ for Windows to your hard disk and configuring your system for A+ for Windows operation. It also describes any execution instructions not covered in the Cleo A+ for Windows User's Guide.

Application Programmer's Interface Installation

The Application Programmer's Interface section contains the information you need to write application programs using A+'s own Application Programmer's Interface (API). This section is an add-on option only. A sample API program is also an add-on option.

Documentation Conventions

The following documentation conventions apply throughout this manual:

Italics Italicized words in this format identify the titles of manual sections.

bold Bold type is used for cross-references to other chapters within the manual, or to other sections within a chapter.

italics Italicized words in this format represent substituted items. Substitute your own file name, device name, telephone number, etc., for the italicized word. File names may optionally specify a disk drive and/or path name as follows: drive:/pathname/filename.

[ ] Brackets represent an optional parameter. Do not include the brackets when entering the option.

| Vertical bars separate option selections. Select only one of the options. Do not include the bar when entering the option. Vertical bars separate the menu and submenu selections. Select each menu option to access the desired function.

... An ellipsis indicates the item may repeat.

KEYNAME An essential name is in this format, for example ENTER, refers to a specific key on your terminal's keyboard.

Some keyboard commands require that you press one key and hold it down while you press one or more other keys. These are combination keystrokes. To indicate this, key names are shown together with a + sign between them (for example, CTRL+C). While holding down the first key, press the other key(s).

0xnn A number preceded by 0x (for example 0x20) indicates a hexadecimal value.

What is Cleo A+?

The Cleo A+ program lets your computer transmit files to and receive files from any other micro, mini, or mainframe computer that supports asynchronous file transfer protocols. A+ lets you transmit and receive files interactively or unattended. In interactive mode, you can use the menu items or buttons to initiate file transfers. In unattended mode, all of the commands in the job (script) file execute, and can be started manually, from within a batch file, or added to the system's startup.

The A+ program offers you commands for making a connection, transmitting and receiving data, creating and executing job/script files, changing configuration parameters, controlling and monitoring the transmission line, creating interactive user-defined messages and menus, and executing other programs.

You can modify the A+ configuration file interactively at operation time. You can create one or more custom configuration files which may be invoked when A+ is executed, or during an A+ session. Configuration parameters can change individually while running in unattended mode.

A log file lets you track all your communications transactions. Log files contain the date and time, the commands executed, and the status of each command. With a serial line monitor you can view or save to disk the protocol characters and data files as they transmit. These are powerful diagnostic tools for isolating communications problems.

A+ lets you execute other applications from within a job/script file without leaving the program.

Features • XMODEM, XMODEM-1K, YMODEM, YMODEM-G, ZMODEM, Kermit , ASCII, ANSI Clear, FTP, OFTP over

TCP/IP(optional)

• Terminal emulation (including TTY, VT52, VT100, VT220, and VT320)

• Host support (including Telnet, local network host, and PPP)

• Wide Area Networking (WAN) support for Dial-Up Networking and Remote Access Server (RAS)

• Interactive or job file operation

• Automatic job file creation

• Automatic dial support with a wide variety of AT command compatible modems

• Dial directory support with optional job execution on connect

• Local printer support

• Configurable character translations

• Configurable key mapping

• On-line diagnosis of communications problems

• File naming control

• Environment variable and user-defined variable support

Specifications File Transfer Protocols: XMODEM, XMODEM-CRC, XMODEM-1K, YMODEM, YMODEM-G, ZMODEM, Kermit,

SuperKermit, Long Block Kermit, ASCII, ANSI Clear, FTP, and OFTP over TCP/IP.

Terminal Emulated: VT100, VT220, VT230, VT52, or TTY

Line Discipline: Asynchronous

Data Rate: 300, 1200, 2400, 4800, 9600, 19,200, 38,400, 57,600, or 115,200 bps (bits per second)

Parity: None, odd, even, mark or space

Data Bits: 7 or 8

Stop Bits: 1 or 2

Flow Control: Software (XON/XOFF), hardware (RTS/CTS), or disabled

Transmission Code: Binary

Transmission Line: Leased, switched (dial-up), or direct connect

Link Control: Point-to-point

Channel Type: Half-duplex or full-duplex, 2-wire or 4-wire lines

Status Line: Display

Local printer: Supported

Automatic Answer: Supported

Automatic Disconnect: Supported

Automatic Dial: AT Command

Automatic Baud Rate Detection: Supported

Chapter 1 - A+ Configurator

Cleo A+ for Windows User's Guide 17

Chapter 1.

The Cleo A+ Configurator

This chapter is an overview of the Cleo A+ Configurator, it's interface window, option functionality, and parameter descriptions. The following options or topics (listed in alphabetical order) have their own tabbed page in the Configurator and are discussed in this chapter:

• PORT

• Modem

• Terminal

• File Transfer

• Start Up

• WAN Info

• Wan Option

• ASCII

• ANSI

• Kermit

• Zmodem

• FTP

• OFTP (Optional)


18 Cleo A+ for Windows Users Guide

1.1 A+ Configurator

The Cleo A+ Configurator lets you customize your configuration file for a Cleo A+ communications session. You can start the A+ Configurator program in a couple of different ways:

• When using the Window's Start Menu, move the mouse pointer to Start|Programs|Cleo A+|A+ Configurator and double-click. Note: If you have installed Cleo A+ for multiple sessions you will find A+ Configurator and A+ Configurator_1, and the number will be incremented to contain the number of sessions that you have purchased. If you do not find multiple names here for the number of sessions you have purchased you will need to contact your Cleo representative to get a correct License number for your purchase.

• When using the apluscfg.exe icon to execute from the target directory C:\APLUS\apluscfg.exe. Double-click on the icon to open the A+ Configurator program.

Figure 1.1.1 Cleo A+ Configurator Icon

Double-click apluscfg

Note: A saved Cleo A+ Configurator file is an ascii text file and may be opened and modified with a text editor. (i.e. NotePad, WordPad, or Write)



There are 13 tabbed pages making up the A+ Configurator and they include the following categories: Port, Modem, Terminal, File Transfer, StartUp, WAN Info, WAN Option, ASCII, ANSI, Kermit, Zmodem, FTP, and OFTP. The options for all of A+ Configurator's categories display by clicking on the corresponding tab or Pressing ALT and the corresponding tab letter. For instance, the FTP tab is F so to go to the FTP tab press ALT+F.

Figure 1.1.2 Cleo A+ Configurator Window

There are two types of boxes in the A+ Configurator. The drop-down list boxes require clicking on the down-arrow to view a list of options and selecting the desired one. For the A+ Configurator boxes, highlight the contents of the box and type the desired parameter into the box.

Changes may be changed/saved with the keyboard. To select Default, Revert, Save, or Exit use the ALT key, and type the underscored letter of the desired action. ALT+S, for instance, will save the parameters to the loaded filename.

If you have made changes that you do not want to save, the Revert button lets you change back to the original values for the current configuration page. Each page also has its own Default button to lets you reset its options back to default for all of that page's parameters.

The A+ Configurator has a setup menu icon or box in the upper left corner. When clicked the right-mouse button on the Cleo A+ Configurator icon on the heading bar to display the setup menu. This setup menu lets you to move the A+ Configurator window or close it.

If you have made changes to the A+ Configurator, you will get a message asking you to save the changes upon exiting. A file selection displays to select the configuration file name; APLUS.CFG is the default filename. Entering the APLUS.CFG filename lets the newly configured parameters become default when Cleo A+ starts up the next time.



1.2 Cleo A+ Configurator - Port

The Port tab lets you setup the parameters for the Device, Speed (in bps), Parity, Data Bits, Stop Bits, and Flow Control options.

Figure 1.2 Cleo A+ Configurator Port View

1.2.1 Device The Device is the COM port that the data communications device is setup at in your Windows environment. The listed parameters for Device are COM1: through //./COM20 and NONE. This follows the UNC naming conventions for all of the Windows Operating Systems. If the Dial Type is set to WAN, the Device, Speed, Parity, Data Bits, Stop Bits, and Flow Control options will not be used. The WAN dialer uses the Window's Dial Up Networking setup.

The DEVICE=COMPort parameter may also be used to setup the device.



1.2.2 Speed (BPS) The Speed option lets you setup the bits per second rate in which the COM port communicates with the modem. Valid options are the standards for Windows. This includes 1200, 2400, 4800, 9600, 19,200, 38,400, 57,600, and 115,200 bits per second (bps). The default speed is 9600 bps.

If you connect at a rate different from the specified speed, you will need to change the Speed setting after connection. If, however, the Autobaud option is ON, the speed will automatically change to the modem speed indicated by the "CONNECT baudrate" dial result message as long as it is a supported baud rate. See 1.3.2 Autobaud for details.

The SPEED=PortSpeed parameter may also be used to set the speed.

1.2.3 Parity The Parity option lets you setup the parity used for the COM port. Valid parities are NONE, ODD, EVEN, MARK and SPACE. Normally, Parity is NONE with 8-bit data. With 7-bit data, parity is normally set to either ODD or EVEN. The default parity is NONE.

The PARITY=Parity parameter may also be used to set the parity.

1.2.4 Data Bits The Data Bits option lets you setup the number of data bits used per byte. A byte is normally composed of 8 bits. All 8 bits may be used for data, or only 7 bits may be used for data with the eighth bit reserved for parity or ignored. The default number of data bits is 8.

The DATA=DataBits parameter may also be used to set data bits.

1.2.5 Stop Bits The Stop Bits option lets you specify or change the number of stop bits used per byte. Asynchronous communications always sends one start bit to signify the beginning of a byte of data; either 1 or 2 stop bits may be sent following the data byte to signify the end of the data. The default number of stop bits is 1.

The STOP=StopBits parameter may also be used to set the stop bits.

1.2.6 Flow Control The Flow Control option lets you enable or disable port flow control. Flow Control works when the modem phone line speed and the port speed is operating at different rates due to the machine being busy and cannot process incoming data fast enough. Valid flow controls are SOFTWARE, HARDWARE, and NONE. SOFTWARE (also referred to as logical, DC1/DC3, XOFF, or in-band) flow control configures the COM port for XON and XON/XOFF flow control. The default is NONE.

The following table shows how the parameters are interdependent and will let help you to set up your communications session for optimal throughput.



Table 1.1 Flow Control Considerations

FLOWCONTROL= DATA MODEM SETTINGS AUTOBAUD=

FLOWCONTROL=NONE (default)

XON and XOFF characters are present in the data file. The protocol that is required may use 0x11 or 0x13 characters for CRC values.

Use "MODEMINIT=" or "DIALINIT=" to send AT commands to the modem for disabling all flow control from the modem.

Note: Use your Modem's Manual to determine the correct AT string.

AUTOBAUD=ON

Configure the modem for a constant DTE speed to return extended result messages and not result codes. i.e X4V1Q.

FLOWCONTROL=SOFTWARE No XON and XOFF characters in the data or the protocol for CRC values.

Use "MODEMINIT=" or "DIALINIT=" to send AT commands to the modem for enabling MNP or V.42bis flow control on the modem.

The "DATA=", "PARITY=", "STOP=" parameters must match the modem's setup.

AUTOBAUD=OFF

Configure the modem for a constant DTE speed if the modem will be connecting at 14,400 or 28,800 bps or any unsupported rate.

FLOWCONTROL=HARDWARE Hardware flow control uses RTS/CTS on the modem to control the speed of the communications and has no data dependencies.

Use "MODEMINIT=" or "DIALINIT=" to send AT commands to the modem for enabling physical, RTS, or out-of-band flow control

Note: Use your Modem's Manual to determine the correct AT string.

AUTOBAUD=OFF

Configure the modem for a constant DTE speed if the modem will be connecting at 14,400 or 28,800 bps or any unsupported rate.

Many modems using the AT command set have different commands for the same option. Make sure that your modem supports all of the commands that it receives by enabling the Monitor and confirming that an OK is sent from the modem, or by verifying the AT commands in the Modem's manual.

The FLOWCONTROL=SOFTWARE|HARDWARE|NONE parameter may also be used to setup flow control.



1.3 A+ Configurator - Modem

Before setting up the Modem page, use the Port tab to configure your port for the proper speed, parity, data bits, stop bits, and flow control. 1.2 Cleo A+ Configurator - Port for details.

The Modem page lets you enable Autobaud detection, set the time to wait for a connection, control the number of times to redial if the modems do not connect, and send AT commands to the modem.

Figure 1.3 Cleo A+ Configurator Modem View

1.3.1 Dial Type The Dial Type option lets you set the method of dialing your host. The options are PSTN for standard dialing through Cleo A+ or WAN for wide area network dialing through the Windows Dial-Up Networking. The default is PSTN for standard dialing.

When WAN dialing enables, the remaining Modem menu options will become inoperative and the Port menu options Device, Speed, Parity, Data Bits, Stop Bits, and Flow Control are not used. The Device, Speed, Parity, Data Bits, Stop Bits, Flow Control, Wait for Connect and Dial Initialization String options may be configured through the Windows Dial-Up Networking configuration menus. Windows will normally be defaulted to Autobaud Enable OFF.

The DIALTYPE=PSTN|WAN parameter may also be used to set the dial type.



1.3.2 Autobaud The Autobaud option lets you enable or disable automatic detection of modem speed changes. Autobaud detection is important if your modem's configuration enables it to change speeds after the dial is complete. For instance, if you set the SPEED=9600 parameter and your modem connects to a 2400 baud modem. Older modems normally return "CONNECT 2400" then change speeds to 2400 bps, with Autobaud Enable set on, A+ will automatically change the port speed to 2400. Autobaud needs to be off if your modem is configured to remain at a constant DTE speed regardless of the actual connect speed; this includes most newer high=speed modems.

The default is autobaud ON.

The AUTOBAUD=ON|OFF parameter may also be used to setup autobaud functionality.

1.3.3 Wait for Connect The Wait for Connect option lets you specify the number of seconds A+ will wait for the connection to complete. The minimum value is 1, the maximum value is 255, and the default is 60 seconds. Before an autodial, A+ sends out the AT string ATS7=xx, where xx is the time to wait for a connection. If your modem is not completing the connection within the time allowed, you may need to extend this wait.

Note: The AUtodial Txx option will override the Wait for Connect time-out

The DIALWAIT=WaitForConnect parameter may also be used to control the wait for connect.

1.3.4 Dial Retrys The Dial Retrys option lets you specify the number of times A+ will dial the modem if the connection does not complete. The minimum value is 1, the maximum value is 3100, and the default is 3 retries.

Note: A final AUtodial Rxx option will override the Dial Retrys.

The TIMES=DialRetrys parameter may also be used to control the redial attempts.

1.3.5 Modem Initialization String The Modem Initialization String option lets you add an AT modem string to the modem when starting Cleo A+. This string consists of one or more AT commands. A few special characters that may be used within the AT string: the tilde (~) causes a 1/2 second pause; the caret-M (^M) causes a carriage return to be sent to the modem. See your modem's manual for more information on AT commands. The maximum for this string is 50 characters. This string must be removed, (i.e. MODEMINIT=) if you are running on a direct connect or leased line.

Note: For your convenience there is two configuration files that are included with the software. One is Aplus_Optima.cfg and it is has a Modem Initialization String for an Optima modem, and an Aplus_UDS.cfg file, which has a Modem Initialization String for a Universal Data Systems modem.

The Modem Initialization String is transmitted to the modem only upon startup; to send a modem initialization string to the modem before dialing or answering, use the Dial Initialization String option DIALINIT=.

The MODEMINIT=ATString parameter may also be used to setup the modem with an AT initialization string.



1.3.6 Dial Initialization String The Dial Initialization String option lets you enter an AT command to configure your modem before each autodial or autoanswer command. This string may consist of one or more AT commands. A few special characters that may be used within the AT string: the tilde (~) sends a 1/2 second pause; the caret-M (^M) sends a carriage return to the modem. See your modem manual for more information on AT commands. There is no default Dial Initialization String. The maximum length of this string is 50 characters.

The DIALINIT=Atcommands parameter may be used to setup the dial initialization string.



1.4 A+ Configurator - Terminal

The Terminal page lets you setup the terminal mode settings.

Figure 1.4 Cleo A+ Configurator Terminal View

1.4.1 Terminal Type The Terminal Type option lets you specify a terminal to emulate (act like). Supported terminal types include vt100 to emulate a DEC VT100 terminal, vt220 to emulate a DEC VT220 terminal, vt320 to emulate a DEC VT320 terminal, vt52 to emulate a DEC VT52 terminal, and TTY to emulate a TTY terminal. The default is vt100.

The TERMINAL=TerminalType parameter may also be used to setup the terminal type.

1.4.2 Local Echo The Local Echo option lets you echo typed characters to the screen. If the modem or the remote echo your characters, this option does not need to be ON. If you do not see your typed characters on the terminal window, and would like to, you can turn Local Echo ON. The default is Local Echo OFF The LOCALECHO=ON|OFF parameter may also be used to setup the local echo.



1.4.3 Remote Echo The Remote Echo option lets you echo all incoming characters back to the remote system. The default is remote echo OFF. If the remote terminal does not have local echo capabilities, you may want to turn this option on. This will display the remote's screen characters on its screen. The REMOTEECHO=ON|OFF parameter may also be used to setup the remote echo.

1.4.4 Line Wrap The Line Wrap option lets you configure end-of-line and end-of-screen displays.

Line Wrap will:

• Continue the characters onto the next line when receiving more characters than will fit on a line.

• Scroll the screen up one line and continue characters on the last line when receiving a new line of characters while on the last line of the screen.

If Line Wrap is off, A+ will:

• Overwrite the last character of the current line with additional characters received than will fit on the current line.

• Overwrite the last line when receiving a new line of characters while on the last line of the screen. The default is line wrap ON.

The LINEWRAP=ON|OFF parameter may also be used to setup the line wrap.

1.4.5 Incoming CR Translation The Incoming CR Translation option lets you setup incoming carriage return (0x0D) translations. The default is IGNORE for no translation. You may also ignore incoming carriage returns or translate an incoming carriage return to NL (new line (0x0A) or to CR/NL (0x0D and 0x0A). If incoming characters keep writing over the same line, try changing Incoming CR Translation to CR/NL.

The CRTRANSLATE=IGNORE|CR|CR/NL|NL parameter may also be used to setup the CR translation.

1.4.6 Enter Key Translation The Enter Key Translation option lets you setup outgoing Enter/Return key translations. The default is CR, which sends a carriage return (0x0D) character when the ENTER key is pressed. You may also translate ENTER to NL (new line (0x0A)) or to CR/NL (0x0D and 0x0A). The ENTERTRANS=CR|CR/NL|NL parameter may also be used to setup the Enter translation.



1.5 Configure - File Transfer

The File Transfer configuration lets you setup file transfer mode settings. Select File Transfer and the following menu will appear:

Figure 1.5 Cleo A+ Configurator File Transfer View

1.5.1 Protocol The Protocol option lets you setup a file transfer type. Supported file transfer types include Xmodem, Xmodem1K, Ymodem, YmodemG, Zmodem, Kermit, ASCII, ANSI Clear, FTP, or OFTP. The default is Zmodem. A brief description of each protocol follows. See 1.5.1 Protocol for more information on setting up ASCII, ANSI, Kermit, Zmodem, FTP, or OFTP (Optional).

1.5.1.1 XMODEM

XMODEM transmits files in 128-byte blocks. The receiver tries to initiate an XMODEM file transfer using CRC error checking. If the sender does not respond, the receiver continues trying to initiate the file transfer using checksum error checking. The Receive Timeout (RECTIMEOUT=Seconds parameter) and the Startup Timeout (STARTTIMEOUT=Seconds parameter) may be used to setup how quickly XMODEM receive commands change from CRC to checksum error checking. XMODEM does not support multiple files or remote filenaming.

1.5.1.2 XMODEM1K

XMODEM1K is an extension of XMODEM which transmits files in 1K (1024 byte) blocks using CRC error checking. XMODEM1K does not support checksum error checking, multiple files, or remote filenaming.



1.5.1.3 YMODEM

YMODEM is an extension of XMODEM1K, which supports multiple files and remote file naming. The receiver initiates a YMODEM file transfer. YMODEM sends the file name and file size in the first (#0) block. After all of the files transmit, YMODEM sends another block with a blank file name and file size.

1.5.1.4 YMODEMG

YMODEMG is similar to YMODEM but does not allow for error recovery. It is intended for use with error correcting modems (e.g. MNP, V.42bis, etc.) or short-distance connections. YMODEMG supports multiple files and remote file naming.

1.5.1.5 ZMODEM

ZMODEM supports multiple files, remote file naming, 16-bit or 32-bit CRC, interrupted file continuation, file skip, file streaming or windowing, and 1K or 4K block sizes. The transmitter initiates a ZMODEM file transfer. ZMODEM sends the file name, file size, and file creation date.

1.5.1.6 Kermit

Kermit supports multiple files, remote file naming, data compression, and different block check methods. Kermit transmits files in 96 byte block sizes. Long block Kermit may transmit files in up to 9024-byte blocks. Super Kermit supports sliding windows, which allow up to 32 blocks to transmit before requiring an acknowledgment. If it encounters an error, only the bad block retransmits. The transmitter initiates a Kermit file transfer. The 8th-bit prefixing option allows 8-bit binary data to be transmitted in 7 bits.

1.5.1.7 ASCII

ASCII is not a true file transfer protocol. ASCII transfers do not have start and end of block indicators and do not support error checking; therefore, data is unreliable. A+ sends ASCII files one line (maximum 180 characters) per block. Received ASCII files must normally time out, posting an RECEIV status or the user may abort. If an ASCII end-of-file character appears in the file, a NRMEOF status posts for received files. The following are unused status: EAREOF, SKIP, CONTEN, REPEAT, and RETRAN for ASCII mode.

1.5.1.8 ANSI Clear

ANSI Clear is a very simple, loosely defined file transfer protocol based on ASCII transfers. ANSI Clear transfers do not have a start block indicator but do have an end block indicator; they use only a character count and end-of-block character for error checking; and may optionally require block acknowledgments; therefore, data is unreliable. ANSI Clear files normally are in 127 or 128 character blocks. These blocks must end in a specified character, usually a carriage return or a tilde (~). Blocks may or may not require an acknowledgment (usually a carriage return) when transmitting, and send an acknowledgment when receiving. ANSI Clear files end in a block containing the characters EDIEOF. The following are unused status: EAREOF, SKIP, CONTEN, REPEAT, RETRAN, and RMTABT for ANSI Clear mode.



1.5.1.9 FTP

FTP (File Transfer Protocol) may be used only in local or PPP host connections. FTP supports multiple files and remote filenaming. The client (A+) initiates all file transfers. A+ transfers all FTP files using a binary (or image) file type, a file structure, and stream mode. Before initiating FTP file transfers, you must issue the �CONNECT FTP� command (see 4.10 CONNECT - Connect to or Disconnect from a Telnet, FTP, or OFTP) to log on to FTP. Once this connection is established, you may use FTP commands such as the CWD command to change directories. You must specify the host name including a path if the file is not in your login directory or your current directory. Because TCP/IP verifies data integrity, only NRMEOF, ABORT, NOFILE and RMTABT status posts in FTP mode.

1.5.1.10 OFTP (Optional)

OFTP (Odette File Transfer Protocol) runs over PPP connections. Either side may initiate file transfers. A+ transfers all OFTP files using binary mode. Before initiating OFTP file transfers, you must issue the �CONNECT OFTP� command (see 4.10 CONNECT - Connect to or Disconnect from a Telnet, FTP, or OFTP) to log on to OFTP. Because TCP/IP verifies data integrity, only NRMEOF, LINDWN, PROTOCOL, OUTOFTURN, ABORT, and RMTABT status post in OFTP mode.

1.5.2 Upload Directory The Upload (Send) Directory option lets you specify the default directory in which to find transmit files. The default is .\ which will look for files in the current directory. Note: The default directory overrides by specifying the path with the Transmit menu option, SEND tool bar button, or in the SEnd, BInary, or TExt command file name.

The UPDIR=path parameter may also be used to setup the send directory.

1.5.3 Download Directory The Download (Receive) Directory option lets you specify the default directory in which to receive files. The default is .\ which will receive files to the current directory. Note: The default directory overrides by specifying the path with the Receive menu option, REC tool bar button, or in the REceive or PRint command file name.

The DOWNDIR=path parameter may also be used to setup the receive directory.

1.5.4 Maximum Errors The Maximum Errors option lets you limit the number of errors encountered during each file transfer. The minimum value is 10, the maximum value is 255, and the default is -1. A Maximum Error of -1 allows unlimited errors per file transfer. On reaching the Maximum Errors limit, a RETRAN status message displays and the transfer aborts.

The MAXERRORS=ErrorCount parameter may also be used to setup the total errors.

1.5.5 Maximum Errors/Block The Maximum Errors/Block option lets you limit the number of errors encountered while transmitting or receiving each block of data. The minimum value is 10, the maximum value is 255, and the default is 10. On reaching the Maximum Errors/Block limit, a RETRAN status message displays and the transfer aborts.

The BLOCKERRORS=ErrorCount parameter may also be used to setup the total block errors.



1.5.6 Receive Timeout The Receive Timeout option lets you setup the time (in seconds) to wait for incoming data once a file has started. The minimum value is 2, the maximum value is 255, and the default is 10. On reaching the Receive Timeout, a RECEIV status message displays and the transfer aborts.

The Receive Timeout also controls the time to wait for a response to a XMODEM, XMODEM1K, YMODEM, or YMODEMG receive bid. If the first block from the remote site is not received within the Receive Timeout, A+ will send another receive bid.

The RECTIMEOUT=Seconds parameter may also be used to setup receive timeout.

1.5.7 Startup Timeout The Startup Timeout option lets you setup the time (in seconds) to try initiating a file transfer before aborting. The minimum value is 2, the maximum value is 255, and the default is 60. When the Startup Timeout reaches its end, a BIDLMT transmit status message or a NODATA receive status message displays and the transfer is aborted.

The STARTTIMEOUT=Seconds parameter may also be used to setup the startup timeout.

1.5.8 Encryption Method The Encryption Method option lets you choose whether outgoing files encrypt and incoming files decrypt. Encryption allows for a reasonable amount of data security. Encryption works only in A+ to A+ connections using ASCII, ZMODEM, or Kermit protocols. Encryption must not be used for ANSI CLEAR, XMODEM, XMODEM1K, YMODEM, YMODEMG, or FTP file transfers. If encryption is enabled and the received file was not encrypted or was encrypted with a different key, A+ will not attempt to decrypt the file. If encryption is disabled or the encryption key is different and the received file has encryption, A+ will save the file as is. The default is no file encryption.

PGE encryption is a proprietary A+ file encryption method that uses an internal key to scramble and unscramble data. You may set your own encryption key (or password) with the PGEKEY=key parameter. For example: LET PGEKEY=DJONES sets the encryption key to DJONES. The PGE key may be a string that�s 1 to 50 characters. Setting PGEKEY= (without specifying a key) returns it to the default internal key.

The ENCRYPT=NONE|PGE parameter may also be used to setup file encryption.



1.5.9 Accept Incoming Filenames The Accept Incoming Filenames option lets you choose whether incoming YMODEM, ZMODEM, KERMIT, and FTP files names are accepted if no REceive, PRint, or receive filename is specified. The choices are YES, OVERWRITE, or NO. The default is YES. The Accept Incoming Filenames option does not affect ASCII, ANSI Clear, XMODEM, or XMODEM1K file transfers.

OVERWRITE unconditionally saves the incoming file to the file name specified by the remote system overwriting any existing file of the same name. Accept Incoming Filenames must be set to OVERWRITE to allow Zmodem Crash Recovery.

YES saves the incoming file to the file name specified by the remote; if a file with the same name already exists, the file is saved as the default file name. For example, if the incoming file name was REMOTE.PRT and REMOTE.PRT already existed on your system, the file saves as RCVFILE.000; if RCVFILE.000 already existed, it saves as RCVFILE.001, etc.

NO ignores the incoming file names. All received files accumulate serially as RCVFILE.000, RCVFILE.001, etc, unless it has changed with a new filename.

The protocol's incoming file name overrides by specifying a REceive, PRint, or Download filename.

The FILENAMES=YES|NO|OVERWRITE parameter may also be used to setup incoming file names.

1.5.10 Default Send Mode The Default Send Mode option lets you setup whether or not data is translated before being transmitted with the Transmit|Send menu option or the SEnd command. The choices are Binary, Text, or Scan. In Binary mode, the file is sent as-is without translation. In Text mode, the file translates through the xlatout.ovr table before transmitting. In Scan Mode, the scanning that takes place is one that checks the file for non-ASCII data. If non-ASCII data is present, the file transfers in binary (as is) mode; otherwise, it is sent in text (translated) mode. The default is Binary.

The DEFSENDMODE=BINARY|TEXT|SCAN parameter may also be used to setup the outgoing translation.

1.5.11 Default Receive Mode The Default Receive Mode option lets you setup whether or not incoming data is translated before being saved with the Receive menu option, the REC tool bar button, or the REceive, PRint, or SCreen job/script command. The choices are Binary or Text. In Binary mode, the file saves as is without translation. In Text mode, the file translates through the xlatin.ovr table before it saves to a file. The default is Binary.

The DEFRECEIVEMODE=BINARY|TEXT parameter may also be used to setup the incoming translation.

1.5.12 Compression The Compression option lets you setup whether or not outgoing files are compressed, and incoming files decompress. A+'s data compression is a proprietary method based on a popular deflate algorithm. Compression works only in A+ to A+ connections. Compression should not be used for ANSI Clear or FTP file transfers. The ASCIIEOF character must not be setup for an end of file character when transferring ASCII files with compression enabled.

The amount of compression depends on the contents of the original file. While text, files may compress from 40% to 60%. Random files are compressed little or not at all. The amount of compression displays in the file transfer status window. If compression is enabled and the received file was not compressed, A+ will not attempt to decompress the file. If compression is disabled and the received file was compressed, A+ will save the file as is. The default is no file compression.

The COMPRESS=YES|NO parameter can also be used to control file compression.



1.6 A+ Configure Start Up

The Start Up configuration lets you setup the initial log, monitor, recorder, and job files along with tokens, and screen display.

The StartUp A+ Configurator page only take effect when the parameters are specified in the default configuration file (APLUS.CFG) or a configuration file specified on the A+ command line with the CONFIGFILE=ConfigFile parameter.

Figure 1.6 Cleo A+ Configurator StartUp View

1.6.1 Log File Name The Log File Name option specifies a file name for the log file. Cleo A+ logging lets you save all status results to the specified log file name. The log file is informative in verifying of the communications session. See A.3 The Log File for the log file format. The default log file name is APLUS.LOG.

The LOGFILE=LogFile parameter may also be used to set the log file name.



1.6.2 Log Mode The Log Mode option sets whether logging is on or off when A+ begins. The log mode options are:

• NONE to preserve the existing log file. No Log file will open and no transactions will record. This is the default

• OVERWRITE to create a log file if none exists, or overwrite the log file if one exists.

• APPEND to create a log file if none exists, or add to an existing log file.

The log can toggle off and on with the LOg command, the Window|Log Window menu option or the LOG tool bar button.

The LOGMODE=OVERWRITE|APPEND|NONE parameter may also be used to setup the initial log file mode.

1.6.3 Monitor File Name The Monitor File Name option specifies a file name for the monitor file. The monitor invokes a built-in serial line monitor to display the actual received/, transmitted protocol to the specified file. The monitor is helpful in determining communications errors. See A.4 The Monitor Filefor the monitor file format. The default monitor file name is APLUS.MON.

The MONITORFILE=MonitorFile parameter may also be used to setup the monitor file name.

1.6.4 Monitor Mode The Monitor Mode option controls whether monitor is on or off when A+ begins. The monitor mode options are:

• NONE to preserve the existing monitor file. No Monitor file will open and no transactions record. This is the default.

• OVERWRITE to create a monitor file if none exists, or overwrite an existing monitor file.

• APPEND to create a monitor file if none exists, or add to an existing monitor file.

The MOnitor command will turn the monitor off and on, the Window|Monitor Window menu option or MON tool bar button.

The MONITORMODE=OVERWRITE|APPEND|NONE parameter may also be used to set the monitor file mode.

1.6.5 Recorder File Name The Recorder File Name option specifies a file name for the recorder job file. The recorder saves all Cleo A+ actions as they are executed to the specified file name. The recorder is helpful in rerunning the same communications session several times. See A.2 The Job/Script File for the job file format. The default recorder file name is APLUS.JOB.

The RECORDERFILE=JobFile parameter may also be used to set the recorder file mode.

1.6.6 Recorder Mode The Recorder Mode option controls whether the job recorder is on or off. This parameter lets you save an interactive session. The session when ran by manually entering commands at the command prompt or clicking on tool bar buttons will be saved to a job file which may be edited with a text editor or executed as is.

The recorder mode parameters are:



• NONE (default) Preserves an existing Recorder job file and does not create a new job file.

• OVERWRITE Writes over the Recorder job file if one exists or create a new-recorded job file.

• APPEND Will append a saved Recorder job file or create a new recorded job file if one is not saved.

• NEW_FILE When the Job file Recorder is started with NEW_FILE, it will overwrite the APLUS.JOB file. If APLUS.JOB is non-existent it will create the file and save the executed commands to this file or another name if entered one is entered when the user turns off the Recorder mode and saves the file.

It is in this mode that the Recorder button displays its activity with a highlighted button, and only opens a Recorder Window if a "Tool Bar Button" is used to execute commands. Once the job file is finished, the Recorder button if clicked on again will close the file and save it. In addition, it will turn off the highlighting that represents the Recorder is active.

The Recorder may also be turned off and on with the JOb command, the Window|Recorder Window menu option or REC button.

The RECORDERMODE=OVERWRITE|APPEND|NONE|NEW_FILE parameter may also be used to control the initial recorder file mode.

1.6.7 Job File Name The Job File Name option lets you start a job file to running automatically upon startup. The job file may run all of your communication sessions using your saved list of Cleo A+ commands. This option lets the user run in unattended mode so that it may be ran when no one else is using the system's resources, for example, after work hours. There is no default Job File Name.

• When JOBFILE=JobFile is entered on the command line it overrides the job file that is saved to the configuration file.

• A job file may also be run from within Cleo A+ with the System|Run Job menu option, the JOB tool bar button, or the EXecute command.

Note: When the LET command sets the JOBFILE configuration parameter within the job file, LET JOBFILE=JobFile it starts the JOBFILE immediately.

1.6.8 Tokens The Tokens option lets you enable, environment, and user-defined variable processing, and/or to set token variable(s). It also enables the COunter command. Tokens are similar to MS-DOS replaceable parameters or Unix positional parameters. The first token may be accessed with %1% or $1, the second with %2% or $2, and so on. These tokens may replace any job file text, except for command names or labels. Up to 19 tokens may be setup for passing information. The default is ON.

The TOken command must be enabled to work for setting/and changing with the TOken command (see 4.49 TOken - Enable, Disable, Display or Set Token Variables). The same is true with the EXecute command (see 4.18 EXecute - Execute Commands from a Job/Script File).

The TOKENS=OFF|ON lets you enable or disable Tokens from the command line, or job file.

TOKENS=TokenList(up to 19) parameter is used to setup tokens.



1.6.9 Display Mode The Display Mode option lets you disable part or all of the A+ screen display. NORMAL starts a normal sized window with an A+ icon on the taskbar. All of A+ windows will display in NORMAL Mode. A Display Mode of MINIMIZED will start a Cleo A+ and Aserve icon on the task bar. None of the Cleo A+ windows will display in MINIMIZED mode. A Display Mode of MAXIMIZED will start Cleo A+ in full-screen sized windows. All of the windows will display in MAXIMIZED Mode. The default is NORMAL.

The DISPLAY=NORMAL|MINIMIZED|MAXIMIZED parameter can be used to configure the display.

1.6.10 Monitor Window The Monitor Window option lets you disable the Monitor Window from running during the session. The Monitor toolbar button is dim and the Monitor Window will not display. This will let you use less of your system resources, and not display monitor information to the user at the screen. The default is OFF.

Note: This option, however, will not prevent you from using the Monitor File Name and Monitor Mode options to create a monitor file while your session is running. The monitor file will save to a file in attended mode or unattended mode when these options are used.

The MONITORWINDOW=OFF|ON parameter can be used to setup the monitor feature.



1.7 A+ Configurator - WAN Info

The WAN Info page lets you configure for Wide Area Networking using a local host or through Windows Dial-Up Networking.

Figure 1.7 Cleo A+ Configurator WAN Info View

1.7.1 User The User option specifies a login name for PAP (Password Authentication Protocol) or CHAP (Challenge Handshake Authentication Protocol) link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require that you manually enter login information to establish a connection, which will require scripting (see 1.7.8 Script), or popup terminal login (see 1.8.7 Terminal After Dial).

The WANUSER=UserName parameter may also be used to control the WAN user name.



1.7.2 Password The Password option specifies an optional automatic user password for PAP or CHAP link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require that you manually enter login information to establish a connection, which will require scripting (see 1.7.8 Script), or popup terminal login (see 1.8.7 Terminal After Dial).

The WANPASSWORD=UserPassword parameter may also be used to control the WAN password.

1.7.3 Domain The Domain option specifies an optional automatic domain name for PAP or CHAP link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require you to manually enter login information to establish a connection, which will require scripting (see 1.7.8 Script), or popup terminal login (see 1.8.7 Terminal After Dial).

The WANDOMAIN=DomainName parameter may also be used to control the WAN domain name.

1.7.4 Net Protocol The Net Protocol option specifies whether the TCP/IP or the IPX protocol is used for the network communications. The default is TCP/IP.

The WANNETPROTOCOL=TCPIP|IPX parameter may also be used to control the network protocol.

1.7.5 Frame Protocol The Frame Protocol option specifies whether the PPP or the SLIP protocol is used for the frame protocol. The default is PPP.

The WANFRAMEPROTOCOL=PPP|SLIP parameter may also be used to control the frame protocol.

1.7.6 Device Type The Device Type option specifies the WAN device type to use for communications. The options are MODEM, ISDN, and X.25. The default is MODEM.

The WANDEVTYPE=MODEM|ISDN|X25 parameter may also be used to control the WAN device type.



1.7.7 Device Name The Device Name option specifies the name of the modem to use for WAN dialing. Hitting the down arrow displays all the configured modems on your system. The WANSHOW command also displays the device numbers and device names known to the system.

Note: The Device Name, if typed, must be an exact match, including the number of spaces between words. Example: Standard 9600 bps Modem.

The WANDEVNAME=ModemName parameter may also be used to setup the WAN device name.

1.7.8 Script The Script option specifies a script file for automating user logins while making the connection. Scripting is available only on Windows NT 4.0 with Service Pack 3 or higher. Popup terminal windows may be used on Windows 95 for entering user login information (see 1.8.7 Terminal After Dial for detailed information).

Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence and will not require scripting or popup terminal login. Some Internet Service Providers (ISPs) and online services, however, require that you manually enter login information to establish a connection. With Scripting support for Dial-Up Networking under Windows NT, you can write a script to automate this process. A script is a text file that contains a series of commands, parameters, and expressions required by your ISP or online service to establish the connection and use the service. There are two types of script languages defined for Windows NT:

• Switch.INF file. You can edit this file directly from the Script tab on the Edit Phonebook Entry from the Dial-Up Networking window. This is the default.

• *.SCP files. You can modify or create Dial-Up Scripting Command Language files with any text editor, such as Microsoft Notepad.

See the system root \SYSTEM32\RAS directory for more information on both of these scripting languages.

The WANSCRIPT=ScriptFileName parameter may also be used to control the WAN script name.

1.7.9 Host The Host option specifies the target host socket name or address number. The format of the host address is x.x.x.x, where each x may be 0 through 255. If a host name (i.e. ftp.cleo.com), the DNS and DNS Alt. or the WINS and WINS Alt. addresses (if defined), locate the corresponding host ip address. If the host name is not at any of these locations, the HOSTS file in the system root or system root \SYSTEM32\DRIVERS\ETC directory is used to locate the corresponding host address.

The HOST=HostName|HostAddress parameter may also be used to set the host.



1.7.10 IP Address The IP Address option lets you specify an intermediate dial-up IP Address. The format of the IP Address is x.x.x.x, where each x may be 0 through 255. Dial-Up Networking will try to use this IP Address as the address for the dial-up connection only if the Specific IP Address option is selected (see 1.8.1 Specific IP Address). To avoid errors during dialing, you must either enter an IP Address or de-select the Specific IP Address option in the WAN Options configuration menu.

The WANIPADDRESS=x.x.x.x parameter may also be used to control the IP address.

1.7.11 DNS The DNS option specifies a primary Domain Name Server address. Use the Domain Name Server to find an IP address for the specified Host name. The format of the DNS address is x.x.x.x, where each x may be 0 through 255.

The WANDNS=x.x.x.x parameter may also be used to set a primary Domain Name Server address.

1.7.12 DNS Alt The DNS Alt option specifies a secondary Domain Name Server address. This alternate Domain Name Server is used to find an IP address for a given Host name if it cannot be located on the primary Domain Name Server. The format of the DNS Alt. address is x.x.x.x, where each x may be 0 through 255.

The WANDNSALT=x.x.x.x parameter may also be used to set a secondary DNS address.

1.7.13 WINS The WINS option specifies a primary Windows Name Server address. Use the Windows Name Server to find an IP address for a given Host name using non-routable protocols like NetBIOS and NetBEUI. The format of the WINS address is x.x.x.x, where each x may be 0 through 255.

The WANWINS=x.x.x.x parameter may also be used to control the WINS.

1.7.14 WINS Alt The WINS Alt option specifies a secondary Windows Name Server address. Use the alternate Windows Name Server to find an IP address for a given Host if it cannot be located on the primary Windows Name Server. The format of the WINS Alt. address is x.x.x.x, where each x may be 0 through 255.

The WANWINSALT=x.x.x.x parameter may also be used to control the alternate WINS.



1.8 A+ Configurator - WAN Option

The WAN Option page lets you setup autodialing for use with Windows Dial-Up Networking.

Figure 1.8 Cleo Configurator WAN Option View

1.8.1 Specific IP Address The Specific IP Address option lets you negotiate for an IP address for the dial-up connection. If this option is active, Dial-Up Networking will try to use the specified IP Address as the address for the dial-up connection. This corresponds to selecting the �Specify an IP address� setting in the TCP/IP Settings menu of the Dial-Up Networking configuration. If not selected, the value of the IP Address option is not used. In addition, the server assigns the IP address. Clearing this corresponds to selecting the �Server assigned IP address� setting in the TCP/IP Settings menu. The default is ON.

The WANSPECIFICIP=ON|OFF parameter can also control whether the specified IP address or the server-assigned IP address is used.



1.8.2 Specific Server Address The Specific Server Address controls the address for the dial-up connection. If this option is active, the DNS, DNS Alt, WINS, and WINS Alt addresses specify the name server addresses for the dial-up connection. This corresponds to selecting the �Specify name server addresses� setting in the TCP/IP Settings menu of the Dial-Up Networking configuration. If this option is disabled, Dial-Up Networking will ignore the values in DNS, DNS Alt, WINS, or WINS Alt. Clearing this corresponds to selecting the �Server assigned name server addresses� setting in the TCP/IP Settings menu. The default is OFF.

The WANSPECIFICSERVER=ON|OFF parameter may also be used to specify the name server address.

1.8.3 Header Compression The Header Compression option specifies whether Dial-Up Networking will negotiate to use IP header compression on PPP connections. This option corresponds to the �Use IP Header compression� checkbox in the TCP/IP Settings menu of the Dial-Up Networking configuration. Selecting this option significantly improves performance. When connecting to a server that does not correctly negotiate IP header compression, this option needs to be disabled. The default is OFF.

The WANIPHEADERCOMPRESS=ON|OFF parameter may also be used to control the header compression.

1.8.4 Remote Gateway The Remote Gateway option specifies whether the default route for IP packets will be through the dial-up adapter when the connection is active. This option corresponds to the �Use default gateway on remote network� checkbox in the TCP/IP Settings menu. The default route stays, as is, when this option is disabled. The default is OFF.

The WANREMOTEGATEWAY=ON|OFF parameter may also be used to control the remote gateway.

1.8.5 LCP Extensions The LCP Extensions option specifies whether the PPP LCP (Link Control Protocol) extensions defined in RFC 1570 enable. Activating the LCP Extensions may be necessary to connect to certain older PPP implementations, but interferes with features such as server-callback. This option needs to be off unless specifically required. The default is OFF. Windows 95 currently ignores this option.

The WANLCPEXT=ON|OFF parameter may also be used to control the LCP extensions.

1.8.6 Modem Lites The Modem Lites option specifies whether the system task-bar modem lights enable when the connection is active. Under Windows 95, this option corresponds to the �Display modem status� checkbox in the Options menu of the modem properties; these properties are accessible through the �Configure� button on the phone book entry property page. Under Windows NT, this option is currently ignored; the appearance of modem lights is controlled by the �Show modem and ISDN lights� checkbox on the global Dialing Preference-General menu. The default is OFF.

The WANMODEMLITES=ON|OFF parameter may also be used to control the modem lights under Windows 95.



1.8.7 Terminal After Dial The Terminal After Dial option specifies whether or not a terminal window is displayed for user login input after making the connection. Under Windows 95, this option corresponds to the �Bring up terminal window after dialing� checkbox in the Options menu of the modem properties; these properties are accessed through the �Configure� button on the phone book entry property page. Windows NT does not support Terminal After Dial but does allow automatic scripting of the login information (see 1.7.8 Script for details). The default is OFF.

Note: Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence and will not require scripting or popup terminal login. Some Internet Service Providers (ISPs) and online services, however, require that you manually enter login information to establish a connection.

The WANTERMAFTERDIAL=ON|OFF parameter may also be used to control the terminal after dial.

1.8.8 Software Compression The Software Compression option specifies whether the PPP driver will try to negotiate CCP (Compression Control Protocol) with the server. This option corresponds to the �Enable software compression� checkbox on the �Server Type� menu. The option will be active by default, but not selecting this option can reduce the negotiation period if the server does not support a compatible compression protocol. The default is OFF.

The WANSOFTWARECOMPRESS=ON|OFF parameter may also be used to activate the software compression.

1.8.9 Encrypt Password The Encrypt Password option specifies whether secure password schemes are to authenticate the client with the server. Selecting this option prevents the PPP driver from using the PAP plain-text authentication protocol. Instead, it uses either CHAP or SPAP authentication protocol to authenticate the client. Deselecting this option allows PAP, CHAP, or SPAP authentication. This option activates for increased security, but should not be selected for increased interoperability. Under Windows 95, this option corresponds to the �Require encrypted password� checkbox on the �Server Type� menu. Under Windows NT, this option corresponds to the �Require encrypted password� checkbox on the �Security� menu. See also MS Encrypt Password below. The default is OFF.

The WANENCRYPTPASSWORD=ON|OFF parameter may also be used to activate whether the password is encrypted.

1.8.10 MS Encrypt Password The MS Encrypt Password option specifies whether Microsoft�s secure password schemes authenticate the client with the server. Selecting this option prevents the PPP driver from using the PPP plain-text authentication protocol or MD5-CHAP, MS-CHAP or SPAP. This option is active for maximum security, but should not be selected for maximum interoperability. This option takes precedence over Encrypt Password. The default is OFF.

Note: Windows 95 ignores this option, and with Windows NT this option corresponds to the �Require Microsoft encrypted password� checkbox in the �Security� menu.

The WANMSENCRYPTPASSWORD=ON|OFF parameter may also be used to activate the password is Microsoft encrypted.



1.8.11 Data Encrypt The Data Encrypt option specifies whether data encryption negotiates when establishing the connection. This option is not active unless Ms Encrypt Password is also set. The default is OFF

Note: With Windows 95, this option is not available. Under Windows NT, this option corresponds to the �Require data encryption� checkbox in the �Security� menu.

The WANDATAENCRYPT=ON|OFF parameter may also be used to activate the data encryption.

1.8.12 Network Logon The Network Logon option specifies whether Dial-Up Networking logs on to the network after the point-to-point connection is established. Under Windows 95, this option corresponds to the �Log on to network� checkbox on the �Server Type� menu. This option is to be active when you are logging on to networks where you must log on in order to use file servers. The default is OFF.

Note: This option is not for Logging on to Internet access, since that network has no servers to authenticate the client. Under Windows NT, this option is unavailable.

The WANNETWORKLOGON=ON|OFF parameter may also be used to activate the network logon.

1.8.13 Use Logon Credentials The Use Logon Credentials option specifies whether the username, password, and domain of the currently logged-on user is active when dialing. The default is OFF.

Note: This option is not available unless Ms Encrypt Password is active. Under Windows 95, this option is not used. Under Windows NT, this option corresponds to the �Use current username and password� checkbox in the Security menu.

The WANLOGONCREDENTIALS=ON|OFF parameter may also be used to activate the use of logon credentials.



1.9 A+ Configurator - ASCII

The A+ Configurator lets you setup the block size, line delay, and end-of-file character for each ASCII file transfer.

Figure 1.9 Cleo A+ Configurator ASCII Protocol View

1.9.1 Block Size The Block Size option lets you setup the number of characters sent in each ASCII transmission block. The minimum value is 0, the maximum value is 255, and the default is 0. A Block Size of 0, assigns transmission blocks to be one line long; that is, the block ends after each line feed (0x0A) character. The Block Size combined with the Line Delay sets the pacing of ASCII transmissions.

The ASCIIBLK=0|BlockSize parameter may also be used to set the ASCII block size.

1.9.2 Line Delay The Line Delay option lets you setup the time (in 1/10th-second intervals) to wait after sending each ASCII block. The minimum value is 0, the maximum value is 255, and the default is 5 to wait ½ second between blocks. The Line Delay combined with the Block Size lets you setup the pace of ASCII transmissions.

The LINEDELAY=Seconds parameter may also be used to set the ASCII line delay.



1.9.3 EOF Character The EOF Character option lets you specify the ASCII end-of-file character. This character ends the transmitted ASCII file and, when received by the receiver, it ends the incoming ASCII file. The EOF Character is an ASCII decimal value. See A.6.1 XLATOUT.OVR Translation Tablefor a list of ASCII characters. The minimum value is 0, the maximum value is 255, and the default is 26. An EOF Character of 0 disables the EOF function. This lets you send the file as-is without appending an EOF character. It also lets you receive files that contain any characters. If the EOF character is disabled, ASCII receives will have to timeout with a RECEIV status instead of NRMEOF.

The ASCIIEOF=0|EOFChar parameter may also be used to set the ASCII end of file character.



1.10 A+ Configurator - ANSI

The ANSI configuration lets you setup the block size, line delay, end-of-block character, and acknowledgment character for each ANSI Clear transfer.

Figure 1.10 Cleo A+ Configurator ANSI Protocol View

1.10.1 Block Size The Block Size option lets you setup the number of characters sent or received in each ANSI Clear block. The minimum value is 80, the maximum value is 255, and the default is 128. The ANSI Clear Block Size is non-standard but is normally 127 or 128. The EOB Character, if specified, comes after the number of characters specified by Block Size.

The ANSIBLK=BlockSize parameter may also be used to setup the ANSI Clear block size.

1.10.2 Line Delay The Line Delay option lets you setup the time (in 1/10th second intervals) to wait after sending each ANSI Clear block. The minimum value is 0, the maximum value is 255, and the default is 5 to wait ½ second between blocks. If acknowledgments are not used, the Line Delay lets you setup the pacing of ANSI Clear transmissions, it is ignored if an ACK Character is set.

The ANSIDELAY=Seconds parameter may also be used to setup the ANSI Clear line delay.



1.10.3 EOB Character

The EOB Character option lets you specify the ANSI Clear end of block character. This character is sent at the end of each transmitted block, and, when it is received, ends an incoming ANSI Clear block. The EOB Character is an ASCII decimal value. A.6 The Character Translation FilesFor a list of ASCII characters. The minimum value is 0, the maximum value is 255, and the default is 13. The ANSI Clear EOB Character is normally 13 (carriage return) or 126 (tilde).

The ANSIEOB=EOBChar parameter may also be used to setup the ANSI Clear end of block character.

1.10.4 ACK Character The ACK Character option lets you specify an ANSI Clear block acknowledgment character. If set, this character transmits to respond to each correctly received ANSI Clear block, and is expected after sending each block. The ACK Character is an ASCII decimal value. See A.6 The Character Translation Filesfor a list of ASCII characters. The minimum value is 0, the maximum value is 255, and the default is 13. The ANSI Clear ACK Character, if used, is normally 13 (carriage return) or 126 (tilde). An ACK Character of 0 disables the requirement to send and receive acknowledgments.

The ANSIACK=0|AckChar parameter may also be used to setup the ANSI Clear acknowledgment character.



1.11 A+ Configurator - Kermit

The A+ Configurator page lets you setup the packet length, block check method, number of sliding windows, and the prefix. As well as, the pad, start of block, and end of line characters for Kermit file transfers.

Figure 1.11 Cleo A+ Configurator Kermit Protocol View

1.11.1 8th bit Prefix Character The 8th bit Prefix Character option lets you setup the character that is sent prior to any character greater than 128. The 8th bit prefix character is specified in ASCII decimal. See A.6 The Character Translation Filesfor a list of ASCII characters. The minimum value is 38, the maximum value is 127, and the default is 38. The 8th bit prefix character is normally 38 (&).

Note: The 8th bit prefix character rarely needs to be changed.

The KERMQCTL=8thBitPrefixChar parameter may also be used to setup Kermit�s 8th bit prefix character.



1.11.2 Setup Prefix Character The Setup Prefix Character option lets you setup the character that transmits before any setup character. Setup characters are 0 through 31 and 127. The setup prefix character is an ASCII decimal value. See A.6 The Character Translation Files for a list of ASCII characters. The minimum value is 35, the maximum value is 127, and the default is 35. The setup prefix character is normally 35 (#).

Note: The setup prefix character rarely needs to be changed.

The KERMQCH=CntlPrefixChar parameter may also be used to setup Kermit�s 8th setup prefix character.

1.11.3 Maximum Packet Length The Maximum Packet Length option lets you setup the maximum transmission block size. The minimum value is 0, the maximum value is 9024, and the default is 1024. Although packet lengths greater than 94 are only supported by SuperKermit, A+ will fall back to the largest block size supported by the remote system.

Note: The Maximum Packet Length should rarely need to be changed.

The KERMPACKET=PacketLength parameter may also be used to setup Kermit�s maximum packet length.

1.11.4 Pad Character The Pad Character option lets you setup the character used to pad each receive block. The pad character is an ASCII decimal value. See A.6 The Character Translation Filesfor a list of ASCII characters. The minimum value is 0, the maximum value is 127, and the default is 0. The Pad Character is normally 0 (null), but may be 127 (delete) or any other control character. The Pad Character is ignored if the Number of Pads is 0.

The KERMPADCH=PadChar parameter may also be used to setup Kermit�s pad character.

1.11.5 Number of Pads The Number of Pads option lets you setup the number of pad characters that precede each receive block. The minimum value is 0, the maximum value is 127, and the default is 0. The Number of Pads is normally 0, but padding may be used to setup communications equipment or handshaking.

The KERMNPADS=NumberOfPads parameter may also be used to setup Kermit�s number of pad characters.

1.11.6 Start of Block Character The Start of Block Character option lets you specify the start of block character. This character transmits at the beginning of each transmitted block; and when in receive mode it starts an incoming block. The Start of Block Character is an ASCII decimal value. See A.6 The Character Translation Filesfor a list of ASCII characters. The minimum value is 0, the maximum value is 64, and the default is 1.

The KERMSTART=StartOfBlockChar parameter may also be used to setup Kermit�s start of block character.



1.11.7 EOL Character The EOL Character option lets you specify the end of line character. This character ends each transmitted block, and when receiving it at the end of a line, it will end an incoming block. The EOL Character is an ASCII decimal value. See Table A.6 The Character Translation Filesfor a list of ASCII characters. The minimum value is 13, the maximum value is 64, and the default is 13.

Note: The EOL Character rarely needs to be changed.

The KERMEOL=EndOfLineChar parameter may also be used to setup Kermit�s end of line character.

1.11.8 Block Checking Method The Block Checking Method option lets you specify the type of error checking. The options are CHKSUM (for 6-bit checksum), CHKSUM2 (for two character 12-bit checksum), or CRC (for three character 16-bit cyclic redundancy check), and the default is CRC.

Note: Since A+ will fall back to the best block checking method supported by the remote system, the Block Checking Method rarely needs to be changed.

The KERMBLKCHK=BlockCheckMethod parameter may also be used to setup Kermit�s block checking method.

1.11.9 Sliding Windows

The Sliding Windows option lets you specify the number of additional blocks (or windows) Super Kermit will transmit before requiring an acknowledgment. The minimum value is 0, the maximum value is 31, and the default is 6. Basic Kermit requires an acknowledgment to every block (i.e. 0 sliding windows) before continuing.

Note: Since A+ will automatically fall back to the maximum number of sliding windows supported by the remote system, the Sliding Windows should rarely need to be changed.

The KERMWINS=NumberOfWindows parameter may also be used to setup Kermit�s sliding windows.



1.12 A+ Configurator - Zmodem

The A+ Configurator page lets you setup the transmit frame size, crash recovery, and window sizes to optimize your communication session.

Figure 1.12 Cleo A+ Configurator Zmodem Protocol View

1.12.1 Transmit Frame Size The Transmit Frame Size option lets you to specify the maximum transmission block size. The minimum value is 128, the maximum value is 32768, and the default is 1024. If the line is good, the Transmit Frame Size can maximize throughput by increasing the value. If the line is bad, decreasing the Transmit Frame Size will increase the throughput of good blocks.

The ZFRAME=FrameSize parameter may also be used to setup ZMODEM�s frame size.



1.12.2 Crash Recovery Window Size The Crash Recovery option lets you disable crash recovery or specify the crash recovery method. The options are OFF, SIMPLE, or CRC, and the default is OFF. Simple crash recovery resends the file starting at the last byte count of the remote file; this method may cause an invalid file to be sent if the file had been modified before retransmission. CRC crash recovery resends the entire file if the CRC on the original file and the CRC on the remote file are different; this method causes the entire file to be resent unless it was already entirely transmitted. Off disables any crash recovery.

Accept Incoming Filenames must be set to OVERWRITE to allow ZMODEM Crash Recovery. See 1.5.9 Accept Incoming Filenames for details.

The ZCRASH=OFF|SIMPLE|CRC parameter may also be used to setup ZMODEM�s crash recovery.

1.12.3 Transmit Window Size The Transmit Window Size option lets you specify the number of characters to transmit before requiring an acknowledgment. If the remote requests acknowledgments at a smaller window size, A+ will back down to the requested number of characters. The minimum value is 0, the maximum value is 32768, and the default is 1024. A Transmit Window Size of 0 allows unlimited blocks/windows to be transmitted without an acknowledgment. The Transmit Window Size should be a multiple of the Transmit Frame Size. If the line is bad, it is a good idea to set a small window size, for instance 1024. If the line is good, you may set a larger window size, for instance 4096 or 10240.

The ZSENDWND=SizeOfTransmitWindow parameter may also be used to setup ZMODEM�s transmit window size.

1.12.4 Receive Window Size The Receive Window Size option lets you specify the number of characters you want the remote to send before requiring an acknowledgment. The remote may still require acknowledgments at a smaller window size; A+ will acknowledge whenever the remote requests an acknowledgment. The minimum value is 0, the maximum value is 32768, and the default is 1024. A Receive Window Size of 0 allows unlimited blocks/windows to be transmitted without an acknowledgment. If the line is bad, it is a good idea to set a small window size, for instance 1024. If the line is good, you may set a larger window size, for instance 4096 or 10240.

The ZRECWND=SizeOfReceiveWindow parameter may also be used to setup ZMODEM�s receive window size.



1.13 A+ Configurator - FTP

The FTP configuration lets you setup the user login and password and the range of local data ports that FTP (File Transfer Protocol) uses in the sessions. FTP is for transmitting and receiving files over a PPP connection to your FTP Server.

Figure 1.13 Cleo A+ Configurator FTP Protocol View

1.13.1 FTP User Login The FTP User Login option lets you specify your login user name for automatic login to the FTP server. The user name may be up to 35 characters long.

The FTPUSER=UserName parameter may also be used to setup the FTP login name.

1.13.2 FTP User Password The FTP User Password option lets you specify your user login password for automatic login to the FTP server. The password may be up to 35 characters long.

The FTPPASS=FTPPassword parameter may also be used to setup the FTP password.



1.13.3 FTP Default Directory The FTP Default Directory option lets you specify the default directory on the remote FTP server. This may be set if your default login directory is not the directory you would like to transfer files. The directory name may be up to 255 characters long.

The FTPDIR=FTPDirName parameter may also be used to setup the FTP default directory name.

1.13.4 First Local Data Port # The First Local Data Port # option, along with the Last Local Data Port # option, lets you specify the range of local data ports (or channels or sockets) that may be used for the FTP connection. The minimum value is 0, the maximum value is 61383, and the default is 1024.

The FTPLOPORT=Port# parameter may also be used to setup the first local data port number for an FTP connection.

1.13.5 Last Local Data Port # The FTPHIPORT=Port# parameter may also be used to setup the last local data port number for an FTP connection.

Each FTP file transfer uses a command port (normally 21) to send FTP commands, and a data port to send the actual data. The FTPHOSTPORT=HostNumber may be used to specify the local host port (or channel or socket) number for commands. The minimum value is 0, the maximum value is 16383 and the default is 21.



1.14 A+ Configurator - OFTP

The Odette file transfer protocol is different from FTP in the respect that it communicates with both entities as peers. There is an initiator and a responder. After the connection is established, the peer entities take turns in sending any files that they may have ready for transfer. It is possible to restrict OFTP to the role of initiator or responder, and possible to restrict it to just send or receive files.

Note: The OFTP window will be dimmed if you have not purchased a license for the OFTP.

Figure 1.14 Cleo A+ Configurator OFTP Protocol View

1.14.1 CAP INIT The Cap Init option lets you restrict Cleo A+ to initiate, respond, or do both in an OFTP session. The OFTPCAPINIT=INITIATE|RESPOND|BOTH parameter may also be used to setup whether it will be the initiator or the responder or both.

Unlike the other protocols in Cleo A+, the OFTP configuration page in the Configurator may determine the commands that are working in the job file. The Initiator of the session will need to use different commands to proceed through a successful session than the Responder. See Chapter 5. Cleo A+ Tutorial for help writing job files.

1.14.2 CAP MODE The Cap Mode option lets you restrict Cleo A+ to only receive or send files. With this option, for example, you will generate an error message if receive is setup and the peer's system attempts to transmit files to your system.

OFTPCAPMODE=SENDER|RECEIVER|BOTH, possible to restrict A+ to receiving or sending files through OFTP.



1.14.3 USER DATA The User Data option lets you setup the user data. It is an eight-character field that can send the user data. The data string for this option is set up on the remote system to receive this string as a user id number.

The OFTPUSERDATA=datastring parameter may also be used to setup the FTP login name

1.14.4 PASSWD The Password option lets you setup the password. It is and eight character field that can be used to send data. The password for this option is set up on the remote system to receive this string as the password.

The OFTPPASSWD=eightcharacterdatastring parameter may also be used to setup the password.

1.14.5 PID The Id Code option lets you setup the id for the remote system. This string is a 26-character string that is setup by the remote system to receive this string as the id number. This code number will also conform to the ISO6523 standard.

The OFTPID=twentysixcharacterid parameter may also be used to setup the id string.

1.14.6 REMOTE The Remote option lets you setup the parameters for the system to connect with for your data communications session.

The OFTPREMOTE=hostname|IP address parameter may also be used to setup the remote host.

1.14.7 SEP The Separator option lets you setup the record length for in a variable-length record file.

The OFTPSEP=separatorstring parameter may also be used to demarcate records in variable-length record files.



1.14.8 DEST The Destination option lets you setup the default destination that goes into the start file packet. The OFTP protocol accommodates files, which transfer via intermediate hosts to the ultimate destination.

The OFTPDEFDEST=destidcode parameter may also be used to specify the destination.

1.14.9 COMP The Compression option lets you setup A+ to decompress incoming files (the compression scheme definition is a part of the OFTP protocol). YES tells the OFTP peer that it is ok to send compressed files.

The OFTPCOMP=YES|NO parameter may be used to let the remote send compressed files to A+.

1.14.10 BUFSIZ OFTP uses a buffer size of 100,000 characters. This option lets you adjust the length of DATA packet from 128 to 100,000 characters. The upper limit (100,000 characters) is protocol-defined.

The OFTPBUFSIZ=bufsize parameter may be used to change the buffer size.

1.14.11 WINDOW The OFTP sliding window size lets you change the window size. The valid range is from 1 to 1000.

OFTPWINDOW=windowsize parameter may be used to change the window size.

Chapter 2 - Operation


Chapter 2.

Operation

This chapter explains how to start a communications session. It also describes the Cleo A+ window, the file transfer status, and running as a hidden application. The following information is covered:

• The Cleo A+ command line

• Starting Cleo A+

• The A+ window

• File transfer status

• Running Cleo A+ in background mode with the HIDE option

Chapter 2 - The A+ Menus

60 Cleo A+ for Windows User's Guide

2.1 The Cleo A+ Command Line

The A+ Command Line can be modified to create a specific A+ Command Line. To add an A+ command for executing at the startup of Cleo A+, create a shortcut icon for the Cleo A+ Application. Then, single-click the right mouse button on the shortcut icon and select Properties, next, add your option(s) to the end of the Target file name (see Figure 2.1). Afterwards your shortcut is ready to execute with your pre-configured Command Line options.

Figure 2.1 Cleo A+ Command Line View

The Command Line options descriptions are in Chapter 1 - Configuration. If an invalid option is specified, A+ will exit with an exit code of 4. A+ may be executed without any options. If the APLUS.CFG configuration file does not contain a port name, you will get a prompt asking for the port name. The options below are not case sensitive and are usable on the Command Line, in the Configuration file, or in a Job file:

[CONFIGFILE=]ConfigFile is an option to select a custom configuration file. This option lets you run with settings other than the default configuration. You can create and/or change configuration files within A+ with the Configuration|Edit then Configuration|Save or Configuration|Save As menu options (see Chapter1. The Cleo A+ Configurator) If the configuration file extension is .CFG or .cfg, the CONFIGFILE= is implied, i.e. APLUS new.cfg and APLUS CONFIGFILE=new.cfg are the same. Note: If no CONFIGFILE= option is specified, A+ will use the parameters from APLUS.CFG file. If the APLUS.CFG file does not exist, A+ runs with the specified command line option settings or its own default configuration.



Command line options are order dependent, i.e. options are processed in the order they appear on the command line. Therefore, in order to override a configuration file option, the new option must appear after the CONFIGFILE=ConfigFile option on the A+ command line.

[JOBFILE=]JobFile is an option to execute a custom job/script file. This option allows you to run a series of A+ commands without operator intervention. You may create custom job files within A+ with the Window|Recorder Window menu option or the REC speed button (see 3.7.4 Recorder Window - Toggle Command Recorder Window), the JOb command, or with a standard text editor. If the job file extension is .JOB or .job, the JOBFILE= is implied, i.e. APLUS JOBFILE=new.job and APLUS new.job are the same. The JOBFILE=JobFile option corresponds to the StartUp|Job File Name menu option in the Configurator notebook.

LOGMODE=APPEND| OVERWRITE|NONE are optional commands for log file control. Only one of the three options is selectable. A+

includes the ability to log all commands and user messages to the log file APLUS.LOG. This log file is helpful in checking the status of the communications session. See A.3 The Log File for the log file format. The LOGMODE= command selects how APLUS.LOG is used: LOGMODE=OVERWRITE creates the log file APLUS.LOG if none exists or overwrites APLUS.LOG if it does exist. This is the recommended option; LOGMODE=APPEND creates the log file APLUS.LOG if none exists or appends to APLUS.LOG if it does exist; LOGMODE=NONE preserves the existing log file. A log file is not created and no transactions are recorded. This is the default. The LOGMODE=APPEND|OVERWRITE| NONE option corresponds to the StartUp|Log File Mode menu option in the Configurator Notebook.

DISPLAY=NORMAL| MINIMIZED|MAXIMIZED is an option to disable all or part of the A+ screen display. This is helpful when running job

files in the background or from another program. The DISPLAY= command selects which screens are displayed: DISPLAY=NORMAL starts the display with a NORMAL sized window and the Cleo A+ icon running on the task bar. This is the default; DISPLAY=MINIMIZED starts up a minimized A+ window and places an icon on the task bar. The message windows do not display in MINIMIZED mode. In addition, the A+ window can be restored to a normal size by right-clicking the mouse and selecting Restore from the menu, or by double-clicking the taskbar icon with the left mouse button. DISPLAY=MAXIMIZED starts up a MAXIMIZED window. All message windows will display.



TOKENS=ON|OFF|TokenList is an option to enable or disable tokens, environment variables, user-defined variables, pre-defined variables, and counter processing, and/or to set token variable(s). You can supply up to 19 tokens. If multiple tokens are specified, the entire token string must be enclosed in quotes, i.e. �TOKENS=token1 token2 token3�. These tokens may be accessed within A+ with %1%, %2%, %3%, or $1, $2, $3, etc. Tokens may also be enabled, disabled, set and/or changed with the TOken command (see 4.49 TOken - Enable, Disable, Display or Set Token Variables). Alternatively, with the EXecute command (see 4.18 EXecute - Execute Commands from a Job/Script File). Environment variables, user-defined variables, pre-defined variables, and counter processing will also enable or disable with the TOken command. The Token command is enable by default. The TOKEN=ON|OFF|TokenList option corresponds to the StartUp|Tokens menu option in the Configurator notebook.



2.2 Starting Cleo A+

To start the Cleo A+ from Windows, open Start|Programs|Cleo A+ and single click the mouse on the Cleo A+ icon.

2.2 Windows Start Menu

To start Cleo A+ , double-click the left mouse button on the Cleo A+ icon within the Cleo A+ group:



2.3 The Cleo A+ Window

The Cleo A+ for Windows display has the usual Window type interface when executed:

Figure 2.3 Cleo A+ Window

Note the location of the Title Bar, the Menu Bar, the Tool bar, and the Cleo A+ Status Bar.

2.3.1 Title Bar The Title Bar (see Figure 2.3) contains the Control Menu Icons in the right-hand corner, with the Minimize, Maximize, and Close icons. This Window can resize by clicking on and dragging the corner of the screen. The window can maximize to fill your entire screen by clicking on the maximize button. The window may be minimized to an application button by clicking on the minimize button. The Close icon will exit the Cleo A+ program.



2.3.2 Menu Bar From the Menu Bar, Cleo A+ menus can activate by clicking the left mouse button on a menu option.

Figure 2.3.2 Cleo A+ System Menu

Some submenu options have an ellipsis (...) directly after the option text. The Run Job... option, for instance, will open a Dialog Window which contains a directory listing of the job files in the default directory. While the Exit item will execute without additional prompts.

Some submenu options can display as dimmed instead of black. These options are not selectable at that moment. The Print current window... option, for instance, is not selectable until a window becomes open and selected. A window with focus will print. I.e. click on a command, log, monitor, terminal, or recorder window to print the contents of the window.

Submenu options can become active by typing the underscored letter of the desired option. The Alt key is not required to activate submenus. Pressing X, for instance, will execute the Exit option.

See Chapter 3. The A+ Menus for a description of each of the menu options.



2.3.3 Tool Bar Buttons A+ options may also be activated by clicking the left mouse button on the corresponding buttons. The buttons are:

Figure 2.3.3 Tool Bar Buttons

is the JOB icon for the System|Run Job Dialog Window

is the PRINT icon for the System|Print Current Window

is the DIAL icon for the Line|Dial Dialing Directory Window

is the HANG icon for the Line|Hangup Option

is the ANS icon for the Line|Answer Option

is the SEND icon for the Transmit|Send Dialog Window

is the RCV icon for the Receive|To File Dialog Window

is the CFG icon for the Config|Edit Window

is the CMD icon for the Windows|Command Window

is the LOG icon for the Windows|Log Window

is the MON icon for the Windows|Monitor Window

is the REC icon for the Windows|Recorder Window

is the TRM icon for the Windows|Terminal Window

is the HELP icon for the Help|Contents Window



2.3.4 Status Bar The Cleo A+ Status Bar is displayed at the lower edge of the A+ window. The Status Line normally displays the status of the A+ commands: the last status message, the line connection status, the device, speed, parity, data bits, and stop bits, and the status of the last command.

During local network, SLIP, or PPP host mode, the status line displays the terminal emulation status: the terminal type, the line connection status, and the host name or host number.

Where:

StatusMessage specifies intermediate status messages. When you point to a speed button, this section will display a short

explanation of the speed button.

LineStatus specifies the line connection status. LineStatus may be ONLINE or OFFLINE depending on the state of the CD (Carrier Detect) or DSR (Data Set Ready) signal on the COM port.

Device specifies the COM port used for communications. Device is set with the Port|Device menu option in the Configurator notebook or DEVICE=COMport parameter or at the A+ prompt.

Speed specifies the speed (in bits per second) used to talk to the COM port. Speed may be 1200, 2400, 4800, 9600, 19200, 38400, 57,600, or 115,200. Speed is set with the Port|Speed menu option in the Configurator notebook or with the SPEED=PortSpeed parameter; the default is 9600.

Parity specifies the parity on the port. Parity may be NONE, ODD, EVEN, MARK, or SPACE. Parity is set with the Port|Parity menu option in the Configurator notebook or with the PARITY=NONE|ODD|EVEN|MARK|SPACE parameter; the default is NONE.

DataBits specifies the number of data bits per byte. DataBits may be 7 or 8. DataBits is set with the Port|Data Bits menu option in the Configurator notebook or with the DATA=8|7 parameter; the default is 8.

StopBits specifies the number of stop bits per byte. StopBits may be 1 or 2. StopBits is set with the Port|Stop Bits menu option in the Configurator notebook or with the STOP=1|2 parameter; the default is 1.

HostName specifies the local network, SLIP, or PPP host socket name or number. The format of the host number is x.x.x.x, where each x may be 0 through 255.

LastStatus specifies the status of the last command executed. See A.3.3 Status Messages for a description of each status message.

During job file execution, the status bar displays the current job file command and the status of the last executed command in addition to the line connection status. Where: Command specifies the job/script command that is currently executing.

LastStatus specifies the status message from the previous job/script command.



2.4 File Transfer Status

When A+ sends or receives a file, it displays the following window:

Figure 2.4 Cleo A+ File Transfer Window

Where:

File Name is the name of the transmitting file. If the name of the file is too long to display, the path information displays as an ellipsis (...).

Protocol is the selected file transfer protocol.

Mode is the format the file is being sent or received in. The mode is Binary for non-translated files and Text for translated files.

Elapsed Time is the number of seconds from the beginning of the file transfer. Note this count updates every second unless it is transferring large blocks or the system is very busy.

Approx. CPS is the approximate number of characters successfully sent or received per second. The CPS updates after each acknowledged block.

% is the percentage of characters that have been successfully sent or received. This percentage updates after each acknowledged block. The percent does not update for ASCII, ANSI CLEAR, XMODEM, or XMODEM1K receives.

File Size is the number of characters in the file transferred. The file size does not post for ASCII, ANSI CLEAR, XMODEM, or XMODEM1K receives.

Bytes is the number of characters that have been successfully sent or received. This count updates after each block.



Errors is a running total of the number of non-fatal errors during the transfer of the current block. Check the Last Error for the type of error that last occurred.

Status displays the status of the last block transmitted.

Last Error displays a short description of the last error.

You can end the transfer at any time by clicking on the Cancel button.

The final transfer status will display on the status bar and in the log file (if open). See A.3.2 The Transmit/Receive Status Line for a description of status messages.



2.5 Running Cleo A+ in background mode

This section explains the requirements for the Cleo A+ to run in a silent or background mode using the HIDE Aplus.ini file option and DISPLAY Configuration file option.

The Aplus.ini file lists the HIDE option at a default setting of HIDE=1. When changing the HIDE to 2 Cleo A+ will initiate without the Aplus and Aserve icons on the Operating System's task bar. In addition, for this option to work another parameter must be set.

The Configuration file must include the DISPLAY=MINIMIZED. When using these settings, you will not be able to determine from the main screen that the program is running. However, by pressing CTR+ALT+DEL you will see both the Cleo A+ and the Aserve programs as operating tasks.

The background session can be ended by selecting the program (notice that you will have to end a job file this way if your job file branches continuously) and clicking the "End Task" button. If your job file does not have continuous branching in it and exits gracefully with the QUit command, there is no need to end the program with the CTR+ALT+DEL keys.



Chapter 3.

The A+ Menus

This chapter describes each of the Cleo A+ pull-down menus in detail. The following menus are in this chapter:

• System - Run jobs and print

• Edit - Clipboard access

• Line - Connect/disconnect phone line

• Transmit - Send to the host system

• Receive - Receive file(s)

• Configuration - Display or change configuration

• Window - Display or change windows

• Help - Display help information

The A+ commands used to run job files are described in Chapter 4 - A+ Commands.



3.1 System - Run Jobs and Print

The System menu lets you execute job files, configure your printer, print the current window, change the settings on your printer, display Cleo A+ Release Information, or Exit A+.

Figure 3.1 Cleo A+ System Menu Items

3.1.1 Run Job - Execute a Job/Script File The System|Run Job menu item (or JOB tool bar icon) causes A+ to sequentially process the commands in the selected job file. A job file is an ASCII text file consisting of one or more A+ commands to run automatically. A job file is similar to an operating system script or batch file.

Custom job files may be created with the Window|Recorder Window, the REC tool bar icon, the JOb command, or a text editor. See 3.7.4 Recorder Window - Toggle Command Recorder Window for recorder details. See A.2 The Job/Script File for the job file layout. See Chapter 5. Cleo A+ Tutorial for job file examples.



The Run Job menu item opens the following dialog box:

Figure 3.1.2 Cleo A+ Run Job|Open a Job File Dialog Window

This dialog box is a standard Windows file opening dialog box. The desired file name may be typed in at the File name text box or files may be selected from the list box which lists all files of the type selected in the Files of type list box. The Files of type lets you list only job files (files with the extension .job) or all files in the current drive and directory. The Look in (or Folders or Directories and Drives) list boxes let you select folders and drives.

To start a job file, single-click on a job filename in the window. The filename will appear in the File Name box. When you have selected (or typed) the job file you want to start, click the Open button to begin job file execution. You may exit the job file selection box without starting a session by clicking the Cancel button.

Upon completion of a job file that does not end with the QUit command, the program returns to interactive mode and monitors the line for further incoming data (with Auto Receive enabled). Many commands executed from within a job file remain in force after job file completion. For instance, if you had enabled the screen in a job file, all auto-received files will go to the screen.

The following methods will execute job files:

• Include the job file name as an option on the A+ command line: APLUS JOBFILE=FILE.JOB

• Set the Startup|Job Name menu item in the A+ Configurator before executing A+.

• Use the EXecute (execute job file) command from the A+ Command Windows prompt: Command> EXECUTE FILE.JOB



3.1.2 Print Current Window - Print the Contents of the Current Window The System|Print Current Window menu item (or PRINT tool bar button) lets you print the contents of the currently selected window. You can use this menu item to print the command, log, monitor, or recorder windows from within A+. The menu item appears dimmed if no windows are active.

3.1.3 Printer Setup - Select and Configure the Default Printer This printer setup dialog box is a standard Windows printer dialog box, which will vary on Windows version you are using. You can display a list of available printers by clicking on the arrow to the right of Name: or Specific Printer: Select your printer by clicking on the name in the list box. To configure your printer, select it in the list box then click on Properties.

Figure 3.1.3 Cleo A+ System|Print Setup



3.1.4 Information - Current A+ Information The System|Information menu item displays the current A+ version numbers, configuration and translation table files, etc.

Figure 3.1.4 Cleo A+ System|Information Window

3.1.5 Exit - Exit a Cleo A+ Session The System|Exit menu item lets you exit gracefully from a Cleo A+ session. Exit causes a log off message to write to the log file. All open files will close including the monitor, log, receive, and the print files.

The following methods will exit A+ gracefully:

• Click on the Cleo A+ icon on the heading bar and select Close, or click on the Windows Close (X) button in the upper right corner of the A+ window.

• Use the System|Exit menu item.

• Use the QUit command: Command> QUIT from the command window created by the Windows|Command Window menu item or from within a job/script file.



3.2 Edit - Clipboard Access

The Edit menu lets you cut, copy, and paste information within A+ command and terminal windows. Like most Windows programs, A+ lets you transfer text data to and from the clipboard. You, for instance, can copy information from your terminal window into your word processor or vice versa.

Figure 3.2 Cleo A+ Edit Menu Items

To select text within an A+ window:

Using the Mouse 1. Position the cursor at the beginning of the desired text. 2. Press and hold the left mouse button. 3. Move the mouse to the end of the text. 4. Release the mouse button.

3.2.1 Cut The Cut menu item transfers the selected text to the clipboard and removes the selected text from the window.

3.2.2 Copy The Copy menu item transfers the selected text to the clipboard but does not remove the selected text from the window.

3.2.3 Paste The Paste menu item copies the contents of the clipboard to the current cursor location in the current window.

3.2.4 Clear All The Clear All menu item copies the contents of the clipboard to the current cursor location in the current window.



3.3 Line - Connect/Disconnect Phone Line

The Line menu lets you dial, answer, or hang up your modem.

Figure 3.3 Cleo A+|Line Menu Items

3.3.1 Dial - Access the Dialing Directory The Line|Dial menu item (or DIAL tool bar button) lets you add to, delete from, or modify an entry in a customized dialing directory. It lets you manually dial telephone numbers not in the dialing directory, or automatically dial a number from the dialing directory.

Figure 3.3.1 Cleo A+ |Line |Dial Dialog Window

The Dialing Directory may have unlimited entries. Each dialing directory entry can have a label of up to 20 characters. Each entry contains custom telephone number, speed, parity, data bits, stop bits, and terminal type settings. All other settings will be from the current (or default) configuration settings. Each entry may also contain an optional job script file that starts upon connection.

The dial directory entries save to the APLUS.DIR file by default. You can create or modify this file with a standard text editor. The default dial directory filename may be changed with the DIALDIR=DialDirectoryFile parameter. See A.7 The Autodial Directory File for details.



To dial a telephone number from the dialing directory automatically, click on the directory entry to select it, then press the Ok button.

On external modems, the modem initialization is selected with the Modem|Modem Initialization String and Modem|Dial Initialization String menu items in the A+ Configurator (or the MODEMINIT=ATstring or DIALINIT=ATstring parameters).

Autodial is for modems with AT command set support.

A dial result message posts to the log file (if open). If the connection does not happen within the specified number of redial attempts, the dialing directory window will appear again allowing you to dial another number.

The Dialing Directory|Manual button or the AUtodial command can also dial the modem. (see 4.3 AUtodial - Automatic Dial).



3.3.1.1 Add - Add an Entry to the Dialing Directory

Add lets you add a dialing directory entry. To add to the dialing directory, click on the Add button. The following dialog box will appear:

Figure 3.3.1.1Cleo A+ Line|Dial|Add Dialog Window

The Name entry lets you identify the specified telephone number. The name is optional. It may be up to 20 characters in length.

The Phone Number entry is the telephone number and optional access code(s) for dialing. Use up to four numbers, separated by pauses, will dial the modem. The Phone Number format is:

[P] telephone# [Txx telephone#...] [Txx] [Rxx]

where:

P is an option to pulse dial. The default is tone dial.

telephone# is the telephone number or access code to be dialed. Use up to four numbers for an access code. Each additional number in a multi-number sequence proceeds by the Txx option. All numbers must be entered in one of the following formats: 18005551212 or 1-800-555-1212 Spaces are not allowed within a number.



Txx specifies a time delay in seconds. The Txx option must be included before each additional telephone number or access code dialed in a multi-number sequence. Valid entries for xx are 1 to 99.

The final Txx is optional and specifies the time to wait for the answer back tone from the remote modem. If the final Txx option is not specified, the answer back tone detect period is specified by the Dial|Wait for Connect menu option in the A+ Configurator (or DIALWAIT=WaitForConnect parameter). See 1.3 A+ Configurator - Modem for details.

Rxx specifies the number of redial attempts. Valid entries for xx are 1 to 31,000 or -1 for unlimited. After the final number dials, A+ monitors the line for an answer back tone detect period specified by the Wait for Connect or Txx option. When the answerback connects the communication session continues; otherwise, the auto dial sequence repeats according to the number of attempts specified by the Rxx option. When the Rxx option is omitted, autodial defaults to the number of redial attempts specified by Dial|Dial Retrys menu option in the A+ Configurator (or TIMES=DialRetrys parameter). See 1.3 A+ Configurator - Modem for details.

Examples:

Phone Number P 1-800-555-1212 R10

Pulse dialing (P) is used to dial the telephone number (1-800-555-1212) up to 10 times (R10). Phone Number 9 T5 18005551212 T10 6548110 R4

Tone dialing is used. A PBX access code (9) is dialed, a 5 second pause occurs (T5); the telephone number (18005551212) is dialed, a 10 second pause occurs (T10); an access code (6548110) is dialed. This sequence may repeat up to 4 times (R4) in attempt to complete the telephone connection. A message will display indicating the connection status.

The Terminal specifies the terminal emulation type. The default Terminal is VT100 (see 1.4 A+ Configurator - Terminal for more details).

The Speed specifies the speed used to talk to the port and modem. The default Speed is 9600 (see 1.2 Cleo A+ Configurator - Port for more details).

The Parity specifies the data parity. The default Parity is NONE (see 1.2.3 Parity for more details).

The Data Bits specifies the number of data bits. The default Data Bits is 8 (see 1.2 Cleo A+ Configurator - Port for more details).

The Stop Bits specifies the number of stop bits. The default Stop Bits is 1 (see Stop Bits in 1.2 Cleo A+ Configurator - Port for more details).



The Linked Script is an optional job/script file to execute after a successful telephone connection. You can use the DIALINGDIR pre-defined variables within this linked script file to determine if the script starts from the Dialing Directory. Example:

BRANCH ON $DIALINGDIR = YES TO 1 AUTODIAL Chicago BRANCH ON FAIL TO 100 1 FIND �login:�

This lets you run the same job/script file from a linked Dial Directory or directly with the System|Run Job menu option or the Job tool bar button. The default is no linked script.

The Dial Type specifies the method of dialing your host. The options are PSTN for standard dialing through A+ or WAN for wide area network dialing through the Windows Dial-Up Networking. Note: WAN dialing is not available in A+ for Windows 3.x or Windows NT 3.x versions. The default Dial Type is PSTN for standard A+ dialing (see 1.3.1 Dial Type in for more details).

When WAN dialing is selected the Speed, Parity, Data Bits, and Stop Bits options will become dimmed and it no longer will use the Port menu options, which are Device, Speed, Parity, Data Bits, Stop Bits, and Flow Control. The Device, Speed, Parity, Data Bits, Stop Bits, Flow Control, Wait for Connect, and Dial Initialization String options may be configured directly through the Windows Dial-Up Networking configuration menus; Windows will normally default Autobaud Enable to OFF. Other WAN dialing options may be set through the Configurator.

3.3.1.1 .1 Config - Configure for Network Dialing

The Config button lets you configure for WAN dialing s selectable only when the Dial Type is set to WAN.



3.3.1.1.1.1 Login When the Config button is selected the following tabbed menu appears:

The User Name specifies a user login name for PAP (Password Authentication Protocol) or CHAP (Challenge Handshake Authentication Protocol) link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require you to manually enter login information to establish a connection, which will require a pop up terminal window or running a script. See 1.7.1 User for more details.

The Password specifies an optional automatic user password for PAP or CHAP link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require you to manually enter login information to establish a connection, which will require a pop up terminal window or running a script. See 1.7.2 Password for more details.

The Domain Name specifies an optional automatic domain name for PAP or CHAP link authentication. Most modern systems will use the specified User, Password, and Domain parameters for automatic login during the connection sequence. Some Internet Service Providers (ISPs) and online services, however, may require you to manually enter login information to establish a connection, which will require a pop up terminal window or running a script. See 1.7.3 Domain for more details.

The Dial Using specifies the name of the modem to use for WAN dialing. Hitting the down arrow lets you display all the configured modems on your system. The WANSHOW command also displays the device numbers and device names known to the system. Note: The Device Name, if typed, must be an exact match including the number of spaces between words. Example: Standard 9600 bps Modem. See 1.7.7 Device Name for more details.

The After Dialing (login) selects how the user name, password, and domain name pass to the remote system. Most modern systems will use the specified User Name, Password, and Domain Name parameters for automatic login during the connection sequence and no special login is required. Some Internet Service Providers (ISPs) and online services, however, may require you to manually enter login information to establish a connection. This will require a pop up terminal window running on Windows or automating the login by running a script on Windows NT.

The Pop up a terminal window option specifies whether a terminal window displays for user login input after making the connection. A pop up terminal window is only available on Windows 95. This option corresponds to the �Bring up terminal window after dialing� checkbox in the Options menu of the modem properties; these properties are accessed through the �Configure� button on the phone book entry property page. The default is OFF. See 1.8.7 Terminal After Dial for more details.

The Run this script option lets you specify a script file for automating user logins while making the connection. Scripting is available only on Windows NT 4.0 with Service Pack 3 or later. With Scripting support for Dial-Up Networking under Windows NT, you can write a script to automate this process. A script is a text file that contains a series of commands, parameters, and expressions required by your ISP or online service to establish the connection and use the service. There are two types of script languages defined for Windows NT:

• Switch.INF file. You may edit this file directly from the Script tab on the Edit Phonebook Entry from the Dial-Up Networking window. This is the default.

• *.SCP files. Create these Dial-Up Scripting Command Language files with any text editor, such as Microsoft Notepad.

See the system root \SYSTEM32\RAS directory for more information on both of these scripting languages. See 1.7.8 Script for more details.



3.3.1.1.1.2 Server The Type of Dialup Server selects either PPP or SLIP frame protocol. The default is PPP. See 1.7.5 Frame Protocol for more details.

The Network Protocols options selects whether the TCP/IP or IPX protocol works for the network communications. The default is TCP/IP. See 1.7.4 Net Protocol for more details.

The Log on to network option specifies whether Dial-Up Networking logs on to the network after the point to point connection establishes. Under Windows, this option corresponds to the �Log on to network� checkbox on the �Server Type� menu. This option is desirable when you are logging on to networks where you must log on to access file servers. This option is not to be set up for Internet accesses since the network has no servers to authenticate the client. The default is OFF.

Note: With Windows NT, this option is disabled. See 1.8.12 Network Logon for more details.

The Enable software compression option specifies whether the PPP driver will attempt to negotiate CCP with the server. This option corresponds to the �Enable software compression� checkbox on the �Server Type� menu. The option selects by default, but not selecting this option can reduce the negotiation period if the server does not support a compatible compression protocol. The default is OFF. See 1.8.8 Software Compression for more details.

The Require encrypted password option specifies whether secure password schemes must be used to authenticate the client with the server. Selecting this option prevents the PPP driver from using the PAP plain-text authentication protocol and instead uses either CHAP or SPAP authentication protocol to authenticate the client. Deselecting this option allows PAP, CHAP, or SPAP authentication. This option is selectable for increased security, but should not be selected for increased interoperability. Under Windows 95, this option corresponds to the �Require encrypted password� checkbox on the �Server Type� menu. Under Windows NT, this option corresponds to the �Require encrypted password� checkbox on the �Security� menu. The default is OFF. See 1.8.9 Encrypt Password for more details. See also 3.3.1.1.1.2 Server.

The Enable PPP LCP extension option specifies whether the PPP LCP (Link Control Protocol) extensions defined in RFC 1570 enables. Enabling LCP extensions may be necessary to connect to certain older PPP implementations, but interferes with features such as server-callback. This option is selectable unless specifically required. The default is OFF.

Note: This option is not configurable with Windows 95. See 1.8.5 LCP Extensions for more details.

The Modem status option specifies whether the system task bar modem lights enable when the connection is active. With Windows 95, this option corresponds to the �Display modem status� checkbox in the Options menu of the modem properties; these properties access through the �Configure� button on the phone book entry property page. With Windows NT, this option is currently ignored; the appearance of modem lights is controlled by the �Show modem and ISDN lights� checkbox on the global Dialing Preference-General menu. The default is OFF. See 1.8.6 Modem Lites for more details.



3.3.1.1.1.3 TCP/IP The Server assigned IP Address and Specific IP Address options sets whether a specific IP address routes for the dial-up connection. When selecting the Server assigned IP Address, the server assigns the value of the IP Address option and the following IP address setting is not selectable. This corresponds to selecting the �Server assigned IP address� setting in the TCP/IP Settings menu of the Dial-Up Networking configuration. If the Specific IP Address option is selected, Dial-Up Networking will try to use the specified IP Address as the address for the dial-up connection; this corresponds to selecting the �Specify an IP address� setting in the TCP/IP Settings menu of the Dial-Up Networking configuration. The default is Server assigned IP Address OFF and Specific IP Address ON. See 1.8.1 Specific IP Address for more details.

The IP Address option is selectable only when the Specific IP Address is set. The IP Address option works to specify an intermediate dial-up IP Address. The format of the IP Address is x.x.x.x, where each x may be 0 through 255. Dial-Up Networking will try to use the selected IP Address as the address for the dial-up connection. To avoid errors during dialing, you must either enter an IP Address or select the Server assigned IP Address option. See 1.7.10 IP Address for more details.

The Server assigned name server addresses and Specific name server addresses options control whether a specific name server address is available for the dial-up connection. If the Specific name server addresses option is selected, the following Primary DNS, Secondary DNS, Primary WINS, and Secondary WINS addresses are used to specify the name server addresses for the dial-up connection. This corresponds to selecting the �Specify name server addresses� setting in the TCP/IP Settings menu of the Dial-Up Networking configuration. When selecting the Server assigned name server addresses option, the server will assign the name server and Dial-Up Networking will ignore values. The values that it ignores are Primary DNS, Secondary DNS, Primary WINS, and Secondary WINS; this corresponds to selecting the �Server assigned name server addresses� setting in the TCP/IP Settings menu. The default is Server assigned name server address ON and Specific name server addresses OFF. See 1.8.2 Specific Server Address for more details.

The Primary DNS option specifies a primary Domain Name Server address. The Domain Name Server will find an IP address for the specified Host name. The format of the DNS address is x.x.x.x, where each x may be 0 through 255. See 1.7.11 DNS for more details.

The Secondary DNS option specifies a secondary Domain Name Server address. This alternate Domain Name Server is used to find an IP address for given Host names if it cannot be located on the primary Domain Name Server. The format of the DNS Alt. address is x.x.x.x, where each x may be 0 through 255. See 1.7.12 DNS Alt for more details.

The Primary WINS option specifies a primary Windows Name Server address. The Windows Name Server finds an IP address for a given Host name using non-routable protocols like NetBIOS and NetBEUI. The format of the WINS address is x.x.x.x, where each x may be 0 through 255. See 1.7.13 WINS for more details.

The Secondary WINS option specifies a secondary Windows Name Server address. This alternate Windows Name Server finds an IP address for a given Host if it cannot be located on the primary Windows Name Server. The format of the WINS Alt. address is x.x.x.x, where each x may be 0 through 255. See 1.7.14 WINS Alt for more details.

The Use IP header compression option specifies whether or not Dial-Up Networking will negotiate to use IP header compression on PPP connections. This option corresponds to the �Use IP Header compression� checkbox in the TCP/IP Settings menu of the Dial-Up Networking configuration. Selecting this option allows IP header compression to significantly improve performance. Disable IP header compression when connecting to a server that does not correctly negotiate IP header compression. The default is OFF. See 1.8.3 Header Compression for more details.

The Use default gateway on remote network option specifies whether the default route for IP packets will be through the dial-up adapter when the connection is active. This option corresponds to the �Use default gateway on remote network� checkbox in the TCP/IP Settings menu. With an unselected option, the default route remains unmodified. The default is OFF. See 1.8.4 Remote Gateway for more details.



3.3.1.1.1.4 Security The Accept any authentication including clear text option allows the PPP driver to use any of the PAP, CHAP, or SPAP authentication protocols to authenticate the client. Select this option for increased interoperability. Under Windows NT, this option corresponds to the �Require encrypted password� checkbox on the �Security� menu. The default is ON. See 1.8.9 Encrypt Password for more details.

The Accept only encrypted authentication option allows either CHAP or SPAP (but not PAP) authentication protocol to authenticate the client. Select this option for increased security. Under Windows NT, this option corresponds to the �Require encrypted password� checkbox on the �Security� menu. The default is OFF. See 1.8.9 Encrypt Password for more details.

The Accept only Microsoft encrypted authentication option specifies whether the Microsoft�s secure password schemes authenticate the client with the server. Selecting this option prevents the PPP driver from using the PPP, CHAP, or SPAP. Select this option for maximum security. Under Windows NT, this option corresponds to the �Require Microsoft encrypted password� checkbox in the �Security� menu. The default is OFF. See 1.8.10 MS Encrypt Password for more details.

The Require data encryption option specifies whether data encryption must be negotiated successfully for the connection to be established. This option is not selectable unless Accept only Microsoft encrypted authentication is also set. Under Windows NT, this option corresponds to the �Require data encryption� checkbox in the �Security� menu. The default is OFF. See 1.8.11 Data Encrypt for more details.

The Use current name and password option specifies whether the username, password, and domain of the currently logged on users are for dialing. Ignore this option unless Accept only Microsoft encrypted authentication is selectable. Under Windows NT, this option corresponds to the �Use current username and password� checkbox in the Security menu. The default is OFF. See 1.8.13 Use Logon Credentials for more details.

3.3.1.2 Delete - Delete a Dialing Directory Entry

Delete lets you remove entries from the dialing directory. To remove selected entries, click on the directory entry then click the Delete button. Verify the deletion when the prompt appears.

3.3.1.3 Edit - Edit a Dialing Directory Entry

Edit lets you modify entries in the dialing directory. To make modifications to selected entries, click the left mouse button on the directory entry then click the Edit button. A window similar to the Add window will appear.

3.3.1.4 Manual - Manual Dial a Phone Number

Manual lets you dial a telephone number not in the dialing directory. To dial a new telephone number, click the Manual button. The following dialog box will appear:



Figure 3.3.1.4 Cleo A+|Line|Dial|Manual Dialog Window

The Dial options are:

Delay is an option to specify a five-second-time delay (T5). This corresponds to the AUtodial Txx option. The delay time lengthens via the keyboard. Valid entries for xx are 1 to 99. The final delay is optional and specifies the time to wait for the remotes answer tone. If the final Txx option is not specified, the answer back tone detect period is 60 seconds or Wait for Connect.

Pulse is an option to pulse dial. The default is tone dial. This corresponds to the AUtodial P option.

Tone is an option to tone dial. This is the default.

Retries is an option to specify three redial attempts. This option corresponds to the Rxx option. The number of redials change via the keyboard. Valid entries for xx are 1 to 31,000 or -1 for 31,000. After the final number is dialed, A+ monitors the line for about 60 seconds to detect an answer back tone from the remote modem. If the answer back tone is detected, communications are enabled, otherwise the auto dial sequence will be repeated according to the number of attempts specified by the Rxx option. When omitting the Rxx option, the Dial defaults to three redial attempts or Dial Retrys.

Cancel is an option to stop Cleo A+ from continuing in the dialing process. Use the Cancel button at any time during the dialing.

To automatically dial the telephone number click on the Ok button.

3.3.2 Hangup - Hangup the Phone Line The Line|Hangup menu item (or Hang Up tool bar button) enables the A+ program to disconnect the current phone line connection. Note: If the line is disconnected during the session, A+ will remain in answer mode for further transactions. Hangup does not disable the autoanswer. To disable the modem from answering, use the VOice command.

The HAngup and the VOice commands will hangup the modem. (see 4.22 HAngup - Disconnect Phone Line and 4.50 VOice - Disconnect Phone Line and Disable Autoanswer for more details).



3.3.3 Answer - Answer the Phone Line The Line|Answer option (or the Telephone tool bar button) disconnects the current telephone line connection and initializes the modem for autoanswering.

On external modems, the modem initialization is selected with the Modem|Modem Initialization String and Modem|Dial Initialization String menu options in the A+ Configurator (or the MODEMINIT=ATstring or DIALINIT=ATstring parameters). The speed at which the modem initialization string is sent is selected with the Port|Speed menu option in the A+ Configurator (or the SPEED=PortSpeed parameter).

Answers with the ANswer command (see 4.1 ANswer - Automatic Answer for more details).

3.3.4 Data - Enter Data Mode The Line|Data menu item sets A+ to ignore the state of the carrier detect (CD) or data set ready (DSR) signals and enter an ONLINE state so that data transfer may occur. The Data Terminal Ready (DTR) signal is raised. No protocol is on the line as the result of this command.

The DAta command (see 4.13 DAta - Data Mode for more details).



3.4 Transmit - Send to the Host System

The Transmit menu lets you send files or keyboard messages to the remote system. The Transmit menu options are not selectable when off-line.

Figure 3.4.1 Cleo A+ Transmit Menu Items



3.4.1 Send - Send File(s) in Scanned Mode The Transmit|Send menu item (or SEND tool bar button) may be used to transmit any file(s) to the remote system. Selecting the Send, Binary, or Text menu items opens the following window:

Figure 3.4.1 Cleo A+ Transmit Menu Items

3.4.1.1 Selecting Files to Send

The File Select dialog box is similar to standard Windows file opening dialog boxes. Type the desired file name into the File Name box. Files are selectable from the list box below, which lists all files of the type selected in the List Files of Type list box. The Directories and Drives list boxes lets you change both drives and directories.

To select a file, double-click on a filename in the list box or click on a filename in the list box then press the Select button. The filename will appear in the File Name box, and the drive, path, filename, and mode (in parentheses) will appear in the Selected Files list. To select all the files listed in the Files list box, press the Select All buttons to transfer all the files into the Selected Files list box. To remove all the selected files, press the Clear button. To remove individual files, click on a filename in the Selected Files list box then press the Delete button.

3.4.1.2 Protocol

The current file transfer type from the File Transfer|Protocol menu in the A+ Configurator is displayed. To select a different protocol for this file transfer click the mouse on the down arrow, then click on the desired protocol from the list.



3.4.1.3 Character Translation

Each file may be translated through the xlatout.ovr file before being sent or may be sent as-is. The translation selection, displayed in the two checkboxes, apply to the currently highlighted file in the Selected Files listbox.

No Translation sends the data as-is. Without this menu item, the File Transfer|Default Send Mode menu option in the A+ Configurator (or the DEFSENDMODE=BINARY| TEXT|SCAN parameter) is used to determine whether the message is translated before transmission. This menu item corresponds to the SEnd, TExt, BInary, or KEy -N option.

Translation enables the translation of the data via the XLATOUT.OVR file before transmission. Without this menu item, the File Transfer|Default Send Mode menu option in the A+ Configurator (or the DEFSENDMODE=BINARY| TEXT|SCAN parameter) is used to determine whether the message is translated before transmission. This menu item corresponds to the SEnd, TExt, BInary, or KEy -T option.

3.4.1.4 Remote File Naming

A+ will support remote file naming when communicating with YMODEM, YMODEMG, ZMODEM, or KERMIT. This remote name, the same name as the original, will assign to the file received by the remote processor.

3.4.1.5 Sending Files

After you have typed the file name to send or queued the files to send in the Selected Files list box, click the Ok button to transfer the file(s) to the remote. You can exit the File Select box without sending the files by pressing the Cancel button.

A File Transfer Status box displays on the screen during transmission. See 2.4 File Transfer Status for details. The transmission can abort at any time with the Cancel button. After transmission, a status posts to the status line on the window, and a status line is written to the log file (if open). This gives a completion status message for the transmission including the number of data blocks sent (see A.3.3 Status Messages for more details).

Note that if one of a group of selected files terminates by anything other than a NRMEOF (normal end of file) status, you will receive a prompt to cancel the remaining transfers.

The Send menu items can execute with the SEnd command (see 4.43 SEnd - Transmit File(s) for more details).

3.4.2 Binary - Send File(s) in Binary Mode The Transmit|Binary menu item may be used to transmit any files to the remote system in transparent mode. These files transmit "as is". Executable files and other non-ASCII files transmit with the Binary option only.

See 3.4.1 Send - Send File(s) in Scanned Mode for more details. Note the character translation option is not available. All files are sent as-is without translation.

The Binary menu items execute with the BInary command also (see 4.4 BInary - Transmit Binary File(s) for more details).

3.4.3 Text - Send File(s) in Text Mode The Transmit|Text menu item may be used to transmit files to the remote system. These files translate through the XLATOUT.OVR file before transmission. Translation is, for instance, to compensate for character differences between line terminator values on different operating systems.



Word processors create documents that appear to be ASCII files, and the temptation is to transmit these files using the Text option. However, some word processing packages change the high bit on each character, specifying a command to the word processor. If you suspect this is the case with your word processor, send the document files using the Binary option.

See 3.4.1 Send - Send File(s) in Scanned Mode for more details. Note: the character translation option is not available. All files translate before sending them.

The Text menu items also execute with the TExt command (see 4.48 TExt - Transmit Text File(s)).

3.4.4 Key - Send a Message in Text Mode The Transmit|Key menu item is used to send a keyboard message to the remote system. This message is normally sent �as-is� without translation.

3.4.4.1 Entering the Message Text

Type the desired message into the Message Text box. The message must not be longer than 150 characters. The message may include multiple lines. To send non-ASCII characters, use the \ replacements listed in Table 4.1 Non-ASCII Character Replacements in Chapter 4 - A+ Commands.




Each message may be translated through the xlatout.ovr file before being sent or may be sent as-is. The translation selection displays in the two checkboxes:

No Translation data sent as-is. Without this option, the File Transfer|Default Send Mode menu option in the A+ Configurator (or DEFSENDMODE=BINARY| TEXT|SCAN parameter) is used to determine whether the message is translated before transmission. This option corresponds to the SEnd, TExt, BInary, or KEy -N option.

Translation data translates through the XLATOUT.OVR translation table before transmission. Without this menu item, the File Transfer|Default Send Mode menu option in the A+ Configurator (or DEFSENDMODE=BINARY| TEXT|SCAN parameter) is used to determine whether the message is translated before transmission. This menu item corresponds to the SEnd, TExt, BInary, or KEy -T option.

3.4.4.3 Sending the Message

After you have typed the message to send in the Message Text box, click the Ok button to transmit the message. You can exit without sending the message by pressing the Cancel button.

The Key menu item may also be executed with the KEy command (see 4.25 KEy - Transmit a Keyboard Message for more details).



3.5 Receive - Receive File(s)

The Receive menu lets you receive one or more files from the remote system and save them to a disk file, spool them to a selected printer, or display them to the screen. The Receive menu items will appear dimmed when the line is disconnected.

Figure 3.5 Cleo A+ Receive Menu Items

3.5.1 To File - Receive File(s) to Disk File The Receive|To File menu item (or RCV tool bar button) places A+ into receive mode and waits to receive one or more files from the remote terminal. Received files normally save �as-is�.

3.5.1.1 Setting the Filename

The File Name menu item lets you specify the file name for receiving. When the Receive|To File (or To Printer or To Screen) option is selected, a will box appear that lets you save the file to your hard disk.

When specifying no filename for YMODEM, YMODEMG, ZMODEM, or Kermit file transfers, the file saves as the incoming file name. When specifying no filename for XMODEM, XMODEM1K, ASCII, or ANSI Clear transfers, the received files accumulate serially as RCVFILE.000, RCVFILE.001, etc.

When specifying a filename, but no file extension, files accumulate serially starting at .000. For example, setting the File Name to mytext will save data to the file mytext.000 unless mytext.000 already exists. If mytext.000 exists, mytext.001 is tried, and so on, until it finds a nonexistent filename. Note: the original text is lost if it writes to a file with the same file name.

When specifying a filename with a numeric extension, files accumulate serially starting at that number. For example, setting the File Name to mytext.000 will save data to mytext.000 regardless of whether a file already exists with that name. Note: the original file mytext.000 is lost.

When specifying a filename with a period and no extension or with a non-numeric extension, after the first receive file saves; additional files accumulate serially starting with a .000 extension. For example, setting the File Name to mytext will save data to mytext regardless of whether a file already exists with that name. The next file received saves as mytext.000, mytext.001, etc. Note: the original text is lost if it writes to a file with the same file name.

When in FTP file transfer mode, you may specify two filenames. The required first filename is the file on the host that you want to receive. To transfer from a directory other than your FTP login directory (which may be different from your host login directory or your current host directory), you must specify the host�s path name and file name. The optional second filename is the file to save on your system. If the second file name is not specified, the file is saved as the host filename without the path.



3.5.1.2 Protocol

The current file transfer type from the Configure File Transfer|Protocol menu is displayed. To select a different protocol for this file transfer click on the down arrow, then click on the desired protocol from the list.


Each file may be translated through the xlatin.ovr file upon reception or may be saved as-is. The translation selection, displayed in the two checkboxes, apply to the currently highlighted file in the Selected Files list box.

No Translation allows data to be saved as-is. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFSENDMODE= BINARY|TEXT parameter) is used to determine whether the message is translated upon reception. This option corresponds to the REceive, PRint, or SCreen -N option.

Translate allows data to be translated through the XLATIN.OVR translation table upon reception. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFSENDMODE= BINARY|TEXT parameter) is used to determine whether the message is translated upon reception. This option corresponds to the REceive, PRint, or SCreen -T option.

3.5.1.4 Receiving File(s)

A File Transfer Status window displays on the screen during reception. See 2.4 File Transfer Statusfor more details. To abort the receive select the Cancel button at any time. After each receive completes, a status line is posted to the log file (if open) giving a completion status message for the reception including the number of data blocks sent. (See A.3 The Log File for more details).

A+ continues to receive files and write them to disk until (1) an end of transmission is received from the remote, or (2) the receive mode is exited with the Cancel button, or (3) the receive timeout has expired. In Auto Receive mode, the To File option is in effect until another receive mode is entered with a To File, To Screen, or another To Printer option.

The REceive, PRint, or SCreen commands will also receive files.

The To File option may also be executed with the REceive command (see 4.38 REceive - Receive File(s) for more details).



3.5.2 To Printer - Print Received File(s) The Receive|To Printer menu item places A+ in receive mode and waits to receive one or more files from the remote terminal. This is equivalent to the Receive|To File option, except that files are automatically spooled to the default printer.

The To Print File Name is described in 3.5.1.1 Setting the Filename. With no Print filename specified, all received print files accumulate serially as PRINT.000, PRINT.001, etc. Note: The default file name PRINT may be changed (see A.1 The Configuration File for more details).

The To Printer options are described in 3.5.1.2 Protocoland 3.5.1.3 Character Translation.

A File Transfer Status window displays on the screen during reception. See 2.4 File Transfer Status for details. You may abort the transmission with the Cancel button at any time. After receiving each file, a status line writes to the log file giving a completion status for the reception including the number of data blocks sent. (See A.3 The Log File).

A+ continues to receive files and write them to disk until (1) an end of transmission is received from the remote, or (2) the receive mode is exited with the Cancel button, or (3) the receive timeout has expired. In Auto Receive mode, the To File option is in effect until another receive mode is entered with a To File or another To Printer option.

Note: After one file terminates with an error the remaining files will not be received.

The REceive, and PRint commands will receive files also.

The To Printer option may also be executed with the PRint command (see 4.35 PRint - Receive File(s) & Spool to Printer).



3.6 Configuration - Display or Change Configuration

The Configuration menu provides a method of viewing or changing the A+ configuration file.

Figure 3.6 Cleo A+ Configuration Menu Items

3.6.1 Load - Load a Configuration File The Configuration|Load menu items bring up a standard file selection dialog box to lets you select a new configuration file. This Configuration File Select dialog box is a standard Windows file opening dialog box. Type the desired file name into the File Name box. A file is selectable from the list box below, which lists all files of the type selected in the Files of Type list box. The Files of Type list box lets you list only configuration files (files with the extension .CFG) or all files in the current drive and directory. The Folders/Directories and Drives list boxes lets you change either folders or directories and drives.

To select a configuration file, click on a filename in the file list box. The filename will appear in the File Name box. When you have typed or selected a configuration file, press the OK button to load the configuration parameters from the selected file. You can exit the Configuration File Select box without loading a configuration file by pressing the Cancel button.

The CONFIG ConfigFile command may also be used to load a custom configuration file.



3.6.2 Save - Save the Current Configuration The Configuration|Save menu item lets you update the current configuration file with new settings. To modify an existing configuration file, first Load the configuration file to be changed, Edit the settings, and Save them.

The following methods may be used to load these configuration files for subsequent A+ executions:

• Include the configuration file name as an argument when A+ is executed: APLUS -C FILE.CFG

• Enter the filename with the Configuration|Load menu item within A+.

• Place the COnfig command with a filename on the command line. CONFIG FILE.CFG from the Windows|Command Window menu item or within a job/script file.

If the Save or Save As menu item is not used, configuration changes are in memory only until the program is exited.

The SAve command saves the current configuration settings.

3.6.3 Save As - Save Current Configuration under a New Name The Configuration|Save As menu item brings up a standard file selection dialog box to lets you write the current configuration to a new file. This Configuration File Select dialog box is a standard Windows file opening dialog box. Type the desired file name is in the File Name box. The list box below lists all current files of the type selected in the Files of Type list box. The Files of Type box lets you display saved configuration files (files with the extension .CFG) or all files in the current drive and directory. The Folders/Directories and Drives list boxes lets you change both folders and directories and drives.

Entering the filename APLUS.CFG allows this configuration to become the A+ default. When you have typed a configuration file, press the OK button to save the current configuration parameters to the new file. You can exit the Configuration File Select box without saving a configuration file by pressing the Cancel button.

If the Save or Save As menu item is not used, configuration changes are in memory only until the program is exited.

The SAve command saves the configuration setting also.

3.6.4 Edit - Edit the Current Configuration The Configuration|Edit menu item (or CFG tool bar button) brings up the A+ A+ Configurator which allows you to change the current configuration settings. See Chapter 1. The Cleo A+ Configurator for more details.



3.6.5 Translation Tables - Load a Translation Table The Configuration|TranslationTables menu item provides an easy method of viewing or changing the incoming and outgoing character translations. After you select the Translation Tables menu item, the following window will appear:

Figure 3.6.5 Cleo A+ Configuration Menu Items|Translation Table Menu Item Dialog Window

Where:

Outgoing Table is the outgoing translation file previously created with a text editor. See A.6 The Character Translation Files. The default outgoing table file name is XLATOUT.OVR.

Incoming Table is the incoming translation file previously created with a text editor. See A.6 The Character Translation Files for the required file format. When this incoming table filename is blank, the Outgoing Table file is for incoming conversions as well. The default incoming table file name is XLATIN.OVR.

The Browse button brings up a standard file selection dialog box to lets you select a file for the highlighted translation table. This Translation Table dialog box is a standard Windows dialog box, and you may type your file name into the File Name box, or select it from the list box. The list box lists files of a type, which is selectable in the Files of Type list box. The Files of Type list box lets you list overlay files (files with the extension .OVR) or all files in the current drive and directory. The Folders/Directories and Drives list boxes lets you change both folders and directories and drives.

To select a translation table file, click on a filename in the files list box. The filename will appear in the File Name box. When you have typed or selected a translation file, press the OK button. You can exit the Translation Table Selection box without selecting a new translation table by pressing the Cancel button.

The Edit button brings up the Notepad editor and lets you view or change the current table.

The Translation Tables menu item executes with the Table command (see 4.47 TAble - Display or Change Translation Table(s) for more details).



3.7 Window - Display or Change Windows

The Window menu item lets you toggle the A+ command, log, monitor, and job recorder windows on and off and change the way they display. You may use the up arrow to view prior data in the window while A+ is idle, but because of a limited buffer size, beginning data may no longer be displayable. Any of these windows may be moved, minimized, or maximized through the Control menu icon/box in the upper left corner or the minimize and maximize buttons in the upper right corner.

Figure 3.7 Cleo A+ Window Menu Items

3.7.1 Command Window - Toggle the Command Window The Window|Command Window menu item (or CMD tool bar button) lets you enter A+ commands interactively. This allows for backward compatibility with the older versions. The A+ commands are described in Chapter 4 - A+ Commands.

3.7.2 Log Window - Toggle the Log Window The Window|Log Window menu item (or LOG tool bar button) lets you toggle the state of the A+ log. This protects sensitive data in the job file (for example, passwords) and lets other commands log as usual. When the log enables, A+ directs log messages to the log window and to the log file.

The log may also be initialized with the Startup|Log Mode menu item in the A+ Configurator before executing A+. The log file is specified with the Startup|Log Name menu item in the A+ Configurator. The default name is APLUS.LOG.

The Log Window menu item may also be executed with the LOg command (see 4.30 LOg - Open, Close, or Write to the Log File).



3.7.3 Monitor Window - Toggle the Line Monitor Window The Window|Monitor Window menu item (or MON tool bar button) lets you toggle the state of the built-in serial line monitor, when the Monitor Window is on in the Configuration Startup. This line monitor displays the actual received/transmitted protocol to the Monitor Window and writes it to the monitor file. The monitor is helpful for determining communication errors.

Directing protocol information to a disk file consumes a lot of disk space. It is usual for the monitor file size to be approximately four times as large as the data received or transmitted. Sending a 100K file may actually create a 500K monitor file.

The monitor may be initialized with the Startup|Monitor Mode menu item in the A+ Configurator before executing A+. The monitor file name is specified with the Startup|Monitor Name menu item in the A+ Configurator. The default name is APLUS.MON.

See A.4 The Monitor File

The Monitor Window menu item executes with the MOnitor command (see 4.32 MOnitor - Open or Close a Serial Line Monitor).

3.7.4 Recorder Window - Toggle Command Recorder Window The Window|Recorder Window menu item (or REC tool bar button) lets you record all the A+ actions to create a job file. A job file is an ASCII file consisting of one or more A+ commands to run automatically. A job file is similar to an operating system script or batch file.

The job recorder may be initialized with the Startup|Recorder Mode menu item from the Setup program or the A+ Configurator before executing A+. The job file name is specified with the Startup|Recorder File Name menu item in the A+ Configurator. The default name is APLUS.MON. If the job file exists, the recorder appends new commands to the end of the file.

Executed A+ menu menu items will be entered into the specified job file as A+ commands (see Chapter 4. Cleo A+ Command Language). To end the job file, toggle the Recorder Window off.

Job files may also be create with the JOb command (4.24 JOb - Record Commands or Scramble a Job/Script File) or created and/or modified with a standard text editor. See A.2 The Job/Script File for the job file layout. See Chapter 5. Cleo A+ Tutorial for job file examples.

Any of the following methods will execute these job files:

• Include the job file name as an argument when A+ is executed: APLUS -J FILE.JOB

• Set the Startup|Job Name menu item from the A+ Configurator before executing A+.

• Enter the job file name with the System|Run Job menu item or the JOB tool bar button.

• Use the EXecute (execute job file) command: Command> EXECUTE FILE.JOB from the Windows|Command Window menu item or from within another job/script file.



3.7.5 Terminal Window - Toggle the Terminal Emulation Window The Window|Terminal Window menu item lets you toggle the state of the A+ terminal emulation window. This lets you disable the terminal emulation window if you do not need terminal emulation. Enabling terminal emulation will direct all non-file transfer messages to the terminal emulation window.

3.7.6 Cascade - Cascade All A+ Windows The Window|Arrange|Cascade menu item lets you arrange all the A+ command, log, monitor, and recorder windows in a cascaded format where each window is the same size descending from the upper left corner of the A+ main window. This is the default window arrangement.

3.7.7 Tile Vertically - Tile All A+ Windows Vertically The Window|Arrange|Tile Vertically menu item lets you arrange all the A+ command, log, monitor, and recorder windows in a vertically tiled format so each is visible and none are overlapping.

3.7.8 Tile Horizontally - Tile All A+ Windows Horizontally The Window|Arrange|Tile Horizontally menu item lets you arrange all the A+ command, log, monitor, and recorder windows in a horizontally tiled format so each is visible and none are overlapping.

3.7.9 Arrange Icons - Line Up All A+ Window Icons The A+ command, log, monitor, and recorder windows can be minimized (made into icons) and remain active. These icons can be dragged anywhere within the A+ main window. The Window|Arrange|Arrange Icons menu item gathers up these icons and places them in a line at the bottom of the A+ main window.

3.7.10 Close All - Close All A+ Windows The Window|Arrange|Close All menu item closes the A+ command, log, monitor, and recorder, and terminal windows at one time.



3.8 Help - Display Help Information

The Help menu provides an online A+ manual. A+�s Help is in standard Windows Help format. Click on any underlined topic to view information on that topic. Alternatively, press the TAB key to select the topic and then press ENTER to view. If you are unfamiliar with Help, the Help|Using Help menu item displays more information on using Help.

Figure 3.8 Cleo A+ Help Menu Items

3.8.1 Contents - Online A+ Manual The Help|Contents menu item (or HELP tool bar button) displays a table of contents. From this table of contents, you can access any part of the A+ for Windows manual.

3.8.2 Using Help - Help Information About Using Help The Help|Using Help menu item describes how to use Help.

Chapter 4 - A+ Commands


Chapter 4. Cleo A+ Command Language

This chapter describes the A+ commands in detail, the way that they run, the effect on the script, and the environment. Unless advised otherwise, commands are usable in the script, as well, as interactively from the Command prompt. In addition, they can execute with scripting during unattended operations. The listing below is in a functional and alphabetical order. See Chapter 5. Cleo A+ Tutorial for examples of asynchronous sessions. This chapter discusses the following commands:

Going ONLINE or OFFLINE: • AUtodial - dialing with modem • ANswer - answering to go online • HAngup - going offline • VOice - going offline and disabling answering • DAta - changing to online without dialing or checking for Carrier Detect • AT - setting up the modem for dialing or answering • LIneup - checking the line status for online or offline • CONNECT - connecting with FTP or Telnet for PPP sessions

Sending and Receiving: • SEnd - Transfer data • BInary - Transfer binary file(s) • TExt - Transmit text file(s) • KEy - Transmit a keyboard message • REceive - Receive file(s) • PRint - Receive file(s) and spool to printer • FInd - Receive data until string match • GEt - Get information from remote user

Setting up the sessions parameters • COnfig - Display or change configuration • SAve - Save the current configuration • LEt - Set a configuration parameter or user variable • TAble - Display or change translation table(s)

Keeping records: • Display - Display Message on Screen • LOg - Open, close, display, or write to the log file • MOnitor - Open or close a serial line monitor • HElp - Command and configuration help information

Write scripts for automated sessions: • JOb - Record session or scramble a job/script file • EXecute - Execute commands from a job/script file • RETURN - Return to calling job/script file • ## - Job/script comment line

Use conditional commands and for smart acting scripts: • IF - Perform following commands if a condition is true • ELSE - Perform following commands if IF condition is false • ENDIF - End IF/ELSE condition • BRanch - Branch in job/script file based on condition



Use variables to create flexible scripts: • TOken - Enable, disable, display, or set token variables • LEt - Set a configuration parameter or user-defined variable • STart - Display or initialize counter • +COUNTER - Increment counter • -COUNTER - Decrement counter

Use creative file functions: • EXISTS - Check if file exists • OPEN - Open a READ or WRITE file • READ - Read a line from READ file • WRITE - Write a line to a WRITE file • CLOSE - Close a READ or WRITE file • DELETE - Delete file(s)

Use string commands to get exact information: • LENGTH - Get the length of a string • COMPARE - Compare two strings • COMBINE - Combine two strings • LEFT - Get leftmost characters of a string • MID - Get middle characters of a string • RIGHT - Get rightmost characters of a string • SEARCH - Search string for a character or string

Use WAN when PPP connections over dialup is necessary: • WANGETENTRY - Get WAN settings from a phone book entry • WANSETENTRY - Create WAN phone book entry • WANSHOW - Display WAN devices and connections

Use theses additional commands to let scripts perform: • SYstem - Execute an operating system command or application program • WAitfor - Wait until specified time • SLeep - Pause specified seconds • QUit - Exit A+ Most A+ commands execute by entering the first two letters of the desired command. Type in full all Commands that are in caps.



4.1 ANswer - Automatic Answer

The ANswer command lets you disconnect the line, configure the modem to auto-answer, and wait for a specified amount of time or until a specified time for an incoming telephone call. The ANswer command line format is:

ANswer minutes [port] or

ANswer hh:mm

where:

minutes is the number of minutes (1-9999) to wait for an incoming phone call.

port is the optional host or local port number. This is valid only if a host has been specified with the HOST=HostName option. You may alternately use the CONNECT LISTEN port command for an untimed wait for connection. See 4.10 CONNECT - Connect to or Disconnect from a Telnet, FTP, or OFTP for details.

hh:mm is the hour and minutes in military time to wait for a call. For example: 1 p.m. is 13:00, 2:30 p.m. is 14:30, etc.

ANswer may be placed in front of transmit or receive commands to wait a specified time for a line connection. When establishing connection if it not completed within the specified period, the ANswer command times out and continues with the next command in the job file.

The AT command "ATS0=1" is sent to configure the modem to answer on the first ring. The AT command sends the AT String at the same settings that the following parameters are set or at the default values: Speed, Data Bits, Parity, and Stop Bits parameters (see 1.2 Cleo A+ Configurator - Port). However, the Dial Initialization String sends to the modem before answering.

Example: ANSWER 6:00

waits until 6:00 AM for an incoming call.

Example: ANSWER 60

waits one hour (60 minutes) for an incoming call.

An answer status window will appear while waiting for the connection, and you may abort the wait with the Cancel button at any time during the answer period.

The modem result message and code post for the ANswer. You may branch on the modem result message or one of the following status messages: OK when it answers; FAIL when there is no calls; or DIAL_ABORT when the ANswer aborts with the Cancel button. See A.3.1 The Autodial/Autoanswer Status Line and A.3.3 Status Messages for more details.

If the ANswer timeout expires with the line inactive and no BRanch commands follows, subsequent commands become void and do not take place (except for COnfig and System commands) until the next ANswer, AUtodial, or QUit command is reached.



4.2 AT - Send an 'AT' String to the Modem

The AT command lets you send an AT command string to configure the attached AT command compatible modem. This string may consist of a single or multiple AT commands. The AT command line format is:

AT ATcommands

where:

AT is the "attention" command for AT compatible modems. This should precede all AT commands.

commands is the AT command or series of commands to send to the modem. The following special characters may be used within the AT string: the tilde (~) causes a 1/2 second pause; the caret-M (^M) causes a carriage return to be sent to the modem. See your modem manual for more information on AT commands.

The Speed, Data Bits, Parity, and Stop Bits parameters control how the AT string sends (see 1.2 Cleo A+ Configurator - Port for more details).

Example:

AT ATX4

sends the "ATX4" AT command string to the modem to set it for returning result codes/messages from the extended result set 4. This string sets the modem to return busy, no dial tone, and connection speed messages when dialing and answering. A modem result message posts for the AT command. You may branch on this result message or one of the following status messages: OK if the modem accepts the command; or FAIL if it rejects (for when the modem returned an ERROR result status or did not reply). See A.3.3 Status Messages for details.

The AT command only supports AT command compatible modems.



4.3 AUtodial - Automatic Dial

The AUtodial command provides automatic dialing to establish the modem line connection with a remote system. AUtodial permits a dialing sequence of up to four telephone numbers and/or access codes. AUtodial lets you: tone or pulse dial, dial multiple numbers and /or access codes, and specify the delay between dialing of multiple numbers, the wait for the remote answer, and the number of redial attempts if call is incomplete. The AUtodial command line format is:

AUtodial [P] telephone# [Txx telephone#...] [Txx] [Rxx] or

AUtodial !WANPhoneBookEntry

where:

P is an option to pulse dial. The default is tone dial. This option is only available with standard PSTN (non-WAN) dialing.

telephone# is the telephone number or access code to be dialed. Up to four numbers will dial. Each additional number in a multi-number sequence proceeds by the Txx option. All numbers must be entered in one of the following formats: 18005551212 or 1-800-555-1212 Spaces are not allowed within a number.

Txx specifies a time delay in seconds. The Txx option must be included before each additional telephone number or access code dialed in a multi-number sequence. Valid entries for xx are 1 to 99.

The final Txx is optional and specifies the time to wait for the answer back tone from the remote modem. If the final Txx option is not specified, the answer back tone detect period is specified by the Modem|Wait for Connect menu option in the A+ Configurator (or the DIALWAIT= WaitForConnect parameter). See 1.3 1.3 A+ Configurator - Modem for details. This option is only available with standard PSTN (non-WAN) dialing.

Rxx specifies the number of redial attempts. Valid entries for xx are 1 to 31,000 or -1 for 31,000. After the final number dials, A+ monitors the line for an answer back tone detect period specified by the Wait for Connect or Txx option. If the answerback is detected, communications are enabled, otherwise the auto dial sequence will be repeated according to the number of attempts specified by the Rxx option. When the Rxx option is omitted, AUtodial defaults to the number of redial attempts specified by Dial|Dial Retrys in the A+ Configurator (or Times=DialRetrys parameter). See 1.3 1.3 A+ Configurator - Modem for details.

!WANPhoneBookEntry is the name of the Dial-Up Networking phone book entry preceded by an exclamation point (!) character. This lets you directly dial an existing Windows phone book entry. Note you must provide the WAN Logon entries (WANUSER, WANPASSWORD, and WANDOMAIN) since these are not set in the phone book. When Windows NT misses these items it will use your user logon information and Windows 95 will prompt you for the missing information.



For standard PSTN dialing (non-WAN dialing), the Dial Initialization String is sent to configure the modem before autodialing. See 1.3 1.3 A+ Configurator - Modem for details. The Speed, Data Bits, Parity, and Stop Bits setup the parameters for sending the Dial Initialization String and autodial string. (see 1.2 Cleo A+ Configurator - Port for more details).

Example: AUTODIAL P 1-800-555-1212 R10

Pulse dialing (P) is used to dial the telephone number (1-800-555-1212) up to 10 times (R10).

Example: AUTODIAL 9 T5 18005551212 T10 3978110 R4

Tone dialing is used. A PBX access code (9) is dialed, a 5 second pause occurs (T5); the telephone number (18005551212) is dialed, a 10 second pause occurs (T10); an access code (6548110) is dialed. This sequence repeats up to 4 times (R4) attempting to complete the telephone connection.

When the dial is complete or the dial retries has expired, a dial result message posts for the AUtodial. You can branch on this result message or one of the following status messages: OK when the connection is complete or FAIL when the connection does not take place, or when using an invalid number or dial directory entry. Alternatively, DIAL_ABORT if AUtodial is aborted with the Cancel button. See A.3.1 The Autodial/Autoanswer Status Line and A.3.3 Status Messages for more details.

If the connection is not completed within the specified number of redial attempts and no BRanch command follows, commands following the incomplete AUtodial (except for COnfig and SYstem) are skipped until the next AUtodial, ANswer, or QUit command.

AUtodial supports the "AT Command Set" that is available with AT command compatible modems.

AUtodial can also execute interactively with the Line|Dial menu item or the DIAL tool bar button.



4.4 BInary - Transmit Binary File(s)

The BInary command transmits a file or files to the remote system with no translation. The Protocol menu option (PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K|YMODEM|YMODEMG|ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer protocol for the transmission. Files transmit "as is". The BInary command line format is:

BInary filename [RemoteFilename]

where:

filename is the file or files to be sent to the remote system. Wildcards and/or drives and paths are useable within file names. Note that when one of a group of transmit files specified by a wildcard terminates by anything other than a NRMEOF (normal end of file) status, the remaining files are not sent and the command is aborted. With the YMODEM, ZMODEM, Kermit, and FTP protocols, the filenames (without the drive or path name) receive to the remote with the same filename.

RemoteFilename is an optional remote file name override. This filename, instead of the original filename, assigns to the file received by the remote processor. The file name override is supported only by YMODEM, ZMODEM, Kermit, and FTP file transfer protocols; it is not supported by XMODEM, ASCII, or ANSI Clear. You may send a drive and/or path name with the file name. To transfer a file to a directory other than your FTP login directory, you must specify the host�s path name and file name.

Example: BINARY *.HLP

sends all files with the .HLP extension.

Example: BINARY C:\MYFILES\MY.EXE /usr/YOUR.EXE

will send the file C:\MYFILES\MY.EXE with the file name /usr/YOUR.EXE. This will save the MY.EXE file on a remote UNIX system as YOUR.EXE in the /usr directory.

A File Transfer Status window will display on the screen during transmission. See 2.4 File Transfer Status in for details. Note: you may abort the transmission with the Cancel button at any time.

After each file transmits, a status line posts to the log and monitor files, if open, giving a completion status message for the transmission and the number of data blocks sent. See A.3.2 The Transmit/Receive Status Line for details. If the transmission was successful, a NRMEOF (Normal End of File) status message will display. See A.3.3 Status Messages for a complete list and A.3.3 Status Messagesfor a complete description of each status message.

In a job/script file, you may branch on any of the following status messages: OK if the transmission is successful; FAIL if the transmission fails; or any of the status messages listed in Table A.3. Note: if using a wildcard to transmit multiple files, you may branch only on the status of the last file transmitted.

If the line is down when the BInary command is executed and no branch command follows, A+ will wait until a connection is made before continuing.

BInary may also be executed interactively with the Transmit|Binary or Transmit|Send option or the SEND tool bar button.



4.5 BRanch - Branch in Job/Script File Based on Condition

The BRanch command lets you make decisions within a job/script file based on the status of the communications session. The format of the BRanch command is:

BRanch ON|NOT status TO label or

BRanch ON|NOT return_code TO label or

BRanch ON|NOT SIZE [<|=|>] file_size TO label or

BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label or

BRanch ON|NOT %variable%|$variable <|=|> number TO label or

BRanch ON|NOT %variable%|$variable = string TO label or

BRanch ON TRUE TO label where:

ON branches on a true condition.

NOT branches on a false condition.

status is the latest status message from an A+ command.

return_code is the return code from the command or program executed with the SYstem command.

file_size is the size of last received file as saved to disk.

c is the COUNTER number (1, 2, or 3).

number is the numeric value to be compared to the contents of COUNTERc or a configuration parameter, token, or variable.

variable is the configuration parameter, token, environment variable, user-defined variable, or pre-defined variable to be compared.

string is the string to be compared to the specified configuration parameter, token, or variable.

label is the numeric label of the command to jump to. Note: This is not a physical line number but a pre-appended number; valid values for label are 1 to 9999.

See 4.24 JOb - Record Commands or Scramble a Job/Script File for details on recording job files. It is a good idea to add BRanch and/or IF commands to recorded job files to allow better control when communications errors occur.

BRanch is for within a job/script file (see JOb) only.



4.5.1 BRanch ON|NOT status TO label BRanch lets you jump to a label in the job file based on a true or false test against the status message. The status message represents the result of the latest A+ command executed. See A.3.3 Status Messages for more details. Example:

AUTODIAL 654-8110 R10 BRANCH ON FAIL TO 999 TEXT account.* BRANCH ON NRMEOF TO 100 KEY * Error sending files * 100 RECEIVE newcust.fil BRANCH ON NRMEOF TO 200 KEY * Error receiving file * 200 VOICE 999 AUTODIAL 397-8111 R10 :

In the example above, A+ attempts to call the phone number 654-8110. If this call fails to make a connection after 10 retries, the number 654-8110 would be dialed (BRANCH ON FAIL TO 999). If, on the other hand, the connection completed, all files starting with account will transmit. If the files were transmitted correctly (BRANCH ON NRMEOF TO 100), a file will be received to newcust.fil, otherwise a key message will be sent informing the remote that the files were sent incorrectly. If newcust.fil were received incorrectly, a key message will be sent informing the remote that the file was not received properly. The line will then be disconnected and A+ will attempt to call the telephone number 654-8110 and continue.

Note: You may branch on the status code, instead of the status message, with the following command: BRANCH ON|NOT $STATUSN = xx TO label.

Example: TEXT account.* BRANCH ON $STATUSN = 15 TO 100

will branch to label 100 if all the files were transmitted correctly ($STATUSN = 15) because the status code for NRMEOF is 15.

Note: You may also branch on an OK or FAIL status. For file transfers, BRANCH ON OK TO label is equivalent to BRANCH ON NRMEOF TO label and BRANCH ON FAIL TO label is equivalent to BRANCH NOT NRMEOF TO label. For AUtodial and ANswer, BRANCH ON OK TO label is equivalent to BRANCH ON CONNECT [xxxxx] TO label; and BRANCH ON FAIL TO label is equivalent to BRANCH NOT CONNECT [xxxxx] TO label.



4.5.2 BRanch ON|NOT return_code TO label BRanch lets you jump to a label in the job file based on the return code (exit code) from a program executed with the SYstem command. If a job file contains a SYstem command followed by a BRanch command, the program return code posts to the log file then used by the BRanch command to test against the value in the return_code field.

Example:

RECEIVE FILE.NEW SYSTEM CHEKFILE BRANCH NOT 0 TO 200 TEXT NEWS 200 KEY *** LOGGING OFF ***

After receiving the file FILE.NEW, the SYstem command loads and executes the program CHEKFILE. CHEKFILE will check the contents of FILE.NEW and exit with a return code of 0 if it contains a request for news and non-zero if it does not. If CHEKFILE exited with a return code of 0, A+ will send a NEWS file, if CHEKFILE exited with a non-zero return code, A+ will log off without sending a NEWS file.

4.5.3 BRanch ON|NOT SIZE [<|=|>] file_size TO label BRanch lets you jump to a label in the job file based on the size of the latest received file. If the <, >, or = is omitted, a BRANCH ON will cause a branch. If the received file is greater than or equal to size file_size; a BRANCH NOT will cause a branch if the received file is less than size file_size.

Example:

10 RECEIVE newfile BRANCH ON SIZE 82 TO 10 TEXT signoff

A+ will keep receiving files until it received a file with 81 or fewer characters. This will happen if only one 80 character line was received (80 chars + NL). It will then send a file containing the signoff message.

4.5.4 BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label BRanch lets you jump to a label in the job file based on the contents of the specified counter.

Example:

START COUNTER1=0 10 RECEIVE newfile +COUNTER1 BRANCH ON %COUNTER1 < 5 TO 10 TEXT signoff

A+ will receive five (5) files, newfile.000 through newfile.004. It will then send a file containing the signoff message.



4.5.5 BRanch ON|NOT %variable%|$variable <|=|> number TO label BRanch lets you jump to a label in the job file based on a true or false test of a configuration parameter, token, environment variable, user-defined variable, or pre-defined variable against the specified number. The number may be another configuration parameter, token, environment variable, pre-defined variable, user-defined variable, or counter. Example:

BRANCH NOT $DAY = 1 TO 100 AUTODIAL Headquarters SEND MonthEnd.report HANGUP 100 QUIT This job file could be run automatically every day to determine if it is the first day of the month. If it is the first day of the month, a month end report will be send to headquarters, otherwise A+ will quit.

4.5.5.1 Configuration Parameter Variables

Configuration parameter variables, such as SPEED and PROTOCOL, contain the values assigned to each configuration option. See A.1 The Configuration File for a list and Chapter 1. The Cleo A+ Configurator for a description of each configuration parameter.

4.5.5.2 Token Variables

Token variables are similar to MS-DOS replaceable parameters or UNIX positional parameters. The first token may be accessed with %1 or $1, the second with %2 or $2, and so on. Tokens are set with the TOken command or the TOKENS=TokenList command line option. These tokens may be used anywhere within A+, except as command names or labels. See 4.49 TOken - Enable, Disable, Display or Set Token Variables for details.

4.5.5.3 Environment Variables

Environment variables (also referred to as named variables or shell variables) are definable within the operating system. Environment variables let you pass values (such as paths, filenames, telephone numbers, etc.) from the operating system or another program into A+. These environment variables may be used anywhere within A+, except as command names or labels. See your operating system manual for information on setting environment variables. See 4.49 TOken - Enable, Disable, Display or Set Token Variables for an example using environment variables.



4.5.5.4 Predefined Variables

Predefined variables are some common settings that are pre-assigned by A+. These predefined variables may be used anywhere within A+ except as command names or labels. A+ predefines the following variable names:

DATE contains the full date including weekday, month, day and year: SUN JUNE 22, 1997.

WEEKDAY contains the day of the week: MON, TUES, WED, etc.

MONTH contains the month: JAN, FEB, MAR, APR, etc.

DAY contains the day of the month: 1, 2, 3, etc.

YEAR contains the year: 1997, 1998, 1999, 2000, etc.

TIME contains the current time in military time in hour:minutes:seconds: 08:00:00, 13:21:56, etc.

HOUR contains the current hour in military time: 01, 12, 13, 24, etc.

MINUTE contains the current minutes of the hour: 00, 01, 60, etc.

SECOND contains the current seconds of the minute: 00, 01, 60, etc.

STATUS contains the status message from the last command: NRMEOF, LINDWN, etc. See A.3.3 Status Messages for a list and description of the status messages.

STATUSN contains the status code from the last command: 15 (for NRMEOF), 22 (for LINDWN), etc. See A.3.3 Status Messages for a list and description of the status codes.

CLEO_RSTRING contains the string of characters returned from commands. For example: MID �1234567890" 5 3 will return the string �567� in CLEO_RSTRING.

PID contains the process id of A+.

MACHINE contains the machine name defined in the operating system.

USERNAME contains the current login username. The username may be up to 30 characters in length. If no user has logged in, the USERNAME variable will be blank. See 1.7.1 User for a description of how to set the USERNAME variable.

USERINFO contains the login information for the current user. The user information may be up to 30 characters in length. If no user has logged in, the USERINFO variable will be blank. See 1.7.1 User for a description of how to set the USERINFO variable.

USERLEVEL contains the login access level for the current user. The access level may be 0 through 10. If no user has logged in, the USERLEVEL variable will be blank. See 1.7.1 User for a description of how to set the USERLEVEL variable.

4.5.5.5 User-defined Variables

User-defined variables can pass values (such as paths, filenames, telephone numbers, etc.) within or between A+ job/script files. User-defined variables may have any name except configuration parameter names (SPEED, PROTOCOL, FILENAMES, DISPLAY, etc.) or pre-defined variable names (DATE, WEEKDAY, MONTH, etc.). See 4.28 LEt - Set Configuration Parameter or User-Defined Variable for an example of using user-defined variables.



4.5.6 BRanch ON|NOT %variable%|$variable = string TO label BRanch lets you jump to a label in the job file based on a true or false test of a configuration parameter, token, environment variable, user-defined variable, or pre-defined variable against the specified string. The string may be another configuration parameter, token, environment variable, user-defined variable, or pre-defined variable. See 4.5.6 BRanch ON|NOT %variable%|$variable = string TO label for a description of each variable type. Example: KEY �Enter employee name:� -R GET EmployeeName BRANCH ON $EmployeeName = Alex TO 100 BRANCH ON $EmployeeName = Kim TO 101 BRANCH ON $EmployeeName = Mike TO 102 The above example checks the response from the remote system and branches to different locations in the job file based on the response.

4.5.7 BRanch ON TRUE TO label TRUE is a special status that lets you branch unconditionally to a job file label.

Example:

BRANCH ON TRUE TO 123

will always branch to the line labeled 123 regardless of the latest status return message.

4.5.8 BRanch Command Tips

BRanch commands may be stacked within a job file to handle multiple branch conditions.

Example:

ANSWER 15 BRANCH NOT OK TO 345 123 RECEIVE file.new BRANCH ON LINDWN TO 345 BRANCH NOT NRMEOF TO 123 345 VOICE QUIT

This job file will wait 15 minutes for an incoming call. If the modem answers within this time, the REceive command executes; otherwise, the VOice and QUit commands are processed. The first BRanch after the REceive command tests for a LINDWN condition and branches to VOice and QUit if the line is down. (NOTE: Not all modems/systems detect a line down condition - do not use this sequence with a modem/system that does not have line down detection.) The following BRanch statement checks for not NRMEOF and tries to REceive again if the file was received in some type of error. Note that specifying the file extension causes file.new to overwrite each time this command executes.



If the REceive filename has no extension, extension numbering will start at .000. If .000 already existed, A+ will search for the first extension number that does not exist. This distinction is useful for a command sequence such as:

478 RECEIVE goodfile BRANCH ON NRMEOF TO 478

which will accumulate received files until some type of error occurred.

Careful thought to the construction of your job file is necessary when using the log option of A+. A loop such as:

44 RECEIVE file.new BRANCH NOT NRMEOF TO 44

may cause problems for the log file. If the line were to drop, an LINDWN, NODATA, or RECEIV status returns, and the branch takes place. Since a line down condition is likely to persist for some time and the REceive and BRanch command record continuously in APLUS.LOG, disk space rapidly fills. For a modem/system with line down detection, a better scheme is:

22 ANSWER 15 44 RECEIVE file.new BRANCH ON LINDWN TO 22 BRANCH NOT NRMEOF TO 44

In the above sequence, the REceive executes only when the line to be active. For a modem/system without line down detection, a better scheme will be:

22 ANSWER 15 44 RECEIVE file.new BRANCH ON NODATA TO 22 BRANCH ON RECEIV TO 22 BRANCH NOT NRMEOF TO 44



4.6 CLOSE - Close a READ or WRITE File

The CLOSE command lets you close the previously opened file. The file opens from the OPEN command and the CLOSE command will close it. The CLOSE command has no options; the CLOSE command line format is:

CLOSE

Files are automatically closed when all data is READ, when another OPEN command is issued, or when A+ exits.

Example: OPEN MyFile READ FileLine CLOSE

which will open the file MyFile, read the first line of the file, then close the file.

The status of the CLOSE command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The CLOSE command will return an OK status if the file closed. If there is an error closing the file (for instance if a file was never OPENed or the file was automatically closed with READ command), a NOFILE status is returned.

When using the CLOSE you must type the entire command name, and not just the first two letters.



4.7 COMBINE - Combine Two Strings

The COMBINE command provides an easy method of combining two character strings into one character string. The COMBINE command line format is:

COMBINE string1 string2

where:

string1 may be a word, a string of characters enclosed in quotes, or a variable.


The combined string saves in the pre-defined variable CLEO_RSTRING. This variable is recallable later in the job file. Note all of the string function commands change the CLEO_RSTRING variable. If you would like to access this string throughout the job file save the CLEO_RSTRING pre-defined variable to a user-defined variable.

Example: COMBINE $LastName �,� COMBINE $CLEO_RSTRING $FirstName LET FullName=$CLEO_RSTRING

which will save the LastName,FirstName in the user-defined variable FullName.

The COMBINE command always returns a 0 status. The status of the COMBINE command does not display.

When using the COMBINE you must type the entire command name, and not just the first two letters.



4.8 COMPARE - Compare Two Strings

The COMPARE command provides an easy method of comparing the contents of two character strings. The COMPARE command line format is:

COMPARE string1 string2

where:



The status of the COMPARE command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The COMPARE command will return a 0 if the two strings are equal and have the same case. If string1 is greater than string2, COMPARE returns a 1. If string2 is greater than string1, COMPARE returns a 2 status. This status saves to the pre-defined variable STATUSN. Note most commands change the STATUSN variable. If you would like to access this status throughout the job file, you should save STATUSN to a user-defined variable.

Example: COMPARE $USERNAME KRISTINA BRANCH NOT $STATUSN = 0 TO 100 KEY �Welcome Kristina�

which will send a personalized message if the Login user name was Kristina.

When using the COMPARE you must type the entire command name, and not just the first two letters.



4.9 COnfig - Display or Change Configuration

The COnfig command lets you view or modify the default parameters. The COnfig command line format is:

COnfig [filename]

where:

filename is a custom configuration file previously created with the A+ Configurator, the SAve command, the Configuration|Save or Configuration|Save As menu option, or a text editor.

COnfig, executed without a filename, displays the Configuration Menu to allow you to manually modify the current configuration. COnfig without a filename is not valid in a job/script file. The CFG tool bar button displays the configuration menu. See Chapter 1. The Cleo A+ Configurator for a detailed description of the configuration menus and parameters.

COnfig, executed with a filename, loads the configuration parameters from the previously created configuration file. See A.1 The Configuration File for the configuration file layout. Configuration files may also be loaded by setting the using the CONFIGFILE=CfgFile command line option when starting A+, using the Configuration|Load menu option within A+, or using the COnfig command from a job/script file.

Modify the Individual configuration parameters with the LEt command.

Example: CONFIG

displays the following configuration menu to let you load, change, and save configuration options:

See Chapter 1. The Cleo A+ Configurator for details.

Example: CONFIG CHICAGO.CFG

loads the configuration parameters listed in the file CHICAGO.CFG.

The status of the COnfig command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The COnfig command will return an OK status if the configuration file loads properly. If there is an error in the specified configuration file, COnfig will return an ERROR status. When a file cannot open, COnfig will return a NOFILE status.

Modify the Configuration files (cfg) with a standard text editor, such as Note Pad or Write. See A.1 The Configuration File for the configuration file layout.

COnfig may also be executed interactively with the Configuration|Edit menu item, the CFG tool bar button. You may change individual configuration parameters with the LEt command from the Command Window or a Job File.

COnfig itself is not valid in a job/script file (see JOb).



4.10 CONNECT - Connect to or Disconnect from a Telnet, FTP, or OFTP

The CONNECT command lets you connect to or disconnect from a Telnet, FTP, OFTPor host session. The CONNECT command may only be used when a HOST=HostName parameter is specified. The CONNECT command line format is:

CONNECT FTP|TELNET|port or

CONNECT LISTEN port or

CONNECT CLOSE

where:

FTP is an option to start an FTP session on the current host.

TELNET is an option to start a Telnet session on the current host.

OFTP is an option to start an OFTP session on the current host.

port is an option to connect to a given port number on the host for peer-to-peer communications. The port number is a local data port number agreed upon by both peers. The minimum value is 0 and the maximum value is 61439.

LISTEN port is an option to wait for a connection to the specified port on host for peer-to-peer communications, or to wait for an OFTP session. The port number is a local data port number agreed upon by both peers. The minimum value is 0 and the maximum value is 61439. Or if using OFTP, use CONNECT LISTEN OFTP to connect and start a peer-to-peer OFTP session. Note: To allow a timeout, you may use the ANswer minutes port command. See 4.1 ANswer - Automatic Answer for details.

CLOSE is an option to end the current host session

The status of the CONNECT command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The CONNECT command will return an OK status if the connection is made properly. If there is an error in making or breaking the connection, CONNECT will return a FAIL status.

See 5.4 FTP File Transfer, 5.5 A Telnet Session, and 5.6 Peer-to-Peer Connection and 5.7 OFTP Receiving and Sending Job Files for examples of connecting to Telnet, FTP, or host sessions.

When using the CONNECT you must type the entire command name, and not just the first two letters.



4.11 +COUNTER - Increment Counter

The +COUNTER command increments one of nine counters. Counters will count the repetitions of a function. The format of the +COUNTER command is:

+COUNTERc where: c is the number of the counter (1 through 9).

Example: START COUNTER1=1 10 RECEIVE newfile%COUNTER1. +COUNTER1 BRANCH NOT %COUNTER1 = 11 TO 10 KEY DONE

A+ will receive 10 files: newfile1 through newfile10. It will then send a DONE message.

The +COUNTER command always returns an OK status.

See also 4.12 -COUNTER - Decrement Counter, 4.45 STart - Display or Initialize Counter, and 4.5.4 BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label.

When using the COUNTER you must type the entire command name, and not just the first two letters.



4.12 -COUNTER - Decrement Counter

The -COUNTER command will decrement one of nine counters. Counters will count the repetitions of a function. The format of the -COUNTER command is:

-COUNTERc where: c is the number of the counter (1 through 3).

Example: START COUNTER2=10 10 SEND file%COUNTER2.new -COUNTER2 BRANCH ON %COUNTER2 > 5 TO 10 KEY DONE

A+ will send five files: file10.new, file9.new, file8.new, file7.new, and file6.new. It will then send a DONE message.

The -COUNTER command always returns an OK status.

See also 4.11 +COUNTER - Increment Counter, 4.45 STart - Display or Initialize Counter, and 4.5.4 BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label.

When using the COUNTER you must type the entire command name, and not just the first two letters.



4.13 DAta - Data Mode

The DAta command raises the Data Terminal Ready (DTR) signal on the port and forces A+ into an ONLINE state. The DATA command has no options; the DATA command line format is:

DAta

You must use the DAta command before transmitting or receiving data for the following conditions:

• your machine does not detect the line connection status • the Data Carrier Detect (CD) signal on the port is low even when you are connected • you are directly connected to another local machine which doesn�t connect the CD signal

If the DAta command is not used, you will receive a LINDWN status and A+ will not attempt file transfers when the data carrier detect (CD) signal is low.

Example: DATA SEND MyFile

which will unconditionally send the file MyFile even if CD was low on the port.

The DATA command will always return an OK status.

DAta may also be executed interactively with the Line|Data menu item.



4.14 DIRMATCH � Directory Pattern Match

The DIRMATCH command allows you to determine the number of files that match a file pattern. The DIRMATCH command line format is: DIRMATCH pattern where: pattern is a match pattern that is valid for the Windows operating system you are using. The status of the DIRMATCH command is not displayed. If no files match the pattern, a NOFILE status will be returned and $CLEO_RSTRING will be 0. Otherwise an OK status will be returned and the number of matching files will be returned in the $CLEO_RSTRING. DIRMATCH Example ########################################################LOG *SEND DATA*########################################################DIRMATCH *send*.*LET FILECOUNT=$CLEO_RSTRINGFIND ":" 10

BRANCH NOT MATCH TO 911START COUNTER1=0100 KEY RCFIND "READY TO RECEIVE" 20

BRANCH NOT MATCH TO 311+COUNTER1LET DATA=8LET PARITY=NONELET STARTTIMEOUT=20WRITE *** Sending Data ***\nMSEND *send*.*

BRANCH ON NOFILE TO 101BRANCH NOT NRMEOF TO 311

LOG $CLEO_RSTRING sent successfullyLET DATA=7LET PARITY=EVENFIND "transfer complete" 20

BRANCH NOT MATCH TO 311WRITE *** Data Sent Succesfully ***\n

BRANCH NOT %COUNTER1 = $FILECOUNT TO 100



4.15 DISPLAY - Display a Message on Screen

The Display command lets you display a message window with a message to the screen. The Display command line format is:

Display "message"

where:

message is the message to display in the message window This message may be no longer than 80 characters.

Example:

DISPLAY "Your session is successful!"

can display to tell the user that all went well. Nothing sends on the line in response to the command.

The status of the Display command will not display, but can be useful for branching (See 4.5.1 BRanch ON|NOT status TO label). The Display command will return an OK status if the message displays. A FAIL status is returned if the format of the Display command is wrong (i.e. the message was not enclosed in quotes).



4.16 ELSE - Perform Following Commands if IF Condition is False

The ELSE command lets you perform the commands which follow only if the previous IF condition was false. The ELSE command has no options; the ELSE command line format is:

ELSE

The IF, ELSE, and ENDIF commands together let you control the flow of a job/script file based on some condition.

Example: KEY �Type R to receive or S to send� -R GET $UserReply IF $UserReply = R SEND news ELSE RECEIVE ENDIF

This job file depends on the response from the remote user as to whether to send or receive.

The ELSE command does not change the status.

See also 4.23 IF - Perform Following Commands if a Condition is True and 4.17 ENDIF - End IF/ELSE Condition.

ELSE is for use from within a job/script file (see JOb) and is not a valid during manual operation.



4.17 ENDIF - End IF/ELSE Condition

The ENDIF command ends the previous IF and/or IF/ELSE condition. The ENDIF command has no options; the ENDIF command line format is:

ENDIF

The IF, ELSE, and ENDIF commands together let you control the flow of a job/script file based on some condition.

Example: IF $PROTOCOL = KERMIT KEY Sending news via Kermit ENDIF SEND news

The above job file will send a message only if the current protocol is Kermit. It will always send the news file.

The ENDIF command does not change the status.

See also 4.23 IF - Perform Following Commands if a Condition is True and 4.16 ELSE - Perform Following Commands if IF Condition is False.

When using the ENDIF you must type the entire command name, and not just the first two letters.

ENDIF is useful within a job/script file (see JOb), and is not valid during manual operations.



4.18 EXecute - Execute Commands from a Job/Script File

The EXecute command causes A+ to sequentially process the commands in the specified job or script file. The Job files may execute from within another job file. The EXecute command in combination with the RETURN command may be used to call individual job files each performing a different task, similar to making function calls. The EXecute command could even be used to execute a job file sent from the remote site to automate updates, perform remote system diagnostics, remotely run software, etc. The EXecute command line format is:

EXecute JobFile [token [token]...]

where:

JobFile is a custom job/script file previously created with the JOb command, the Window|Recorder Window menu item, the REC tool bar button, or a standard text editor.

token is an optional token for job file parameter substitution. Specify up to 19 tokens. Tokens may also be set from the A+ command line (see 2.1 The Cleo A+ Command Line) or set/changed with the TOken command (see 4.49 TOken - Enable, Disable, Display or Set Token Variables).

During job file execution, the status of the job file displays on the status line.

If the job file does not end with the QUit command, A+ returns to the terminal emulation screen. Many commands executed from within a job file remain in force after job file completion.

The EXecute command may be included in a job file. This causes a new job file to load and execute. Note, A+ does not automatically return to the original job file upon completion of a nested job file; the RETURN command must be used to return to the calling job file. See 4.39 RETURN - Return to Calling Job File.

Example: EXECUTE LOGON.JOB EXECUTE TRANSMIT.JOB EXECUTE RECEIVE.JOB EXECUTE LOGOFF.JOB

may be used to break down each task into separate job files. Each job file will end in a RETURN command to return to the calling job file.

The BRanch command provides an alternative to nested job files. Instead of EXecuting other job files from within a job file, one large job file creates and the BRanch command used to move within that job file to achieve the same effect.



Example: ANSWER 24:00 RECEIVE NEW.JOB EXECUTE NEW.JOB HANGUP QUIT

## NEW.JOB TO GET FILES SEND C:\NEW\*.* RETURN

may be used to wait for an incoming call, receive a job/script file, execute the received job/script file, hang up, and quit. In this case, the received job file will send all the files in the C:\NEW directory back to the remote site. The received job file could be also be used to perform remote updates, remotely run software, perform system diagnostics, backups, etc. The received job file may contain SYstem commands to access Windows programs, but because Windows programs will not display on the remote terminal, all programs should be set to run automatically without user interaction.

The status of the EXecute command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The EXecute command returns the status of the last command executed in the called job file. A NOFILE status is returned if the job file could not be found/opened. A DSKERR status is returned if the job file to unscramble.

EXecute may also be executed interactively with the System|Run Job menu item and the JOB tool bar button.



4.19 EXISTS - Check if File Exists

The EXISTS command causes A+ to check if the specified file exists. The EXISTS command line format is:

EXISTS filename

where:

filename is the file to check.

Example: 100 EXISTS SendFile BRANCH ON NOFILE TO 200 EXECUTE SEND.JOB 200 RECEIVE BRANCH ON TRUE TO 100

In the example above, A+ will run the SEND.JOB job file when a file is available to send. This job file will keep A+ in receive mode unless there is a file to send.

The status of the EXISTS command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). The EXISTS command returns OK if the file exists or NOFILE if the file does not exist.

When using the EXISTS you must type the entire command name, and not just the first two letters.



4.20 FInd - Receive Data until String Match

The FInd command causes A+ to receive data until it receives a match to one of the specified strings. You may specify up to five strings to match on. The incoming data optionally saves to a file.

The FInd command line format is:

FInd "string1" [OR "string2" [OR "string3" [OR "string4" [OR "string5"]]]] [filename] [timeout]

where:

stringx are the data strings to match. Strings may be a maximum of 80 characters. The string encloses in quotes ("). To search for non-ASCII characters, use the \ replacements listed in Table 4.1 Non-ASCII Character Replacements.

filename is the optional file in which to save incoming data. If no filename is included with the command, all of the received data discards and is not saved. If a filename is without a file extension, files accumulate serially starting at .000 without overwriting current files that have the same name. Example: FIND "PASSWORD:" mystuff will save data to the file mystuff.000 unless mystuff.000 already exists. If mystuff.000 exists, mystuff.001 is tried, and so on, until it finds a nonexistent filename. If a filename includes an extension, files are accumulated serially starting at that number. Existing files with the same name overwrite. Example: FIND "PASSWORD:" mystuff.new will save data to mystuff.new regardless of whether a file already exists with that name.

timeout is the length of time (in seconds) to wait for the specified string. The range is 1 to 255 seconds or -1 for no timeout. An entry with no timeout defaults to a timeout of 60 seconds



A+ continues to receive data until (1) incoming data matches a specified string, (2) the timeout expires, or (3) it's receive mode is exited with the Cancel button.

Example: FIND �\x07�

will wait until it received the bell character to continue.

The status of the FIND command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). If a match is in string1, a MATCH status message returns. If a match is in string2, a MATCH2 status message returns. If a match is in string3, a MATCH3 status message returns. If a match returns on string4, a MATCH4 status message returns. If a match returns on string5, a MATCH5 status message returns. If no data is forthcoming, the program returns a NODATA or RECEIV status message and continues with the next command in the job file. When the user clicks the Cancel button during the FInd, the FInd returns an ABORT status.



4.21 GEt - Get Information from the Remote User

The GEt command lets you receive information from the remote user, which can direct the job/script file operation. The GEt command line format is:

GEt reply [timeout] [terminator]

where:

reply is the user-defined variable in which to save the remote user�s response.

timeout is the length of time (in seconds) to wait for a reply from the remote user. The range is 1 to 255 seconds or -1 for no time out. The default is -1 for no time out.

terminator is the reply terminator character in the form of the \ replacements specified in Table 4.1 Non-ASCII Character Replacements. The default is carriage return (\r).

GEt will wait for the remote user to type a response followed by an ENTER key (or the specified terminator character). GEt then saves everything typed up to, but not including, the terminator character in the reply variable. GEt variables may be accessed with the %variable% or $variable command.

Example: KEY �Enter the file name to download: � -R GET SendName SEND $SendName

This lets the remote user to interactively specify the file he/she wants to receive.

Example: GET FirstWord \X20 The above example saves the first word (characters up to a space) typed by the remote user into the variable FirstWord.

The status of the GET command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). GEt returns an OK status if it receives a character from the remote. If no data appears within the timeout, GEt returns a NODATA status and continues with the next command in the job file. When data transmits to the port but no terminator character before the timeout, GEt returns a RECEIV status and continues with the next command in the job file.



4.22 HAngup - Disconnect Phone Line

The HAngup command disconnects the telephone line between your modem and the remote site. The HAngup command line format is:

HAngup [WANPhoneBookEntry|*]

where:

WANPhoneBookEntry is the name of the Dial-Up Networking phone book entry to disconnect.

* lets you disconnect all the Dial-Up Networking connections.

During standard PSTN (non-WAN) dialing, A+ sends an "ATH" command to the modem to hang up the telephone line. The Port|Speed menu option in the A+ Configurator (or SPEED=PortSpeed parameter) controls the speed the AT string is sent.

Example: ANSWER 10 BRANCH NOT OK TO 1 RECEIVE filename

1 HANGUP QUIT

The above job file will disconnect the line if the remote modem did not connect properly.

The HANGUP command does not change the status.

The VOice command will disconnect the telephone line. The VOice command also disables autoanswer. See 4.50 VOice - Disconnect Phone Line and Disable Autoanswer.

HAngup may also be executed interactively with the Line|Hangup menu option



4.23 IF - Perform Following Commands if a Condition is True

The IF, ELSE, and ENDIF commands let you control job/script execution based on the condition of a configuration parameter, counter, token, environment variable, user-defined variable, or pre-defined variable. The IF command line format is:

IF %variable%|$variable <|=|> number [THEN] or

IF %variable%|$variable = string [THEN]

where:

variable is the configuration parameter, token, counter, environment variable, user-defined variable, or pre-defined variable to be compared. See 4.5.6 BRanch ON|NOT %variable%|$variable = string TO label for a description of configuration parameters, tokens, counters, environment variables, user-defined variables, and pre-defined variables.

number is the numeric value to be compared to the configuration parameter, token, environment variable, user-defined variable, or pre-defined variable. This number may be another token or variable.

string is the string to be compared to the specified configuration parameter, token, environment variable, user-defined variable, or pre-defined variable. If the string is more than one word, it must be enclosed in quotes, i.e. �this is a string�. This string may be another variable.

Example:

AN 10 GET USERINFO 60 \X0D IF $USERINFO = SalesDept IF $USERINFO = Ordering SEND Sales.txt ELSE IF $USERINFO = EngineeringDept SEND Engineer.txt ENDIF ENDIF

The above job file sends a department specific file to the user. The USERINFO variable is a pre-defined variable set by the GET command. Pre-defined variables are described in 4.7.6 Branch ON|NOT %variable%|$variable = string TO label.

The IF command requires an ENDIF command to end the condition. IF/ENDIF statements will work without an ELSE statement. The IF/ELSE statements may be nested.

The IF command does not change the status.

IF is intended for use within a job/script file (see JOb) and not valid during manual operations.



4.24 JOb - Record Commands or Scramble a Job/Script File

The JOb command lets you record all the A+ commands and actions to a job file. The JOb command also lets you scramble an existing job/script file to protect telephone numbers, passwords, etc. A job file is a file consisting of one or more A+ commands, which will run automatically. A job file is similar to an operating system script or batch file. The JOb command line format is:

JOb [filename] [-O|-A] or

JOb old_job_file scrambled_file

where:

filename is the job (or script) file to be created. If no filename is specified, the recorder is toggled on or off. The default filename is APLUS.JOB. This default filename may be changed with the Recorder File Name menu option (RECORDERFILE=JobFile parameter).

-O is an option to overwrite an existing job file with the same name.

-A is an option to append to an existing job file with the same name. This is the default.

old_job_file is the existing job file to be scrambled. This file does not delete after creating a scrambled job file. It is a good idea to save this file (unscrambled) somewhere apart from the A+ files; the scrambled file cannot be unscrambled.

scrambled_file is the scrambled job file to be created.

During scrambled job file execution, you may want to set StartUp|Display menu option in the Configurator menu to DISPLAY=MINIMIZED parameter to stop the display and/or turn the log file off during sensitive transactions.

If the job recorder is off, entering JOb with or without a filename directs the protocol characters to the Recorder Window and to the recorder file. When the recorder is on, entering the JOb command without a filename closes the Recorder Window and recorder file.

Example: JOB BBS.JOB -O

starts the job/script file recorder to record all your actions to the file BBS.JOB.

Example: JOB BBS.JOB SCRAMBLE.JOB

scrambles the existing BBS.JOB job/script file and saves it to the SCRAMBLE.JOB file.

The status of the JOb command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). JOb returns an OK status after the recorder file opened successfully. If there is an error opening the recorder file, a DSKERR status returns.

See A.2 The Job/Script File for examples. Job files created with the JOb command modify with a text editor to add job control commands such as BRanch or IF/ELSE/ENDIF.



The StartUp|Recorder Mode in the A+ Configurator (or RECORDERMODE=NONE|OVERWRITE|APPEND parameter in the initial configuration file) may also be used to start A+ with the recorder on.

The following methods will execute job files:

• Include the job file name as an argument when A+ is executed: APLUS APLUS.JOB

• Set the Configuration|Startup|Job File Name menu item in the Setup program, the Configurator program, or within A+.

• Use the System|Job menu item or JOB tool bar button from within A+.

• Use the EXecute (execute job file) command: Command> EXECUTE APLUS.JOB from the Windows|Command Window menu item or from within another job/script file.

Job files may also be created with the Window|Recorder Window menu item, the REC tool bar button, or a text editor. See 3.7.4 Recorder Window - Toggle Command Recorder Window for recorder details. See Chapter 5. Cleo A+ Tutorial for job files examples.

JOb may be executed interactively with the Window|Recorder Window menu item. The job recorder may also be started automatically with the StartUp|Recorder Mode menu item in the A+ Configurator (or RECORDERMODE=OVERWRITE|APPEND parameter).

The JOb command is intended for use in a job file and is not valid during manual operations.



4.25 KEy - Transmit a Keyboard Message

The KEy command is used to send a message to the remote system as if the characters were typed on the keyboard. The File Transfer|Default Send Mode menu item in the Configurator menu (or DEFSENDMODE=SCAN| BINARY|TEXT parameter) is used to determine whether the message is translated through the xlatout.ovr translation table before transmission. The KEy command line format is:

KEy [message [-N|-T|-R]]

where:

message is the message to be sent to the remote system. The message must be no longer than the maximum keyboard line size of 150 characters.

An Enter key will transmit at the end of this message. The Terminal Emulation|Enter Key Translation menu item in the A+ Configurator (or ENTERTRANS=CR|CR/NL|NL parameter) may be used to control the Enter character(s); the default is CR for carriage return.

-N sends the data as-is. Without this option, the File Transfer|Default Send Mode option (or DEFSENDMODE=SCAN|BINARY|TEXT parameter) is used to determine whether the message is translated before transmission.

-T data translates through the xlatout.ovr translation table before transmission. Without this option, the File Transfer|Default Send Mode menu item in the A+ Configurator (or DEFSENDMODE=SCAN|BINARY|TEXT parameter) is used to determine whether or not the message is translated before transmission.

-R allows the Enter key to omit from the end of this message. Without this option, the Enter key appends to the end of the message. This option is useful when prompting for information from the remote.

If the KEy command is entered alone, A+ sends only the Enter key character(s). This will send blank lines.

To include spaces at the beginning and/or end of the message, quote marks (") may be used to enclose the message. Example:

KEY " Send spaces "

will send spaces before and after the message.

To send non-ASCII characters in a key message, use the \ replacements listed in Table 4.1.

Example: KEY Column #1\tColumn #2

will display: Column #1 Column #2

on the remote terminal.

When specifying multiple options the dash character (-) must precede all options.



Example:

KEY Enter file name: -NR

will send the message Enter file name: as-is without translation and without a trailing Enter key character leaving the cursor after the prompt.

After each message transmits, a status line writes to the log and monitor files, if open, giving a completion status message for the transmission and the number of data blocks sent. See A.3.2 The Transmit/Receive Status Line for details. If the transmission was successful, a NRMEOF (Normal End of File) status message will display. See A.3.3 Status Messages for a complete list and for a complete description of each status message.

In a job/script file, you may branch on any of the following status messages: OK if the transmission is successful; FAIL if the transmission fails; or any of the status messages listed in Table A.3.

KEy executes interactively with the Transmit|Key option.

____________________________________________________________________________________________________

CHARACTER REPLACEMENT Decimal \xxx * Octal \Oxxx * Hexidecimal \Xxx * Carriage Return (013) \r New Line (010) \n Tab (009) \t Backspace (008) \b Backslash (092) \\ Quote (034) \�

* The decimal and octal values are three digit numbers and hexadecimals are two digit numbers. For example, the carriages return character is \013, \O015, or \X0D. ____________________________________________________________________________________________________

TABLE 4.1 NON-ASCII CHARACTER REPLACEMENTS



4.26 LEFT - Get Leftmost Characters of String

The LEFT command provides an easy method of accessing the first character(s) of a string. The LEFT command line format is:

LEFT string NumberOfChars

where:

string may be a word, a string of characters enclosed in quotes, or a variable.

NumberOfChars is the number of characters to get.

The new string containing NumberOfChars characters saves to the pre-defined variable CLEO_RSTRING. Recalling this variable's value may take place later in the job file. On the other hand, when recalling this string throughout the job file you can save CLEO_RSTRING to a user-defined variable, i.e. LET FirstChars=$CLEO_RSTRING.

Example: KEY Enter your full name: -R GET UserResponse SEARCH $UserResponse /X20 LEFT $UserResponse $STATUSN LET FirstName=$CLEO_RSTRING KEY Welcome $FirstName

will send the Enter your full name: prompt, save the remote user�s response in the user-defined variable UserResponse, then search the string for the space character. The position of the space character returns as the STATUSN variable. Then the first characters of the user�s response up to the space character saves to the user-defined variable FirstName, which is sent as a personalized welcome message.

The LEFT command always returns a 0 status.

When using the LEFT you must use the entire command name, and not just the first two letters.



4.27 LENGTH - Get the Length of String

The LENGTH command provides an easy method of determining the number of characters in a string. The LENGTH command line format is:

LENGTH string

where:


A+ returns the length in the status. This status saves to the pre-defined variable STATUSN. Note: most commands change the STATUSN variable. If you would like to access this status throughout the job file, you should save STATUSN to a user-defined variable, i.e. LET StringLength=$STATUSN.

Example: 100 KEY Enter a file name: -R GET FileName LENGTH $FileName IF $STATUSN > 8 KEY The filename $FileName is too long. Please re-enter. BRANCH ON TRUE TO 100 ENDIF

will send the Enter a file name: prompt, save the remote user�s response in the user-defined variable FileName, then check the length of the user�s response. When the filename is longer than eight characters an error message occurs and a prompt for a new filename.

When using the LENGTH you must use the entire command name, and not just the first two letters.



4.28 LEt - Set Configuration Parameter or User-Defined Variable

The LEt command lets you change individual configuration parameters instead of loading complete configuration files. LEt also lets you set user-defined variables. The LEt command line format is:

LEt parameter=setting or

LEt user _variable=setting

where:

parameter is the configuration parameter (SPEED, PROTOCOL, FILENAMES, DISPLAY, etc.) to change. See A.1 The Configuration File for a list of configuration parameters. See Chapter 1. The Cleo A+ Configurator for a detailed description of each parameter.

user _variable is the name of the user-defined variable. User-defined variables may have any name except configuration parameter names (SPEED, PROTOCOL, FILENAMES, DISPLAY, etc.) or pre-defined variable names (DATE, WEEKDAY, MONTH, etc.). See A.1 The Configuration File and 4.5.5.4 Predefined Variables for a list of pre-defined variables.

setting is the new parameter or variable setting. This setting may be a string or a number. See Chapter 1. The Cleo A+ Configurator and A.1 Configuration File in Appendix A for a detailed description of configuration parameter settings.

Example: LET PROTOCOL=KERMIT

changes the file transfer protocol type to Kermit.

Example: LET MyFileName=file.new : SEND $MyFileName

transmits the file file.new. MyFileName is a user-defined variable.

The status of the LEt command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). LEt returns an OK when the parameters is accepted, or a FAIL status when the parameter could not be set.



4.29 LIneup - Get Line Status

The LIneup command checks the status of the line connection and lets you start the job script execution based on its condition. The LIneup command has no options; the LIneup command line format is:

LIneup

The status of the LIneup command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). When the line connects, a CONNECT status message returns. When the line disconnects due to a faulty connection, bad telephone line, or the remote hangs up prematurely, a LINDWN status occurs.

Example:

LINEUP BRANCH ON CONNECT TO 999 AUTODIAL HOST 999 FIND �Login:� :

Example: IF $LINEUP = LINDWN AUTODIAL HOST ENDIF FIND �Login:�

Both examples above will automatically dial the host if the line were down. When the connection is established, it will search for a login prompt.

The interactive A+ status line will also display an ONLINE or OFFLINE status.



4.30 LOg - Open, Close, or Write to the Log File

The LOg command lets the user turn logging on and off or write a message to the log file. A log file lets you track all your communications transactions. Log files contain the date and time, the commands executed, and the status of each command. This may be used to review communications sessions or as a powerful diagnostic tool for tracing problems. The LOg command line format is:

LOg [filename.LOG] [-O|-A] or

LOg message

where:

filename is the log file to be created or appended. This log file name must have a .LOG extension, i.e. CHICAGO.LOG. The default filename is APLUS.LOG. This default filename may be changed with the StartUp|Log File Name menu option in the A+ Configurator (or LOGFILE=LogFile parameter).

-O is an option to overwrite an existing log file.

-A is an option to append to an existing log file with the same name. This is the default.

message is a message to be written to the log file. This message, for instance, may describe actions in the job file. The message must be no longer than 150 characters.

If the log is off, entering LOg with or without a filename directs the protocol characters to the Log Window and to the log file. When the log is on, entering the LOg command without a filename closes the LOg Window and log file. Toggling the log protects parts of job files (for example, password transmissions) while other commands log as usual.


Example: LOG CHICAGO.LOG -A

appends to the existing CHICAGO.LOG file using extended logging.

Example: LOG ***COMMUNICATIONS WAS SUCCESSFUL***

writes the ***COMMUNICATIONS WAS SUCCESSFUL*** message to the current log file.

The statuses of the LOg command will not display but is useful for branching (see A.3.3 Status Messages). LOg returns an OK status if the log command was successful or a DSKERR status if A+ was unable to write to the log file.

See A.3 The Log File for a sample log file.



The log file runs automatically on A+ start up if the Configuration File setting is not set for None. See 2.1 The Cleo A+ Command Line or 1.6.2 Log Mode for more information. The default log file name, APLUS.LOG, may be changed. See 1.6.1 Log File Name for details.

The Startup|Log Mode menu item in the Configurator menu (or LOGMODE=NONE|OVERWRITE|APPEND parameter) may also be used to start A+ with the log enabled.

LOg runs in interactive with the Window|Log Window menu item or the LOG tool bar button.



4.31 MID - Get Middle Characters of String

The MID command provides an easy method of accessing a middle string of character(s) in a character string. The MID command line format is:

MID string FirstCharPosition Length

where:


FirstCharPosition is the character position of the first character to get.

Length is the length of the string to get.

The new string saves to the pre-defined variable CLEO_RSTRING. This variable is recallable later in the job file.

Example: KEY Enter your birthday in MM/DD/YY format: -R GET UserResponse MID $UserResponse 4 2 LET BirthDate=$CLEO_RSTRING

will send the Enter your birthday in MM/DD/YY format: prompt, save the remote user�s response in the user-defined variable UserResponse, then save the day of the month in the user-defined variable BirthDate.

The MID command returns the length of the returned string.

When using the MID you must use the entire command name, and not the first two letters only.



4.32 MOnitor - Open or Close a Serial Line Monitor

The MOnitor command invokes a built-in serial line monitor to display the actual received/transmitted protocol characters to the Monitor Windows and save them to a file. The monitor is helpful in determining communication errors. The MOnitor command line format is:

MOnitor [filename] [-O|-A|-C]

where:

filename is the monitor file to be created or appended. The default file name is specified with the Startup|Monitor File Name menu item in the Configurator menu (or MONITORFILE=MonitorFile parameter). This file will contain the protocol characters. Note the filename specified should not be a printer or other slow device.

-O is an option to overwrite an existing monitor file with the same name. This is the default.

-A is an option to append to an existing monitor file.

-C is an option to display the standard ASCII characters (0x20 through 0x7F) in character format (i.e., 0x41 will display as the character "A"). The remaining characters (0x00 through 0x1F and 0x80 through 0xFF) will display in hexadecimal format. Without this option, all characters will display in hexadecimal.

Note: The MOnitor -S option is ignored under Windows versions of A+. The default is to always display the monitor data to the Monitor Window in addition to saving it to a file.

If the monitor is off, entering MOnitor with or without a filename directs the protocol characters to the Monitor Window and to the monitor file. When the monitor is on, entering the MOnitor command without a filename closes the Monitor Window and monitor file.


Example:

MONITOR CHICAGO.MON -AC

appends (-A) to the existing CHICAGO. MON file with monitor data saved in character (-C), or ASCII, formats.

Saving protocol information to a disk file consumes a lot of disk space. Note: the protocol once saved may be up to four times as large as the actual data received or transmitted. Receiving a 100K file may actually use 500K of disk space.

The status of the MOnitor command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). MOnitor returns an OK status if the monitor command was successful or a DSKERR status if A+ was unable to write to the monitor file.

When you encounter an A+ error status message, check A.3.3 Status Messages in Appendix A - File Formats for possible actions before using the monitor. If you are getting a NRMEOF status but are receiving or transmitting data that you think should be different, use the monitor command to determine exactly what is being sent and received. For transmit problems, for instance, use the MOnitor command before the transmit command to save the monitor to a file and again after the transmit command to turn the monitor off.



Example: MONITOR SIGNON.MON

TEXT SIGNON MONITOR

This will create a monitor file with the name SIGNON.MON. This monitor is viewable with a text editor or printed. See A.4 The Monitor File for examples, a table of protocol characters, and a table of ASCII characters. If necessary, a printout of your monitor file may be E-MAILed or faxed to Cleo's Technical Support department.

The monitor may also be invoked by (1) including the MONITORMODE=OVERWRITE or MONITORMODE=APPEND parameter as an argument when A+ is executed (see 2.1 The Cleo A+ Command Line). (2) Specifying the Monitor Mode within the APLUS.CFG file (see 1.6.4 Monitor Mode). (3) Or by using the Window|Monitor menu item or MON tool bar button within A+ (see 3.7.3 Monitor Window - Toggle the Line Monitor Window).

Example:

APLUS MONITORMODE=OVERWRITE

creates an APLUS.MON monitor file to save all protocol characters.

A.4 The Monitor File for examples and a table of ASCII characters.

MOnitor may also be controlled interactively with the Window|Monitor Window menu item in the A+ Configurator or the MON tool bar button. The StartUp|Monitor Mode menu menu item in the A+ Configurator (or MONITORMODE=OVERWRITE|APPEND parameter) may also be used to start A+ with the monitor enabled.



4.33 MSend - Multiple Send

The MSend command may be used to transmit multiple files to the remote. The File Transfer|Protocol menu option in the Configurator notebook (or PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K|YMODEM|YMODEMG|ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer type used for the transmission. The File Transfer|Default Send Mode menu option in the Configurator notebook (or DEFSENDMODE=SCAN|BINARY|TEXT parameter) is used to determine if the file is translated through the xlatout.ovr translation table before transmission. The MSend command line format is:

MSend pattern

where:

pattern is a file match pattern that is valid for the Windows operating system you are using.

A File Transfer Status window is displayed on the screen during transmission. See 2.4 File Transfer Status in Chapter 2 - Operation for details.

After each file is transmitted, a status line is posted to the log and moniotr files, if open, giving a completion status message for the tranmission and the number of data blocks sent. See A.3.2 The Transmit/Receive Status Line in Appendix A - File Formats for details. If the transmission was successful, a NRMEOF (Normal End of File) status message will display. See Table A.3 Transmit Completion Status Messages in Appendix A. File Formats for a complete list and A.3.3 Status Messages for a complete description of each status message.

MSEND Example

LOG ts.log -ocMON ts.mon -ocLET PROTOCOL=ZMODEMANS 5

100 MSEND *send*.*BRANCH ON NOFILE TO 300BRANCH NOT NRMEOF TO 200

## Capture the name of the file that matched so it can be logged laterLET FILENAME=$CLEO_RSTRING

## Log the filename150 LOG $FILENAME was sent successfully

## Loop back to get the next matching filenameBRANCH ON TRUE TO 100

## This file failed to send.200 LOG $FILENAME was NOT sent successfully

BRANCH ON TRUE TO 100

300 LOG Ran out of files to sendVOICE500 QUIT



4.34 OPEN - Open a File to READ or WRITE

The OPEN command lets you open a file to read with the READ or to write with the WRITE command. The OPEN command line format is:

OPEN filename [-O|-A]

where:

filename is the file to read with the READ command or to write with the WRITE command.

-O is an option to overwrite an existing file with the same name. Using either -O or -A will open a WRITE file.

-A is an option to append to an existing file with the same name. Using either -O or -A will open a WRITE file.

When entering a file name without an option, the file opens for READing; when using an option, the file opens for WRITEing.

The status of the OPEN command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). If the file can not open, a NOFILE status returns otherwise an OK status returns.

See 4.37 READ - Read a Line from READ File for examples.

When using the OPEN you must type the entire command name, and not just the first two letters.



4.35 PRint - Receive File(s) & Spool to Printer

The PRint command places A+ in receive mode and waits to receive one or more files from the remote. This command is equivalent to the REceive command, except these files are automatically spooled to the printer. The Protocol menu option (PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K|YMODEM| YMODEMG|ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer type used for the transmission. The File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine if the file is translated through the xlatin.ovr translation table upon reception. The PRint command line format is:

PRint [filename [-N|-T]

where:

filename is the optional receive file name override. XMODEM, ASCII, and ANSI CLEAR file transfer protocols (and YMODEM, ZMODEM, Kermit, and FTP with the File Transfer|Accept Incoming Filenames menu option in the A+ Configurator set to NO (FILENAMES=NO)): If no filename has been specified since A+ logon, all received files are accumulated serially as PRINT.000, PRINT.001, etc. These files are automatically spooled to the printer. YMODEM, ZMODEM, Kermit, and FTP: If no filename has been specified and the File Transfer|Accept Incoming Filenames menu option in the A+ Configurator set to OVERWRITE (FILENAMES=OVERWRITE), received files are saved with the file name from the remote system overwriting any existing file of the same name. If no filename has been specified and the File Transfer|Accept Incoming Filenames menu option in the A+ Configurator set to YES (FILENAMES=YES), received files are saved with the file name from the remote; if a file with the same name already exists, the file is saved as the default file name (PRINT.000, PRINT.001, etc.). For example, if the incoming file name was REMOTE.PRT and REMOTE.PRT already existed on your system, the file will be saved as PRINT.000 if PRINT.000 didn't already exist, or PRINT.001 if PRINT.001 didn't already exist, etc. These files are automatically spooled to the printer. When the filename is without a file extension, the files save with a numeric file extension starting with .000 and do not overwrite the previously saved files, which have the same name. Example: PRINT prtstuff will save data to the file prtstuff.000 unless prtstuff.000 already exists. If prtstuff.000 exists, prtstuff.001 is tried, and so on, until named with a nonexistent filename. When the filename has a numeric extension, the files accumulate serially starting with the named number. The existing files with the same name lose their content when the file copies over the file. Example: PRINT prtstuff.000 will save data to prtstuff.000 regardless of whether a file already exists with that name.



When a filename has a period and no extension or a non-numeric extension, after the named file receives, the additional files accumulate serially starting with a .000 extension. The existing files with the same name will no longer exist, and the original file data is lost. Example: PRINT prtstuff. will save the data to prtstuff regardless of whether a file already exists with that name. The next files will save as prtstuff.000, prtstuff.001, etc.

In FTP file transfer mode, you may specify two filenames. The required first filename is the file on the host that you want to receive. To transfer from a directory other than your FTP login directory (which may be different from your host login directory or your current directory on the host), you must specify the host�s path name and file name. The optional second filename is the file you want it saved to on your system. If the second file name is not specified, the file is saved as the host filename without the path.

-N data saves as-is. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine whether the message is translated upon reception.

-T data translates through the xlatin.ovr translation table upon reception. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine whether the message is translated upon reception.

Printer files print via the Notepad editor. This default editor may be changed with the Printer|Association Extension option in the Configurator menus (or PRINTEXTENSION=EditorFileExtension parameter). See 1.1 A+ Configurator. Print files may optionally be deleted after printing with the Printer|Remove Spooled Files option in the Configurator menus (or DELSPOOLFILE=ON|OFF parameter).

Example: PRINT PRTFILE Files are accumulated serially as PRTFILE.000, PRTFILE.001, etc., until no more files are received. The received files are then spooled to the printer.

A File Transfer Status window displays on the screen during transmission. See 2.4 File Transfer Status for details.

After each of the files are received, a status line is written to the log and monitor files, if open, this gives a completion status for transfer and gives the number of data blocks received. See A.3.2 The Transmit/Receive Status Line for details. When the print command is successful, a NRMEOF (Normal End of File) status displays. See A.3.2 The Transmit/Receive Status Line for a complete list and A.3.3 Status Messages for a complete description of each status message.

A+ will continue to receive files, and write them to disk until; receiving an end of transmission from the remote; or (2) the print is canceled with the Cancel button; (3) the receive timeout expires; or (4) an error occurs.

Note: when one file terminates abnormally, no other files will receive afterwards.



In a job/script file, you may branch on one of the following status messages: OK if the receive is successful; FAIL if the receive fails; or any of the status messages listed in Table A.2. Note, when receiving multiple files, you may branch on the status of the last file received.

The default print file name may be changed from PRINT with the PRNBASENAME=PrintFilename parameter.

If the line is down when the PRint command is executed and no branch command follows, A+ will wait until a connection is made before continuing.

PRint may also be executed interactively with the Receive|To Printer option or the PRINT tool bar button.



4.36 QUit - Exit A+

The QUit command lets Cleo A+ gracefully exit from a communications session. The QUit command line format is:

QUit [exit_code|$STATUSN]

where:

exit_code is an optional decimal number to be returned (via the EXIT() call) to the operating system on exit. If an option is omitted, A+ will return with an exit code of 0.

STATUS is an option to return (via the EXIT() call) the last command status code to the operating system on exit. See A.3.2 The Transmit/Receive Status Line and A.3.3 Status Messages for status codes. If an option is omitted, A+ will return with an exit code of 0.

The QUit exit code is useful within a job file where you may want to BRanch to different QUit commands depending on the status of the communications session. The status passes along to the program or script calling A+. See your operating system manual for handling exit codes. Table 4.2 lists standard A+ exit codes. You may designate exit codes for additional error conditions, but to avoid confusion user defined exit codes should start at values higher than the standard exit codes.

Example: BINARY FILE.NEW IF $STATUS = NRMEOF 5 RECEIVE QUIT ELSE QUIT 100 ENDIF

transmits the FILE.NEW file. If the file is transmitted normally, A+ will wait to receive a file then quit with a zero exit code; otherwise if there is an error in the transmission, A+ will quit with an exit code of 100. The calling program or batch/script file could check for a non-zero exit code to determine if there were errors in communications.

The QUit $STATUSN is an alternate method of exiting with the status of the last command executed. The status code passes along to the program or script calling A+. See your operating system manual for handling exit codes. Tables A.2 and A.3 in Appendix A - File Formats list A+ status codes.

Example: BINARY FILE.NEW QUIT $STATUSN

transmits the FILE.NEW file then quits with the status code from the BInary command. The calling program could check for an exit code of 15 (NRMEOF) or any other error status codes to determine if there were errors in communications.

The QUit command causes a log off message to post to the log file (if open). All pending files are closed including the monitor, log, receive, print, recorder, and any OPENed files. If an exit_code or $STATUSN is specified, it is returned to the operating system. If an exit_code or $STATUSN is not specified, a zero (0) exit code is returned.

QUit does not drop the modem/phone line. To drop the line, use the HAngup or VOice command before QUit.



____________________________________________________________________________________________________ EXIT CODE RESULT 0 No errors 1 Reserved 2 Unable to initialize port 3 Reserved 4 Command line error 5 Config file error 6 Reserved 7 Error opening the device 8 Device not active error 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Job file not found 16 Reserved 17 Path error 18 Device in use by A+ 19 Shared memory create error 20 A+ IAPI is loaded and resident 21 A+ killed 22 Error unscrambling job file 23 Error opening terminfo file 24 API pipes error 25 No device specified 26 Invalid host name 27 Can't create socket 28 No socket connection to host 29 A+ not installed 30 Can�t access security file 31 Licensing errror 32-35 Reserved ____________________________________________________________________________________________________

TABLE 4.2 STANDARD A+ EXIT CODES

You may designate other exit codes for additional error conditions.

QUit may also be executed interactively with the System|Exit option.



4.37 READ - Read a Line from READ File

The READ command lets you read a line of data from a file. This data may direct the actions of the remaining job/script file operation. For instance, you could read a file containing a list of filenames to upload to the host. The READ command line format is:

READ line

where:

line is the variable in which to store the line of data read from the READ file.

READ reads the next line in the OPENed file and stores it in the specified variable. If the file is not open, a NOFILE status is returned; when there are no more lines in the READ file, a NODATA status is returned; otherwise an OK status is return.

READ variables may be accessed with the %variable% or $variable command.

Example:

OPEN FileList 10 READ SendName BRANCH ON NODATA TO 20 SEND %SendName% BRANCH ON TRUE TO 10 20 LOG ** ALL FILES HAVE BEEN SENT **

uploads the files listed in the FileList file.

Example: RECEIVE FILE.NEW OPEN FILE.NEW READ FileLine DISPLAY �The first line of the received file says: $FileLine� CLOSE

will receive a file, then open the file, read the first line of the file and display it on your screen, then close the file.

See also 4.34 OPEN - Open a File to READ or WRITE.

When using the READ you must type the entire command name, and not the first two letters only.



4.38 REceive - Receive File(s)

The REceive command waits to receive one or more files from the remote. The File Transfer|Protocol menu option in the A+ Configurator (or PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K |YMODEM|YMODEMG|ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer type used for receiving. The File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine if the file is translated through the xlatin.ovr translation table upon reception. The REceive command line format is:

REceive [filename] [-N|-T]

where:

filename when naming the receive file name, instead of, receiving the file name from the remote XMODEM, ASCII, and ANSI CLEAR file transfer protocols (and YMODEM, ZMODEM, Kermit, and FTP with the File Transfer|Accept Incoming Filenames menu option in the A+ Configurator set to NO (FILENAMES=NO)): If no filename has been specified since A+ logon, all received files are accumulated serially as RCVFILE.000, RCVFILE.001, etc. YMODEM, ZMODEM, Kermit, and FTP: When no filename is specified, the File Transfer|Accept Incoming Filenames menu item, and the A+ Configurator is set to overwrite (FILENAMES=OVERWRITE). The received files will have the name that transfers by the remote system, which will overwrite the data in a file with the same name. When no filename is specified, the File Transfer|Accept Incoming Filenames menu item in the Configurator is set to YES (FILENAMES=YES), and the received files save with the name that transfers by the remote system. When a file with the same name already exists, the file saves as the default file name (RCVFILE.000, RCVFILE.001, etc.). For example, if the incoming file name was REMOTE.FIL and REMOTE.FIL already existed on your system, the file will be saved as RCVFILE.000 if RCVFILE.000 didn't exist, or RCVFILE.001 if RCVFILE.001 if it didn�t exist, etc. When a filename is without a file extension, files accumulate serially starting at .000 without overwriting current files that have the same name. Example: RECEIVE mystuff will save data to the file mystuff.000 unless mystuff.000 already exists. If mystuff.000 exists, mystuff.001 is tried, and so on, until it finds a nonexistent filename When a filename has a numeric extension, the files accumulate serially starting at that number. Existing files with the same name overwrite. Example: RECEIVE mystuff.000 will save data to mystuff.000 regardless of whether a file already exists with that name. When using a filename with a period and no extension, or with a non-numeric extension, after receiving the first file, additional files are accumulated serially starting with a .000 extension. Existing files with the same name will overwrite.



Example: RECEIVE mystuff. will save data to mystuff regardless of whether a file already exists with that name. The next files received will save as mystuff.000, mystuff.001, etc.

In FTP file transfer mode, you may specify two filenames. The required first filename is the file on the host that you want to receive. To transfer from a directory other than your FTP login directory (which may be different from your host login directory or your current directory on the host), you must specify the host�s path name and file name. The optional second filename is the file you want it saved to on your system. If the second file name is not specified, the file is saved as the host filename without the path.

-N will force data to be saved as-is. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine whether the message is translated upon reception.

-T forces data to translate through the xlatin.ovr translation table upon reception. Without this option, the File Transfer|Default Receive Mode menu option in the A+ Configurator (or DEFRECEIVEMODE=BINARY|TEXT parameter) is used to determine whether the message is translated upon reception.

Example: LET PROTOCOL=KERMIT RECEIVE -T

will receive a Kermit file and save it as the incoming filename after translation. If the incoming filename exists, the File Transfer|Accept Incoming Filenames menu item in the Configurator menu (or FILENAMES=YES|NO|OVERWRITE) parameter determines how the file is saved.

A File Transfer Status window displays during reception. See 2.4 File Transfer Status for details.



When each file received stops transmitting, a status line posts to the log and monitor files, if open, giving a completion status message for the receiving and the number of data blocks received. See A.3.2 The Transmit/Receive Status Line for details. If the receive was successful, a NRMEOF (Normal End of File) status message will display. See A.3.2 The Transmit/Receive Status Line for a complete list and A.3.3 Status Messages for a complete description of each status message.

A+ will continue to receive files, and write them to disk. Until one of these four items happens (1) it receives an end of transmission from the remote, (2) the receive mode is exited with the Cancel button, (3) the receive timeout has expired, or (4) an error has occurred. Note that if one of a group of files terminates abnormally, the remaining files on the host will not transmit to the client.

In a job/script file, you may branch on one of the following status messages: OK if the receive is successful; FAIL if the receive fails; or any of the status messages listed in Table A.2.

Note: if receiving multiple files you may branch only on the status of the last file received; intermediate files always have a NRMEOF (Normal End Of File) status.

The default receive file name may be changed from RCVFILE with the RECBASENAME=ReceiveFileName parameter.

If the line is down when the REceive command is executed and no branch command follows, A+ will wait until a connection is made before continuing.

REceive may also be executed interactively with the Receive|To File option or the RCV tool bar button.



4.39 RETURN - Return to Calling Job File

The RETURN command lets you return to the job file that EXecuted it. With the EXecute and RETURN commands, shorter job files will execute and perform their distinct functions. This is similar to making function calls. The RETURN command line format is:

RETURN

The exit code or status code is useful within a job file where you want to return to the called job.

Example: ## MAIN.JOB AUTODIAL Chicago KEY LOGON VJR EXECUTE TRANSMIT.JOB KEY LOGOFF 1 HANGUP QUIT

## TRANSMIT.JOB SEND MYFILE.NEW RETURN

The MAIN.JOB job file dials a Chicago site, sends a logon message, and then executes the TRANSMIT.JOB job file to send MYFILE.NEW. When MYFILE.NEW ends with an error (NOT NRMEOF), MAIN.JOB hangs up and quit, otherwise MAIN.JOB will send a logoff message before hanging up and quitting.

RETURN is for use in a job/script file (see JOb), and is not valid for manual operations.

When using the RETURN you must type the entire command name, and not just the first two letters.



4.40 RIGHT - Get Rightmost Characters of String

The RIGHT command provides an easy method of accessing the last character(s) of a character string. The RIGHT command line format is:

RIGHT string NumberOfChars

where:


NumberOfChars is the number of characters to get.

The new string containing NumberOfChars characters saves to the pre-defined variable CLEO_RSTRING. This variable is accessible later in the job file. Note all of the string function commands change the CLEO_RSTRING variable. If you will like to access this string throughout the job file you can save CLEO_RSTRING to a user-defined variable, i.e. LET LastChars=$CLEO_RSTRING.

Example: KEY Enter your phone number: -R GET UserResponse RIGHT $UserResponse 7 LET PhoneNumber=$CLEO_RSTRING

Will send the Enter your phone number: prompt, save the remote user�s response in the user-defined variable UserResponse, then save the last seven characters of the user�s response into the user-defined variable PhoneNumber.

The RIGHT command always returns a 0 status.

When using the RIGHT you must use the entire command name, and not just the first two letters.



4.41 SAve - Save Current Configuration

The SAve command writes the configuration parameters to a file. The SAve command format is:

SAve [filename]

where:

filename is the configuration file to be created. When no filename is present, the configuration saves to APLUS.CFG.

You can modify the Configuration files (cfg) standard text editor, such as, Note Pad or Write. See A.1 The Configuration File for the configuration file layout.

Example: LET PROTOCOL=FTP

SAVE

t the protocol parameter. The current configuration saves to the default configuration file APLUS.CFG.

The status of the SAve command will not be displayed but may be used for branching (see 4.5.1 BRanch ON|NOT status TO label). SAve returns an OK status if the save command was successful a DSKERR status if A+ was unable to save to the configuration file.

Note: The SAve command lets you save only the configuration options that list in the default APLUS.CFG file. It does not let you save any configuration file options that are user-defined variables or not supported in this release of the A+ software.

These configuration files may be used during subsequent A+ executions by including the configuration filename as an argument when executing A+, or by executing the COnfig command with the filename as an argument:

A+ CONFIGFILE=CFGFILE or CONFIG CFGFILE

The configuration parameters read directly from the previously created disk file CFGFILE.

SAve may also be executed interactively with the Configuration|Save or Configuration|Save As menu option.



4.42 SEARCH - Search String for a Character or a String

The SEARCH command provides an easy method of finding the first occurrence of a character or a string of characters within a character string. The SEARCH command line format is:

SEARCH SearchString StringToFind

where:

SearchString is the string to search. SearchString may be a string of characters, a string of words enclosed in quotes, or a variable.

StringToFind is the string of characters that it will find. StringToFind may be a character, a string of characters, a string of words enclosed in quotes, or a variable. To search for non-ASCII characters, use the \ replacements listed in Table 4.1 Non-ASCII Character Replacements.

A+ returns the beginning position of the matched string in the status. If the string is not found, a status of 0 is returned. This status saves to the pre-defined variable STATUSN. Notice that most commands change the STATUSN variable. If you would like to access this status throughout the job file, you should save STATUSN to a user-defined variable, i.e. LET MatchPosition=$STATUSN.

Example: KEY Enter your full name: -R GET UserResponse SEARCH $UserResponse /X20 LEFT $UserResponse $STATUSN LET FirstName=$CLEO_RSTRING KEY Welcome $FirstName

will send the Enter your full name: prompt, save the remote user�s response in the user-defined variable UserResponse, then search the string for the space character (/X20). The position of the space character returns in the STATUSN variable. Then the first characters of the user�s response up to the space character saves into the user-defined variable FirstName, which sends a personalized, welcome message.

When using the SEARCH you must use the entire command name, and not just the first two letters.



4.43 SEnd - Transmit File(s)

The SEnd command transmits a file or file(s) to the remote. The File Transfer|Protocol menu option in the A+ Configurator (or PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K|YMODEM|YMODEMG| ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer type used for the transmission. The File Transfer|Default Send Mode menu option in the A+ Configurator (or DEFSENDMODE=SCAN|BINARY|TEXT parameter) is used to determine if the file is translated through the xlatout.ovr translation table before transmission. The SEnd command line format is:

SEnd filename [RemoteFilename] [-T| [-N]

where:

filename is the file or files to be sent to the remote system. Wildcards and/or drives and paths may be used within file names. Note that if one of a group of transmit files specified by a wildcard terminates by anything other than a NRMEOF (normal end of file) status, the remaining specified files do not transmit and the command aborts. With YMODEM, ZMODEM, Kermit, and FTP file transfer protocols, the remote processor names this received filename unless the optional RemoteFilename is in use.

RemoteFilename is an optional remote file name override. This filename, instead of the original filename, assigns the file received by the remote processor. You may send a drive and/or path name with the file name. The file name override is supported only by YMODEM, ZMODEM, Kermit, and FTP file transfer protocols. Remote file naming is not supported by the XMODEM, ASCII, or ANSI protocols.

-N data sent as-is. Without this option, the File Transfer|Default Send Mode menu option in the A+ Configurator (or DEFSENDMODE=SCAN| BINARY|TEXT parameter) is used to determine whether the file is translated before transmission.

-T data sent translated. Data translates through the xlatout.ovr file before transmission. Without this option, the File Transfer|Default Send Mode menu option in the A+ Configurator (or DEFSENDMODE=SCAN| BINARY|TEXT parameter) is used to determine whether the file is translated before transmission.

Example: SEND APLUS.*

sends all files starting with the APLUS prefix.

Example: SEND C:\MYFILES\MY.EXE /usr/YOUR.EXE

will send the file C:\MYFILES\MY.EXE with the file name /usr/YOUR.EXE. This will save the MY.EXE file on a remote UNIX system as YOUR.EXE in the /usr directory.

A File Transfer Status window displays on the screen during transmission. See 2.4 File Transfer Status



After each file transmits, a status line writes to the log and monitor files, if open, giving a completion status message for the transmission and the number of data blocks sent. See A.3.2 The Transmit/Receive Status Line for details. If the transmission was successful, a NRMEOF (Normal End of File) status message will display. See A.3.3 Status Messages for a complete list and A.3.3 Status Messages for a complete description of each status message.

In a job/script file, you may branch on one of the following status messages: OK if the transmission is successful; FAIL if the transmission fails; or any of the status messages listed in Table A.3. Note if a wildcard is used to transmit multiple files, you may branch only on the status of the last file transmitted.

If the line is down when the SEnd command is executed and no branch command follows, A+ will wait until a connection is made before continuing.

SEnd transmits interactively with the Transmit|Send menu option and the SEND tool bar button.



4.44 SLeep - Pause Specified Seconds

The SLeep command lets you pause for the specified amount of time. The format of the SLeep command is:

SLeep seconds where: seconds is the number of seconds to pause before continuing with the next A+ command.

Example: 1 AUTODIAL 654-8110 R1 BRANCH NOT BUSY TO 999 SLEEP 60 BRANCH ON TRUE TO 1 999 BRANCH ON FAIL TO 1 KEY LOGON DNJ

In the above sequence, if the remote modem is busy A+ will wait one minute (60 seconds) before attempting to redial.

A sleep status window will appear letting you to abort the wait with the Cancel button.

The SLeep command does not write a status to the Log file. However, you can branch on the following status messages: OK if the pause is completed, ABORT if SLeep aborts with the Cancel button, or FAIL if the seconds are invalid. See A.3.3 Status Messages for details.

See also 4.51 WAitfor - Wait until Specified Time.



4.45 STart - Display or Initialize Counter

The STart command displays the current counter values or initializes one of nine counters. The format of the STart command is:

STart [[COUNTERc]=x] where: c is the number of the counter (1 through 9).

x is the value used to initialize the specified counter. If this option is not specified, the counter is initialized to 1.

The STart command with no parameter will display the current values for each counter that is in use.

Counters are for counting the number of repetitions of a function. The contents of a counter may be accessed when counter is preceded by a % or $ character. For example, the string %COUNTER1 or $COUNTER1 in any command is replaced with the current value of COUNTER1.

Example:

START COUNTER1=1 10 RECEIVE newfile +COUNTER1 BRANCH ON %COUNTER1 < 4 TO 10 TEXT signoff

In the example above, A+ will receive three files (newfile.000 through newfile.002) before sending the signoff message with the text command.

Example:

START COUNTER1=1 10 RECEIVE file$COUNTER1.new +COUNTER1 BRANCH ON $COUNTER1 < 4 TO 10 TEXT signoff

In the example above, A+ receives three files (file1.new, file2.new, and file3.new) before sending the file, which contains the signoff message.

Counters may also be used to access token variables when counter is preceded by the %% or $$ characters. For example, the string %%COUNTER1 or $$COUNTER1 in any command is replaced with the token for the current value of COUNTER1.



Example:

TOKEN 1=one 2=two 3=three START COUNTER1=1 10 RECEIVE file$$COUNTER1.new +COUNTER1 BRANCH ON $COUNTER1 < 4 TO 10 TEXT signoff

In the example above, A+ will receive three files (fileone.new, filetwo.new, and filethree.new) before sending a file, which contains the signoff message.

The STart command always returns an OK status.

See also 4.11 +COUNTER - Increment Counter, 4.12 -COUNTER - Decrement Counter, and 4.5.4 BRanch ON|NOT %COUNTERc|$COUNTERc <|=|> number TO label.



4.46 SYstem - Execute an Operating System Command or Application Program

The SYstem lets commands and programs execute from within A+. The SYstem command line format is:

SYstem command

where:

command is the Windows or DOS command or application to execute.

During the execution of the SYstem command, the line monitoring pauses, for this reason using the SYstem, must be done when no activity is expected. The SYstem is for cautious use within job/script files.

These command types are useable with SYstem:

1. Internal Commands - break, cd, chcp, chdir, cls, copy, ctty, date, del, dir, erase, exit, loadhi (1h), md, mkdir, more, path, prompt, rd, ren, rename, rmdir, set, time, type, ver, verify, vol.

2. External Commands - Files with an EXE, COM, and BAT extension.

SYstem will return an exit code. The exit code passes from the Internal or External Command to A+. The code lets branching occur when the correct BRanch is in the job file. See 4.5.2 BRanch ON|NOT return_code TO label for details.

To use the internal commands, it is necessary to invoke the command processor CMD.EXE or COMMAND.COM. In addition, providing a complete path ensures that Windows will find the command processor. It is important to note that not all Window Systems execute, run, and return values in the same way. When using Internal Commands: The environment variable COMSPEC will show the correct path to the processor.

For Windows NT COMSPEC=C:\WINNT\SYSTEMS32\CMD.EXE For Windows 95 or 98 COMSPEC=C:\COMMAND.COM

Note: These are the default paths, which are changeable. It is important to verify the path. The following command will open an MS-DOS window, delete the file Remove.txt, and close the window. The "/C" will cause the window to close. For Windows NT SYSTEM C:\WINNT\SYSTEM32\CMD.EXE /C DEL Remove.txt. The following command will open an MS-DOS window, copy the file, and close the window. The "/C" causes the window to close. For Windows 95 or 98 SYSTEM C:\COMMAND.COM /C COPY Rcvfile.001 First.fil.



When using an external command:

The external commands with the SYstem command is necessary to invoke the command processor -CMD.EXE or COMMAND.COM. Execute these commands if you want the MS-DOS window to close for batch (BAT) files. Provide the complete path to the command processor. The COMSPEC environment variable will show the correct path to the command processor.

The environment variable COMSPEC will show the correct path to the processor. For Windows NT COMSPEC=C:\WINNT\SYSTEMS32\CMD.EXE For Windows 95 or 98 COMSPEC=C:\COMMAND.COM

Note: These are the default paths, which are changeable. It is important to verify the paths.

Windows 95/NT

SYstem Notepad.exe This will open an MS-DOS window, start the Note Pad program, and wait for the Note Pad program to finish. Then it waits for the window to close. An error code will return to the job file.

SYstem edistart.bat This will open an MS-DOS window, start the edistart.bat file, and wait for the MS-DOS batch file to finish. Then it waits for the window to close. An error code will return to the job file.

Windows 95/98

SYstem Start /w C:\Command.com /c ProgramName.exe This will open an MS-DOS window, run ProgramName.exe, wait for it to finish, and close the window. The error code from the batch file does not return to the job file.

SYstem Start /w C:\Command.com /c edistart.bat This will open an MS-DOS window, start the edistart.bat file, and wait for the MS-DOS batch file to finish, Then it waits for the window to close. An error code does not return to the job file.

Note: These commands do not work when running Windows NT. The system will not be able to find the Start program.

Windows 98

SYstem Notepad.exe This will open an MS-DOS window, start the Note Pad program, and wait for the Note Pad program to finish. Then it waits for the window to close. An error code will return to the job file.

SYstem edistart.bat This will open an MS-DOS window, start the edistart.bat file, and wait for the MS-DOS batch file to finish. Then it waits for the window to close. An error code does not return to the job file.



4.47 TAble - Display or Change Translation Table(s)

The TAble command provides an easy method of viewing or changing the incoming and outgoing character translations. The TAble command line format is:

TAble [OutFilename [InFilename]]

where:

OutFilename is the outgoing translation file previously created with a text editor. The default outgoing translation file is xlatout.ovr. The default filename may also be changed with the OUTTABLE=OutFileName startup parameter. See A.6 The Character Translation Files for the required file format.

InFilename is the incoming translation file previously created with a text editor. The default translation file is xlatin.ovr. The default filename may also be changed with the INTABLE=InTableName startup parameter. See A.6 The Character Translation Files for the required file format.

TAble, when executed with two filenames, reads the translations found in the previously created files. Translations found in the first file are for character conversions for outgoing data. Translations found in the second file are for subsequent character conversions for incoming data.

Example: TABLE xlatout.cap xlatin.ovr

changes the outgoing translation table to convert all lowercase characters to uppercase characters before transmission. Incoming characters translate normally.

TAble, when executed with a single filename, reads the translations found in the previously created file. These translations are for subsequent outgoing and incoming conversions. See A.6 The Character Translation Files for details.

TAble, executed without a filename, displays the outgoing translation table, and then the incoming translation table, one screen at a time.

After a TAble OutFileName InFileName command, a status line does not write to the LOg or MOnitor files. However, you may branch on one of the following status messages: OK if the translation table(s) loaded properly, FAIL if there was an error in the table(s), or NOFILE if the specified file(s) could not be found or opened. See A.3.3 Status Messages for details.

TAble may also be executed interactively with the Configuration|Translation Tables menu item.



4.48 TExt - Transmit Text File(s)

The TExt command transmits a file or multiple files to the remote. The File Transfer|Protocol menu item in the A+ Configurator (or PROTOCOL=ASCII|ANSI|XMODEM|XMODEM1K|YMODEM|YMODEMG| ZMODEM|KERMIT|FTP parameter) is used to determine the file transfer protocol used for the transmission. Files translate through the xlatout.ovr translation table before transmission. The TExt command line format is:

TExt filename [RemoteFilename]

where:

filename is the file or files to be sent to the remote system. Wildcards and/or drives and paths are for use within file names. Note that if one of a group of transmit files specified by a wildcard terminates by anything other than a NRMEOF (normal end of file) status, and the remaining file transfer will abort. With YMODEM, ZMODEM, Kermit, and FTP file transfer protocols, this filename (without the drive or path name) assigns to the file received by the remote processor unless the optional remote file name override is set for overriding the received filename.

RemoteFilename is an optional remote file name override. This filename, instead of the original filename, assigns the name received by the remote processor. You may send a drive and/or path with the file name. The file name override is valid with the YMODEM, ZMODEM, Kermit, FTP, and unsupported by XMODEM, ASCII, or ANSI protocols.

Example: TEXT *.HLP

sends all files with the .HLP extension.

Example: TEXT C:\MYFILES\MY.TXT /usr/YOUR.TXT

will send the file C:\MYFILES\MY.TXT with the file name /usr/YOUR.TXT. This will save the MY.TXT file on a remote UNIX system as YOUR.TXT in the /usr directory.

A File Transfer Status window displays on the screen during transmission. See 2.4 File Transfer Status for details.

After each file transmits, a status line posts to the log and monitor files, if open, giving a completion status message for the transmission and the number of data blocks sent. See A.3.2 The Transmit/Receive Status Line for details. If the transmission was successful, a NRMEOF (Normal End of File) status message will display. See A.3.3 Status Messages for a complete list and A.3.3 Status Messages for a complete description of each status message.

In a job/script file, you may branch on one of the following status messages: OK if the transmission is successful; FAIL if the transmission fails; or any of the status messages listed in Table A.3. Note if a wildcard is used to transmit multiple files, you may branch only on the status of the last file transmitted.

If the line is down when the TExt command is executed and no branch command follows, Cleo A+ will wait until a connection is made before continuing.

TExt may also be executed interactively with the Transmit|Text or Transmit|Send option or the SEND tool bar button.



4.49 TOken - Enable, Disable, Display or Set Token Variables

The TOken command enables, disables, displays, changes, or adds to the current token values. The format of the TOken command is:

TOken [ON|OFF] or

TOken token [token...] or

TOken x=token [x=token...] where: ON is an option to enable token, variable, and counter processing. Token, variable, and counter processing

may also be enabled with any form of the TOken command (except TOken OFF) or the StartUp|Tokens menu option in the A+ Configurator (or TOKEN=ON|OFF|TokenList parameter). ON is default for the Token command.

OFF is an option to disable token, variable, and counter processing. Disabling this processing lets you send filenames and/or keyboard messages containing the $ and % characters.

token is an optional variable for parameter substitution. You may supply up to 19 tokens. Using tokens enables tokens, variables, and counter processing.

x is the number of the token to be added or changed. x may be a value between 1 and 19 inclusive.

If the TOken command has no options when entered, A+ displays the status of the token/variable/counter processing and values for each of the tokens.

Tokens are similar to MS-DOS replaceable parameters or UNIX/XENIX positional parameters. The first token may be accessed with %1 or $1, the second with %2 or $2, and so on. These tokens may be used anywhere within A+, except as command names or labels.

Example:

TOKEN file1 file2 file3 TEXT $1 $2 RECEIVE %3

will result in:

TEXT file1 file2 RECEIVE file3

which will send file1 to the remote as file2 and save the received file as file3.



Tokens and environment variables (also referred to as named variables or shell variables), user-defined variables, or pre-defined variables are usable together in different combinations. These variables may be accessed with the %variable% or $variable command.

For example, if TEMP=C:\windows\temp in the environment, the following commands:

TOKEN 5=file5 6=file6 7=file7 TEXT $TEMP\$5 $6 RECEIVE %TEMP%\%7

will result in:

TEXT C:\windows\temp\file5 file6 RECEIVE C:\windows\temp\file7

which will send C:\windows\temp\file5 to the remote as file6 and save the received file as C:\windows\temp\file7. See your operating system manual for information on setting environment variables. See 4.5.5.1 Configuration Parameter Variables, 4.5.5.2 Token Variables, 4.5.5.3 Environment Variables, 4.5.5.4 Predefined Variables, and 4.5.5.5 User-defined Variables for a description of each variable type.

Tokens may also be set from the A+ command line (see 2.1 The Cleo A+ Command Line) or set/changed with the EXecute command (see 4.18 EXecute - Execute Commands from a Job/Script File).



4.50 VOice - Disconnect Phone Line and Disable Autoanswer

The VOice command disconnects the telephone line between your modem and the remote site and, for standard PSTN connections, disables autoanswer. The VOice command line format is:

VOICE [WANPhoneBookEntry|*]

where:

WANPhoneBookEntry is the name of the Dial-Up Networking phone book entry to disconnect.

* lets you disconnect all the Dial-Up Networking connections.

During standard PSTN (non-WAN) hangup, A+ sends an "ATHS0=0" command to the modem to hang-up the telephone line and disable autoanswer. The Port|Speed option in the A+ Configurator (or SPEED=PortSpeed parameter) controls the speed the AT string is sent.

AUTODIAL 815-555-1212 BRANCH NOT OK TO 1 RECEIVE filename

1 VOICE QUIT

The above job file will disconnect the line if the modems failed to connect properly.

VOice will execute interactively with the Line|Hangup option or the HANG tool bar button. The Line|Hangup option or the HANG tool bar button do not, however, disable autoanswer.



4.51 WAitfor - Wait until Specified Time

The WAitfor command lets you wait until the specified time to continue in the job file. This command is helpful to schedule communications, for instance when the telephone rates are lower. The format of the WAitfor command is:

WAitfor [+]hh:mm where: + waits for a specific amount of time before it continues.

Example: WAITFOR +1:00 will wait one hour before continuing. Without the plus sign, WAitfor waits until the specified time. Example: WAITFOR 1:00 will wait until 1:00 a.m. before continuing.

hh is the hour in military time. For example: 1 p.m. for hour 13, 2 p.m. for hour 14, etc.

mm is the minutes.

A waitfor status window will appear allowing you to abort the wait with the Cancel button.

The WAitfor command returns the status message OK when the wait is complete, ABORT when it aborts with the Cancel button, or FAIL when the time entered is not correctly typed.

Example:

WAITFOR 22:00 AUTODIAL 1-800-555-1212 :

waits for 10:00 p.m. to dial the host and begin the session.

See also 4.44 SLeep - Pause Specified Seconds.



4.52 WANGETENTRY - Get WAN Settings from a Phone Book Entry

The WANGETENTRY command retrieves the WAN Info and WAN Option settings from an existing phone book entry. This information could then be used directly by A+ or saved to a configuration file for future use. The WANGETENTRY command line format is:

WANGETENTRY PhoneBookEntryName

where:

PhoneBookEntryName is the name of the Dial-Up Networking phone book entry to get.

Example: WANGETENTRY SCO SAVE SCO.CFG

Gets the information from the Dial-Up Networking SCO entry and saves this information to the SCO.CFG file for future use by A+.

See also 4.53 WANSETENTRY - Create WAN Phone Book Entry.



4.53 WANSETENTRY - Create WAN Phone Book Entry

The WANSETENTRY command creates a new phone book entry using the specified telephone number and the current WAN Info and WAN Option settings. This phone book entry could then be modified or dialed directly by any Windows Dial-Up Networking user or by A+. The WANSETENTRY command line format is:

WANSETENTRY PhoneNumber PhoneBookEntryName

where:

PhoneNumber is the telephone number to dial.

PhoneBookEntryName is the name of the Dial-Up Networking phone book entry to create.

Example: WANSETENTRY 1-800-555-1212 ChicagoISP

Will save the telephone number and current WAN Info and WAN Option information to a new Dial-Up Networking ChicagoISP phone book entry.

See also 4.52 WANGETENTRY - Get WAN Settings from a Phone Book Entry.



4.54 WANSHOW - Display WAN Devices and Connections

The WANSHOW command displays the WAN devices and connections known to the system. The device list displays the WAN Device Name (WANDEVNAME). The connection list helps manage connections made by directly dialing an existing Windows phone book entry. The WANSHOW command has no options; the WANSHOW command line format is:

WANSHOW

Example: WANSHOW

can post the following information:

WAN Device Numbers: 00 Standard 9600 bps Modem #2 01 Standard 9600 bps Modem WAN Connections: APLUS_2000 Standard 9600 bps Modem (PPP on IP 2.0.0.5)

Where the WAN Device Number displays the device number (00), and follows with a device name (Standard 9600 bps Modem #2). In addition, the WAN Connections displays the connected WAN phone book name (APLUS_2000) followed by the device name (Standard 9600 bps Modem) and some WAN connection information (PPP on IP 2.0.0.5).



4.55 WRite - Write a Line to a WRITE File

The WRite command writes the specified string to the previously OPENed file. Note: A WRITE file must be OPENed with the -O or -A option to overwrite or append to an existing file. The WRite command line format is:

WRite message [-T]

where:

message is the message to be saved to the opened file. The message must be no longer than 255 characters. To include spaces at the beginning and/or end of the message, quote marks (") may be used to enclose the message. To send non-ASCII characters in a message, use the \ replacements listed in Table 4.1 Non-ASCII Character Replacements.

-T converts characters by sending them through the xlatout.ovr translation table before they save.

The message, like most commands, may contain tokens, user-defined variables, pre-defined variables, and environment variables.

Example: OPEN ScreenData -O WRITE The fifth line is: $FifthLine\n

The above example writes the fifth line in the Terminal Window to the ScreenData file. Note, the WRite command does not add a new line character to the end of the string. The \n replacement character performs this function.

Example: OPEN NewFile -O WRITE This is line 1\nThis is line 2\n

will save the following lines to NewFile:

This is line 1 This is line 2



4.56 XX - Post Current A+ Information

The XX command writes current A+ information such as the A+ version and serial numbers and the port settings to the log file (if open). The XX command has no options; the XX command line format is:

XX The XX command posts a message similar to:

Cleo A+ (V.2.36) under Windows 95/98/NT/2000 with IAPI available Copyright Cleo Communications 1995, 1999-2001 Running on COM2 at 38000,N,8,1 Serial #APL123456 Installation date 11/14/01



4.57 ## - Job/Script Comment Line

The ## command lets you add comments to job files. The format of the ## command is:

## [comment] where: comment is an optional comment to describe job file functions. This comment may be up to 80 characters in

length.

Example:

## This job file receives stock reports from Chicago office.

The above comment describes the contents of the job file.

Comment lines will not write to the log file. To write a comment to the log file, use the LOg message command.

## lets comments be entered into a job/script file (see JOb).

Chapter 5 - A+ Tutorial


Chapter 5. Cleo A+ Tutorial

This chapter contains several examples of hypothetical A+ sessions. The examples are set up as job files, which run in unattended mode. The way to start the session is with the JOBFILE=JobFile parameter in the configuration file, the System|Run Job menu item or the JOB tool bar button from within A+. These commands (without the BRanch command) can also typed from the Command Window. When applicable, both sides of the communication session show.

This chapter contains the following examples:

• Retail sales

• Bulletin board

• Bulletin board service

• FTP file transfer

• Telnet session

• Peer-to-peer connection

• OFTP file transfer

A section discussing the session follows each example.

These examples demonstrate some of the flexibility inherent in A+. A series of commands enter interactively from the command prompt or from a job file to handle almost any of your communication needs.

For more detailed information on A+ commands, see Chapter 4 - A+ Commands.

Appendix A+ - File Formats


5.1 Retail Sales

Retail sales outlets must send weekly reports to the headquarters in Chicago. These reports include new orders and employee information. The stores receive from Chicago: payroll information and current stock on ordered inventory.

Store 100 job file Chicago job file AUTODIAL 1-800-555-1212 1 ANSWER 600 LET PROTOCOL=ASCII LET PROTOCOL=ASCII KEY signon store 100 100 GET Signon RIGHT $Signon 3 LET StoreNumber=$CLEO_RSTRING RECEIVE Signon KEY store $StoreNumber signed on LET PROTOCOL=ZMODEM LET PROTOCOL=ZMODEM TEXT Orders RECEIVE Orders.$StoreNumber TEXT Employee RECEIVE Employee.$StoreNumber RECEIVE Payroll.new TEXT Payroll$StoreNumber PRINT Stock.new TEXT Stock$StoreNumber HANGUP HANGUP QUIT BRANCH ON TRUE TO 1

The above job files assume both terminals are running A+. Either side can replace another asynchronous file transfer when it performs the same functions. The Store 100 job file begins with an AUtodial command to call the Chicago office. After the connection, Store 100 sent a signon message to Chicago, this saves to the user-defined variable Signon. The Chicago side will then save the store number in the user-defined variable StoreNumber. The Chicago side response does not save to disk.

Store 100 then sent order and employee information to Chicago, which received them and saved the files to disk as Orders.100 and Employee.100. Chicago then transmitted payroll and stock information. Store 100 received the payroll information to disk as Payroll.new. The current stock information saves to disk as Stock.new and immediately spooled to the printer.

Store 100 ended its job file with the HAngup and QUit commands which disconnected the telephone line and exited the A+ package. Chicago used the HAngup command which disconnected the phone line then branched back to the beginning of the job file to be ready to answer a call from the next branch store.



5.2 Bulletin Board

An investor wishes to receive a daily stock report from a bulletin board.

Bank branch office job file AUTODIAL 1-800-555-1212 FIND �Login:� KEY sign_on FIND �Password:� KEY secret_password FIND �Option:� KEY 2 FIND �Option:� KEY 3 LET PROTOCOL=ZMODEM FIND �file to receive:� KEY stocks RECEIVE FIND �Option:� KEY 3 VOICE QUIT

In the above example, the job file begins with an AUtodial command to call the bulletin board.

A+ waits until it receives a login prompt from the bulletin board, then sends a response. A+ will wait for a password prompt, and then send a response. A+ waits for an option prompt, then sends a �2� response to download a file. A+ then waits for an option prompt, then sends a �3� response to select ZMODEM file transfer, and sets the file transfer type to ZMODEM. A+ then waits for a file name prompt, then sends the filename to receive. The REceive command receives the stocks file. When the file is complete, A+ waits for an option prompt, then sends a �3� response to quit. The VOice command drops the telephone line and disables autoanswer, and QUit exits A+.



5.3 Bulletin Board Service

An investment firm has a bulletin board service for investors so that they may call to order stocks or receive stock reports.

Bulletin Board job file ## Bulletin board service for stock orders and reports 10 ANSWER 999 BRANCH ON FAIL TO 10 SLEEP 20 KEY " Welcome to the XYZ Company bulletin board!" KEY FIND "username" 300 BRANCH NOT MATCH TO 10 25 KEY KEY " Main Menu Options� KEY "1. Upload stock orders" KEY "2. Download stock reports" KEY "3. Exit" KEY KEY "Option: " -R GET option IF $option = 1 EXECUTE protocol.job KEY KEY "Enter filename to transmit: " -R GET FileName BRANCH ON NODATA TO 25 RECEIVE $FileName ELSE IF $option = 2 EXECUTE protocol.job KEY "Enter filename to receive: " -R GET FileName BRANCH ON NODATA TO 25 BINARY $FileName ELSE IF $option = 3 HANGUP BRANCH ON TRUE TO 10 ELSE KEY " Invalid selection!" ENDIF ENDIF ENDIF BRANCH ON TRUE TO 25

All transactions in this session take place without human intervention with job files and the ANswer command. The job file begins with a comment line identifying the job file. This follows by the ANswer command, which hangs up the previous session and wait 999 minutes for an incoming call. After the incoming call is detectable, the BRanch executes and the job file continues with the SLeep command. If the 999-minute wait period expires without a connection, the BRanch performs to restart the job file.



The SLeep command waits for any modem handshaking traffic to complete and for the remote user to change speeds if needed. The KEy command is used to send a welcome message to the remote terminal. The KEy command with no options sends only a carriage return which skips a line. If the FIND command receives the username ok the job file continues, but if it does not the job file restarts.

If the FIND command MATCH is valid, the following KEy commands send an option menu to the remote. The KEY "Option: " command uses the -R option to prompt for an option, leaving the cursor after the message. The GEt command receives the user�s response, saving it in the option variable. The IF/ELSE commands then check the option variable and perform different functions based on the user response. The indenting is unnecessary but is helpful to match IF/ELSE/ENDIF commands.

If the user response was 1, the protocol.job file is executed to prompt the user for the file transfer type and set the PROTOCOL= parameter accordingly. See following page for a listing of the protocol.job file. When the RETURN command is executes from the protocol.job file, processing resumes at the next command. The KEy command prompts for a filename. If the filename is valid (not NODATA), the REceive command is executed to receive the file. When the file transfer is complete, the menu displays again.

If the user response was 2, the protocol.job file is executed to prompt the user for the file transfer type and set the PROTOCOL= parameter accordingly. See below for a listing of the protocol.job file. The KEy command prompts for a filename. If the filename is valid (not NODATA), the BInary command is executed to transmit the file. When the file transfer is complete, the menu displays again.

If the user response was 3, A+ hangs up the line and branches back to answer again.

When receiving an invalid response, an error message and the menu option post.

The protocol.job file follows. It is similar to the main menu processing. The LEt command set the protocol type according to the user�s response. The RETURN command returns the processing back to the next command in the calling job file. This feature allows you to write subroutine-like job files to perform routine functions.

## This is �protocol.job� which prompts for the file transfer type. KEY KEY " File Transfer Types� KEY "1. XMODEM" KEY "2. YMODEM" KEY "3. ZMODEM" KEY KEY "Option: " -R GET TransferOption IF $TransferOption = 1 LET PROTOCOL=XMODEM ELSE IF $TransferOption = 2 LET PROTOCOL=YMODEM ELSE IF $TransferOption = 3 LET PROTOCOL=ZMODEM ENDIF ENDIF ENDIF RETURN



5.4 FTP File Transfer

The following script demonstrates how to use FTP:

## FTP file transfer example LET HOST=ftp.cleo.com LET FTPUSER=anonymous LET [email protected] LET PROTOCOL=FTP CONNECT FTP BRANCH ON FAIL TO 10 LET ENTERTRANS=NL FTPCMD CWD /usr/aplus SEND APLUS.HLP RECEIVE APLUS.HLP new.hlp CONNECT CLOSE QUIT ## ERROR 10 CONNECT CLOSE QUIT 100

This session begins with a comment line that identifies it. This is followed with the LET HOST=, LET FTPUSER=, LET FTPPASS= commands to set the host domain name or IP adresss, the FTP user name (root is default), and the FTP password. The protocol is set with PROTOCOL=FTP, and the FTP connection is made with CONNECT FTP.

When the FTP session is successful, the LET ENTERTRANS=NL is used to set the new line terminator for FTP commands. Next the FTPCMD "CWD /usr/aplus" command is used to send the FTP command CWD (to change the FTP working directory).

The SEND APLUS.HLP command sends the file APLUS.HLP to the host system. Then the RECEIVE APLUS.HLP new.hlp receives the APLUS.HLP file back from the host system and saves it in the file new.hlp. The FTP connection is then closed and the session ends gracefully.

When the FTP connection fails because the username or password is invalid, the FTP connection is closed and the session ended with an exit code of 100.



5.5 A Telnet Session

The following is an example, which demonstrates how to write a TELNET session. You may type this to a file and save it. Note Pad, Write, or Word Pad will save the file as an ASCII text file, which is readable for Cleo A+. Then, modify the HOST name, Login/Password, and data file's name for your new session. You may even want to include other comments, such as the job file creators name, or the last modification date for the file.

############ ## TELNET ## ############ LET HOST=ftp.cleo.com ## START SESSION ## CONNECT TELNET BRANCH ON FAIL TO 10 ## SEND LOGIN AND PASSWORD ## FIND "login" 15 BRANCH NOT MATCH TO 10 SLEEP 1 KEY "USER_NAME" FIND "word" 5 BRANCH NOT MATCH TO 10 SLEEP 1 KEY "secret_password" ## SAVE FOLDER LIST ## FIND "#" 10 BRANCH NOT MATCH TO 10 KEY ls -x FIND "#" ls_results 20 BRANCH NOT MATCH TO 10 ## DISCONNECT CLEO.COM ## CONNECT CLOSE QUIT ## ERROR 10 CONNECT CLOSE QUIT 100

All of the transactions in this session will take place without human intervention. The job file begins with a comment line, which identifies the job file as the TELNET job file. This follows with the LET HOST= command, that sets the domain name or ip address. Next, a Telnet connection is made with the CONNECT TELNET command.

When the Telnet session is successful, A+ will wait for 15 seconds, or until a login prompt with the command FIND "ogin" 15 command. When the login prompt is found, A+ pauses for a second (SLEEP 1), and sends the user name to the host with the KEY "USER_NAME" command. Then, A+ waits 5 seconds for a password prompt with the command FIND "word" 5 command. When the password prompt is found, A+ pauses for a second (SLEEP 1), and sends the password to the host with the KEY "secret_password" command.

A+ waits 10 seconds for a prompt from the other system with the command FIND "#" 10 command. When the command prompt is found, A+ sends the ls -x UNIX command with the command KEY ls -x. The response is saved to the user-defined variable ls_results with the command FIND "#" ls_results 20. Then the Telnet connection closes and the session ends gracefully.

When an error occurs, the Telnet connection will close with an exit code of 100.



5.6 Peer-to-Peer Connection

The following script example show how to use a peer-to-peer connection with a network:

Host Client ## Peer-to-peer client example ## Peer-to-peer host example LET HOST= ftp.cleo.com CONNECT LISTEN 1024 CONNECT 1024 BRANCH ON FAIL TO 10 BRANCH ON FAIL TO 10 FIND "Hello" KEY "Hello" KEY "Hello received" FIND "Hello received" LET PROTOCOL=XMODEM1K LET PROTOCOL=XMODEM1K SEND APLUS.HLP RECEIVE new.txt RECEIVE new.txt SEND APLUS.HLP CONNECT CLOSE CONNECT CLOSE QUIT QUIT ## ERROR ## ERROR 10 CONNECT CLOSE 10 CONNECT CLOSE QUIT 100 QUIT 100

Both job files begin with the comment lines identifying the session. The client side then sets the host name or number with the LET HOST= command. The host side issues a CONNECT LISTEN 1024 command to listen for a connection on port 1024; the client side issues a CONNECT 1024 command to attempt a connection on port 1024. The host could have instead issued an ANSWER 10 1024 command to wait 10 minutes for a connection.

When the session is successful, the hello message exchanges, and the protocol sets to XMODEM1K. The APLUS.HLP file transfers bi-directional and saves to file called new.txt. The connection closes successfully.

When a connection fails the connection closes, and the session will end with an exit code of 100.



5.7 OFTP Receiving and Sending Job Files

In this example, the job file receives data from the remote using the OFTP protocol over a TCP/IP network.

LOG OFTP.LOG LET OFTPTRACELEVEL=7 SLEEP 5 CONNECT LISTEN OFTP RECEIVE OFTP_RCV.FIL LOG "RECEIVE STATUS IS "$STATUS" CONNECT CLOSE QUIT

This job file sets the LOG file to be named OFTP.LOG and the OFTPTRACELEVEL=7 for sending all status information to the log file. The SLEEP 5 pauses before making the connection. The RECEIVE executes and the data from the remote is saved to the OFTP_RCV.FIL file. The status of the RECEIVE command writes to the LOG file with the $STATUS predefined variable. Afterwards, the CONNECT CLOSE will end the session and QUIT will exit A+.

The job file below receives data from the remote using the OFTP protocol.

LOG OFTP.LOG LET OFTPTRACELEVEL=7 SLEEP 20 CONNECT OFTP SEND binary.fil LOG "Send Status is "$STATUS" CONNECT CLOSE QUIT

This job file sets the LOG file to be named OFTP.LOG and the OFTPTRACELEVEL=7 for sending all status information to the log file. It then waits 20 seconds before connecting on the TCP line with the CONNECT OFTP command. The SEND executes and the data sends to the remote. The status of the transaction is saved to the LOG file with the $STATUS predefined variable. Afterwards, the CONNECT CLOSE will end the session and QUIT will exit A+ gracefully.



Appendix A.

File Formats

Cleo A+ accesses and creates various files in the course of operation. This appendix contains information on the format of the following files:

• The CONFIGURATION file

• The JOB file

• The LOG file

• The MONITOR file

• The CHARACTER TRANSLATION files

• The AUTO DIRECTORY file

• The INITIALIZATION file

• The A+ DIRECTORY file

Appendix A - File Formats


A.1 The Configuration File

A+ lets you run with your custom configuration files using the CONFIGFILE=CfgFile command line option when starting A+ or using the Load Configuration File option from within Cleo A+. If the APLUS.CFG configuration file exists, this becomes the A+ default configuration.

The configuration file also lets you automate A+ operation. For instance, if the configuration file contains a JOBFILE=JobFile parameter, the specified job/script file will be executed.

Configuration files may be created and/or modified with a standard text editor or from within A+ using the Config menu option. Parameters not specified in the configuration file are set according to the previous parameter settings, the APLUS.CFG file if it exists, or to A+'s internal defaults (see Table A.1). Therefore, to remove settings, you must specify the parameter with no setting, i.e. MODEMINIT= suppresses the Modem Initialization String.

Table A.1 lists the configuration file parameters with their default values and ranges. For more details see Chapter 1. The Cleo A+ Configurator and the following section. ____________________________________________________________________________________________________ PARAMETER DEFAULT OPTIONS [Port] DEVICE= NONE COM port name or None SPEED= 9600 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 PARITY= NONE NONE, ODD, EVEN, MARK or SPACE DATA= 8 7 or 8 STOP= 1 1 or 2 FLOWCONTROL= NONE NONE, SOFTWARE, or HARDWARE HOST= Host socket name or address number [Modem] AUTOBAUD= ON OFF or ON DIALWAIT= 60 1 - 255 TIMES= 3 1 - 3100 MODEMINIT= AT&MX4V1QE Modem configuration string S8=5&C1&D1M1S0=1 DIALINIT= Modem configuration string [Dial Up Type] DIALTYPE= PSTN PSTN or WAN ____________________________________________________________________________________________________

TABLE A.1 CONFIGURATION PARAMETERS (1 of 5)



____________________________________________________________________________________________________ PARAMETER DEFAULT OPTIONS [Terminal Emulation] TERMINAL= vt100 vt100, vt320, wyse50, ansi, etc. LOCALECHO= OFF OFF or ON REMOTEECHO= OFF OFF or ON LINEWRAP= ON OFF or ON STATUSLINE= ON ON CRTRANSLATE= CR IGNORE, CR, CR/NL, NL ENTERTRANS= CR CR, CR/NL, NL DESTRUCTBS= OFF OFF or ON HANGUP= ON OFF or ON SHELLSUSPEND= ON OFF or ON COMMANDKEY= 1 1-26 ATTRIBUTES ON OFF or ON [File Transfer] PROTOCOL= ZMODEM XMODEM, XMODEM1K, YMODEM, YMODEMG, ZMODEM, KERMIT, ASCII, ANSI, FTP, and OFTP UPDIR= .\ Default upload (send) directory DOWNDIR= .\ Default download (receive) directory MAXERRORS= -1 10 - 255 or -1 BLOCKERRORS= 10 10 - 255 or -1 RECTIMEOUT= 10 2 - 255 STARTTIMEOUT= 60 2 - 255 DEFSENDMODE= BINARY BINARY, TEXT, or SCAN DEFRECEIVEMODE= BINARY BINARY or TEXT AUTORECEIVE= ON OFF or ON BATCHRECEIVE= OFF OFF or ON FILENAMES= YES YES, NO, or OVERWRITE COMPRESS= NO YES or NO ENCRYPT= NONE NONE or PGE [OFTP] OFTPCAPINIT= BOTH BOTH OFTPCAPMODE= BOTH BOTH OFTPID= OFTPUSERDATA= OFTPPASSWD= OFTPREMOTE= OFTPSEP= \0x0A OFTPDEFDEST= OFTPCOMP= NO NO OFTPBUFSIZ= 1024 OFTPWINDOW= 4 ____________________________________________________________________________________________________




____________________________________________________________________________________________________ PARAMETER DEFAULT OPTIONS [Start Up] LOGFILE= APLUS.LOG Log file name LOGMODE= NONE NONE, OVERWRITE, or APPEND MONITORFILE= APLUS.MON Monitor file name MONITORMODE= NONE NONE, OVERWRITE, or APPEND MONITORWINDOW= OFF OFF or ON RECORDERFILE= APLUS.JOB Recorder job file name RECORDERMODE= NONE NONE, OVERWRITE, or APPEND JOBFILE= Job file name to be auto-executed DISPLAY= NORMAL NORMAL, MINIMISED, MAXIMIZED TOKENS= ON ON, OFF, or token list [ASCII] ASCIIBLK= 0 0 - 255 LINEDELAY= 5 0 - 255 ASCIIEOF= 26 0 - 255 [ANSI] ANSIBLK= 128 0 - 255 ANSIDELAY= 5 0 - 255 ANSIEOB= 13 0 - 255 ANSIACK= 13 0 - 255 [KERMIT] KERMQCTL= 38 38 - 127 KERMQCH= 35 35 - 127 KERMPACKET= 1024 0 - 9024 KERMPADCH= 0 0 - 127 KERMNPADS= 0 0 - 127 KERMSTART= 1 0 - 64 KERMEOL= 13 13 - 64 KERMBLKCHK= CRC CRC, CHKSUM, CHKSUM2 KERMWINS= 6 0 - 31 ____________________________________________________________________________________________________




____________________________________________________________________________________________________ PARAMETER DEFAULT OPTIONS [ZMODEM] ZFRAME= 1024 128 - 32768 ZCRASH= OFF OFF, SIMPLE, CRC ZSENDWND= 1024 0 - 32768 ZRECWND= 1024 0 - 32768 [FTP] FTPUSER= FTP user name FTPPASS= Scrambled FTP password FTPDIR= FTP default directory FTPTYPE= BINARY BINARY or TEXT FTPLOPORT= 1024 0 - 61383 FTPHIPORT= 5999 0 - 61383 [WAN Logon] WANUSER= WAN User name WANPASSWORD= WAN Password WANDOMAIN= WAN Domain [WAN Information] WANNETPROTOCOL= TCPIP TCPIP or IPX WANFRAMEPROTOCOL= PPP PPP or SLIP WANIPADDRESS= Specific IP Address WANDNS= Primary Domain Name Server address WANDNSALT= Secondary Domain Name Server address WANWINS= Primary Windows Name Server address WANWINSALT= Secondary Windows Name Server address WANDEVTYPE= MODEM MODEM, ISDN, or X25 WANDEVNUMBER=* 0 WAN modem number WANDEVNAME= WAN modem name WANSCRIPT= Windows NT WAN script name [WAN Options] WANSPECIFICIP= OFF OFF or ON WANSPECIFICSERVER= OFF OFF or ON WANIPHEADERCOMPRESS= OFF OFF or ON WANREMOTEGATEWAY= OFF OFF or ON WANLCPEXT= OFF OFF or ON WANTERMAFTERDIAL= OFF OFF or ON WANMODEMLITES= OFF OFF or ON WANSOFTWARECOMPRESS=OFF OFF or ON WANENCRYPTPASSWORD= OFF OFF or ON WANMSENCRYPTPASSWORD=OFF OFF or ON WANDATAENCRYPT= OFF OFF or ON WANNETWORKLOGON= OFF OFF or ON WANLOGONCREDENTIALS= OFF OFF or ON ____________________________________________________________________________________________________



The following pages describe the non-standard parameters. These options may be added to the job file, or set within A+ at the command prompt using the LET command, i.e. LET BLOCKFILL=26.

BLOCKFILL=FillChar is used to specify the block fill character (in ASCII decimal) that is sent to the remote at the end of XMODEM and YMODEM file transfers. The minimum value is 0, the maximum value is 255, and the default is 0 for a null fill character. If you have problems sending the last block of data, try changing the BLOCKFILL to 26.

DIALDIR=DialDirectoryFile is used to specify the file containing the autodial directory. The default is APLUS.DIR. The filename may contain a path.

FTPHOSTPORT=HostNumber is used to specify the local host port (or channel or socket) number for FTP communications. The minimum value is 0, the maximum value is 16383 and the default is 21. This value should rarely need to be changed.



A.2 The Job/Script File

A+ lets you run custom job files using the JOBFILE=JobFile parameter when executing A+ or using the System|Job menu option, the JOB tool bar button, or EXecute jobfile command while in A+. You can create job files for A+ by using the Window|Record menu item or the REC tool bar button (see 3.7.4 Recorder Window - Toggle Command Recorder Window) or a standard text editor.

The following example shows the format for a job file:

## JOB FILECONFIG CFGFILE ## change configurationANSWER 10 ## answer the phone lineKEY **SIGNON** ## send sign-on messageTEXT TXFILE.TXT ## transmit fileRECEIVE RCVFILE ## receive file to diskPRINT PRTFILE ## receive and spool fileKEY **SIGNOFF** ## send sign-off messageVOICE ## hang-up phone lineQUIT ## exit A+

The first line in the above example is a comment line. Comment lines begin with the characters ## and may be placed anywhere in a job file. The following lines contain A+ commands. Each A+ command must be on a separate line. Most commands may be shortened to the first two characters, i.e. CONFIG CFGFILE and CO CFGFILE are identical to A+.

See Chapter 5. Cleo A+ Tutorial for more job file examples.



A.3 The Log File

A+ has the ability to log all transactions and messages to the log file APLUS.LOG. The LOGMODE=OVERWRITE, LOGMODE=APPEND, or LOGMODE=NONE command line option lets you select how the log file is used. See 2.1 The Cleo A+ Command Line for more details on the LOGMODE= command line option.

The following example shows the format of the log file APLUS.LOG:

17:25:00 ********* A+ LOGON ********* TUE MAY 3, 2000 17:25:03 Command> AU 654-8110 DIAL: CONNECT_9600 : Connect Code = 18 17:25:15 Command> KE SIGNON_cleo.com 17:25:17 TT: KEY :NRMEOF :1 blocks 17:25:23 Command> TE CLEO.MSG 17:27:50 TT: CLEO.MSG :NRMEOF :8 blocks 17:27:59 Command> KE SIGNOFF 17:28:01 TT: KEY :NRMEOF :1 blocks 17:28:03 Command> VO 17:28:37 Command> QU 17:28:39 ********* A+ LOGOFF ********* TUE OCTOBER 3, 1994

The first and last lines contain the time and date of the start and finish of A+ execution. The lines in between contain the time, commands executed, and status of the commands. The status lines description is below.

A.3.1 The Autodial/Autoanswer Status Line After an autodial command is completed, a status line to the log and monitor files (if open). The status line format is:

DIAL : connect_msg : Connect Code = connect_code

After an autoanswer is completed, a status will write to the log and monitor file (if open). The status line format is:

ANSWER : connect_msg : Connect Code = connect_code

where:

connect_msg is the connection message returned by the attached AT command modem. If the modem returns a connect code instead of a connect message, the code will display as the connect message.

connect_code is the connection code returned by the attached AT command modem. If the modem returns a connect message instead of a connect code, the connect code displays as -1.

For example, the following status line: DIAL : CONNECT_9600 : Connect Code = 18 will be posted after autodialing a CCITT V.32 AT command modem which connected at 9600 baud.



A.3.2 The Transmit/Receive Status Line After each file transmission or reception, a status line will write on the screen and to the log and monitor files (if open). The status line format is:

DirectionTranslationProtocol : Filename : Status : BlockCount blocks

where:

Direction T for transmit file R for receive file P for receive print file

Translation B for binary file T for text (translated) file

Protocol A for ASCII file transfer N for ANSI Clear file transfer X for XMODEM file transfer 1 for XMODEM(1K) file transfer Y for YMODEM file transfer G for YMODEM(G) file transfer Z for ZMODEM file transfer K for KERMIT transfer F for FTP transfer O for OFTP transfer

Filename name of transmitted or received file KEY for keyboard messages EOT for End of Transmission (to Screen) for files received to screen

Status receive or transmit completion status message (see Tables A.2 and A.3)

BlockCount number of data blocks sent or received; for ASCII transfers, the number of lines (0x0A's) sent or received

For example, the following status line: TBZ : LETTER.TXT : NRMEOF : 20 blocks will post after A+ transmitted (T) with the BInary (B) command a ZMODEM (Z) file named LETTER.TXT completely (NRMEOF) in 20 blocks.

Tables A.2 and A.3 list receive and transmit status messages along with a brief explanation of the each. A more detailed description of each message is on the following pages.



____________________________________________________________________________________________________ Status Message Status Code* Explanation

ABORT 23 Keyboard-forced abort

BUFOVF 29 Buffer overflow

DSKERR 41 Write to disk failure

EAREOF 20 Early end of file

ERROR 4 ANSI Clear error

LINDWN 22 System line down

NODATA 24 No incoming data

NOFILE 26 No file exists for FTP

NRMEOF 15 Normal end of file

RECEIV 33 Receive timeout expiration

REMOVE 54 Remote Kermit requested the file be removed

RETRAN 38 Maximum errors limit expiration

RMTABT 28 Remote terminal aborted

SKIP 44 A+ requested file be skipped

* Used only by the QUit STATUS command and the IAPI. ____________________________________________________________________________________________________

TABLE A.2 RECEIVE COMPLETION STATUS MESSAGES

____________________________________________________________________________________________________

StatusMessage Status Code* Explanation

ABORT 23 Keyboard-forced abort

BIDLMT 30 Remote not ready receive

CONTEN 45 Line bid contention

ERROR 4 ANSI Clear error

LINDWN 22 System line down

NOFILE 26 Unable to open file

NRMEOF 15 Normal end of file

REPEAT 39 Receive timeout expiration

RETRAN 38 Maximum error limit expiration

RMTABT 28 Remote terminal aborted

SKIP 44 Remote terminal requested file be skipped

* Used only by the QUit STATUS command and the IAPI. ____________________________________________________________________________________________________

TABLE A.3 TRANSMIT COMPLETION STATUS MESSAGES



A.3.3 Status Messages Status messages are viewable or acted upon with the BRanch command to control job execution. The status code is saved in the pre-defined variable STATUS which may be used anywhere in the job/script file. Table A.4 lists the status messages returned for each A+ command. ____________________________________________________________________________________________________

Command Status (Code*) Explanation ANswer OK (46) Connection complete; FAIL (19) No incoming calls; DIAL_ABORT (9) ANswer aborted by user; Various Result message/code from modem (see A.3.1 The Autodial/Autoanswer Status Line). AT OK (46) Modem accepted command; FAIL (19) Modem rejected command. AUtodial OK (46) Connection complete; DIAL_ABORT (9) AUtodial aborted by user; FAIL (19) Dial retires expired, no connection; Various Result message from modem (see A.3.1 The Autodial/Autoanswer Status Line). BInary Various See Table A.3. BRanch None Does not change current status value. CLOSE OK (46) Closed file; NOFILE (26) Error closing file. COMBINE 0 COMPARE 0 Strings were equal; 2 String 2 > String 1; 1 String 1 > String 2. COnfig OK (46) Configuration loaded; ERROR (4) Error in configuration; NOFILE (26) Unable to open file. CONNECT OK (46) Connection complete; FAIL (19) Error making the connection. +COUNTER OK (46) Counter incremented. -COUNTER OK (46) Counter decremented. DAta OK (46) DTR raised. DELETE 0 File deleted; non-zero Error deleting file. DIRMATCH NOFILE (26) No match found OK (46) Match found DISPLAY OK (46) Message displayed; FAIL (19) Format error; BKGRND (53) A+ is in background mode. ELSE none Does not change current status. ENDIF none Does not change current status. EXecute OK (46) Job file loaded; DSKERR (41) Unable to unscramble file; NOFILE (26) Unable to open file. * Status codes are used by the QUit STATUS command and the API. ____________________________________________________________________________________________________

TABLE A.4 A+ COMMAND STATUS MESSAGES (Part 1 of 3)



____________________________________________________________________________________________________

Command Status (Code*) Explanation EXISTS OK (46) File exists; NOFILE (26) File does not exist. FInd MATCH (27) String1 matched incoming data; MATCH2 (49) String2 matched incoming data; MATCH3 (50) String3 matched incoming data; MATCH4 (51) String4 matched incoming data; MATCH5 (52) String5 matched incoming data; NODATA (24) No data received before timeout; RECEIV (33) String not found before timeout; ABORT (23) FInd aborted by user. GEt OK (46) Response from user received; NODATA (24) No response from user before timeout. HAngup OK (46) Line hung up. IF none Does not change current status. JOb OK (46) Recorder file opened O.K.; DSKERR (41) Error opening recorder file. KEy Various See Table A.2. LEFT 0 LENGTH length Length of string. LEt OK (46) Configuration parameter changed; FAIL (19) Configuration parameter could not be changed. LIneup CONNECT (1) Line is up; LINDWN (22) Line is down. LOg OK (46) Log successful; DSKERR (41) Unable to write log file. MID 0 MOnitor OK (46) Monitor successful; DSKERR (41) Unable to write monitor file MSend Various See Table A.3. OPEN OK (46) Read file opened O.K.; NOFILE (26) Unable to open read file. PRint Various See Table A.2. QUit None Unconditional exit from A+. READ OK (46) Line read from read file; NODATA (24) End of read file. NOFILE (26) Unable to open read file. REceive Various See Table A.2. RETURN Various See Tables A.2 and A.3 exit_code Job specified return code. RIGHT 0 SAve OK (46) Saved configuration file; DSKERR (41) Unable to save configuration file. SEnd Various See Table A.3. SEARCH 0 Character/string not found; position First position of matched char/string. SLeep OK (46) Pause time complete; ABORT (23) SLeep aborted by user; FAIL (19) Error in command. STart OK (46) Start successful. SYstem exit_code Exit code from the operating system command or program. * Status codes are used by the QUit STATUS command and the API. ____________________________________________________________________________________________________




____________________________________________________________________________________________________

Command Status (Code*) Explanation TAble OK (46) Translation table(s) loaded; FAIL (19) Error in table(s); NOFILE (26) Unable to open file(s). TExt Various See Table A.3. TOken OK (46) Token(s) set. VOice OK (46) Line disconnected. WAitfor OK (46) Wait time complete; ABORT (23) Wait aborted by user; FAIL (19) Error in specified time. WRITE OK (46) Wrote message to file; FAIL (19) Error writing to file. ## None Does not change current status value. * Status codes are used by the QUit STATUS command and the API. ____________________________________________________________________________________________________




Each of the transmit and receive status messages are described below along with suggested corrective actions.

ABORT The ABORT status is generated in the receive (from the Receive menu, REceive, PRint, or SCreen) mode or in the transmit (from the Transmit menu option, TExt, BInary, or KEy) mode by hitting the CANCEL button at any time during the transmission process.

BIDLMT The BIDLMT status is generated when the remote computer is not ready to receive data within the time set by the STARTTIMEOUT=Seconds parameter. Corrective Action: The STARTTIMEOUT=Seconds parameter may be set to a higher value.

BKGRND The BKGRND status is generated when A+ is running in background mode and cannot display to the screen. Corrective Action: Do not use commands that display, such as the Display command, when running in background mode.

BUFOVF The BUFOVF status is generated when the incoming data is too large to fit in the communications buffer. Corrective Action: Have the remote send fewer characters per block. If the character count seems reasonable, check your telephone line for excessive noise.

CONTEN The CONTEN status indicates that both computers are trying to transmit at the same time. The CONTEN status will only be posted for ZMODEM or KERMIT file transfers. Corrective Action: Use a receive command (from the Receive menu, REceive, PRint, or SCreen) to receive before sending.

DSKERR The DSKERR status indicates a write to disk failure. Corrective Action: A+ attempts to write to the disk multiple times when an error is detected to insure against inaccurate or transient error returns. DSKERR occurs when a specified path is invalid, or if the specified file exists and is write protected, or the disk is full. When there seems to be enough space and you get this message, examine your disk for problems.

EAREOF The EAREOF status is generated when an end of transmission sequence was received before A+ completely received the file. The EAREOF status will post when receiving YMODEM or ZMODEM files. Corrective Action: If this error occurs frequently, save a monitor file to disk so you can look at the protocol (See the MOnitor command). If necessary, a printout of this file may be e-mailed or faxed to Cleo's Technical Support.



ERROR The ERROR status is generated in receive (from the Receive menu, REceive, PRint) mode when the correct number of characters or the correct end of block character is not received. It is generated in the transmit (from the Transmit menu, TExt, BInary, or KEy) mode when an acknowledgment is not received. ERROR is posts when transmitting or receiving ANSI Clear files. Corrective Action: When an ERROR occurs on the first block, verify your ANSIBLK, ANSIEOB, and ANSIACK settings. If it occurs elsewhere in the file, the line may be noisy. Since ANSI Clear does not allow retransmitting blocks with errors, no errors are allowed.

LINDWN The LINDWN status is generated when A+ senses that the communications line has gone down. A low Data Carrier Detect pin will cause a LINDWN status. Corrective Action: When a LINDWN status occurs during or following the transmission of the signon, check the format of your signon. If you are running in interactive mode, try recording a job file; some hosts have short receive timeout periods before disconnecting. After these ideas fail, contact your host for more information.

NODATA The NODATA status is generated when no data has been received from the remote computer within the time set by STARTTIMEOUT=Seconds parameter. Corrective Action: The STARTTIMEOUT=Seconds parameter may be set to a higher value. Verify that the remote will be transmitting at this point.

NOFILE The NOFILE status is posted when the file to be sent cannot be found or opened. Corrective Action: Specify the complete path name for the file you wish to send. Make sure you have the correct privileges or authority to access the file.

NRMEOF The NRMEOF status is posted for a Normal End of File condition. The data receives or transmits in good form within the protocol. Note: Because ASCII is not a true protocol, the NRMEOF status will never be posted when receiving ASCII data; it will, however, be posted when transmitting ASCII data.

RECEIV The RECEIV status posts during receiving when the number of Receive Timeouts exceeds the Max Errors/Block count. Note that this condition is very similar to the NODATA status except that the RECEIV condition occurs when the remote computer has started receiving. Corrective Action: The RECTIMEOUT=Seconds and BLOCKERRORS=ErrorCount parameters may be set to higher values. If this status occurs frequently after receiving a varying number of blocks, check your telephone line for excessive noise.

REMOVE The REMOVE status is posted during a Kermit receive when a �discard file� message is received. The received file deletes. Corrective Action: Check with the remote to find out why they are sending the �discard file� message. It may be because the file transmission had too many errors.

REPEAT The REPEAT status is posted during transmitting when the number of Receive Timeouts exceeds the Max Errors/Block count.



Corrective Action: The RECTIMEOUT=Seconds and BLOCKERRORS=ErrorCount parameters may be set to a higher value. If this status occurs frequently after receiving a varying number of blocks, check your telephone line for excessive noise.

RETRAN The RETRAN status is posted when the number of errors exceeds the Maximum Errors count. Corrective Action: The MAXERRORS=ErrorCount parameter may be set to a higher value. If this status occurs frequently after receiving a varying number of blocks, check your telephone line for excessive noise.

RMTABT The RMTABT status is generated when a remote abort sequence is received during the transmission or reception of a file. In general, this will indicate something is wrong on the remote computer as it is attempting to gain control of the line. The remote may be expecting to send a file, not receive one. Corrective Action: If this status re-occurs, contact your host site to find out why the host is sending the abort sequence at an unexpected time.

SKIP The SKIP status is generated when either A+ or the remote system requested that the ZMODEM file not be sent. Corrective Action: The skip request should only be sent when the incoming file is the same or older than an existing file with the same name. Contact your host site to find out if this is the reason the file is not accepted.

TXABRT The TXABRT status is generated when data cannot be sent out the port or when the remote system sends a fatal error message. Corrective Action: On systems that do not detect line down, verify that the line is up and that the CTS (Clear To Send) signal is high. If this status occurs consistently, contact your host site to find out why the host is sending a fatal error.



TABLE A.5 A+ COMMAND STATUSES listed by number.

1=CONNECT

2=RING

3=NOCARRIER

4=ERROR

5=CONN1200

6=NODIALTONE

7=BUSY

8=NOANSWER

9=DIALABORT

10=CONN2400

11=CONN4800

12=CONN9600

13=CONN14400

14=CONN19200

15=NRMEOF

16=CONN201

17=CONN208

18=CONN9600

19=FAIL

20=EAREOF

21=HANGUP

22=LINDWN

23=ABORT

24=NODATA

25=TRUE

26=NOFILE

27=MATCH

28=RMTABORT

29=BUFOVF

30=BIDLMT

31=WAIT

32=DELAY

33=RECEIV

34=TXABRT

35=INTEOF

36=IDLE

37=EOTND

38=RETRAN

39=REPEAT

40=INTRPT

41=DSKERR

42=NOTOPN

43=FALSE

44=SKIP

45=CONTENT

46=OK

47=NETWRK

48=LOGON

49=MATCH2

50=MATCH3

51=MATCH4

52=MATCH5

53=BKGRND

54=REMOVE

55=PROTOCOL

56=OUTOFTURN

57=TIMOUT

58=SPARE_58

59=SPARE_59

60=CONN38400

61=CONN57600

62=CONN115200


TABLE A.5 A+ COMMAND STATUS MESSAGES listed by status

ABORT=23

BIDLMT=30

BKGRND=53

BUFOVF=29

BUSY=7

CONN115200=62

CONN1200=5

CONN14400=13

CONN19200=14

CONN201=16

CONN208=17

CONN2400=10

CONN38400=60

CONN4800=11

CONN57600=61

CONN9600=18

CONN9600=12

CONNECT=1

CONTENT=45

DELAY=32

DIALABORT=9

DSKERR=41

EAREOF=20

EOTND=37

ERROR=4

FAIL=19

FALSE=43

HANGUP=21

IDLE=36

INTEOF=35

INTRPT=40

LINDWN=22

LOGON=48

MATCH=27

MATCH2=49

MATCH3=50

MATCH4=51

MATCH5=52

NETWRK=47

NOANSWER=8

NOCARRIER=3

NODATA=24

NODIALTONE=6

NOFILE=26

NOTOPN=42

NRMEOF=46

OUTOFTURN=56

PROTOCOL=55

RECEIV=33

REMOVE=54

REPEAT=39

RETRAN=38

RING=2

RMTABORT=28

SKIP=44

SPARE_58=58

SPARE_59=59

TIMOUT=57

TRUE=25

TXABRT=34

WAIT=31



A.4 The Monitor File

A+ includes the ability to save all protocol characters and data to a monitor or trace file. This is helpful in determining communication problems. You can invoke the monitor to determine the cause of communications problems but, because it slows communications and consumes a lot of disk space you will want to run your regular sessions with it off.

A.4.1 Terminal Emulation Mode The Window|Monitor menu option or the MON tool bar button may be used to toggle the monitor on to save data to the APLUS.MON file. See 3.7.3 Monitor Window - Toggle the Line Monitor Window for details on executing the Monitor function.

Monitor saves data as it comes in and goes out the port in hexadecimal form transmitted by A+ starts with the ">" (greater than) character. Data received by A+ starts with the "<" (less than) character. The following example shows the format of the monitor file:

< 0D 45 4E 54 45 52 20 59 4F 55 52 20 49 4F 49 54 49 41 4C 53 3A > 44 4E 4A 0D < 45 4E 54 45 52 20 59 4F 55 52 20 50 41 53 53 57 4F 52 44 3A > 53 45 43 52 45 54 0D

A line-by-line description of the above example follows:

Lines 1 & 2 The remote site sent an "ENTER YOUR INITIALS:" prompt. See Table A.5 for hexadecimal to ASCII translations.

Line 2 A+ sent a "DNJ" response.

Line 3 The remote site sent an "ENTER YOUR PASSWORD:" prompt.

Lines 3 & 4 A+ sent a "SECRET" response.

Table A.5 lists the standard U.S. ASCII translations.

A.4.2 File Transfer Mode If you encounter an error status message in file transfer mode, check A.3.3 Status Messages for possible actions before using the monitor. If you are getting a NRMEOF status but are receiving or transmitting data that you think should be different, use the MOnitor command to determine exactly what is being sent and received. For transmit problems, for instance, use the MOnitor command before the transmit command to save the monitor to a file and again after the transmit command to turn the monitor off. For example:

MONITOR SIGNON.MON SEND SIGNON MONITOR

This will create a monitor file with the name SIGNON.MON. This monitor file may later be displayed to the screen with the DOS command "TYPE SIGNON.MON" or UNIX command "cat SIGNON.MON", or it may be viewed with a text editor or printed. If necessary, a printout of this file may be mailed or faxed to Cleo's Technical Support department.



The monitor displays the characters in hexadecimal format. When the MOnitor -C option is set, the characters 0x20 through 0x128 display in ASCII format. Data transmitted by A+ starts with the ">" (greater than) character. Data received with A+ starts with the "<" (less than) character. Example:

< 15 > 01 01 FE 31 32 33 34 35 36 37 38 39 30 0D 0A 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 71 72 73 74 75 76 77 78 79 7A 0D 0A 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 4A < 06 > 04 < 06 TBX : 123abc : NRMEOF : 1 blocks

A line-by-line description of the above example follows:

Line 1 The remote site sent (<) a request to receive (15) an XMODEM file with checksum error checking.

Lines 2-7 A+ sent (>) a start of header character (01), the block number (01), the reverse block number (FE) (i.e. 255 minus the block number), the data (31 32 33 34 35 36 37 38 39 30 0D 0A 61 62 63 64 65 66

67 68 69 6A 6B 6C 6D 6E 6F 70 71 72 73 74 75 76 77 78 79 7A 0D 0A), null characters (00) to pad the block, and a checksum character (4A). The data is displayed in hexadecimal (see Table A.5 for ASCII translations). The error check character follows; this character is compared at the remote end for errors.

Line 8 The remote site sent (<) a positive acknowledgment (ACK) character (06). This positive acknowledgment means that the remote received the block correctly.

Line 9 A+ sent (>) an end of transmission (EOT) character (04). The end of transmission indicates that A+ is finished sending and the line is released to allow the remote system to transmit.

Line 10 The remote site sent (<) a positive acknowledgment (06). This positive acknowledgment means that the remote received the EOT.

Line 11 A+ posts a status line message to indicate the outcome of the command: A+ transmitted the binary XMODEM (TBX) file 123abc (123abc) normally (NRMEOF) in 1 block (1 blocks).

Table A.5 lists the standard U.S. ASCII translations for the data.



____________________________________________________________________________________________________

GRAPHIC ASCII | GRAPHIC ASCII hex/dec | hex/dec @ 40/64 | ` 60/96 A 41/65 | a 61/97 B 42/66 | b 62/98 C 43/67 | c 63/99 D 44/68 | d 64/100 E 45/69 | e 65/101 F 46/70 | f 66/102 G 47/71 | g 67/103 H 48/72 | h 68/104 I 49/73 | i 69/105 J 4A/74 | j 6A/106 K 4B/75 | k 6B/107 L 4C/76 | l 6C/108 M 4D/77 | m 6D/109 N 4E/78 | n 6E/110 O 4F/79 | o 6F/111 P 50/80 | p 70/112 Q 51/81 | q 71/113 R 52/82 | r 72/114 S 53/83 | s 73/115 T 54/84 | t 74/116 U 55/85 | u 75/117 V 56/86 | v 76/118 W 57/87 | w 77/119 X 58/88 | x 78/120 Y 59/89 | y 79/121 Z 5A/90 | z 7A/122 [ 5B/91 | { 7B/123 \ 5C/92 | | 7C/124 ] 5D/93 | } 7D/125 ^ 5E/94 | ~ 7E/126 _ 5F/95 | DEL 7F/127 ____________________________________________________________________________________________________

TABLE A.5 ASCII TRANSLATIONS (Part 2 of 2)



A.5 The Recorder File

The Recorder file is an ASCII text file, which edits with Note Pad, Word Pad, or Write. When you turn the recorder on, and walk through the session while saving the session to a file the file that saves is the recorder file. The file has it's own format. When a session records, all of the commands capture, and comments insert in the file. The job commands associated with that action indent under that action. The following is a sample recorded job file:

## A+ Recorded Job File Mon May 22 11:37:55 2000 ## DIAL Recorded LET DIALTYPE = PSTN LET DEVICE=COM1: LET TERMINAL = VT100 LET SPEED=9600 LET PARITY=NONE LET DATA=8 LET STOP=1 HANGUP AUTODIAL 815-654-8110 ## SEND Recorded LET Protocol=ZMODEM SEND C:\APLUS_TEST\testfile.snd ## HANGUP Recorded HANGUP ## QUIT Recorded QUIT ## LOG END Recorded LOG ## MONITOR END Recorded MONITOR



A.6 The Character Translation Files

When using the Character Translation files incoming files translate upon reception and outgoing files translate before transmission. The provided xlatout.ovr and xlatin.ovr files contain standard translation tables. The TAble filename [filename] command is useful when loading custom translation file(s).

Character translation tables do not control outgoing and incoming character translations for terminal emulation mode. All typed characters are transmitted as-is and all incoming characters are displayed as-is.

A.6.1 XLATOUT.OVR Translation Table The Xlatout.ovr file translates characters for outgoing transfers. The TExt command, the SEnd or KEy command (with the -T option or DEFSENDMODE=Text or Scan), or the Transmit|Send menu item (with the DEFSENDMODE=Text or Scan) or Transmit|Text menu item will translate files before sending them.

If the xlatout.ovr file exists but the xlatin.ovr file does not exist, the xlatout.ovr file will translate incoming and outgoing file transfer character translations. The REceive and PRint commands (with the -T option or DEFRECEIVEMODE=Text) or the Receive menu option (with DEFRECEIVEMODE=Text) translates the data before saving it to disk, or printing. The TExt command, SEnd and KEy command (with the -T option or DEFSENDMODE=Text or Scan), or the Transmit menu item (with the DEFSENDMODE=Text or Scan) will translate files before transmitting them.

You may modify the default xlatout.ovr file or create your own translation file with an ordinary text editor. The original xlatout.ovr saves under a different name before making any modifications. The following example shows the format for the outgoing character translation file:

# US 0 0 1 1 : 10 13,10 convert outgoing NL to CR/NL 11 11 : 255 255

The first line in this xlatout.ovr file is a comment line. Comment lines begin with the # character and may be placed anywhere in the translation file. The following lines contain character translations. The first number in each line represents the original character in decimal and the second number represents the character to send in decimal. Characters may be converted to two characters (note the 10 13,10 line which converts a new line to carriage return/new line characters). Characters may also be removed with the * character. When using a single translation file, the first number also represents the original incoming character and the second number represents the character to save. All characters after the second or third character and before the newline character are ignored by A+. Comments will display here (note the convert outgoing NL to CR/NL line).



A.6.2 XLATIN.OVR Translation Table If the xlatin.ovr file exists, it is usable for incoming character translations. The REceive, PRint, or SCreen command (with the -T option or DEFRECEIVEMODE=Text) or the Receive menu option (with DEFRECEIVEMODE=Text) translates received data before being saved to disk, printed, or displayed.

You may modify the default xlatin.ovr file or create your own translation file with an ordinary text editor. The original xlatin.ovr can save under a different name so that it is not lost before making any modifications. The following example shows the format for the incoming translation file:

# US 13 * drop incoming CRs 16 16 17 17 18 18 : 225 225

The first line in this xlatin.ovr file is a comment line. Comment lines begin with the # character and may be placed anywhere in the translation file. The following lines contain character translations. The first number in each line represents the original incoming character in decimal and the second number represents the character to be saved/displayed in decimal. Incoming characters convert to two characters. Incoming characters may also be removed with the * character (note the 13 * line which drops the incoming carriage return characters). All characters after the second or third character and before the newline character are ignored by A+. Comments may be displayed here (note the drop incoming CRs line).

See Table A.5 for standard character conversions.

Use care in modifying translation tables. A+ may not work properly if protocol characters (for example, the ESC character) are translated incorrectly.



A.7 The Autodial Directory File

The Autodial Directory function displays a custom dialing directory to let you to select the host you need to dial. Create or modify the APLUS.DIR file with the Autodial Directory Add option or with a standard text editor. This file has the following format, with each field separated by a colon:

RemoteName:Phone#:Speed:Parity:Data:Stop:TerminalType:LinkedScript

where:

RemoteName identifies the remote site to dial. This may be any name or number up to 15 characters in length.

Phone# specifies the phone number of the host to dial. All numbers must be entered in one of the following formats: 18005551212 or 1(800) 555-1212 or 1-800-555-1212 Hyphens (-) and parentheses may be used to make the string readable; spaces, however, are within a number. The telephone number may be up to 30 characters in length. A+ permits the dialing of a sequence of telephone numbers and/or access codes between numbers with the comma (,) character. For example: 9,18005551212,,,3978110 dials a PBX access code (9), pauses 2 seconds (,), dials the telephone number (18005551212), pauses 6 seconds (,,,), then dials a long distance access code (3978110).

Speed specifies the rate in to talk to the COM port and the modem. Valid speeds are 300, 1200, 2400, 4800, 9600, 19200, or 38400 bits per second (bps).

If you connect at a rate different from the specified speed, you will need to change the SPEED=PortSpeed parameter setting after connection. If, however, the AUTOBAUD=ON parameter is set, the speed will automatically change to the modem speed indicated by the "CONNECT baudrate" dial result message. See 1.3.2 1.3.2 Autobaud for details.

Parity specifies the parity used to talk to the COM device. Valid parities are NONE, ODD, EVEN, MARK and SPACE. Parity is normally set to NONE with 8 bit data. With 7 bit data, parity is normally set to either ODD or EVEN.

Data specifies the number of data bits used per byte. A byte is normally composed of 8 bits. All 8 bits may be used for data, or only 7 bits may be used for data with the eighth bit reserved for parity or ignored.

Stop specifies the number of stop bits used per byte. Asynchronous communications always sends one start bit to signify the beginning of a byte of data; either 1 or 2 stop bits may be sent following the data byte to signify the end of the data. The default number of stop bits is 1.

TerminalType specifies the terminal type to emulate. Supported terminal types: vt100 to emulate a DEC VT100 terminal, vt320 to emulate a DEC VT320 terminal, and wyse50 to emulate a WYSE 50 terminal. The default terminal type is vt100.

LinkedScript specifies an optional job/script file to execute upon connection. A job/script file automates communications with the remote site.



A.8 The Initialization File

The Aplus.ini file specifies the paths in which to locate A+'s files for starting operations. The Initialization file modifies with a standard text editor, and is located in the installation directory. The file is in use upon startup and is not during operation. If there are multiple copies of the CLEO A+ program on the system, there is one Aplus.ini file for each copy of the software. Each Aplus.ini file must remain in its directory for there is no option to specify a path.

Table A.6 lists the initialization file parameters with their default values. A description of these parameters follows.

TABLE A.6 INITIALIZATION PARAMETERS ____________________________________________________________________________________________________ PARAMETER DEFAULT OPTIONS [STARTUP] SERVER=C:\APLUS\ASERVE.EXE CONFIG=C:\APLUS\APLUSCFG.EXE XLATOUT=C:\APLUS\xlatout.ovr XLATIN=C:\APLUS\xlatin.ovr HELPFILE=C:\APLUS\APLUS.HLP PORT=2000 [ASERVE STARTUP] SOCKETS=0 TERMMODE=1 HIDE=0 [OPTIONS] TXDIR=C:\APLUS



A.8.1 Startup Parameters The SERVER=DriveLetter:\FolderName\Filename entry specifies where Cleo A+ can find the asynchronous server program. The default parameter value is C:\APLUS\ASERVE.EXE.

The CONFIG=DriveLetter:\FolderName\Filename entry specifies where Cleo A+ can find the Configurator program. The default parameter value is C:\APLUS\APLUSCFG.EXE.

The XLATOUT=DriveLetter:\FolderName\Filename entry specifies where the default outgoing translation file is located. The default parameter value is C:\APLUS\XLATOUT.OVR.

The XLATIN=DriveLetter:\FolderName\Filename entry specifies where the default incoming translation file is located. The default parameter value is C:\APLUS\XLATIN.OVR.

The HELPFILE=DriveLetter:\FolderName\Filename entry specifies where the help file is located. The default parameter value is C:\APLUS\APLUS.HLP.

The PORT=DriveLetter:\FolderName\PortNumber entry specifies the shortsock or socket port number. The default parameter value is 2000 for the first license, 2001 for the second license, etc.

A.8.2 Aserve Startup Settings The SOCKETS=0|1 parameter sets which interface is used for communications between the asynchronous server (ASERVE.EXE) and the front end (APLUS.EXE or a user application). The default is SOCKETS=0 for Cleo Communication's shortsock interface. SOCKETS=1 may be set to use sockets for API communications.

The TERMMODE=0|1 parameter sets whether or not unsolicited data is sent through from the asynchronous server (ASERVE.EXE) to the front end (APLUS.EXE or a user application). The default is TERMMODE=1 to enable unsolicited data to be passed through for terminal emulation. TERMMODE=0 may be set to suppress unsolicited data.

The HIDE=0|1|2 parameter sets whether the Cleo APLUS and the API icon displays while the asynchronous server (ASERVE.EXE) is running. The default is HIDE=0 to display the Cleo API icon while the ASERVE program is running. HIDE=1 may be set to hide the Cleo API icon. The HIDE=2 sets Cleo APLUS to hide both icons. Note: If HIDE=2 is used the program can not be stopped by the icons on the task bar.

A.8.3 Options The TXDIR=DefaultFolder parameter sets the default transmit and receive directories. The default folder is C:\APLUS.

Appendix B - Modem Support


Appendix B.

Modem Support

A+ must connect to another asynchronous device via modems (one for each device) or a null modem. This appendix contains information on the following modem types:

• AT command set modems

• Non-autodial modems

• Null modems

For information on the Autodial Directory option, see 3.3.1 Dial - Access the Dialing Directory. For information on the AUtodial command, see 4.3 AUtodial - Automatic Dial. For more detailed information on the Configuration Menu, see Chapter 3. The A+ Menus.



B.1 AT Command Set Modems

A+ supports the AT command set to configure and autodial a variety of modems. AT commands are asynchronous. Moreover, they transfer to the AT compatible modem asynchronously.

The following A+ Configuration parameters are normally required to autodial:

Speed (BPS) = speed required Data Bits = 8 Parity = NONE Stop Bits = 1

The default Modem Initialization String issues the following commands:

&M Dial and communicate asynchronously (for a Hayes modem change to &Q) X4 Return extended result codes/messages V1 Return result messages Q Return result codes/messages E Disable echo back S8=5 Pause 5 seconds1 &C1 Carrier Detect (CD) follows line &D1 Switch to command mode when DTR drops M1 Speaker on until line connect S0=1 Autoanswer on the first ring2

You may need to send additional modem setup strings for various reasons, including:

• If you will be connecting at 14,400 bps or 28,800 bps, your modem must be set up for a constant port (DTE) speed and enable flow control. The Speed sets to 19200 or 38400 bps, AutoBaud Enable must be OFF, and Flow Control must be on.

• If your modem is configured for error correction (MNP or V.42bis), you must be configured to run at a constant port (DTE) speed that is faster than the modem connection (DCE) speed and enable flow control. AutoBaud Enable must be OFF and Flow Control must be on.

Additional modem setup strings may be sent by adding to the default Modem Initialization String Modem (MODEMINIT=), setting the Dial Initialization String (DIALINIT=), or using the AT ATString command. See your modem manual for information on the required AT command(s).

The autodial sends out the Dial Initialization String (DIALINIT=), then issues the following commands:

H0 Hang up the line S7=xx Wait xx seconds for call to complete DT or DP Tone dial a number or Pulse dial a number

The ATS7=xx command is taken from the final Txx option of the AUtodial command or from the Wait for Connect (DIALWAIT=) parameter. The ATDP command to pulse dial is taken from the P option of the AUtodial command; the default is DT to tone dial.

1 The autodial pause time (Txx) rounds to the next five (5) second interval. To pause less than five seconds, set "S8=" to the required pause time and use a pause time of T5. 2 To disable autoanswer, you may change S0=1 to S0=0.



B.2 Non-Autodial Modems

A+ will function with modems that do not support the autodial methods previously described. These modems may establish a connection to the remote site in one of five ways:

• Leased line

• Autoanswer an incoming call 4.2 ANswer - Automatic Answer in Chapter 4 - A+ Commands for details)

• Manually dial a phone handset

• Manually dial through the modem front panel

The default Modem Initialization String should be removed or changed, depending on the modem type and function.



B.3 Null Modems

You may desire to run A+ with a local direct connection. When A+ is on two Windows systems, or even another Unix system, a cable can connect the local devices (i.e. COM1 or COM2). The cable that will let this work successfully is a null modem cable. This cable eliminates the need for modems.

The default Modem Initialization String must be removed from the Configuration file (i.e., set to MODEMINIT=) to run with the null modem cable. Otherwise, the MODEMINIT string transfers to the other system.

Note: Use the DAta command to change the status line to ONLINE when the Carrier Detect (CD) signal is not high.

Appendix C - Utility Programs


Appendix C.

C.1 A+ Status

When the A+ Status program opens, it displays licensing information, and lists the A+ sessions that are running.

Figure C.1 The A+ Status

where:

Serial No: is the A+ serial numbers.

Installation Date: is the installation date.

licenses is the number of A+ copies that may run simultaneously.

Bottom box is the number of A+ copies that are currently running.

cleo a+ for windowsportal.cleo.com/support/byproduct/legacy/cleoapluswin... · 2002. 1. 18. ·...

Documents