Contents | Index | Search


  • Robo-FTP User's Guide
    • Introducing Robo-FTP
      • Notice to Evaluation Users
      • Notice to Upgrade Users
      • Notational Conventions
      • Introducing Robo-FTP
      • Features
        • General Features
        • Script Language Features
    • License and Installation
      • System Requirements
      • License Activation
        • Automatic vs. Manual Activation
        • Manual Licensing
        • Transferring a License
      • Moving to Another Computer
    • Using Robo-FTP
      • Opening the Help File
      • Running Robo-FTP
        • Entering Commands in the Console Window
        • Robo-FTP Console Window Details
          • File Menu
          • Edit Menu
          • Tools Menu
          • Scripts Menu
          • Help Menu
          • System Menu
        • Running Robo-FTP minimized
        • Robo-FTP Upload Manager
        • Using the Trace Window
        • Command Line Switches
      • Connecting to Secure Sites
        • SSL Certificates and Connections
        • FTPS - Secure FTP Using SSL
        • HTTPS - Secure HTTP Using SSL
        • SFTP - Secure FTP Using SSH
        • Generating a SSH Private Key
      • Scheduling File Transfers With Robo-FTP
      • PGP Encryption and Decryption
        • PGP Concepts
          • PGP Public and Private Keys
          • PGP Passphrases
          • PGP ASCII Armoring
          • PGP Digital Signatures
        • Using PGP in Robo-FTP
          • Robo-FTP's Implementation of PGP
          • Using PGP With Robo-FTP Step-By-Step Guide
          • Backing Up Robo-FTP's PGP Keys
      • IBM Host Features
        • ASCII-EBCDIC Translations
        • The NewXlat Utility
      • User Settings vs. Shared Settings
      • Data Compression
      • Limiting Bandwidth Usage
      • Active vs. Passive Mode FTP
      • HTTP Considerations
    • Script Programming
      • Script Programming
      • The Robo-EDIT Script File Editor
      • Script File Command Arguments
      • Script File Command Options
      • Script File Alphanumeric Constants
      • Script File Numeric Constants
      • Script File Variables
      • Using Variables in Command Options
      • Labels in Script Files
      • Comments in Script Files
      • Using Wildcards
      • Using Functions
      • Script Command Overview
        • Script File Commands
        • Script File Commands Grouped by Function
        • Script Commands
          • ACTIVATELIC - Activate license 
          • APPEND - Append one local file to another
          • ARCHIVEDIR - Define Robo-FTP’s archive folder
          • ASK - Ask a yes/no question in a pop-up dialog box
          • BEGINFUNCTIONS - Begin function declaration section
          • BREAK - Set a breakpoint location
          • BROWSE - Display a pop-up open file dialog box
          • CALL - Execute script file and return
          • CHAIN - Transfer control to a new script file
          • CHGDIR - Change local default folder
          • CONSOLE - Control output to console window
          • CONSOLEMSG - Write a message to the console window
          • COPY - Copy one local file to another location
          • CREATEMAIL - Create an e-mail message
          • CRON - Schedule script operations
          • DATEADD - Add specified number of days to a date variable
          • DATESUB - Subtract specified number of days from a date variable
          • DATETIMEADD - Add specified amount to the date and time variable
          • DATETIMESUB - Subtract specified amount from the date time variable
          • DASHBOARDMSG - Command used to update Robo-FTP Dashboard
          • DBCLOSE - Close and optionally delete SQL database file
          • DBGETRESULTS - Get results from a SQL database query
          • DBQUERY - Issue a SQL query
          • DBREWIND - Reset query results pointer to first row of results
          • DBUSE - Create and/or open a SQL database file
          • DEC - Decrement a variable by one
          • DELDIR - Delete an empty local folder
          • DELETE - Delete a local file(s)
          • DIALNET - Connect via RAS/Dial-Up Networking
          • DIFF - Look for differences in the local PC file system
          • DIFFREWIND - Reset file pointer for GETDIFF command
          • DISCONNECT - End a RAS / Dial-Up Connection
          • DISPLAY - Output value of all or a specified variable
          • DOSCMD - Execute an internal MS-DOS command
          • ENDFUNCTION - End function declaration
          • ENDFUNCTIONS - End function declaration section
          • EXEC - Execute an external program
          • EXIT - Terminate Robo-FTP
          • EXPORT - Export configuration settings to a local file
          • FILECOMPAREFROM - Compare file size and time/date stamp from FTP site
          • FILECOMPARETO - Compare file size and time/date stamp to FTP site
          • FTPCLIENT - Activate the Robo-FTP client applet
          • FTPCD - Change to a new directory on an FTP site
          • FTPCMD - Send a "raw" FTP command
          • FTPDELDIR - Delete a directory on an FTP site
          • FTPDELETE - Delete a file on an FTP site
          • FTPDIFF - Look for differences in the FTP site file system
          • FTPDIFFREWIND - Reset file pointer for FTPGETDIFF command
          • FTPGETDIFF -  Get specific changes within FTP site file system
          • FTPGETFILE - Get file from directory structure on FTP site
          • FTPGETREWIND - Reset file pointer for FTPGETFILE command
          • FTPLIST - List current FTP site directory to a file
          • FTPLOGOFF - Disconnect from a remote site
          • FTPLOGON - Connect to a remote site
          • FTPMAKEDIR - Create a new directory on an FTP site
          • FTPPWD - Get current directory on an FTP site
          • FTPRENAME - Rename a file on an FTP site
          • FTPSETERROR - Store Server Response for Conditional Branching
          • FTPSNAPSHOT - Take a "snapshot" of the FTP site file system
          • FTPTOJES - Enable access to JES queue on IBM host
          • FUNCTION - Begin a function declaration
          • GETDIFF - Get specific changes within local PC file system
          • GETFILE - Get file from folder structure on local PC
          • GETMAIL - Get an e-mail message
          • GETNEXTFILE - Get file or folder names on local PC
          • GETREWIND - Reset file pointer for GETFILE command
          • GETSITEFILE - Get file and directory names from an FTP site
          • GO - Rerun the currently defined script file
          • GOTO - Conditional branch to script file label
          • HTTPPOST - Post to HTTP/HTTPS site
          • IFDATE - Conditional branch upon date comparison
          • IFDATETIME - Conditional branch upon date time comparison
          • IFERROR - Test result code and conditionally branch to label
          • IFFILE - Conditional branch to label if file exists
          • IFNFILE - Branch to label if file does not exist
          • IFNO - Conditional branch if ‘No’ is clicked in ASK dialog box
          • IFNSTRCMP - Branch to label if two strings do not match
          • IFNSUBSTR - Branch to label if a substring not found in a master string
          • IFNUM - Conditional branch upon numeric variable comparison
          • IFSIZE - Conditional branch upon file size comparison
          • IFSTRCMP - Branch to label if two strings match
          • IFSUBSTR - Branch to label if a substring found in a master string
          • IFTIME - Conditional branch upon time comparison
          • IFYES - Conditional branch if ‘Yes’ is clicked in ASK dialog box
          • IMPORT - Import configuration settings from a local file
          • INC - Increment a variable by one
          • LISTDIR - List local folder to a file
          • LOG - Control the script log file
          • LOGMSG - Write a message to the script log file
          • LOGNTEVENT - Write a message to the NT application event log
          • LOOPCOUNT - Define loop counter
          • LOOPIF - Test result code and conditionally branch using looping
          • LOOPTO - Conditional branch to label using looping
          • MAILTO - Send an e-mail message via default e-mail client
          • MAKEDIR - Create a new local folder
          • MAKEFILENAME - Create a unique, non-existent file name
          • MESSAGEBOX - Display a text message in a pop-up dialog box
          • MINIMIZE - Minimize Robo-FTP window
          • MOVE - Move one local file to another location
          • NATO - Specify a no activity time-out
          • PAUSE - Time delay script execution 
          • PERFORM - Execute a specified script command
          • PGPDECRYPT - Decrypt a PGP encrypted file
          • PGPENCRYPT - Encrypt a file using PGP
          • PGPIMPORT - Import a PGP key
          • PLAYSOUND - Play a sound file
          • POSTVALUE - Add a value to a post transaction
          • PREPAREPOST - Prepare a http post transaction
          • PRESSANYKEY - Suspend script execution pending a key press
          • PRINT - Print a file
          • PROMPT - Display a text message in a pop-up dialog box
          • RCVFILE - Receive one or more files
          • READFILE - Read string from text file
          • READXTBL - Read custom ASCII - EBCDIC translation table file
          • RENAME - Rename a local file
          • RESTORE - Restore minimized Robo-FTP window to original size
          • RESUME - Resume script execution from a breakpoint
          • RETURN - Return from a called script file or function
          • RSCMD - Send remote server command
          • RSCMDCANCEL - Cancel a non-blocking remote server command
          • RSCMDSTATUS - Check status of non-blocking remote server command
          • SENDFILE - Send one or more files
          • SENDMAIL - Send e-mail message to one or more recipients
          • SESSIONLOG - Control the session log file
          • SET - Assign or concatenate string variable(s)
          • SETEXTRACT - Extract delimited substring from a string
          • SETLEN - Assign length of specified string to a variable
          • SETLEFT - Extract left substring
          • SETMID - Extract mid substring
          • SETNUM - Assign or evaluate numeric variable(s)
          • SETRIGHT - Extract right substring
          • SETSUBSTR - Find number of substrings in string
          • SNAPSHOT - Take a "snapshot" of the local PC file system
          • SRVNAME - Define service name and control interaction with SrvMonitor
          • STAYALIVE - Specify time-out to maintain FTP site connection
          • STOP - Terminate script file execution
          • SYNC - Synchronize local folder(s) with an FTP site
          • TIMEZONE - Declare time zone offset
          • TRACELOG - Control the trace log file
          • TRACEWIN - Activate/Deactivate trace window
          • UNZIP - Extract file(s) from a zip archive
          • WORKINGDIR - Change local default (working) folder
          • WRITEFILE - Write string to specified text file
          • ZIP - Append files to a zip archive
      • Internal Script Variables
        • Using the %cr, %crlf, and %lf Variables
        • Using the %currentlocaldir Variable
        • Using the %currentlogfile and %currenttracelogfile Variables
        • Using the %currentsitedir Variable
        • Using the %date, %datetime, and %time Variables
        • Using the %dbqueryrawresult, %dbqueryrows, and %dbqueryvariables Variables
        • Using the %difffileid, %difffilename, %difffilepath, and %difffiletext Variables
        • Using the %difffiles and %diffnum Variables
        • Using the %downloadcount, %uploadcount, and %syncount Variables
        • Using the %downloaderrors and %uploaderrors Variables
        • Using the %downloadsize and %uploadsize Variables
        • Using the %ftpdifffileid, %ftpdifffilename, %ftpdifffilepath,and %ftpdifffiletext Variables
        • Using the %ftpdifffiles and %ftpdiffnum Variables
        • Using the %ftplastresult and %ftpresultsfile Variables
        • Using the %installdir and %installver Variables
        • Using the %lasterror Variable
        • Using the %lasterrormsg Variable
        • Using the %nextcmd Variable
        • Using the %nextfile, %nextfolder, and %nextpath Variables
        • Using the %nextfiledate, %nextfiledatetime, %nextfilesize, and %nextfiletime Variables
        • Using the %rscmderror Variable
        • Using the %servertype Variable
        • Using the %sitefile and %sitedir Variables
        • Using the %sitefiledate, %sitefiledatetime, %sitefilesize, and %sitefiletime Variables
        • Using the %snapshotfiles and %ftpsnapshotfiles Variables
        • Using the %zipcount and %upzipcount Variables
      • Debugging, Logging and Troubleshooting
        • Interactive Debugging
        • Basic Logging
        • Advanced Logging
        • Troubleshooting
      • Select Topics in Script Programming
        • Variable Arithmetic and Numeric Comparisons
        • Date Arithmetic
        • Using Script File Result Codes
        • Suppressing output to console or log file
        • Comparing Local and Remote Files
        • Comparing File Dates and Times
        • Running Robo-FTP with Prompting
        • Time Zone Differences
        • Scheduling Script Operation
        • Sending and Receiving E-mail in Script Files
        • Windows environment variables
        • The "Hot Send" Feature
        • The "Hot Receive" Feature
        • Passing External Values Into Command Scripts
        • Local and FTP Site Snapshots and Finding New or Changed Files
        • Using the Built-in SQL Database Engine
        • Remote Server Commands
      • Sample Script Files
        • Simple FTP Connection With Error Recovery
        • FTP Connection to Update a Web Site
        • Displaying Files and Directories on a FTP Site
        • Build File Name Including the Current Date
      • Using the Script File Wizard
        • Script File Wizard Step 1 - Setup
        • Script File Wizard Step 2 - Connect
        • Script File Wizard Step 3 - Commands
        • Script File Wizard Step 4 - Send & Receive Files
        • Script File Wizard Step 5 - Disconnect & Exit
        • Script File Wizard Step 6 - Finish
        • Script File Wizard Summary
      • Using the CronMaker Utility
        • CronMaker Event Creation Example, Step 1
        • CronMaker Event Creation Example, Step 2
        • CronMaker Event Creation Example, Step 3
        • CronMaker Event Creation Example, Step 4
        • Cron Event File Format
    • Installing Robo-FTP as a Windows Service
      • Programming Service Scripts
      • Service Installer and Monitor
        • Service Installer
        • Monitoring a Robo-FTP Service
        • Installing a service from the command line
      • Robo-FTP Dashboard
        • Creating Dashboard Services
        • Menu Items
      • Shutting Down a Running Robo-FTP Service
    • Using COM/OLE to Control Robo-FTP
      • COM/OLE Operational Overview
      • Robo-FTP COM/OLE Interface Description -- A Programmer's View
      • COM/OLE Return Codes
      • RoboStartSession -- Method to initiate a Robo-FTP session
      • RoboEndSession -- Method to terminate a Robo-FTP session
      • RoboSendCommand -- Method to send a script command to Robo-FTP
      • RoboStopCommand -- Method to stop a running Robo-FTP script command
      • RoboGetVariable -- Method to get the value of Robo-FTP script variable
      • RoboGetVBSVariable -- VBS method to get the value of Robo-FTP script variable
      • RoboActivateLicense -- Method to activate the Robo-FTP license
      • RoboLicenseStatus -- Method to obtain status of the Robo-FTP license
      • RoboRemoveLicense -- Method to remove the Robo-FTP license
      • RoboCommandProgress -- Event fired to update SENDFILE/RCVFILE progress
      • RoboCommandResult -- Event fired at the conclusion of a non-blocking command
      • RoboDirList -- Event fired to provide directory listing from FTP site
      • RoboFTPMsgs -- Event fired to provide trace information
      • RoboLogMsgs -- Event fired to provide script log information
      • Sample C++ and Visual Basic Project Files
      • Sample C# and VB.NET Project Files
      • Sample VBScript Program
    • Using the Robo-FTP Configurator
      • Files menu
      • Connection menu
      • Manage Sites menu
        • Manage Sites: Add New/Edit FTP Site
        • Manage Sites: Proxy Server Settings
        • Manage Sites: Key/Cert Authentication
      • Configure PGP menu
        • Configure PGP: Create Key
        • Configure PGP: Import PGP Key
        • Configure PGP: Manage Keys
        • Configure PGP: Export Keys
      • Logging menu
      • Configure SSL menu
        • Configure SSL: Choose Certificate
        • Configure SSL: Create Certificate
      • Configure SSH menu
        • Configure SSH: Choose Key
        • Configure SSH: Create Key
      • Configurator: Command Line Switches
    • Using the Robo-FTP Client Applet
      • FTP Connection Menu
      • FTP Settings Menu
      • FTP Commands Menu
      • FTP Help Menu