Georgia State Longitudinal Data System

Transcription

1 Georgia State Longitudinal Data System FTP Client Installation Manual Version 3.0

2 Table of Contents 1 Overview FTP Connection Checklist FTP Installation Instructions Apply license key file Configure the FTP software for your district FTP Connection Checklist Reminder Configuring the FTP Voyager Software Connecting to the FTP Server Uploading Files to the FTP Server File Preparation Scheduling the FTP Uploads General Guidelines Automated Scheduling of FTP Voyager a. SCHEDULING the FTP Uploads i. General Guidelines b. SCHEDULING with FTP Voyager c. Automated Scheduling Batch Job Scheduling of FTP Voyager a. Sending a file from a local to a remote directory b. Synchronizing the data between remote directory and a local c. Sample Log file for File Upload For more information, visit: slds.doe.k12.ga.us Page 2 of 41

3 1 Overview This document explains how to install the Secure File Transfer Protocol (SFTP) software, FTP Voyager, and how to automate the uploading of the Student Course Profile and the Student Record files to the SFTP site. 2 FTP Connection Checklist The following items will be provided by the SLDS implementation team. Please ensure that you have obtained each item prior to connecting to the SFTP site. Users may install the FTP software without the four items listed below but they will not be able to connect SFTP server without a public key, private key, and a private key password. 1. District UserId 2. Public key file (The Public Key will have a.pub file extension.) 3. Private key file (The Private Key will have a.key file extension.) 4. Private key password will be sent to you For more information, visit: slds.doe.k12.ga.us Page 3 of 41

4 3 FTP Installation Instructions 1. Download the client software, FTP Voyager, from GaDOE website Save the zip file and extract to a local folder 4. Run the media file called FTPVoyagerSetup.exe 5. Choose English as the language and click OK. The Setup Wizard appears 6. Choose Next to accept the License Agreement For more information, visit: slds.doe.k12.ga.us Page 4 of 41

5 7. Choose Next Select the Destination Location (select default or choose a specific folder) 8. Choose Next Select the Start Menu Folder For more information, visit: slds.doe.k12.ga.us Page 5 of 41

6 9. Choose Next Select Additional Tasks 10. Choose Next For more information, visit: slds.doe.k12.ga.us Page 6 of 41

7 11. Click the Install button to begin installation For more information, visit: slds.doe.k12.ga.us Page 7 of 41

8 12. Click the Next button to add FTP Voyager as an exception to the Windows Firewall NOTE: This window may or may not pop up depending upon your firewall setup option. For more information, visit: slds.doe.k12.ga.us Page 8 of 41

9 13. Click Finish to complete the FTP Voyager Setup Wizard 14. The FTP Voyager Startup Wizard Welcome page appears For more information, visit: slds.doe.k12.ga.us Page 9 of 41

10 15. Click Next to choose the default Operation Mode (Full mode) 16. Choose Next 17. Choose the default Use PASV Mode For more information, visit: slds.doe.k12.ga.us Page 10 of 41

11 18. Click Finish to complete configuration of the client using the FTP Voyager Startup Wizard The following Welcome screen appears. Click close to close the Tip of the Day. For more information, visit: slds.doe.k12.ga.us Page 11 of 41

12 The FTP Site Profile Manager appears. For more information, visit: slds.doe.k12.ga.us Page 12 of 41

13 4 Apply license key file Please apply the FTP Voyager client license key 1. Go to the local drive where the media zip file has been extracted 2. Run the registration file called FTP_Voyager You will get the below message. Click Yes 3. Click Ok. This step is completed successfully 5 Configure the FTP software for your district. 5.1 FTP Connection Checklist Reminder Please ensure that you have obtained each item prior to attempting to connect to the FTP site. 1. District UserId 2. Public key file (The Public Key will have a.pub file extension.) 3. Private key file (The Private Key will have a.key file extension.) 4. Private key password 5.2 Configuring the FTP Voyager Software 1. Launch the FTP Voyager software. Click Close to close the tips. (If you have not already done so.) 2. Click New Site to create a new site for your district. A window similar to the following screenshot will appear. For more information, visit: slds.doe.k12.ga.us Page 13 of 41

14 Make the following changes as shown below. 3. Change the Name of the site to the name of the district number. In this example, we are using Add County s name to the description 5. Set the FTP site to ftp.gadoe.org 6. Set the default directory to / (forward slash without the begin and end quotes) 7. Uncheck Anonymous Login 8. Set the User ID to the assigned district. Enter the 3 digit district number into the name field. (Note: The district number should match the district number on the Public and Private Keys. It should match the key file provided by the SLDS implementation team.) 9. Leave the password blank For more information, visit: slds.doe.k12.ga.us Page 14 of 41

15 For this instance: Name: 651 Description: FTP Site: ftp.gadoe.org Default Directory: / Uncheck Anonymous Login User ID: your district number Password: leave it blank 10. Click on the Advanced button. This button is the 4 th button on the right hand side of the screenshot shown on the previous page. 11. Select the Security option in Advanced Settings 12. Click on the Connect Using drop-down and select SFTP Using SSH2 (Secure Shell). The port will automatically change from 21 to 22. For more information, visit: slds.doe.k12.ga.us Page 15 of 41

16 For more information, visit: slds.doe.k12.ga.us Page 16 of 41

17 13. Select the Password option under Security and choose the MD5 (S/Key) Ok 14. Click OK to save the Advanced Settings 15. Click Cancel For more information, visit: slds.doe.k12.ga.us Page 17 of 41

18 16. Go to the File Menu bar. Choose View --- Options 17. Choose SSH Options from the Options list and choose SSH Options 18. Select Use compression 19. Select Use public key authentication 20. De-select Use password authentication 21. Select the private key from your local drive. (This file will be sent to you via an from the implementation team. The Private Key will have a.key file extension. The Public Key will have a.pub file extension.) 22. Select the Use private key password check box 23. Enter and confirm the private key password (This information will be sent to you via an by the implementation team.) For more information, visit: slds.doe.k12.ga.us Page 18 of 41

19 24. Click OK to save For more information, visit: slds.doe.k12.ga.us Page 19 of 41

20 6 Connecting to the FTP Server FTP Client Installation Manual To connect, go to the Task Bar on the main FTP Voyager page 1. Choose File --- Connect Using Site Profile Manager 2. Highlight the site that you just created. In this example, Effingham is highlighted in the FTP Site Profiles section. 3. Click Connect to connect to the site. The Status:> will state Listing complete: / if you have successfully connected to the site. For more information, visit: slds.doe.k12.ga.us Page 20 of 41

21 4. The File Voyager page has 6 sections. A brief description of the sections is listed below. Section 1: Displays the name of the FTP site Section 2: Displays the name, size, etc. of files that were uploaded to the FTP site Section 3: This section contains a Local Directory that allows a user to select a folder (from your desktop, My Computer, network drive, etc.) to upload files from. In the example below, the user selected the Voyager Testing folder. Section 4: All of the files listed in the folder from Section 3 above will appear in section 4. Users may select a file to upload by clicking on the file name and then clicking Upload. Section 5: Displays the FTP site connection status. The Status:> will state Listing complete: / if you have successfully connected to the site. Section 6: Displays the name of the file being transmitted. The file name will only appear in this window for a few seconds. Once the file is transmitted this section will be blank. For more information, visit: slds.doe.k12.ga.us Page 21 of 41

22 1 ftp://ftp.gadoe.org For more information, visit: slds.doe.k12.ga.us Page 22 of 41

23 7 Uploading Files to the FTP Server 1. Select the folder that pertains to file that you would like to upload. The folders are located in the middle left section of the page. (Section 3) Users may access any folder that their workstation has access to. In this example, the user selected the Test File folder. Upon clicking on the folder s name, the file(s) in that folder are displayed in Section Highlight the name of the file that you would like to upload. 3. Click the upload button displayed in section 4. A pop-up window will be displayed as soon as the file starts processing. The processing status will also appear in section 6. The File Progress status and the Status in section 6 will be updated based on the processing status. For more information, visit: slds.doe.k12.ga.us Page 23 of 41

24 ftp://ftp.gadoe.org For more information, visit: slds.doe.k12.ga.us Page 24 of 41

25 8 File Preparation File Creation: Create SCP and SR files as you would normally for regular data collection uploads. The file extension should be the same as the extension used for regular data collection extracts. File Placement: Create root folder and name it the system ID number Create two sub-folders under the root folder and name one SCP and the other SR When automated scheduling is set up (mentioned in section 9.2(b)) the entire folder will be transmitted via SFTP and the SCP and SR files will be processed. For more information, visit: slds.doe.k12.ga.us Page 25 of 41

26 9 Scheduling the FTP Uploads The following steps describe how to schedule uploads of data from your local SIS to the secure FTP server. 9.1 General Guidelines 1. To start this procedure as a Service Option 2. You must reconnect to the site on you main FTP Voyager window to see the transferred file in location. 3. FTP Voyager Scheduler must be up and running for job execution at scheduled time(s) 4. A closed Site Profile Manager connection would not inactivate a scheduled FTP Voyager job 5. Users to be provided with 2am FTP transmission location and also users need access to the location from this server 9.2 Automated Scheduling of FTP Voyager a. SCHEDULING the FTP Uploads The following steps describe how to schedule uploads of data from your local SIS to the secure FTP server. i. General Guidelines 1. You must reconnect to the site on you main FTP Voyager window to see the transferred file in location. 2. FTP Voyager Scheduler must be up and running for job execution at scheduled time(s) 3. A closed Site Profile Manager connection would not inactivate a scheduled FTP Voyager job For more information, visit: slds.doe.k12.ga.us Page 26 of 41

27 b. SCHEDULING with FTP Voyager 1. On the main FTP Voyager page, choose Queue -> Start/Show FTP Voyager Scheduler The following page is displayed: 2. Choose New from the Scheduler page and a blank Scheduler Task Settings page will appear. 3. Click on Select to choose the site (FTP Sites Sites Rhinosoft sitename) from which you wish to run the task. Provide a name and a description for the task and check Enabled to schedule a task run. For more information, visit: slds.doe.k12.ga.us Page 27 of 41

28 4. Click on the Schedule tab and provide the frequency of the Schedule task (daily) as well as the date and time at which the task will run. The display below show settings for a one-time task scheduled for Monday, June 18, 2012 at 12:57 PM. For more information, visit: slds.doe.k12.ga.us Page 28 of 41

29 5. Click OK to save the task and return to the Scheduler page as seen below. Note that there is no action (job) associated with the scheduled task as yet. For more information, visit: slds.doe.k12.ga.us Page 29 of 41

30 Local file or folder is the complete path of the file you wish to upload Leave Local is a folder unchecked To associate an action to a task, right-click on the action pane (to the right) and click on the New pop-up that appears. An empty Action page appears. 6. On the Action page perform the following: a. Choose from the drop-down list for Action to perform at scheduled time - Please choose Action as Move Up b. Retain 1 for Order of execution c. Retain (/) as the Remote file or folder d. Check Remote is a folder e. Click Browse File to select the Local file of folder you wish to act upon f. Leave Local is a folder unchecked For more information, visit: slds.doe.k12.ga.us Page 30 of 41

31 7. Click OK to save the Action and associate it with the Schedule For more information, visit: slds.doe.k12.ga.us Page 31 of 41

32 8. At the scheduled time, the job will be executed. The FTP Voyager scheduler window will display the status of the job in the top left quadrant. The bottom left pane will display the log details of the run For more information, visit: slds.doe.k12.ga.us Page 32 of 41

33 c. Automated Scheduling The other step to follow before the Automated Schedule is set up, is to configure the Scheduler to run as system service. The steps are as follows: a. Open FTP Voyager, select Start/Show FTP Voyager Scheduler from the Schedule option on the tool bar as shown below b. The FTP Voyager is displayed as below For more information, visit: slds.doe.k12.ga.us Page 33 of 41

34 c. Go to View and select Options from the dropdown d. When the Options tab opens, check mark the Run as system service and click OK For more information, visit: slds.doe.k12.ga.us Page 34 of 41

35 9.3 Batch Job Scheduling of FTP Voyager a. Sending a file from a local to a remote directory The section documents the upload of a single file from a local directory to the FTP server. "c:\program Files (x86)\rhinosoft.com\ftp Voyager\FTPVoyager.exe" profile="sites.rhinosoft.clayton" autoquit=1 -nostartupwizard -nosplash remote=/ put=d:\tony\sftptesting\voyagertesting\voyagerwork4b.txt logfile=d:\tony\sftptesting\logs\work4.log Each component of the command line is explained below: 1. "c:\program Files (x86)\rhinosoft.com\ftp Voyager\FTPVoyager.exe" -- The full path of the FTPVoyager executable 2. profile="sites.rhinosoft.clayton" The full name of the Site Profile. It can be found in the upper left hand corner of the main page of the FTP Voyager client after establishing a connection to the FTP server. See snapshot below ftp://ftp.gadoe.org For more information, visit: slds.doe.k12.ga.us Page 35 of 41

36 3. autoquit=1 Automatically quit FTP Voyager after starting the command line option 4. -nostartupwizard Disables the initial Startup Wizard 5. nosplash Disables the splash screen at startup 6. remote=/ -- Destination path on the FTP server 7. put=d:\sftptesting\voyagertesting\voyagerwork4b.txt Statement that writes local file to the remote directory 8. logfile=d:\sftptesting\logs\work.log Full path to non-default log file For more information, visit: slds.doe.k12.ga.us Page 36 of 41

37 Remote directory before upload ftp://ftp.gadoe.org Local directory before upload Remote directory after upload of voyagerwork4b.txt ftp://ftp.gadoe.org Local directory after upload of voyagerwork4b.txt

38 b. Synchronizing the data between remote directory and a local The section documents how to synchronize data between a remote directory and a local. "c:\program Files (x86)\rhinosoft.com\ftp Voyager\FTPVoyager.exe" profile="sites.rhinosoft.clayton" autoquit=1 autosync=1 syncoptions=0 -nostartupwizard - nosplash remote=/ local=d:\tony\sftptesting\voyagertesting\ logfile=d:\sftptesting\logs\work4.log Again, each component of the command line is explained below: 1. "c:\program Files (x86)\rhinosoft.com\ftp Voyager\FTPVoyager.exe" -- The full path of the FTPVoyager executable 2. profile="sites.rhinosoft.clayton" The full name of the Site Profile. 3. autoquit=1 Automatically quit FTP Voyager after starting the command line option 4. autosync=1 Automatically synchronize the remote directory with the local with different options 5. syncoptions=0 Synchronize the remote directory only 6. -nostartupwizard Disables the initial Startup Wizard 7. nosplash Disables the splash screen at startup 8. remote=/ -- Destination path on the FTP server 9. local=d:\tony\sftptesting\voyagertesting\ -- Local directory 10. logfile=d:\sftptesting\logs\work.log Full path to non-default log file For more information, visit: slds.doe.k12.ga.us Page 38 of 41

39 Remote directory before directory synchronization ftp://ftp.gadoe.org Local directory before directory synchronization Remote directory after directory synchronization ftp://ftp.gadoe.org Local directory after directory synchronization For more information, visit: slds.doe.k12.ga.us Page 39 of 41

40 c. Sample Log file for File Upload The log below shows the transaction recorded for the upload of following files Voyager Client config.docx, Testscript2.scp and UtilityTest.scp are uploaded to the remote directory 6/8/ :32:01 AM:>FTP Voyager - Version /8/ :32:04 AM:>STATUS:> Connecting to "ftp.gadoe.org" on port 22. 6/8/ :32:04 AM:> SSH Server Version: SSH-2.0-Serv-U_ /8/ :32:04 AM:> Server --> Client encryption: 192 bit aes-cbc 6/8/ :32:04 AM:> Client --> Server encryption: 192 bit aes-cbc 6/8/ :32:04 AM:> Selected public key protocol: ssh-dss 6/8/ :32:04 AM:> Compression: ZLIB 6/8/ :32:05 AM:>STATUS:> Login successful 6/8/ :32:05 AM:>STATUS:> Getting current folder 6/8/ :32:05 AM:> Current folder: / 6/8/ :32:05 AM:>STATUS:> Setting transfer mode to ASCII 6/8/ :32:05 AM:>STATUS:> Listing contents of: / 6/8/ :32:05 AM:> Listing complete: / 6/8/ :32:05 AM:>STATUS:> Connecting to "ftp.gadoe.org" on port 22. 6/8/ :32:05 AM:> SSH Server Version: SSH-2.0-Serv-U_ /8/ :32:05 AM:> Server --> Client encryption: 192 bit aes-cbc 6/8/ :32:05 AM:> Client --> Server encryption: 192 bit aes-cbc 6/8/ :32:05 AM:> Selected public key protocol: ssh-dss 6/8/ :32:05 AM:> Compression: ZLIB 6/8/ :32:06 AM:>STATUS:> Login successful 6/8/ :32:06 AM:>STATUS:> Getting current folder 6/8/ :32:06 AM:> Current folder: / 6/8/ :32:06 AM:>STATUS:> Setting transfer mode to ASCII 6/8/ :32:06 AM:>STATUS:> Listing contents of: / 6/8/ :32:06 AM:>STATUS:> Connecting to "ftp.gadoe.org" on port 22. 6/8/ :32:06 AM:> Listing complete: / 6/8/ :32:06 AM:>STATUS:> Sending: D:\Testscript2.scp -> /Testscript2.scp 6/8/ :32:06 AM:>STATUS:> Setting transfer mode to BINARY 6/8/ :32:06 AM:>STATUS:> Uploading file: /Testscript2.scp 6/8/ :32:06 AM:>STATUS:> Setting date and time of "/Testscript2.scp" to 4/1/ :22:45 AM 6/8/ :32:06 AM:> SSH Server Version: SSH-2.0-Serv-U_ /8/ :32:06 AM:> Server --> Client encryption: 192 bit aes-cbc 6/8/ :32:06 AM:> Client --> Server encryption: 192 bit aes-cbc 6/8/ :32:06 AM:> Selected public key protocol: ssh-dss 6/8/ :32:06 AM:> Compression: ZLIB 6/8/ :32:06 AM:>STATUS:> Sent 411 bytes. 6/8/ :32:06 AM:>STATUS:> Transfer time: 00:00:00.203; 1.98 KB/sec 6/8/ :32:06 AM:>STATUS:> Setting transfer mode to ASCII 6/8/ :32:06 AM:>STATUS:> Listing contents of: / For more information, visit: slds.doe.k12.ga.us Page 40 of 41

41 6/8/ :32:06 AM:> Listing complete: / 6/8/ :32:06 AM:>STATUS:> Sending: D:\UtilityTest.scp -> /UtilityTest.scp 6/8/ :32:06 AM:>STATUS:> Setting transfer mode to BINARY 6/8/ :32:06 AM:>STATUS:> Uploading file: /UtilityTest.scp 6/8/ :32:07 AM:>STATUS:> Setting date and time of "/UtilityTest.scp" to 5/1/ :55:02 PM 6/8/ :32:07 AM:>STATUS:> Login successful 6/8/ :32:07 AM:>STATUS:> Getting current folder 6/8/ :32:07 AM:>STATUS:> Sent 175 bytes. 6/8/ :32:07 AM:>STATUS:> Transfer time: 00:00:00.203; bytes/sec 6/8/ :32:07 AM:>STATUS:> Setting transfer mode to ASCII 6/8/ :32:07 AM:>STATUS:> Listing contents of: / 6/8/ :32:07 AM:> Current folder: / 6/8/ :32:07 AM:>STATUS:> Connecting to "ftp.gadoe.org" on port 22. 6/8/ :32:07 AM:> Listing complete: / 6/8/ :32:07 AM:>STATUS:> Sending: D:\Voyager Client config.docx -> /Voyager Client config.docx 6/8/ :32:07 AM:>STATUS:> Setting transfer mode to BINARY 6/8/ :32:07 AM:>STATUS:> Uploading file: /Voyager Client config.docx 6/8/ :32:12 AM:> SSH Server Version: SSH-2.0-Serv-U_ /8/ :32:12 AM:> Server --> Client encryption: 192 bit aes-cbc 6/8/ :32:12 AM:> Client --> Server encryption: 192 bit aes-cbc 6/8/ :32:12 AM:> Selected public key protocol: ssh-dss 6/8/ :32:12 AM:> Compression: ZLIB 6/8/ :32:13 AM:>STATUS:> Setting date and time of "/Voyager Client config.docx" to 6/6/2011 9:11:44 PM 6/8/ :32:13 AM:>STATUS:> Login successful 6/8/ :32:13 AM:>STATUS:> Getting current folder 6/8/ :32:13 AM:> Current folder: / 6/8/ :32:13 AM:>STATUS:> Sent 1,050,199 bytes. 6/8/ :32:13 AM:>STATUS:> Transfer time: 00:00:05.804; KB/sec For more information, visit: slds.doe.k12.ga.us Page 41 of 41