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
      • Moving to Another Computer
    • Using Robo-FTP
      • Opening the Help File
      • Command Line Switches
        • Running Robo-FTP minimized
      • Entering Commands in the Console Window
      • Connecting To Sites
      • Using the Trace Window
      • Adding Robo-FTP to the Path
      • Scheduling Script Execution
      • 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
        • RoboSetVariable -- Method to set a variable
        • RoboSetWorkingDir -- Method to set the current working directory
        • 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
        • RoboGetSessionPID -- Method to get the value of the current Robo-FTP session's PID
        • 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
    • Script Programming
      • The Robo-EDIT Script File Editor
      • Command Syntax
      • Constants
      • Variables
      • Control Flow Labels for Branching
      • Code Comments
      • Using Wildcards
      • Using Functions
      • Script Commands
        • Script Commands Listed Alphabetically
        • Script Commands Grouped by Function
        • Command Result Codes
        • All 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
          • AUDITDB - Control the auditing database
          • 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
          • CMSDECRYPT - Decrypt a CMS encrypted file
          • CMSENCRYPT - Encrypt a file using CMS
          • CONFIGLOAD - Load a section from a configuration file
          • CONFIGSECTIONS - Load a list of all sections in a configuration file
          • 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
          • DASHBOARDMSG - Command used to update Robo-FTP Dashboard
          • 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
          • 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 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
          • EMAIL - Send an email
          • ENCODING - Set the server-side filename encoding
          • 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 remote file to local file
          • FILECOMPARETO - Compare local file to remote file
          • FTPACCEPT - Accept one client connection
          • FTPCD - Change to a new directory on an FTP site
          • FTPCLIENT - Activate the Robo-FTP client applet
          • 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 properties of remote file(s)
          • 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 - Update current state from remote site file system
          • FTPTMPNAME - Set temporary upload file name
          • 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 properties of local file(s)
          • GETFILEARRAY - Get list of matching local file(s)
          • FTPGETFILEARRAY - Get list of matching remote file(s)
          • GETMAIL - Get an e-mail message
          • GETNEXTFILE - Get properties of local file(s) or folder(s)
          • GETPROPERTY - Read the value of an existing name-value pair
          • GETREWIND - Reset file pointer for GETFILE command
          • GETSITEFILE - Get properties of remote file(s) or folder(s)
          • GO - Rerun the currently defined script file
          • GOTO - Conditional branch to script file label
          • HTTPPOST - Post to HTTP/HTTPS site
          • HASH - Generate a Message Authentication Code
          • 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
          • IFREGEX - Branch to label if a regular express matched in a master string
          • 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
          • KEYS -  creates an array of keys from an existing array
          • 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
          • LOWER - Convert string to lower case
          • 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
          • PGPSIGN - (Deprecated)Digital signature without encryption
          • 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
          • SEARCHFILE - Search a text file for matching records and extract them into an array
          • SENDFILE - Send one or more files
          • SENDMAIL - Send e-mail message to one or more recipients
          • SESSIONLOG - (Deprecated) Control the session log file
          • SET - Assign or concatenate string variable(s)
          • SETEVENT - Set signaled state on named Win32 event
          • SETEXTRACT - Extract delimited substring from a string
          • SETLEFT - Extract left substring
          • SETLEN - Assign length of specified string to a variable
          • SETMID - Extract mid substring
          • SETNUM - Assign or evaluate numeric variable(s)
          • SETPROPERTY - Save or update a persistent name-value pair
          • SETREPLACE - Replace a substring with another substring
          • SETRIGHT - Extract right substring
          • SETSUBSTR - Find number of substrings in string
          • SNAPSHOT - Update current state from local 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
          • TMPNAME - Set temporary download file name
          • TRACELOG - Control the trace log file
          • TRACEWIN - Activate/Deactivate trace window
          • UNZIP - Extract file(s) from a zip archive
          • UPPER - Convert string to upper case
          • WEBBROWSER - Display a web browser window
          • 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 %copyfiles Variable
        • Using the %cr, %crlf, and %lf Variables
        • Using the %currentlocaldir Variable
        • Using the %currentlogfile and %currenttracelogfile Variables
        • Using the %currentscript and %currentscriptdir Variables
        • Using the %currentsitedir Variable
        • Using the %date, %datetime, and %time Variables
        • Using the %dbqueryrawresult, %dbqueryrows, and %dbqueryvariables Variables
        • Using the %deletefiles and %ftpdeletefiles Variables
        • Using the %difffileid, %difffilename, %difffilepath, and %difffiletext Variables
        • Using the %difffiles and %diffnum Variables
        • Using the %downloadcount, %uploadcount, and %syncount Variables
        • Using the %downloadfiles and %uploadfiles 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 %lastfailedcmd Variable
        • Using the %lastfile and %lastpath Variables
        • Using the %nextcmd Variable
        • Using the %nextfile, %nextfolder, and %nextpath Variables
        • Using the %nextfiledate, %nextfiledatetime, %nextfilesize, and %nextfiletime Variables
        • Using the %pgpdecryptfile Variable
        • Using the %programdatadir Variable
        • Using the %protocol Variable
        • Using the %servertype Variable
        • Using the %sitefile and %sitedir Variables
        • Using the %sitefiledate, %sitefiledatetime, %sitefilesize, and %sitefiletime Variables
        • Using the %zipcount and %upzipcount Variables
      • Debugging, Logging and Troubleshooting
        • Interactive Debugging
        • Basic Logging
        • Advanced Logging
        • Debug Logging
        • Troubleshooting
      • Select Topics in Script Programming
        • Compatibility with older versions of PGP
        • Translating Command-Line FTP Instructions
        • Variable Arithmetic and Numeric Comparisons
        • Date Arithmetic
        • Arrays
        • Alternate Default File Paths for Select Commands
        • Suppressing output to console or log file
        • Comparing Local and Remote Files
        • Comparing File Dates and Times
        • External Configuration Files
        • Automatic uploads: "Hot Send"
        • Automatic downloads: "Hot Receive"
        • Monitoring for Files and Iterating over Directory Structures
        • Processing Dynamic Folders
        • Rename files during download
        • Fault Tolerant Scripts
        • Running Robo-FTP with Prompting
        • Time Zone Differences
        • Scheduling Script Operations Within A Script
        • Sending and Receiving E-mail in Script Files
        • Sending SMS Text Messages as E-mail
        • Windows environment variables
        • Using the Built-in SQLite Database Engine
        • Working with Network Drives
        • Passing External Values Into Command Scripts
        • Multi-Purpose Scripts
        • Concurrent Script Execution
        • Returning Error Codes from Scripts
        • Regular Expressions
          • Character Classes
          • Symbolic Names
          • Leftmost Match
      • Sample Script Files
        • Simple Error Trapping
        • FTP Connection to Update a Web Site
        • Displaying Files and Directories on a FTP Site
        • Build File Name Including the Current Date
        • Run a VBScript and use the numeric result
      • 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
    • Robo-FTP Framework
      • Introducing Robo-FTP Framework
      • Web Interface
        • Settings Page
        • Job Page
        • Edit Job Page
        • Run Page
        • History Page
        • Schedule Page
      • Job Definitions
        • Built In Steps
          • Compress
          • Concat
          • Decompress
          • Decrypt
          • DeleteFiles
          • Deliver
          • Encrypt
          • Execute
          • FTPName
          • FTPSyncSrc
          • FTPSyncTrg
          • Monitor
          • Mount
          • Name
          • Notify
          • PostFile
          • Pull
          • Push
          • RemoteTouch
          • Retrieval
          • RunJob
          • SQLQuery
          • SyncSource
          • SyncTarget
          • Validate
          • Whitelist
        • Macro Substitution
        • Other Parameters
        • Sample Job Definition
      • Advanced
        • Base Working Directory
      • Notifications
    • Robo-FTP Interface
      • Robo-FTP Upload Manager
      • Robo-FTP Console
        • File Menu
        • Edit Menu
        • Tools Menu
        • Scripts Menu
        • Help Menu
        • System Menu
      • The Configurator
        • Logging menu
        • Settings menu
          • Export Settings
          • Import Settings
        • Connection menu
        • Manage Sites menu
          • Add New/Edit FTP Site
          • Proxy Server Settings
        • PGP Keys menu
          • Create PGP Key
          • Import PGP Key
          • Export PGP Key
        • SSL Certificates menu
          • Import Certificate
          • Create Certificate
        • SSH Keys menu
          • Export SSH Key
          • Import SSH Key
          • Create SSH Key
        • License Menu
          • Activating a License
          • Removing a License
          • Requesting a Trial Extension
        • Configurator: Command Line Switches
        • Scheduler menu
          • Add/Edit Job
            • Scheduling
          • Viewing Job History
          • Configuring the Scheduler
            • Simple & Advanced Mode
            • Running the scheduler as a different user
            • Switching to a SQL Server back end
            • Running tasks as alternate users
            • Limiting access to jobs
        • Outbound Email menu
          • Add/Edit Email Configuration
      • Client Applet
        • FTP Connection Menu
        • FTP Settings Menu
        • FTP Commands Menu
        • FTP Help Menu
    • Appendix
      • Security
        • Connecting to Secure Sites
          • SSL Certificates and Connections
            • Advanced SSL Options
            • Supported SSL Ciphers
          • FTPS - Secure FTP Using SSL
          • HTTPS - Secure HTTP Using SSL
          • SFTP - Secure File Transfer Using SSH
        • 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