Versions Compared

Old Version 7

changes.mady.by.user Joy McLaughlin

Saved on

compared with

New Version 8

changes.mady.by.user Daniel Rehner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SFTP Exports module gives you the ability to automate and download a daily or weekly export of advising appointments for a term. 

Setup by Client Services

In order to use this feature, your Client Services Manager will need to give you and your instiution access by selecting the SFTP Exports option via the Avaiable Modules box. 

Image Removed

In addition, your Client Service Manager will also Create a New Export and select a Daily or Weekly export job via your institutions school settings. 

Image Removed

Image Removed

Image Removed

After the export has been created and settings have been saved, the next step is to configure your SFTP settings.

Configure your SFTP settings

Note This option enables the user to setup and configure their GradesFirst SFTP settings.  This option should only be changed under the guidance of your institution’s data import specialist.

To configure SFTP settings go to your Admin Settings page by clicking on the arrow located next to your name e.g. "Hello, Joy"  in the top left corner. 

Image Removed

In the options box named Import/Data API click the linkGradesFirst supports daily and weekly exports of certain data. Data files are exported from the GradesFirst system, encrypted using your school's public PGP key, and made available on your SFTP site.

To enable these exports, contact your GradesFirst Client Success Manager.

Configuring your school's PGP key

To configure SFTP and encryption settings:

1. Click on your name at top left and select Admin Settings.

Image Added

2. In the Import/Data API section, click Configure SFTP.

Entering your SSH Public and Export keys 

The Configure SFTP page contains two fields. One for your SSH Public Key and one for your Export Encryption Key. 

Enter your SSH Public key 

Image Removed

  • Enter your PGP / Export Encryption key

    Image Removed
    • Note

    3. Enter and/or verify the ssh public key y

    Image Added

    4. Enter your Export Encryption Key (PGP Key).

    Image Added

    Note Be sure to include the full text of the key from BEGIN to END.

    5.

    Click

    Click Save SSH Public Key.

    For additional information regarding PGP keys and decryption of files please refer to Policies and Procedures.

     Connecting to the server  

         3. Connect to server imports.gradesfirst.com
    • Session - SFTP
    • Host Name- Server name
    • Port Number- 22
    • UserName- Username (provided via the link View My API Key under Admin Settings).

    Image Removed

         4. Verify that the Exports folder is now visible.

    By clicking on the Exports folder you should now see your exported file. Using the right click option on your mouse, choose Download. 

    Image Removed

    This file will be encrypted. To view the appointment information decrypt the file to view the following columns of the export. 

    Image Removed

    The columns on the export will include

     

    Appointment IDPrimary ID (Attendee)Primary ID (Organizer)Appointment Start Date and TimeLocationStudent Service(s) of the appointment

    Image Removed

     

    Once you have set up your Export Encryption Key, your exports will be created on the daily or weekly schedule configured by your Client Success Manager.

    The encrypted export files will be available in an exports folder on your SFTP site at sftp.gradesfirst.com.

    Image Added

    Each file will be encrypted with your school's PGP key.