Document SFTP Importer

Modified on Wed, Feb 28 at 2:06 PM

The Document SFTP Importer (Core.Scheduler Tab) task periodically scans SFTP servers specified on the Documents.Setup.Importer.SFTP Servers tab for documents to import into Student Folders.

By default; the task executes every hour.

SFTP Server Configurations

Multiple servers can be specified.
The path is an optional sub directory of the user. It must exist before the server is enabled. The field is usually blank.
The path must initially be an empty directory.

Sub directories for each Document Type

Every time the Transcribe Document SFTP Importer task runs; it will automatically create sub directories for each document type that exists in the Documents>Setup>Document Types tab.

For example; the File Paths screen here is configured to point at the c:\import directory on a Windows server.

The document types on this server are as follows:

If the server configuration was enabled; when the Transcribe Document Path Importer task runs next; it will automatically create sub directories on that server and look something like this when it is done:

Notice how the Teacher Docs document type was not created.

This is because only document types for student documents are supported at this time.

Importing Student Files

There are several ways that documents can be imported into Genesis

Placing a file in the appropriate sub directory will import the file as that document type.

For example c:\import\MED\123456-1[Test].doc

There are a 4 different ways the file can be named:

Filename Layout	Example Filename	Notes
studentid.ext	123456.pdf	123456 is the studentid; and the document is a PDF.
studentid-ignore.ext	123456-1.pdf 123456-2.pdf	123456 is the studentid; and the document is a PDF. Anything after the - is ignored. This is useful when uploading multiple documents for the same student at the same time.
studentid[title].ext	123456[Welcome Letter].pdf	123456 is the studentid; and the document is a PDF. The text in the [] will be set to the text1 field of the document.
studentid-ignore[title].ext	123456-1[Welcome Letter].pdf	123456 is the studentid; and the document is a PDF. The text in the [] will be set to the text1 field of the document. Anything after the - is ignored. This is useful when uploading multiple documents for the same student at the same time.

ZIP Files containing Student Documents

A zip file containing documents named as above can be placed in the specified directory; where the filename is a document type.zip.

For example; a zip file containing a 123456.pdf, 123457[Hello World].doc could be placed in c:\import\MED.zip.

The documents in that zip file would be imported as MED documents into the appropriate student's folder.

Unrecognized Student Documents

If the imported is unable to find a student to match the imported document, the file and ID will be noted in the error log and the file will be renamed to a ".error" file. So if file 123.pdf is found, and 123 is not a valid student id in Genesis then the file will remain in the import directory with a file name of 123.pdf.error.