User Text Importer

Modified on Thu, Jun 29, 2023 at 10:03 AM

User Text Importer

What does it do?

The User Text Importer scheduled task will scan a directory for CSV Files (Comma Separated Values) and import the data inside of them into Student and/or Staff User Text fields.  

Expected File Format

  • The file must be a CSV (Comma Separated Values) file.  
  • The first row must contain headers.  The actual header names are ignored during the processing of the file.
  • The first column must be the student id.
  • There then can be any number of pairs of columns that represent User Text Code / User Text Value pairs

 

In this example; each row contains one student id, a user text code and value to update.   The user text code WINLOGONID must exist in the Setup -> Districts -> User Text Codes screen or it will not be imported.

Example File 1 

STUDENT_ID, USER_TEXT_CODE, USER_TEXT_VALUE
1234, WINLOGONID, CZinn
1235, WINLOGONID, RZinn
1236, WINLOGONID, RDilts

 

In this example; each row contains one student id, 2 user text code/value pairs of columns.   The user text codes ADID and AD_EMAIL must exist in the Setup -> Districts -> User Text Codes screen or they will not be imported.

Example File 2 

StudentId, ADCode, ADName, Email, EmailValue
1234, ADID, CZinn, AD_EMAIL, czinn@mycompany.com
1235, ADID, RZinn, AD_EMAIL, rzinn@somewhere.edu
1236, ADID, RDilts, AD_EMAIL, rwdilts@facebook.com

 

In this example, we add staff id (or STAFF_ID) to the file.  This allows you to import Staff User Texts in the file.  Make sure to leave the student id blank when importing for staff.

Example File 2 

student id, staff id, utc, utv
1234,    , WINLOGONID, CZinn
1235,    , WINLOGONID, RZinn
    ,8871, WINLOGONID, TCampbell

Configuration Options:

Path on server to scan for files to import

The task will scan this directory for all files.   For every file it finds; it will try to import it.

 

Delete File After Import

If this option is enabled; the file will be deleted from the directory after it has been processed.

If the file is not deleted; it will be processed over and over again until someone manually removes the file from that directory.

 

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article