OIT has migrated to the use of a Managed File Transfer (MFT) server for transmission of files between Feeder Systems and KFS. The legacy SFTP server is still being used for Feeder Systems already established using SFTP and which lack the resources to migrate to the MFT. Both MFT and SFTP function in similar fashion and SFTP clients can be used on both servers to upload or download files.
Transmission Servers
MFT Production: xfer.oit.uci.edu
MFT Development: xfer-dev.oit.uci.edu
Legacy SFTP Production: xfer.adcom.uci.edu
Legacy SFTP Development: xfer-test.adcom.uci.edu
Legacy SFTP XFER Logon ID For Transferring Files
Your system or department must have a logon id to the OIT SFTP server used by KFS in order to upload and download files. This SFTP server is named xfer.adcom.uci.edu for Production and xfer-test.adcom.uci.edu for TestDevelopment. You can find your system or department and the xfer logon id on the page KFS Origin Code Mapping from FS Sub System ID. If your system or department is not found, you may make a request by sending an email to kfs-developers@uci.edu.
Requirements
- The Accounting office must approve of all file feeds to KFS before such files are sent to the production environment. Please contact Accounting and include them in the verification of your data uploads as part of the process.
Recommended SFTP Tools
Create Private And Public Keys For Your XFER Logon ID
If you are using the PuTTY package, it comes with a tool called PuTTYgen (PuTTY Key Generator).
- Run PuTTYgen
- Parameters SSH-2 RSA and number of bits 1024 should be sufficient, these are the default parameters.
- Click on the Generate button to create a public/private key pair and move your mouse as instructed in the blank area of the window.
- Edit the Key comment field by adding your xfer logon id at the beginning for example: kfsucop-rsa-key-20121120. This will helps us identify your key.
- If you plan to automate the file transfer do NOT enter a Key passphrase, otherwise you will be prompted for the passphrase every time you try to connect.
- Click on the Save the public key button. Save it in a secure area.
- Click on the Save the private key button. Save it in a secure area.
- IMPORTANT: Only if you will be connecting from a Solaris Unix server, you will need to convert your private key to OpenSSH. Do this through PuTTYgen by: Go to Conversions->Export OpenSSH and export your private key.
- From the display you will see the public key displayed in the Public key for pasting into OpenSSH. Copy the public key displayed into your clipboard by selecting it.
- Provide the public key to OIT via email (mpsevill@uci.edu, bccraft@uci.edu, mangrich@uci.edu) by pasting the public key in the body of the email. Let us know your xfer logon id and that this is the key to use for KFS upload and download files in XFER.
- Keep the private key in a safe place and do not share it.
- Below is an example of how it should look.
Using SFTP To Connect To xfer.adcom.uci.edu or xfer-test.adcom.uci.edu
This is how you would connect to XFER using WinSCP as your client. Your public key must have been installed by the XFER systems administrators to be able to connect.
...
- Test your connection by clicking on the Login button.
- Once connected you should see something similar to the screenshot below. You should be able to transfer your files.
File Naming Conventions
- Place files being sent to KFS in the upload directory. The download directory will contain any files sent from KFS to your system.
- The file name must start with the file type to correctly identify it (kfsgl_, kfspdp_, kfschk_, fs_, pal_) followed by the xfer logon id (kfsac, kfssb, etc.)
- Make sure to use lowercase for the file names, as the system is case sensitive, this is especially important for the file extension and also the identifier at the beginning.
- It would be useful to end the file names with a timestamp before the extension.
- For example kfsgl_20121130161901.xml (for Collector XML file) or kfsgl_20121130161901.data (Collector flat file), the timestamp in this case is November 30th, 2012 4:19:01 pm.
- The reason why this is preferable as opposed to using a static file name is because in KFS you can upload multiple files and this way you do not overwrite an existing file that has not been processed. KFS will process the multiple files together.
- If your system will be using the GL Black Box please use the prefix fs_ along with the .dat extension, for example fs_20131130161901.dat.
- If your system will be using the PDP Black Box please use the prefix pal_ along with the .dat extension, for example pal_20131130161901.dat.
Once a file is moved from XFER to the KFS staging area it will be renamed with a .staged file extension. These files will be removed from the server probably once a month.
File Purpose XFER Directory Naming Convention Example GL Collector XML Feed upload kfsgl_LOGONID_YYYYMMDDHHMMSS.xml kfsgl_kfssb_20121130161901.xml (for Collector XML file) GL Collector Flat File Feed upload kfsgl_LOGONID_YYYYMMDDHHMMSS.data kfsgl_kfssb_20121130161901.data (Collector flat file) PDP Payment XML Feed upload kfspdp_LOGONID_YYYYMMDDHHMMSS.xml kfspdp_kfssb_20121130161901.xml PDP Check Cancellation upload kfschkcancel_LOGONID_YYYYMMDDHHMMSS.data kfschkcancel_kfssb_20121130161901.data FS Legacy GL Flat File upload fs_LOGONID_YYYYMMDDHHMMSS.dat fs_kfssb_20131130161901.dat PAL Legacy Payment Flat File upload pal_LOGONID_YYYYMMDDHHMMSS.dat pal_kfssb_20131130161901.dat Electronic Invoices upload kfsinv_LOGONID_VENDOR_YYYYMMDDHHMMSS.xml kfsinv_kfsei_NewEngland_62_20121130161901.xml Payroll Budget Costing File* upload/budget biweekly_YYYYMMDD_POPULATION_costtran
monthly_YYYYMMDD_POPULATION_costtranbiweekly_20140511_exsx_costtran
monthly_20140511_exsx_costtranDisbursement Voucher File upload kfsdv_LOGONID_YYYYMDDHHMMSS.csv kfsdv_kfsme_20151118093812.csv PDP Check Feedback Flat File download kfschk_LOGONID_YYYYMMDDHHMMSS.dat kfschk_kfssb_20131130161901.dat Check File* download pdp_check_YYYYMMDD_HHMMSS.xml pdp_check_20131130_161901.xml ACH File* download pdp_ach_YYYYMMDD_HHMMSS.xml pdp_check_20131130_161901.xml Vendor File - outgoing download kfskvo_LOGONID_YYYYMMDDHHMMSS.dat kfskvo_kfsmc_20131130161901.dat Vendor File - incoming upload kfsvendor_LOGONID_YYYYMMDDHHMMSSS.data kfsvendor_kfsaprk_201705151434123.data PDP Payment Load Summary* download paymentLoadSummary_LOGONID_ENV_kfspdp_LOGONID_YYYYMMDDHHMMSS.xml paymentLoadSummary_kfssb_int_kfspdp_kfssb_20140415140758.xml EDD File* download de542_YYYYMMDDHHMMSS_ENV.txt.asc de542_20140716200022_prd.txt.asc 1042s File* download NRApaymentExtract_YYYYMMDD-HH-MM-SS_ENV.csv.asc NRApaymentExtract_20140101-20141231_prd.csv.asc *Internal files
Sample SFTP Unix Shell Script
#!/bin/sh ############################################################################## # By: Developer's Name # Date: 12/06/2012 # Purpose: Connects to XFER ############################################################################## source_host="kfsuser@xfer.adcom.uci.edu" batchfile="sftp_xfer_commands.bat" cd `dirname $0` echo "SFTP into kfsuser" /usr/bin/sftp -oIdentityFile=~/.ssh/kfsuser_private_key -b ${batchfile} ${source_host} |
|---|
...