Here's how it works
uConnect sets up a dedicated Amazon S3 Bucket and access credentials for each school. The school will upload the student list as a CSV file (the file should follow the RFC 4180 standard) using an S3 client or HTTP PUT commands to the assigned bucket. Values should be separated by a comma, and fields containing a comma must be quoted (with double quotes).
Once the first file is uploaded, uConnect will review and then enable the auto sync for them. The file needs to be in CSV format, and must include the following headers: first_name, last_name, email, user_ID or user_login, graduation (please see the charts below for more information on optional and required fields).*
Our team will need to use a unique identifier that matches with an attribute we receive through the SSO integration, so when someone authenticates via SSO we can match it with the users who were preloaded to uConnect through the SIS sync using that identifier.
The unique identifier can be the email_address field. In some cases, email_address is not provided in the attributes we receive via SSO, but only the SSO login name/username, or another unique identifier. When this occurs, we'll need that attribute also available in the SIS sync, under sso_login_name or student_id. Subsequent uploads of the .csv file must overwrite the existing file. uConnect can only process a single file, and if your platform serves different populations (e.g. undergrads, grads, and alumni) and you'd like to upload them into your platform, each should be combined into a single list and a USER_TYPE field should be added, identifying the user type.
A user (with a unique email address, user ID, or login name) can only have one record in the file. (e.g. you cannot have a user with the same ID or email address listed both as a current student and an alumni).
Please note that if you plan on including multiple types of data, for example graduate and undergraduate data, this will need to be added into a single list, with a column added (e.g. study_level) that includes fields indicating Graduate or Undergraduate for each user. The uConnect team will then map it to those user types in your uConnect platform. All additional information you wish to provide should be included in one additional column, with multiple values separated with a ';' (for information like affinity grouping, majors, etc.) for us to map upon import.
Note that with the SIS integration, if a student has opted out of receiving emails previously, or has customized their email preferences, they will remain unchanged.
Additionally, the .csv file must have a header record, and at least 1 data record- otherwise it will be ignored and not processed. (this protects users from getting deleted).
You can use any tool of your preference to upload the file to your assigned Amazon S3 Bucket and automate it, but here is an example of how to do it in a Linux environment.
Please note that the sync is weekly (currently every Saturday night).
If you already have an SIS integration and would like to ask some follow up questions, please contact us at firstname.lastname@example.org.
If you don't already have an SIS integration and are interested in setting up one, please contact email@example.com.
*Below is a list of required and optional core fields you can include :
Required. Records with an invalid or blank value for EMAIL are ignored.
USER_ID or USER_LOGIN
If EMAIL cannot be used as a persistent unique identifier, or if the one provided in the list upload does not match the one passed via SSO, then one of the USER_ID or USER_LOGIN is required and they serve two purposes:
Required only if a Class Year tags is used, and you'd like to send messages to users based on their class year.
This should be provided as a 4-digit value, e.g. 2025, and that is how the graduation value is stored in uConnect. If provided as a full date, uConnect uses 8/31 as the cutoff date to map them to a graduation year.
Optional. If you have separate uConnect communities for different study levels and user types under the People/Audience community group (e.g. Undergraduate Students, Graduate Students, and Alumni), then providing a USER_TYPE field is required to have users assigned to the right communities. You may only provide one user type/study level for a user.
An option flag to opt out a user from all email communications. Can be set to 1, YES, or TRUE, any other values are interpreted as NO (case-insensitive)
An option flag to delete an existing user. Can be set to 1, YES, or TRUE, any other values are interpreted as NO (case-insensitive)
In addition to the core fields above, you may include extra optional fields (e.g. PROGRAM, AFFINITY, …) to pre-assign users to your uConnect Communities.
There are some requirements and considerations for these optional fields:
There is a 1:1 mapping between the extra fields and your uConnect Community Groups:
You may include only 1 extra column for each one of your uConnect community groups.
An extra field can be used to populate tags of only 1 of the community groups.
There is a many:1 mapping between the field values and the communities under the target community group of the extra field:
You can have multiple individual values mapped to a single community.
You cannot map a combination of multiple values to a single community.
If the header name does not match your target uConnect community group, or the field values do not match the communities under the target community group, you need to provide a supporting document describing the mapping.
Fields containing multiple values/communities for a community group must separate the values by a semicolon.