| Command |
Description |
| Alert |
The Alert command is used to send mail or a page.
Example:
:Alert: Mail = C:\Beyond FTP\Failed.Mpf |
| Append/To |
Append
files to an FTP server file
Example:
:Append:
c:\Logfiles\*.Txt
:ToOne : {ftp:Unix}/Logresults/complete.txt |
| Archive |
Archive handling for source and destination files
| None |
The default. No archiving takes place. |
| Source |
Each source file is archived after a successful transfer. |
| Destination |
Each destination file is archived before the transfer completes. |
| Both |
Combination of Source and Destination. |
Example:
:Archive:Source |
| ASCII |
The ASCII
command instructs Beyond FTP to perform all
subsequent transfers in ASCII mode.
Example: :ASCII: |
| Binary |
The
Binary command disables ASCII transfers and returns Beyond FTP to
normal default operation.
Example: :Binary: |
| Block_Script |
This command prevents two scripts from running at the same time. If either the script containing the command or the script specified in the command is running, the second script will be placed in a holding position until the first script is completed.
Example:
:Block_Script:SendAll |
| Comment |
Used to change the comment character, which defaults to #. Comments cause the script compiler to ignore everything following the comment character until the end of line is reached.
Example:
:Comment:# |
| Continuous_Log |
New information is
appended to an existing
script log file.
Example:
:Continuous_Log: |
| Delete_Files |
Deletes files. The optional /S parameter will apply the file mask to all sub-directories of the specified path.
Example:
:Delete_Files /S: c:\Sales Reports\*.old |
| Description |
Script description for reporting.
Example:
:Description: Weekly backups for accounting data |
| File_Date_Filter |
Filter a file expansion based on date. This
can be applied to subsequent transfers, deletes, renames, etc.
Example:
:File_Date_Filter: < -30 days
:File_Date_Filter: > - 1 month
:File_Date_Filter: 1/1/2001 0:0 ~
12/31/2001 23:59 |
| From/To |
From/To is the basic file transfer command. The From and To keywords must occur together, and must completely define the source and destination servers, paths, and files involved in the transfer. From can also be modified with an optional /S parameter, indicating the inclusion of sub-directories in the transfer.
A "Server List " name can be specified on either the From
or To file specification and is prefixed with an exclamation point.
Example:
:From: c:\Sales Reports\*.doc
:To : {!SalesStaff}c:\Daily Reports\*.doc |
| HTTP_Get/HTTP_As |
The HTTP_Get command is used to retrieve information
directly from a web server using the HTTP or HTTPS transfer protocol.
A FTP Server need not be present.
Example:
:HTTP_Get:http://www.aptnet.com/faq.htm
:HTTP_As: C:\APT\faq.htm
:HTTP_User: Admin
:HTTP_EPW: 3133283236F54039
:HTTP_Tags: Yes |
| If/Else/End_If |
Conditional flow control statements.
Examples:
:If: GetData CompletedOk
:End_If:
:If: Not Present
{APTServe}c:\rtansfer\*.*, 5
:Alert: Mail
= C:\BFTP\trouble.mpf
:Stop:
:Else:
:From: {APTServe}c:\transfer\*.*
:To:
c:\inbound\*.*
:If: Not
Inbound CompletedOK
:Alert: Mail = C:\BFTP\xferfailed.mpf
:End_If:
:End_If:
:If: Present {APTServe}c:\transfer\*.*, 5
:From: {APTServe}c:\transfer\*.*
:To: c:\inbound\*.*
:Else:
:Stop:
:End_If: |
| Ignore_Error |
Prevent errors from failing a
CompletedOK condition.
Example:
:Ignore_Error: Yes |
| Immortal |
Automatically restart script whenever it finishes.
Example:
:Immortal: |
| Include |
The Include command allows you to build parameterized script fragments that are “called” at Compile time. You may specify up to 10 parameters. They are identified in the script fragment by the percent (%) escape character followed by a number from 0 to 9.
Example:
:Include: Build,c:\apt,5 |
| Instructions |
Transfer instructions control the handling of file transfer initiation and whether a transfer will be allowed to proceed.
| None |
The default. Transfer occurs under all circumstances. |
| Add |
Target may NOT exist. |
| Freshen |
Target must exist and be older than the source. |
| Rollback |
Target must exist and be newer than the source. |
| Synchronize |
Combination of Add and Freshen. |
Example:
:Instructions:Freshen |
| Log |
The Log command simply places text into the Beyond FTP log file.
Example:
:Log: All files copied. Start processing. |
| MaxPerServer |
The maximum number of transfers that will be processed simultaneously for each of MaxServers servers. The product of MaxServers and MaxPerServer equals the maximum number of simultaneous file transfers that can be processed.
Example:
:MaxPerServer:5 |
| MaxServers |
The maximum number of servers that will be processed simultaneously. Up to MaxPerServer transfers will be processed for each server. The product of MaxServers and MaxPerServer equals the maximum number of simultaneous file transfers that can be processed.
Example:
:MaxServers:2 |
| No_Restart |
Any script that is interrupted by a system failure will be restarted as soon as the Beyond FTP services are initialized. The point at which the
script is restarted depends on this command. Normally, restarting occurs at the exact point of failure. A fair amount of overhead is devoted to keeping track of this point.
Scripts that involve a number of local file actions might incur more overhead than actual processing. This is especially true if a large number of small files are being moved or copied. Specifying No_Restart will greatly improve the speed with which such a
script is processed. However, a failure may cause some processing to be repeated.
Example:
:No_Restart: |
| Queue_Distribution |
Schedule a script to execute within a
script.
Examples:
:Queue_Distribution: {!Sales}GetReports
:Queue_Distribution: ReQueue, 1, 5 |
| Rename_File/To |
Rename_File/To is very similar to the From/To command. The only restriction is that the source and target files must occur on the same disk drive. Server names may be included for both the source and target, and a third party server can be instructed to perform the rename on a locally attached FTP server.
Example:
:Rename_File: {ftp:Public}c:\Sales Reports\*.doc
:To : {ftp:Public}c:\Sales Reports\*.sav |
| Repeat_Time |
Repeat_Time specifies the frequency with which the script will be repeated.
| Daily |
Repeat every day. |
| Weekly |
Repeat every week on the same day. |
| Monthly |
Repeat every month on the same day. |
| SemiMonthly |
Repeat on the 15th and last day of each month |
| StartOfMonth |
Repeat on the first of the month |
| EndOfMonth |
Repeat on the last day of the month |
| WeekDays |
Repeat only on weekdays. Weekends are skipped. |
| WeekEnds |
Repeat only on weekends. Weekdays are skipped. |
Example:
:Repeat_Time:Weekly |
| ReQueue |
Specify error handling in a script. If
a subsequent error is encountered in the script that is defined by a
ReQueue command, then the script is automatically re-scheduled.
| <start error> |
The first error in the range to be checked. |
| <end error> |
The last error in the range to be checked. |
| <add minutes> |
The number of minutes before the action is retried. |
| <retry limit> |
The number of consecutive failures allowed.
|
Example:
:ReQueue: 13000,13100, 5, 10 |
| Return_Results_To |
This command allows you to send a copy of the script results to a second Beyond FTP server.
Example:
:Return_Results_To:{APTServe}C:\Beyond FTP\RemoteScript |
Run
Run_Async |
The Run and Run_Async commands are identical except that
script processing continues as soon as the Run_Async command is executed. This obviates the need for a <timeout> parameter. The <command> parameter is required, and must identify a file that is locally accessible. Programs may not be run from remote servers. Commas are used to separate the various fields. When a field is included, all preceding commas must be present.
These commands will execute any class of file that can be run from the Windows Start menu. This includes BAT files and PIF files as well as all manner of EXE files. Beyond FTP will also process file associations. For example, running a file with the suffix .Doc will cause Beyond FTP to execute the word processor with the <command> file as a parameter.
Example:
:Run: C:\APT\Wft.exe, c:\apt\scripts\getdb.isf /Q, c:\apt, 5
:Run_Async: C:\APT\StroreDB.exe, c:\apt, |
| Server_List |
List of servers involved in an action.
Example:
:Server_List: Sales
NewYork
Chicago
:End_List:
:From: c:\Sales Reports\*.doc
:To : {!Sales}c:\Daily Reports\*.doc |
| Speed |
Transfer speed allows you to control the resources used by individual transfers.
Example:
:Speed: +3 |
| Stop |
Stop the script.
Examples:
:Stop: |
| Time_Range |
This allows you to specify when a script should
begin and end processing within a 24 hour time range.
Examples:
:Time_Range:23:30
:Time_Range:23:30-06:00 |
| WildCard_File |
Wildcard files are text files. They are structured like .ini files, with sections and parameters.
This file specifies where the substitution wildcards are stored for
a script.
Example:
:WildCard_File:C:\Beyond FTP\Processingdata.Ini |
| Wildcard |
Description |
|
Date Wildcards
|
The following wildcards may be used as placeholders for the various date values. In addition, the %T wildcard can be used to adjust the current date. |
| %DW |
Three character day of week abbreviation (Mon, Tue, etc.) |
| %DM |
Two-digit day of the month (01 - 31) |
| %MM |
Three character month abbreviation (Jan, Feb, etc.) |
| %M2 |
Two-digit month number (01 - 12). |
| %Y2 |
Last two-digits of current year. |
| %Y4 |
Four digit year. |
| %T + | - <number> D | H | M |
Where: <number> is the time to add to or subtract from the current
time (Days, Hours, or Minutes).
Example: %T+2D |
| Server Wildcards |
The following wildcards may be used as placeholders for the server names. Note that the length limitations are optional. These wildcards are particularly useful when you are collecting the same file from a number of different locations using a server list. |
%LN [ :<number> ]
|
Name of the local server. May be limited to <number>
characters using the options colon. |
| %RN [ :<number> ] |
Name of the remote server. May be limited to <number>
characters using the options colon. |
| Substitution Wildcards |
The substitution wildcard reads a value from the wildcard file and places it into the script. Like all wildcard actions, this takes place at run-time when the script line is processed. Wildcard files are structured like .ini files, with sections and parameters. The section name is enclosed in square brackets “[]” and parameters simply follow the section. |
| %[<section name>,<parameter>] |
The entire construct is replaced with the parameter value, if any. For example, if the file contained the following:
[Date values]
Yesterday=05/10/2000
and the wildcard was specified as follows:
:From: c:\test\File-%[Date values,Yesterday].txt
:To : c:\temp\Thename.txt
the resulting transfer would copy the file c:\test\file-05/10/2000.txt. |
| File Wildcards |
Normal file wildcards are supported in addition
to the above wildcards.
Examples:
c:\Local\*.*
c:\Local\*.*-%DW
{APTServer}C:\Orders\%DM\*.mdb |
