1. Enable FTP download: To configure this feature the setting needs to be set to Yes.

Size: px

Start display at page:

Download "1. Enable FTP download: To configure this feature the setting needs to be set to Yes."

Josephine May
5 years ago
Views:

1 Configuration Settings Explained: 1. Enable FTP download: To configure this feature the setting needs to be set to Yes. 2. Hosted by: Client decides who hosts the data (See step 2 Gather Necessary Client Information) 3. Server Name: Depends on which hosting method is used: o Hosted by Client Client provides the Server name o Hosted by IBM IBM provides the Server name (the only option is sftp.brassring.com) 4. Protocol Method: Depends on which hosting method is used: a) Hosted by Client Client choose one of these FTP/SFTP and FTPS (Please note if the client chooses FTPS, then we need to get the certificate from them and a SCCD ticket needs to be opened with Hosting to install the certificate) b) Hosted by IBM - Always FTP and grayed out 5. User name: Provided by who is hosting the FTP site (Client or IBM) o Hosted by Client Client provides the user name o Hosted by IBM Prepopulated and grayed out 6. Password: Provided by who is hosting the FTP site (Client or IBM) Hosted by Client Client provides the password Hosted by IBM Prepopulated and grayed out 7. Port: Provided by who is hosting the FTP site (Client or IBM) Hosted by Client Client provides the port name Hosted by IBM Prepopulated and grayed out 8. Folder: Provided by who is hosting the FTP site (Client or IBM) Hosted by Client Client provides the folder path name Hosted by IBM Hosting provides the folder path name For every FTP server used by DIT, there needs to be a root folder set up with the environment name When IBM hosts, the path for the folder in WB should be full path plus client s name at the end. Please enter it as Hosting provides: /users/root/production/p_cycletown /users/root/production/p_ brown /users/root/staging/s_twistedtree 9. Encryption Type: NOTE: When Hosted By = Kenexa, this will default to PGP and cannot be changed. Encryption is required when IBM hosts the FTP site. When PGP is selected then the

2 KeyID, (Public Key), and File extension fields are enabled. To use PGP Encryption, clients need to provide us with their KeyID and public keys. Hosted by Client PGP is strongly recommended but is not required. If the client would like to encrypt the file, select PGP. Hosted by IBM PGP is defaulted and required 10. Encryption Key ID: NOTE: When Hosted By = Kenexa, this field will be required. Encryption is required when IBM hosts the FTP site. Will become available if Hosted By = Client and Encryption Type = PGP. It is recommended that the client use an address or any other unique combination for this field value. Hosted by Client Client provides encryption key id Hosted by IBM Client provides encryption key id 11. Encryption Public Key: NOTE: When Hosted By = Kenexa, this field will be required. Encryption is required when IBM hosts the FTP site. Made available when Encryption Type is set to PGP. Enter the entire content of the key (copy and paste it here) that was provided by the client. The PGP information needs to have BEGIN PGP PUBLIC KEY BLOCK and END PGP PUBLIC KEY BLOCK with key block values in between. Hosted by Client Client provides encryption public key Hosted by IBM Client provides encryption public key 12. Encryption File Extension: NOTE: When Hosted By = Kenexa, this field will be required. Encryption is required when IBM hosts the FTP site. (Default: Blank) Mad available when Encryption Type is set to PGP. Hosted by Client Client provides encryption file extension Hosted by IBM Client provides encryption file extension 13. Encryption Signed Encrypt: () The Client should inform you if the key needs to be signed. If yes, then give the client IBM s public key. Hosted by Client Client provides encryption sign encrypt Hosted by IBM Client provides encryption sign encrypt 14. Compression: () If the client would like their files zipped (win zipped) when delivered then select Yes. Hosted by Client Client provides compression Hosted by IBM Client provides compression 15. Maximum Retry Attempts: The range of the number of attempts is 1 to 5. This is used in the event of a failure to FTP the files. Hosted by Client Client provides maximum retry attempts Hosted by IBM Client provides maximum retry attempts

3 16. Test & Save: Once all the necessary fields are filled out you have the ability to perform a test. This will validate the FTP configurations. If the data validations are successful and a test FTP connection is made, the window display the below message. Changing the FTP settings may limit access to historic FTP files If the test is unsuccessful an error message will be displayed. Upon confirmation the FTP configuration details are saved to the database. The username, password, server name, and key id fields will be encrypted. Important feature information: Supports encryption (PGP) and compression. To use PGP Encryption, clients need to provide you with their KeyID and public key (we would like them to create the keys). Client should let you know if the key should be signed by IBM. If so, then you will need to provide the client with IBM s public key. If the client is using their FTP site, the DIT will upload the reports to their site. The client will need to provide us with the information highlighted in the FTP settings table below. If they plan on using FTPS, then the client s certificate must be given to our hosting team (to be installed on our servers). IBM uses the Binary transport type for DIT FTP. Therefore, when downloading DIT files from an FTP site, users need to be sure that they are downloading as Binary and NOT ASCII or Auto selection; even though the files might be CSV. IBM Hosting the FTP Site Workbench Options and Values If IBM is hosting the FTP site, the client will need to provide us with the information highlighted in the FTP settings table below. The client will access our site to retrieve the reports. Hence, you will need to provide the client with the site name (sftp.brassring.com/), username and password. Label Type Note Enable FTP, Allowed Values Download (Yes, No) Hosted By (Client, Kenexa) Default: Kenexa Server Name options determined by hosting Default is blank. Based upon this selection, the Protocol, username, password, port, and Encryption Type fields are populated and grayed Protocol 3 options (FTP, FTPS, SFTP) out. 50 char limit Default option selected and grayed out based on Server Name selection. User Name Password Port Folder Text Box Hosting must provide this to the WB user.

4 Encryption Type Defaulted to PGP (required) Default: PGP (No Encryption option is grayed out) Encryption Key ID Text Box Required Valid format or unique value. Encryption Public Text area with 4000 char limit. Required Key Encryption File Extension Encryption Sign Encrypt Compression Maximum Retry Attempts Html validation enforced these options: (*.*.GPG, *.*.PGP, *.GPG, *.PGP) Text Box Required Default - blank Numbers 1 to 5 allowed Client Hosting the FTP Site Workbench Options and Values Label Type Note Enable FTP Download, Allowed Values (Yes, No) Hosted By (Client, IBM) User selects Client Server Name Text Box Provided by the client. Required. 50 char limit Protocol Single select Drop Down Box Default: FTP with 3 options (FTP, FTPS, SFTP) User Name Text Box Provided by the client. 50 character max. Required. Password Text Box Provided by the client. 50 character max. Required. Displays with asterisks as typing. Port Text Box Client must provide this. Numbers only. Required. Folder Text Box Client must provide this. Required. Encryption Type Drop Down Box (No, PGP) Default: Neither Encryption Key ID Text Box Enabled when Encryption Valid format or unique value. Encryption Public Key Text area with 4000 char limit. Html validation enforced Enabled when Encryption Encryption File Extension Encryption Sign Encrypt Compression Single select Drop Down Box, with these options: (*.*.GPG, *.*.PGP, *.GPG, *.PGP) Enabled when Encryption Default - blank

5 Maximum Retry Attempts Text Box Numbers 1 to 5

Quick Reference Guide. Online Courier: File Transfer Protocol (FTP) Signing On. Using FTP Pickup

Quick Reference Guide. Online Courier: File Transfer Protocol (FTP) Signing On. Using FTP Pickup Quick Reference Guide Online Courier: File Transfer Protocol (FTP) With SunTrust Online Courier, you can have reports and files delivered to you using a File Transfer Protocol (FTP) connection. There are