File Transfer Execution Method
JAMS Ships with a built in fill-in-the-blank FTP Client that can be used to automate FTP, SFTP, FTPS, and SCP. This article outlines the creation of a Job to retrieve files from an SFTP server.
Create a Job using the File Transfer Execution Method
- In the JAMS Client, select the folder where the Job should be created then hit the Add button
- Name the Job and give it a description then select the File Transfer Execution Method
NOTE: Select Edit this job definition after adding will open the properties view of the job after adding.
- Set Email Address and Username as required from within the Properties tab.
NOTE: The username should be one that can run on Windows on the local JAMS Server or Windows Agent Machine.
- The Source contains multiple tabs of settings for the Job. These tabs are explained in further steps
- In the Files Tab on the Job Source, set the following:
- Set the Transfer Type to SFTP. This will allow users to transfer the files through this protocol to a Linux Machine.
- Ensure the Drop Down is set to Get local files from remote server. This drop-down allows users to either send or receive files between their local machine and the remote node.
- For this example, leave the Recursive box unchecked. This option allows users to transfer all files in a given directory at once
- Set the Remote Server Name to the DNS name or IP address of the Linux node.
- Set the Remote Directory to the location of the File on the remote node
- Set the Remote File Specification to the name of the file being transferred. Include the file extension.
NOTE: A file mask such as *.txt may also be used.
- Set the Local File Specification to the directory where the file will land on the local machine.
- If the file should be deleted from the remote node after transfer, check the Delete After Transfer box. Otherwise, leave this box unchecked.
- The Security Tab on the Job Source lets users set the credentials to use for authentication:
- In the example Below, User Security is used because the user Kevin already has Public Key Authentication set up between JAMS and the Linux Node.
- A user can also be manually specified, by setting the Username and Password of a given user that would authenticate to the Linux Node.
NOTE: Ensure that the user or credentials configured in the security tab have access to both the remote node and the local location.
- The Zip Tab on the Job Source allows users to manipulate or Zip files in the transfer process:
- Unzip after download allows a user to unzip a zipped file after retrieving it.
- Delete zip file after extraction allows a user to delete a source zip file that has already been extracted.
- Zip File Directory is the location of the File
- Zip File Name is the name of the zip file to be transferred
- Credential for Archiver and Password for Archiver allows a user to set the credentials used in the zip transfer
- The Retry Tab on the Job Source allows users to specify how many times a failed FTP Job should retry, as well as the interval between those attempts:
- In the Maximum Retries section, set the number of times the Job should retry on failure. The Retry number is considered to be the number of attempts subsequent to the initial scheduled attempt.
- Set the Retry Delay. This delay will occur between the time the initial attempt failed and the time the new attempt will begin.
- In the Options Tab on the Job Source, users can set the following:
- The Server Type, which can be set to Windows, Unix, or Unknown.
NOTE: Setting the Server Type to Unknown will not cause any major issues.
- The Port which will be used for the connection, the Timeout window for the connection, and the Minimum Key Size for the transfer.
NOTE: When set to 0, JAMS will use a Minimum Key Size of 1024. The maximum Key Size that can be used is 8192.
- Select the Properties tab
- In the Submit Options section, set the Username to JAMS (or any other user on windows that can execute JAMS Jobs.
- If not running on the local JAMS Server, define an Agent by adding the property.
- The Job is now ready to be submitted ad-hoc or the Scheduled Date and Scheduled Time within the Schedule Trigger can be defined as necessary.