Free Form Command Settings

Free Form Command commands allow you to define your own commands using static commands and/or Automation Engine variables.

To define a Free Form Command command:

  1. Select a connection under Free Form.

    2. The only two selectable connections in the drop-down list are the ones selected in the From and To fields at the top of the RA FTP Agent Job definition page, above the command sequence.

  2. Enter commands in the Commands box.

    3. When spaces are included in directories or files, double quotes " " should surround the entire argument.

    This box allows Automation Engine variables in the format &<name>#.

    Important !

    Empty lines are not allowable and will cause the Job to fail.

  3. If you do not want the Job to abort if this command fails, uncheck the Abort job on command failure box.

  4. If you want the Job to abort when source file(s) are not found, check the Abort job when source file(s) not found (only used for put and get commands) box.

  5. Optionally add a description of the command under Description.

  6. The Description field acts as comment in the command sequence, and is not written to the Job report. To write a message to the Job report use an Echo command .

FTP, FTPS, and FTPES Commands

Available FTP, FTPS, and FTPES commands are described below.

  • ascii

    • Sets the mode of file transfer to ASCII.

  • binary

    • Sets the mode of file transfer to binary.

  • image

    • Sets the type to image where the data are sent as contiguous bits which, for transfer, are packed into the 8-bit transfer bytes.

  • ebcdic

    • Sets the type to EBCDIC to use EBCDIC for their internal character representation.

  • local

    • Sets the type to local where the data is transferred in logical bytes of the size specified by the obligatory second parameter, byte size.

  • get remote-path [local-path] [ERASE]

    • Download file.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • put local-path [remote-path] [ERASE]

    • Upload file.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • mget remote-path [local-path] [ERASE]

    • Download multiple files.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • mput local-path [remote-path] [ERASE]

    • Upload multiple files.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • site arg1 [ arg2 ] ...

    • Initiate a site command with argument(s).

  • namelis [remote-directory]

    • Runs an NLST command on a remote directory.

  • ls [remote-directory]

    • Display an abbreviated list of files and subdirectories in a remote directory.

  • dir [remote-directory]

    • View a remote directory.

  • pwd

    • Display remote working directory.

  • cwd

    • Change the working directory.

  • cd

    • Change the working directory on the remote computer.

  • lcd

    • Changes the working directory on the local computer.

  • account password

    • Password for system log-in.

  • allocate bytes

    • Allocate bytes for file storage on the remote computer.

  • mkdir directory-name

    • Create specified directory on the remote computer.

  • rmdir directory-name

    • Remove specified directory on the remote computer.

  • rename from to

    • Rename remote file.

  • move from to

    • Move remote file.

  • delete remote-file

    • Delete remote file.

  • rm remote-file

    • Remove remote file.

  • append local-file [remote-file]

    • Append file to file of same name on the remote computer.

  • transfermode [stream|compressed|block]

    • Set the transfer mode.

  • filestructure [file|page|record]

    • Set the file structure.

In order to accommodate the RA FTP Agent's design, there are additional features added to standard FTP, specifically CANCEL and ERASE. CANCEL means that the file transfer will abort. Where multiple files are transferred, this is done on a case by case basis. ERASE means that the source file is deleted after the file transfer is complete.

SFTP Commands

Available SFTP commands are described below.

  • cd path

    • Change remote directory to 'path'.

  • lcd path

    • Change local directory to 'path'.

  • chgrp grp path

    • Change group of file 'path' to 'grp'.

  • chmod mode path

    • Change permissions of file 'path' to 'mode'.

  • chown own path

    • Change owner of file 'path' to 'own'.

  • help

    • Display this help text.

  • get remote-path [local-path] [ERASE]

    • Download file.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • lls [path]

    • Display local directory listing.

  • ln oldpath newpath

    • Symlink remote file.

  • lpwd

    • Print local working directory.

  • ls [path]

    • Display remote directory listing.

  • mkdir path

    • Create remote directory.

  • put local-path [remote-path] [ERASE]

    • Upload file.

    Includes the option to erase the source on successful transfer by entering the ERASE attribute at the end of the command.

  • pwd

    • Display remote working directory.

  • stat path

    • Display info about path.

  • rename oldpath newpath

    • Rename remote file.

  • rmdir path

    • Remove remote directory.

  • rm path

    • Delete remote file.

  • symlink oldpath newpath

    • Symlink remote file.

  • readlink path

    • Check the target of a symbolic link.

  • realpath path

    • Canonicalize the path.

  • rekey

    • Key re-exchanging.

  • compression level

    • Packet compression will be enabled.