Adding the File Transfer Task to a schedule

To add a file transfer task to a schedule:

  1. Select Maintenance > System Administration > Job Scheduler.
  2. Click Add Schedule.
  3. Specify the name of the File Transfer Task in the Task Description field.
  4. Select File Transfer Task from the Task Type drop-down list.
  5. Fill in the remaining fields. See Adding tasks to the Job Scheduler.
  6. Click Submit.
  7. Click OK.
  8. In the Task Schedule list, click Parameters next to the File Transfer Task you created.
  9. Configure the task by selecting values for the appropriate parameters. Specify this information:
    Log Folder
    Must be set to the directory where the logs are written. The directory path must not include the client and server names. The client and server names are inserted automatically at runtime.
    Log Level
    Set to None, error, warn, info, or debug as required.
  10. Click Add File Transfer Parameters and specify this information:
    Transfer Protocol
    You can specify either FTP or SFTP (uses SSH) depending on the type of server you have configured.
    Type
    You can specify either Export or Import. Export sends the file to an external system that is accessible by WFM. Import will transfer the file from an external system to WFM.
    Transfer Type
    Specify Ascii or Binary for the transfer mode. Ascii is generally used for files that can be opened with a text editor such as .txt or .html. Binary mode transfers files as raw data such as .wav, .jpg, and .wav.
    IP/Domain Name
    The IP address or domain name of your FTP or SFTP server.
    Port
    The port of your FTP or SFTP server. The default port for FTP is 21, while the default port number for SFTP is 22.
    Username
    The username of your FTP or SFTP server.
    Password
    The password of your FTP or SFTP server.
    Source Folder
    Specify the name of the source folder/directory that contains the file(s) you want to transfer.
    Source File
    Specify the name of the source file(s) you want to transfer. You can use file masking to specify multiple files. Use the characters '?' and '*' to represent single or multiple wildcard characters. For example, *.csv will select all csv files and *-???.csv will select all csv files that begin with any amount of characters followed by a "-" character and then three other characters.

    You should note the following about file masking:

    • File masking is not permitted on file extensions.
    • If the file mask produces no matches, no file will be transferred when the job scheduler task runs and a log message will state that no matching file exists.
    • If the file mask produces multiple matches and the job scheduler fails to transfer any of the files, Job Scheduler will retry the file transfer the next time the task runs.
    • By default, files with the extension of .bak will not be transferred. This extension typically signifies a backup copy of a file.
    Destination Folder
    Specify the name of the destination folder/directory.
    Source Archive Option
    You can specify one of these options:
    • None: Once source files are copied to the destination file location, do nothing to the source files.
    • Purge: Once source files are copied successfully to the destination file location, delete the source files.
    • Archive: Once source files are copied successfully to the destination file location, move the source files to the Archive Folder.
    Archive Folder
    Specify a folder/directory for archiving files. This option is only used if Archive is selected from the Source Archive Option above.
    Note: The Source Folder and Archive Folder you specify should be on the same server and it is the user's responsibility to maintain the folder as per their business requirements.
  11. To transfer another file, click Add File Transfer Parameters and add the information for the new file.
  12. Once you are finished adding all files that you want to transfer, click Submit.

You can also click Edit to modify an existing file transfer or Remove to remove a file transfer.

Note: The home directory of the user specified in this task determines the perceived root of the remote server. When file transfer occurs, the home directory of the user is prepended to any folder/directory path specified in this task.