TracCloudTechSSO and TracCloudTechImport: Difference between pages

From Redrock Wiki

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{| style="width:100%; vertical-align:top; "
<div style="float: left; margin-top: 0em; margin-right: 1em; margin-bottom: 1em">{{TracCloudTechTOC}}</div>
| style="width:250px; vertical-align:top; padding:2px 15px 2px 2px;" | {{TracCloudTechTOC}}
<b><span style="color:blue"><big>Importing Student Data into TracCloud</big></span></b>
| style="vertical-align:top; padding:20px 20px 20px 2px;" |
{| style="width:100%; vertical-align:top; "
<big><b>TracCloud Single Sign-on Configuration</b></big><br>


TracCloud supports SAML, CAS, and LDAP for user authentication. Information on each of these options is available below.
TracCloud can import data from any source as long as it's provided in the correct format. Using your current Student Information System (Banner, PeopleSoft, DataTel, etc) as a source, create files that match the specifications below. We will require at least two files- A student file and an enrollment/registration file.


We can be reached at [mailto:helpdesk@go-redrock.com helpdesk@go-redrock.com]
<hr>
'''With Redrock Software's Assistance'''
<hr>
==SAML==
To setup SAML authentication, the following steps will need to be completed. <span style="color:red">At least one of the attributes being sent must match the contents of the username field in your Trac System, typically the first part of the email address. We can also use ID number, full email address, or other unique identifiers, but handle/username is preferred.</span>


<big>1. Install our Metadata</big>
<span style="color:red>
Import files must be in a flat-text format (.csv or .txt), comma or tab delimited. Comma delimited files must have quotes surrounding <b>every</b> field, including numeric fields. A header row is required, and custom fields must be coordinated with Redrock Software to ensure assignment to the correct data field. UTF-8 is preferred. File names must be static, with each import upload overwriting the previous copies of the files.
</span>


:Available here: https://sso.trac.cloud/simplesaml/module.php/saml/sp/metadata.php/trac5-saml


<big>2. Send us your Metadata</big>
There are no restrictions on column order, and optional columns can safely be excluded from your file if preferred.


:Either a URL or an XML file.
{| style="width:100%; vertical-align:top; "
 
<big>3. Send us a test account</big>
 
:This makes implementing SAML on your system significantly faster, but isn't required.
 
<hr>
==CAS==
To setup CAS authentication:
 
<big>1. Add Redrock as an authorized service</big>
:Here is our URL: https://sso.trac.cloud/cas_return.php
 
<big>2. Send us your CAS settings</big>
<b>
:*CAS Login URL
:*CAS Validate URL
:*CAS Logout URL
</b>
<hr>
==LDAP==
To setup LDAP authentication:
 
<big>1. Send us your LDAP settings</big>
<b>
:*Server Address
:*Port Number
:*Service account name </b>(if applicable)<b>
:*Service account password </b>(if applicable)<b>
:*Base DN
</b>
 
Multiple base DN searches can be performed if needed.
<hr>
'''Without Redrock Software's Assistance'''
 
If you're comfortable applying changes here and already have the information above, you can put these settings in place with any SysAdmin account. If you're having any trouble with these settings, feel free to reach out to us at [mailto:helpdesk@go-redrock.com helpdesk@go-redrock.com] or  by [https://go-redrock.kayako.com submitting a helpdesk ticket]. LDAP currently requires additional configuration not available to non-Redrock accounts, reach out to us directly if you plan on using LDAP.
<HR>
<div style="float: left; margin-top: 0em; margin-bottom: 1em"><big>SAML Configuration</big></div><div class="mw-collapsible mw-collapsed"><br><br>
<i>Other > Other Options > Preferences > Login & Security Settings > SAML</i>
[[File:5868886.png|800px]]<br><br>
 
<big>1. Install our Metadata</big>
::Redrock Metadata: https://sso.trac.cloud/simplesaml/module.php/saml/sp/metadata.php/trac5-saml
 
 
<big>2. Fill out SAML settings</big>
 
:* <b>Trac Return URL</b>
:::"<span style="color:red"><nowiki>https://traccloud.go-redrock.com/campuscode/trac/ajax.php?proc=sso_validate</nowiki></span>"
:::Replace 'campus code' with your campus code, as seen in your URL. Otherwise static. Must be lowercase.
::If using a custom URL, use that in place of traccloud.go-redrock.com/campuscode
 
:* <b>SAML Relay URL</b>
:::"<span style="color:red"><nowiki>https://saml2.go-redrock.com/relay.php</nowiki></span>"
:::This is static and never changes.
 
:* <b>Authentication Order</b>
:::Your staff may have more than one account type in the Trac System. You can use the "Authentication Order" preference to determine which account type authenticates first.
 
:* <b>Install your Metadata</b>
:::[[File:6tuk56hyttkl68.png|500px]]
:::After submitting, your Entity ID field will be populated automatically.
 
 
<big>3. Retrieve your attributes</big>
:[[File:6556j67k657kuy.png|500px]]
:Navigate to the provided URL in a Private/Incognito browser and login, you will be provided with a list of attributes and their value for the account that you used. Find the attribute that works for your system (e.g., first part of email address) and copy the name of that attribute into the "Attribute containing unique ID" field in TracCloud. This will need to correspond to the Username fields of accounts in the system.
 
 
<big>4. Enable SAML</big>
:Enable the toggle option in the top-right corner of your SAML window to enable SAML authentication for future logins.
:[[File:75kj5yh56j56kj5ryh.png|800px]]
 
 
<big>(Optional) 5. Custom Logout URL</big>
:Directly below your SSO options, you will find a field to input a custom logout URL. This is the URL that users will be taken to when exiting the Trac System, typically used to also end their SSO session.
:[[File:4h546ik5rh56k5j5.png|800px]]
</div>
<HR>
<div style="float: left; margin-top: 0em; margin-bottom: 1em"><big>CAS Configuration</big></div><div class="mw-collapsible mw-collapsed"><br><br>


<i>Other > Other Options > Preferences > Login & Security Settings > CAS</i>
|-
[[File:53754iu576h4j343.png|800px]]
| style="vertical-align:top; " | <HR>
<br><br>
<big>1. Add Redrock as an authorized service</big>
:Here is our URL: https://sso.trac.cloud/cas_return.php


<big>2. Fill out CAS settings</big>
Click the buttons below to view or download example files. The Section Schedule file is optional.
:* <b>CAS Relay URL</b>
:::"<span style="color:red"><nowiki>https://sso.trac.cloud/relay.php</nowiki></span>"
:::This value is static and should not be changed.


:* <b>Ticket URL</b>
[[File:7360533.png|150px|link=https://wiki.go-redrock.com/images/2/21/Students.txt|View Student File]]
:::Place your CAS Login URL here.
[[File:1502208.png|150px|link=https://wiki.go-redrock.com/images/a/ac/Courses.txt|View Course File]]
[[File:2498178.png|150px|link=https://wiki.go-redrock.com/images/a/ae/Schedule.txt|View Section Schedule File]]


:* <b>Ticket Param</b>
|-
:::Typically "<span style="color:red">ticket</span>"
| style="vertical-align:top; font-size:120%; color:#0C3773; " |
<HR>'''Description of Import fields'''
|-
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!Type!!Description
|-
|A##||Alphanumeric field with a specified maximum length
|-
|#B||Big Integer, maximum value of about 9 quintillion, or a 16-digit numeric value
|-
|Date||Date, <span style="color:red>formatted as YYYY-MM-DD</span>
|-
|Double||Decimal # with up to 12 digits precision
|-
|Time||A specific time using a 24-hour format (HH:MM:SS), e.g., 13:45:00
|-
|Duration||A duration stored in number of minutes, e.g., 90
|}
|-
| style="vertical-align:top; font-size:140%; color:#0C3773; " | <HR>'''Available Student Import Fields'''
|-
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!Name!!Type!!Required!!Field Description!!Example
|-
|ID||#B||Yes*||The unique numeric ID of the student, required if Other_ID isn't being used.||19310045
|-
|Other_ID||A40||Yes*||A secondary ID or handle for the student, required if ID isn't being used.||A19310045
|-
|Other_ID2||A40|| ||An optional tertiary ID or handle for the student.||dsmith1990
|-
|Barcode||A80|| ||A barcode ID for the student, required if scanners are used to log students in.||A2609376378
|-
|OtherStatus||A80|| || An optional secondary status. Primary status is set automatically.||Registered
|-
|Legal_First||A80|| ||The legal first name of the student.||David
|-
|First_Name||A80||Yes||The preferred first name of the student.||Dave
|-
|Last_Name||A80||Yes||The last name of the student.||Smith
|-
|Middle||A80|| ||The middle name or initial of the student.||L.
|-
|Street||A80|| ||The street address of the student.||1234 E. Nowhere St.
|-
|Apt||A80|| ||Apartment Number.||#46
|-
|City||A80|| ||City of the student address.||Tempe
|-
|State||A80|| ||The state of the student address. Two-letter formatting displays best.||AZ
|-
|Zip||A10|| ||The zip code of the student address.||88881
|-
|Country||A10|| ||The country of the student address.||USA
|-
|Home_Phone||A20|| ||The student's home phone number.||555-555-5551
|-
|Work_Phone||A20|| ||The student's work phone number.||555-555-5552
|-
|Cell_Phone||A20|| ||The student's cell phone number.||555-555-5553
|-
|Email||A80|| * ||The student's email address. Required if students are going to be receiving emails from TracCloud.||dsmith@school.edu
|-
|Preferred||A20|| ||The student's preferred phone number, 'Home', 'Work', or 'Phone'.||Home
|-
|Username||A80|| * ||The student's username or handle, required if students are going to be logging into TracCloud.||dsmith
|-
|Birthdate||Date|| ||The student's birthdate.||1970-01-01
|-
|Gender||A80|| ||The student's gender.||Male
|-
|Ethnicity||A80|| ||The student's ethnicity.||Caucasian
|-
|Major||A120|| ||The student's major.||Accounting
|-
|Class||A80|| ||The student's class.||SO
|-
|DegreeGoal||A80|| ||The student's degree goal.||AAS
|-
|Cohort||A80|| ||The student's cohort.||2017SP
|-
|College||A80|| ||The student's college.||Nowhere State University
|-
|Grad_Und||A80|| ||The student's graduate status.||Und
|-
|DateStarted||Date|| ||The student's start or enrollment date.||2015-12-01
|-
|DateWithdrawn||Date|| ||The student's withdrawn date.||2015-12-02
|-
|ReasonWithdrawn||A128|| ||The student's withdrawn reason.||Reasons
|-
|GradDate||Date|| ||The student's graduation date.||2020-10-05
|-
|GradDegree||A128|| ||The student's graduate degree.||AAS
|-
|GPA||Double|| ||The student's GPA.||3.2
|-
|AccumHours||Double|| ||The student's total accumulated hours.||46
|-
|Fund||A80|| ||The student's fund.||Federal Work Study
|-
|Pronouns||A80|| ||The student's preferred pronouns.||He/Him/His
|-
|CustomData1-X||A80|| ||Custom fields, available for any purpose. Multiple custom fields can be used.||?
|-
|}


:*<b>Validate URL</b>
|-
:::Place your CAS Validate URL here.
| style="vertical-align:top; font-size:140%; color:#0C3773; " | <HR>'''Available Registration Import Fields'''


:*<b>CAS Version</b>
|-
:::Typically "<span style="color:red">2.0</span>"
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!Name!!Type!!Required!!Description!!Example
|-
|Course.Subject||A40||Yes||The subject in which the student is enrolled.||ACTG
|-
|Course.Course||A20||Yes||The course number.||100
|-
|Course.Title||A120||Yes||The name of the course in which the student is enrolled.||Intro to Accounting
|-
|Section.Code||A80||Yes||The section code.||03
|-
|Section.CRN||A20|| ||The unique course reference number (cannot be reused).||123456789
|-
|Section.Custom1-X||A80|| ||Optional custom fields relating to this section. Multiple custom fields can be used.||?
|-
|Term.Code||A80||Yes||Term number for this enrollment.||2022SP
|-
|Term.ActiveFrom||Date|| ||Active start date.||2022-10-01
|-
|Term.ActiveTo||Date|| ||Active end date.||2022-12-31
|-
|Faculty.OtherID||A80||Yes*||Faculty ID. Only the primary faculty will be imported. Required if this is the only unique faculty identifier.||J25059
|-
|Faculty.FirstName||A80||Yes||Faculty First Name.||Jane
|-
|Faculty.LastName||A80||Yes||Faculty Last Name.||Doe
|-
|Faculty.UserName||A80||Yes*||Faculty Username, only required if faculty members will be logging into TracCloud, or as primary unique identifier.||JDoe
|-
|Faculty.Salutation||A40|| ||Faculty's salutation.||Dr.
|-
|Faculty.Department||A80|| ||Faculty Assigned Department.||M262
|-
|Faculty.Phone||A80|| ||Faculty's phone number.||555-555-5555
|-
|Faculty.Email||A80||Yes||Faculty's email address. Only required if faculty members need to receive emails, or as a primary unique identifier.||jdoe80@school.edu
|-
|Faculty.Custom1-X||A80|| ||Faculty custom fields. Multiple custom fields can be used.||?
|-
|Student.ID||A40||Yes||The ID/OtherID/OtherID2 of the student this registration is assigned to.||A123456789
|-
|Registration.Grade||A4||||The final grade/withdraw code for this registration. Redrock will require a list of possible grades/codes to properly set this up.||B+
|-
|Registration.RegStatus||A30||||An optional registration status that can be used to deactivate certain enrollments.||Dropped
|-
|Registration.Custom1-X||A80|| ||Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades.||?
|}


:*<b>User Name Attribute</b>
|-
:::Typically "<span style="color:red">cas:user</span>"
| style="vertical-align:top; font-size:120%; color:#0C3773; " | <HR>'''Section Schedule Import Fields''' <span style="color:black">(Optional)</span>
|-
| style="vertical-align:top; font-size:100%; " |


:*<b>Trac Return URL</b>
{| cellpadding="5" cellspacing="0" border="1"
:::Place your CAS Logout URL here.
!Name!!Type!!Required!!Description!!Example
|-
|Course.Subject||A40||Yes||The subject.||MAT
|-
|Course.Course||A20||Yes||The course number.||100
|-
|Section.Code||A80||Yes||The section number.||45
|-
| colspan="5" | Alternatively, a section CRN number can be used instead of the basic course information:
|-
|Section.CRN||A20||Yes||The course reference number.||123456789
|-
| colspan="5" | Plus, the schedule data:
|-
|Schedule.Days||A30||Yes||Days of the week, formatted as MONTUEWEDTHUFRISATSUN.||MONFRI
|-
|Schedule.Time||Time||Yes||Schedule start time, military/24-hour format.||13:00:00
|-
|Schedule.Duration||Duration||Yes||The duration of this section schedule in minutes. ||50
|}


<big>3. Enable CAS</big>
<!-- here is the end of the content table -->
:Enable the toggle option in the top-right corner of your CAS window to enable CAS authentication for future logins.
:[[File:J54yh545m56j5j.png|800px]]
</div>
<HR>
|}
|}

Revision as of 12:33, 16 August 2022

Importing Student Data into TracCloud

TracCloud can import data from any source as long as it's provided in the correct format. Using your current Student Information System (Banner, PeopleSoft, DataTel, etc) as a source, create files that match the specifications below. We will require at least two files- A student file and an enrollment/registration file.


Import files must be in a flat-text format (.csv or .txt), comma or tab delimited. Comma delimited files must have quotes surrounding every field, including numeric fields. A header row is required, and custom fields must be coordinated with Redrock Software to ensure assignment to the correct data field. UTF-8 is preferred. File names must be static, with each import upload overwriting the previous copies of the files.


There are no restrictions on column order, and optional columns can safely be excluded from your file if preferred.


Click the buttons below to view or download example files. The Section Schedule file is optional.

View Student File View Course File View Section Schedule File


Description of Import fields
Type Description
A## Alphanumeric field with a specified maximum length
#B Big Integer, maximum value of about 9 quintillion, or a 16-digit numeric value
Date Date, formatted as YYYY-MM-DD
Double Decimal # with up to 12 digits precision
Time A specific time using a 24-hour format (HH:MM:SS), e.g., 13:45:00
Duration A duration stored in number of minutes, e.g., 90

Available Student Import Fields
Name Type Required Field Description Example
ID #B Yes* The unique numeric ID of the student, required if Other_ID isn't being used. 19310045
Other_ID A40 Yes* A secondary ID or handle for the student, required if ID isn't being used. A19310045
Other_ID2 A40 An optional tertiary ID or handle for the student. dsmith1990
Barcode A80 A barcode ID for the student, required if scanners are used to log students in. A2609376378
OtherStatus A80 An optional secondary status. Primary status is set automatically. Registered
Legal_First A80 The legal first name of the student. David
First_Name A80 Yes The preferred first name of the student. Dave
Last_Name A80 Yes The last name of the student. Smith
Middle A80 The middle name or initial of the student. L.
Street A80 The street address of the student. 1234 E. Nowhere St.
Apt A80 Apartment Number. #46
City A80 City of the student address. Tempe
State A80 The state of the student address. Two-letter formatting displays best. AZ
Zip A10 The zip code of the student address. 88881
Country A10 The country of the student address. USA
Home_Phone A20 The student's home phone number. 555-555-5551
Work_Phone A20 The student's work phone number. 555-555-5552
Cell_Phone A20 The student's cell phone number. 555-555-5553
Email A80 * The student's email address. Required if students are going to be receiving emails from TracCloud. dsmith@school.edu
Preferred A20 The student's preferred phone number, 'Home', 'Work', or 'Phone'. Home
Username A80 * The student's username or handle, required if students are going to be logging into TracCloud. dsmith
Birthdate Date The student's birthdate. 1970-01-01
Gender A80 The student's gender. Male
Ethnicity A80 The student's ethnicity. Caucasian
Major A120 The student's major. Accounting
Class A80 The student's class. SO
DegreeGoal A80 The student's degree goal. AAS
Cohort A80 The student's cohort. 2017SP
College A80 The student's college. Nowhere State University
Grad_Und A80 The student's graduate status. Und
DateStarted Date The student's start or enrollment date. 2015-12-01
DateWithdrawn Date The student's withdrawn date. 2015-12-02
ReasonWithdrawn A128 The student's withdrawn reason. Reasons
GradDate Date The student's graduation date. 2020-10-05
GradDegree A128 The student's graduate degree. AAS
GPA Double The student's GPA. 3.2
AccumHours Double The student's total accumulated hours. 46
Fund A80 The student's fund. Federal Work Study
Pronouns A80 The student's preferred pronouns. He/Him/His
CustomData1-X A80 Custom fields, available for any purpose. Multiple custom fields can be used. ?

Available Registration Import Fields
Name Type Required Description Example
Course.Subject A40 Yes The subject in which the student is enrolled. ACTG
Course.Course A20 Yes The course number. 100
Course.Title A120 Yes The name of the course in which the student is enrolled. Intro to Accounting
Section.Code A80 Yes The section code. 03
Section.CRN A20 The unique course reference number (cannot be reused). 123456789
Section.Custom1-X A80 Optional custom fields relating to this section. Multiple custom fields can be used. ?
Term.Code A80 Yes Term number for this enrollment. 2022SP
Term.ActiveFrom Date Active start date. 2022-10-01
Term.ActiveTo Date Active end date. 2022-12-31
Faculty.OtherID A80 Yes* Faculty ID. Only the primary faculty will be imported. Required if this is the only unique faculty identifier. J25059
Faculty.FirstName A80 Yes Faculty First Name. Jane
Faculty.LastName A80 Yes Faculty Last Name. Doe
Faculty.UserName A80 Yes* Faculty Username, only required if faculty members will be logging into TracCloud, or as primary unique identifier. JDoe
Faculty.Salutation A40 Faculty's salutation. Dr.
Faculty.Department A80 Faculty Assigned Department. M262
Faculty.Phone A80 Faculty's phone number. 555-555-5555
Faculty.Email A80 Yes Faculty's email address. Only required if faculty members need to receive emails, or as a primary unique identifier. jdoe80@school.edu
Faculty.Custom1-X A80 Faculty custom fields. Multiple custom fields can be used. ?
Student.ID A40 Yes The ID/OtherID/OtherID2 of the student this registration is assigned to. A123456789
Registration.Grade A4 The final grade/withdraw code for this registration. Redrock will require a list of possible grades/codes to properly set this up. B+
Registration.RegStatus A30 An optional registration status that can be used to deactivate certain enrollments. Dropped
Registration.Custom1-X A80 Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades. ?

Section Schedule Import Fields (Optional)
Name Type Required Description Example
Course.Subject A40 Yes The subject. MAT
Course.Course A20 Yes The course number. 100
Section.Code A80 Yes The section number. 45
Alternatively, a section CRN number can be used instead of the basic course information:
Section.CRN A20 Yes The course reference number. 123456789
Plus, the schedule data:
Schedule.Days A30 Yes Days of the week, formatted as MONTUEWEDTHUFRISATSUN. MONFRI
Schedule.Time Time Yes Schedule start time, military/24-hour format. 13:00:00
Schedule.Duration Duration Yes The duration of this section schedule in minutes. 50