Overriding RA FTP Agent Job Attributes

You can read and set the specific attributes of RA FTP Agent Jobs by using the script elements GET_ATT and :PUT_ATT. The following topic describes and lists all the available attributes.

The attributes name which you can use in the script elements GET_ATT/:PUT_ATT is structured as follows:

prompt_<Index>_<Field>

<Index> = This is the number of the command sequence whose attributes should be called. Command sequences are numbered in an ascending order in the RA FTP Agent Job definition page, starting with the index "0". Note that changing the order of the command sequences subsequently will also affect their numbering.

<Field> = This is the field that should be addressed within the specified command sequence. Note that each command sequence has certain fields. This means that the specified field must comply with the command-sequence type.

The fields that are specified per command-sequence type are listed below. Basically, you can set (:PUT_ATT) and read (GET_ATT) all fields.

Job attributes are case-sensitive.

General Fields

You can specify the general fields in each command sequence.

Field Description
failJobOnCommandFailure

This cancels the Job if an error occurs.

This option is available for all command sequences regardless of their types.
command

This is the type of the command sequence.

Important !

Do not change this value by using :PUT_ATT because the RA FTP Agent Jobs may abort as a result thereof.

Possible values:

  • "COPY"
  • "FREEFORM" - command line
  • "MKDIR" - creates a directory
  • "DELETE"
  • "RENAME"
  • "LIST" - lists the content of the directory
  • "CD" - changes the directory
  • "JOBMESSAGE" - outputs the log
  • "REMOTECOMMAND" - remote execution

Change the Directory

Field Description
sourceDir The directory to which you want to switch.
execConnection The name of an RA FTP Agent Connection object that is used to run the command.

List a Directory's Content

Field Description
sourceDir The directory whose content should be listed.
execConnection The name of the RA FTP Agent Connection object that is used to run the command.

Create a Directory

Field Description
sourceDir The directory that should be created.
execConnection The name of the RA FTP Agent Connection object that is used to run the command.

Copy

Field Description
sourceDir Source directory
destDir Target directory
fromConnection The RA FTP Agent Connection object for the source.
toConnection The RA FTP Agent Connection object for the target.
eraseSource Deletes the files on the source host after they have successfully been transferred.
multiprocessing  
copyAllChildrenFiles Copies the subdirectories and contents.
sourceNotFoundOption Aborts the Job when the source files cannot be found.
fileType

Transfer type (FTP)

Possible values:

  • "ASCII"
  • "BINARY"
  • "IMAGE"
  • "EBCDIC"
  • "LOCAL"
fileTransferMode

File transfer mode (SFTP)

  • "STREAM"
  • "COMPRESSED"
  • "BLOCK"
onFailureOption The action that should be taken if an error occurs..
ifFileExistsOption The action that should be taken if the file already exists on the target host.

Delete

Field Description
sourceDir The directory or file that should be deleted.
execConnection The name of the RA FTP Agent Connection object that is used to run the command.
deleteAllChildrenFiles Subdirectories are also deleted.
deleteEmptyDirectories Empty directories are deleted.

Rename

Field Description
sourceDir The file or directory that should be renamed.
renameFile The new file or directory name.
execConnection The name of the RA FTP Agent Connection object that is used to run the command.

Command Line

Field Description
commandString Command-line commands
execConnection The name of the RA FTP Agent Connection object that is used to run the command.

Remote Execution

Field Description
sourceDir Directory
execConnection The name of the RA FTP Agent Connection object that is used to run the command.
retCode The expected return code for a successful execution.

Log Output

Field Description
message Message