During implementation, PDFs from your prior system may be imported into SameGoal, giving staff access to historic documents authored in your previous system even after converting to SameGoal.
Imported PDFs will not bootstrap program participation, deadlines, or reports. In order to bootstrap your SameGoal environment in year one, use the Data Loader tool in addition to the PDF Import tool.
The PDF Import tool associates an unlimited number of documents per student going back arbitrarily many years. Documents are associated by attaching them to existing student records in SameGoal. Because this tool does not create student records, either run a demographics integration or use the Bulk Loader to create student records prior to import.
In order to import PDFs into SameGoal, you must first extract the PDFs from your prior system. For most special programs vendors, you’ll need to submit a request to let the vendor know you are planning to transition from their system and request your data be made available as PDFs. Many vendors provide this service at no cost or for a marginal fee.
Each special programs vendor has a slightly different process, but SameGoal has helped districts transition from a wide variety of systems. Check with your implementation coordinator regarding best practices districts have used previously for transitioning from your particular vendor.
Required: To ensure that the directory being uploaded into an environment is for the desired district, the top directory must be the district's SameGoal domain (e.g. applegrove.org/...) or the import will fail. When initiating a new import, the district's domain will be listed at the top in the blue bar as well as in the Stage 1: Configure and Upload instructions.
- Option 1 (best, typically higher association rate): Create a per-student directory and place all PDFs for a given student in a folder.
- All documents in the directory are assumed to be for a single student.
- As long as at least one document in a given directory is able to be successfully associated with a student, all files in the directory will be associated with that student.
- e.g.: <domain>/students/<student1>/filename.pdf
- Option 2 (typically lower association rate): Place PDFs in any directory structure.
- Each file will need to be associated with a student individually.
- e.g.: <domain>/filename.pdf
- Option 1 (best, typically highest association rate): Include the student ID in the filepath.
- When configuring the import, you will indicate where in the filepath the student ID is located.
- e.g.: <domain>/<studentID>.pdf
- Option 2: Include the student's first and last name in the filepath.
- When configuring the import, you will need to write a regular expression indicating where in the filepath the student first and last name is located (we strongly recommend you contact SameGoal support for assistance).
- e.g.: <domain>/<firstname>_<lastname>.pdf
- Option 3 (typically lowest association rate): Use any filepath.
- Best effort document text extraction is performed only (looking for student identifiers that uniquely identify the student record in SameGoal).
- Documents that do not contain text-based unique student identifiers (e.g. scanned image-only signature pages) will not be attached to a student record (whereas they might have been in options 1 or 2).
- e.g.: <domain>/filename.pdf
The PDF Import Tool bulk imports PDFs in 2 stages. First, files are uploaded into SameGoal by an administrator, then they are automatically associated with the corresponding student.
Steps
To bulk import PDFs:- While logged in as an administrative user, navigate to Settings > PDF Import.
- Select New PDF Import at the bottom of the page.
- Drag a folder from your device into the upload field.
- The directory name must match your SameGoal district domain exactly (see PDF directory and naming conventions).
- Configure the upload by indicating where the Student ID is in the example file path.
- You can indicate if the Student ID is in a folder name or the file name. If the portion of the file path that contains the Student ID also contains other information, you can specify how the information is separated. (Recommended)
- If the Student ID is not present, you can also write a regular expression to indicate where the student’s first and last name is or the system can scan the text content of each PDF to search for student information. (Not recommended)
- Once you have configured the upload, hit the Preview button to preview the success rate of the upload.
- If needed, make changes to your directory or upload configurations.
- Once you are satisfied with the preview, click Continue and stay on the page during this stage of the import (Stage 1: Upload). How long this step takes will depend on the size of the upload and your internet speed (it’s typical for the system to process ~one million files per hour).
- A summary of the number of uploaded documents for processing and any upload errors will appear on screen after Stage 1 is complete.
- Once PDFs have been uploaded to SameGoal servers, they are automatically inspected and associated with the corresponding student in SameGoal when possible (Stage 2: Associate). Because this phase happens server-side, you may close the tab, browser, work on something else in SameGoal or even log out while PDFs are being associated.
- Once Stage 2 is complete, you will receive a notification email with a link to review results. Follow this link to see a summary report to review.
lightbulb Tip
If you find PDFs that should have been associated but were not, address any issues and re-run the PDF Import tool. This can be done as many times as necessary to get the desired results. PDFs that have already been associated will not be re-associated.
After the PDF Import tool is run, review the report to ensure all of the desired PDFs were associated to the correct student record. If you find PDFs that should have been associated but were not, address any issues and re-run the PDF Import tool. This can be done as many times as necessary to get the desired results. You can also manually attach PDFs if you wish.
Steps
To view the results of a PDF import:- Log in to SameGoal as an administrative user.
- Go to Settings > PDF Import.
- Select the import summary you'd like to view.
- Summaries are sorted by the date and time the import tool was run.
- Use the Result and Note columns to review. You may filter on these columns in-app if you're on the Plus or Pro edition of SameGoal. Otherwise, you may download the report and filter the results locally.
- Result: This column shows whether or not the document was associated. Potential results include:
- Associated: The PDF has been associated to the student listed in the Student column.
- Previously Associated / Duplicate: The PDF was already associated with a student in a previous import.
- Not Associated: The PDF was not associated and is less than 3 years old.
- Not Associated (older than 3 fiscal years): The PDF was not associated and is more than 3 years old. The document's age is not the reason it did not associate. However, this note is included since if a PDF is older than 3 fiscal years, it is likely less relevant to current document and might not need to be reimported.
- Note: If the document was not associated, this column lists the reason why. (See the common errors below.)
lightbulb Tip
SameGoal does not store PDFs that were not associated with a student record. It is the responsibility of the district to save and store these documents.
The most common reasons a document is not associated to a student record include:
- Unsupported file type: Only PDFs are imported into SameGoal. No other file types (e.g.: doc, docx, jpeg, etc.) can be associated. If you wish to import a different file-type, you must first convert it to a PDF prior to uploading it to the SameGoal PDF Import tool.
- File is too large: SameGoal only associates PDFs that are allowed by your current tier.
- SameGoal Standard - 50MB
- SameGoal Plus - 100MB
- SameGoal Pro - 150MB
- Student not in SameGoal: The student a PDF should be associated with is not currently in SameGoal (e.g. graduated, transferred, etc. prior to implementation).
- Missing student demographics: Each PDF must meet at least one of the criteria below:
- Have a filepath that contains the student ID.
- Have a filepath that contains the student's first name and last name (Note: a regular expression needs to be written in this case and we strongly recommend you contact SameGoal support for assistance).
- Contain both the (a) student ID and (b) last name in the PDF itself such that text extraction can be used (Note: text extraction cannot be used on image only PDFs).
- Be contained in a per-student directory that that includes at least one other document that is able to be successfully associated with a student.
- The student ID is in the wrong position compared to how the import was configured: When the PDF import is configured, you tell the system where in the filepath the student ID is located. If a given filepath contains the student ID in a different position, it will fail to import. For example:
- If the import is configured based on a filepath of <domain>/<firstname>_<lastname>_<studentID>.pdf, the system will look for the student ID in the third position of the filename.
- But if you have a file with a filepath of <domain>/<lastname>_<studentID>.pdf, the student ID is located in the second position of the filename. Thus, it does not match the import configuration.