Overview
This article walks you through creating an Document Import Task from scratch. This article will focus on importing documents. To import data, visit our <insert data import>.
<insert gif>
Things to know before importing documents:
We support a variety of document types: .pdf, .doc, .docx, .txt, .odt, .jpg, .jpeg, .png, .gif, .csv .ppt, .pptx, .svg, .txt,.xls, .xlsx, .html, .bmp, .htm
Document names should contain a unique identifier so documents can be matched to students upon import
Any documents that go unmatched will end up in the Documents Bin unassigned.
It is important to have your document types, source folders, and file names set up correctly. To learn more about managing document types, see here.
Creating a New Document Import
To create a new document import:
Navigate to Data + Automations > Import + Export.
Click on the + button along the right-hand side.
Select Document, and click Confirm.
Selecting an Import Source
After creating the new document import task, a sidesheet will appear for your new import. The first tab to display will be the Source tab. You can import documents from a Dropbox, SFTP, or Google Drive. In this example, we'll use SFTP to upload a file from your device. After selecting SFTP, click the relevant folder.
Matching
After selecting your folder, you can move to the Matching tab and click to add a rule. Toggle the option "Apply this filter to the main folder and the folder in it" if applicable (i.e. if you have the "Resume" folder within your "Documents" folder in the SFTP).
Select Files
This field is where you define the filename pattern. When you have a identifier in the filename, start typing [ to see the full list of identifiers you can match on.
🚀 Pro tip: If there are other characters in the file name that do not help with matching, you can use * within the file name matching rules. The * means that that part of the file name could contain any alphanumeric characters. Note that the email address, highlighted in orange, is a token and is what connects the file name to the particular student profile. You could also add * after the "." in the file name, meaning that the file format could be .pdf, .docx, or something else and Element451 would still find it by this rule and import it.
Document Type
Incoming documents that meet the filename pattern will be brought with the document type defined on the matching rule.
Tags and Folders
Upon import, add tags to documents or assign them in folders to easily filter for them in the Documents Bin
Filters
By adding filters on the matching rule, you can specify which documents you would like to import based on the size of the file, the date on which the file was created, a token within the file name, or some combination of the three. For example, you might want to set a token filter that only imports files with names such that [user:email_address] contains the value ".edu," or a date filter that only imports documents uploaded since the import was last run.
Preview
The Preview tab will allow you to preview documents that would come in to confirm that everything looks good. The preview will let you know how many documents matched the rules and how many did not.
Run Import
After creating matching rules and previewing the incoming documents, you are ready to move on to running the import task.
Run Import
Click Run Import (if running immediately) or Schedule (if running on schedule). Schedules can mean a one-time run in the future or a repeated run. Learn more about <Scheduling Imports>.
Run History
The Run History tab shows the results of all runs executed by the import. Each run result will show the number of documents added by the run and the number of skipped documents in the folder.