Transfer Configuration details

1. Windows - To configure putty, you have to be logged on to Windows with the user that will run the SFTPPlus service.
   • Open a command prompt and change to the newly created SFTPPlus directory
2. You need to preconfigure SFTP sessions using putty.
   1. Start putty.exe (Windows) or ./putty (Linux/Unix)
   2. Create new session by typing a name in the saved sessions box and pressing save, or load an existing session.
   3. set address to the host name or address of the target system
   4. ensure ssh is selected
   5. set port to the correct ssh port (default 22)
   6. set proxy information as required
   7. save session with NAME (used for savedprofile later).
   8. open session, accept key permanently when prompted and login (if allowed). It is important that the remote hosts key is saved, as the SFTPPlus service has no way of asking the user to accept the key. There is no specific requirement for the logon to proceed, and it is possible that the remote system is configured to prevent such access.

      At this stage it is a good idea to create any required remote directories. If a full login is not permitted, then using psftp interactively is an option.

   9. exit the remote system
3. Make a copy of sample.conf in the conf directory.
4. Edit the new conf file (eg with notepad)

   In this file a line that begins with /* and ends with */ is a comment.

   You will have to set server, port, user, password etc. Each line should be in the format parameter = 'value'.

   1. Remove or comment out the disabled = 'y' line - this stops the definition being activated.
   2. subdir - the subdirectory of inbox that files will be placed in for transfer. All files placed here will be transferred. This directory has to exist.
   3. type - type of transfer, currently only sftp is supported.
   4. direction - get or put (put is default)
   5. server - the server name or address of the target system port - port to connect to, usually 22 for sftp
   6. user - the userid on the remote system
   7. password - the password on the remote system
   8. savedprofile - the profile NAME saved by putty earlier
   9. targetdir - the target directory on the remote system for transferred files (for put only). This is a relative path.
   10. forcelowercase - (put only) use lwer case names for the transfer, ignores the original case of the file
   11. targettimestamp - (put only) include a timestamp at the target for uniqueness 'y' or 'n' (default 'y'). Must be set to 'n' for systems that do not support long filenames.
   12. timestamp - (get only) include a timestamp on the received file for uniqueness 'y' or 'n' (default 'y')
   13. remotedir - the directory the file is to be pulled from on the remote system (get only)
   14. remotefile - the file name to be pulled from the remote system (get only)
   15. starttime - Time for transfer to be started, format is hh:mm (get only) This will be repeated daily at the same time
   16. createmd5sum - will an md5sum file be created 'y' or 'n' (default 'y')
   17. sendmd5sum - the md5sum of the file can also be transferred if required.
   18. preprocess - Allow customised processing before transfer if required. As an example, you may wish to copy the incoming file to another inbox directory to copy this file to multiple destinations.
   19. postprocesssuccess - Allow customised processing after a successful transfer if required.
   20. postprocessfail - Allow customised processing after a failed transfer if required.
   21. Response - (put only) set to y if a response file is to be returned. This would typically be created by the remote system after processing the transferred file. The file will be placed in the response$\backslash$subdir directory, which must exist.
   22. responsein - the filename that should be collected. This can be a plain file name or use %fname% and %ftype% for name and type matching. %ftype% does not include the '.' separator, eg if the file format is FNAMErpt.FTYPE use :
       responsein = '%fname%rpt.%ftype%'
       1. responsedir - the directory where the response file will be collected from on the remote system
       2. responsetimestamp - (put only) include a timestamp in the response file for uniqueness 'y' or 'n' (default 'y').
       3. postprocessresponsesuccess - Allow customised processing after a successful transfer if required.
       4. postprocessresponsefail - Allow customised processing after a failed transfer if required.
   23. maxtry - maximum number of attempts for a transfer. If this is exceeded the transfer will be considered to have failed.
   24. waittime - the time to wait between attempts if a transfer fails
   25. initialwait - the time to wait before looking for a response file.
   26. smtpaddress - the smtp email address for email alerts.
   Create the sub-directory of inbox if it does not already exist. Also create the subdirectory of response if expecting a response file.