Rostering Sync Setup
If you would like to use SFTP to upload rosters automatically, here are the instructions for how to get that setup.
Step 1: Create the file
The file that you will be uploading to the SFTP server has the same format that you would upload manually thought the web application. For instructions on how to create that file: see Roster File Contents
Step 2: Connect to the SFTP server
Once your roster file is ready, you can connect to the SFTP server with the client of your choosing. For credentials and host information: see Connect to the SFTP Server.
Step 3: Uploading the file
Now that you are connected, you can upload the file to the server. The folder that you will upload this file will be named “2021_2022”. You should not have to create this folder, it will be created for you automatically. The filename does not matter, in the next step you will tell the Forefront system what you named it.
Step 4: Setting up the import
The last step in the process is to tell the Forefront system to import the file you are uploading and tell us when you would like to run the import. First, log into the Forefront system and navigate to the “Jobs” page using the side navigation link.
Below is a screenshot of the Jobs page.
Now click on the “Create Scheduled Job” button in the “Scheduled Jobs” section of the page. This will bring up a modal to help you set up the daily import.
On this modal, you will leave the job type set to “SFTP_IMPORT” and verify that the file you uploaded to the folder shows up. As for the schedule field, this is what determines how often your import will run and when. The value of the Schedule field is a “Cron Expression”. For more information on how to write cron expressions see this Wikipedia article. By default, the job will run at midnight GMT.
One you are happy with the setup, you can click create, and you are all done! The import will automatically run the next time the scheduled time is reached. If you would like to check the file, you can upload it manually using the + icon in the “Jobs” section of the same page you are currently on.
Please do not hesitate to contact our team at email@example.com should you wish to have our team force an upload or for other questions or concerns.