Introduction

In the Regent Query Tool, users define search criteria and the system identifies and returns student records from across the population that meet the entered criteria.

This page defines the Objects, Properties, Data Value Operators, and Data Values that can be used to build a query using the Editor within the tool.

Overview

Within the Query Tool Editor, query parameters are defined within Rules. Rules can be associated to one another using the Query Operators AND, OR, and NOT. Rules can be defined as part of a Group, and Groups can be associated to other Groups and Rules by the Query Operators AND, OR. and NOT.

A rule consists of a Property of an Object and Data Value for the Property, using a defined Data Value Operator. Available Data Value Operators within a rule depend on the Data Value Operator Type for the Property.

Objects

Object Name	Properties Used as Array of the Object	Definition

Object Name	Properties Used as Array of the Object	Definition
Academic Plan		Provides property selections, such as units and current SAP status.
Academic Year	√	Provides property selections, such as Academic Year FAY, dates, and associated Unmet Cost and Unmet Need.
Award	√	Provides property selections for awards, such as fund, Academic Year and Loan Period dates, FAY, amounts, and associated award status.
Document	√	Provides property selections for documents, such as name, dates, FAY, scope, and associated document status.
ISIR	√	Provides property selections for ISIRs, including but not limited to: FAY, dependency status, dates, comment codes and grade level.
Payment Period	√	Provides property selections for payment periods, such as name, dates, units, grade level, program, and associated SAP status.
Payment Period Award	√	Provides property selections for payment period awards, such as fund, Academic Year dates, FAY, amounts, and associated award status.
Resource	√	Provides property selections for resources, such as name, Payment Period dates, and amounts.
Smart Form Question	√	Provides property selections for Smart Forms, including Smart Form Codes, Question Codes, and Response Values.
Student Address	√	Provides property selections for Student Address, such as Address Type, Source, County, and State.
Student Data		Provides property selections for Student Data, including but not limited to Program Information, Location Information, High School Information, Graduate vs. Undergraduate GPA, Citizenship, Race/Ethnicity, Gender, and Disability Status.
User Defined Field	√	Provides property selections for User Defined Fiedl name and values.

* Objects Names use Pascal Case

Data Value Operators

Operators	String	Number	Date	Boolean	String array

Operators	String	Number	Date	Boolean	String array
Less Than (<)		√	√
Less than or equal (<=)		√	√
Greater than (>)		√	√
Greater than or equal (>=)		√	√
Between (BETWEEN)		√	√
Not between (NOT BETWEEN)		√	√
Is empty (IS EMPTY)	√	√	√
Is not empty (IS NOT EMPTY)	√	√	√
Equals (==)	√	√	√	√
Not Equals (!=)	√	√	√	√
Contains (CONTAINS)	√
Not contains (NOT CONTAINS)	√
Starts with (STARTS WITH)	√
Ends with (ENDS WITH)	√
In	√				√
Not In	√				√

Properties and Data Values

Object	Query Property Name	RQL Object	Definition	Data Value Operator Type	Data Value Field Type	Data Value	RQL Option Names	Cache Name	Cache Path	Analysis Context	Release

Object	Query Property Name	RQL Object	Definition	Data Value Operator Type	Data Value Field Type	Data Value	RQL Option Names	Cache Name	Cache Path	Analysis Context	Release
Academic Plan	-	AcademicPlan	-	-	-	-	-	-	-	-	6.0
	Completed Units	completedUnits	Returns students based on any Completed Units listed at the top of the Academic Plan and provided for each course on the Courses tab, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 45	completeUnits	academicPlan/completedUnits	analysisContext.ActivePlan.CumulativeUnitsEarned
	Current SAP Status	currentSAPStatus	Returns students based on any Current SAP Status listed on the Summary --> Student Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	FA Probation FA Suspended FA Warning MTF Suspended Not Calculated Satisfactory	Probation Suspended Warning MTFSuspended NotCalculated Satisfactory Format Example: "Warning"	currentSAPStatus	academicPlan/currentSAPStatus	analysisContext.ActivePlan.currentSAPStatus
	External Transfer Units	externalTransferUnits	Returns students based on any External Transfer Units provided for each course on the Courses tab, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 24	externalTransferUnits	academicPlan/externalTransferUnits	analysisContext.ActivePlan.externalTransferUnits
	Internal Transfer Units	internalTransferUnits	Returns students based on any Internal Transfer Units provided for each course on the Courses tab, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 24	internalTransferUnits	academicPlan/internalTransferUnits	analysisContext.ActivePlan.internalTransferUnits
	Program Transfer Units	effectiveTransferUnits	Returns students based on any Program Transfer Units listed at the top of the Academic Plan and provided for each course on the Courses tab, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 48	effectiveTransferUnits	academicPlan/effectiveTransferUnits	analysisContext.ActivePlan.effectiveTransferUnits
Academic Year	-	AcademicYear[]	-	-	-	-	-	-	-	-	6.0
	End Date	endDate	Returns students based on any Academic Year End Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/endDate	analysisContext.ActivePlan.AcademicYears.EndDate
	FAY	federalAwardYearName	Returns students based on any Academic Year FAY on the Academic Plan, per query parameters.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: 2023-2024	federalAwardYearName	academicPlan/academicYears/federalAwardYearName	analysisContext.ActivePlan.AcademicYears.federalAwardYearName
	Start Date	startDate	Returns students based on any Academic Year Start Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/startDate	analysisContext.ActivePlan.AcademicYears.StartDate
	Unmet Cost	unmetCost	Returns students based on the Unmet Cost for any Academic Year on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 100	unmetCost	academicPlan/academicYears/unmetCost	analysisContext.ActivePlan.AcademicYears.unmetCost
	Unmet Need	unmetNeed	Returns students based on the Unmet Need for any Academic Year on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3500	unmetNeed	academicPlan/academicYears/unmetNeed	analysisContext.ActivePlan.AcademicYears.unmetNeed
Award	-	Award[]	-	-	-	-	-	-	-	-	6.0
	Academic Year Start Date	academicYearStartDate	Returns students based on any Academic Year Start Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/startDate	analysisContext.ActivePlan.AllAwards.academicYearStartDate
	Academic Year End Date	academicYearStartDate	Returns students based on any Academic Year End Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/endDate	analysisContext.ActivePlan.AllAwards.academicYearEndDate
	FAY	federalAwardYearName	Returns students based on any FAY on the Academic Plan, per query parameters.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: 2023-2024	federalAwardYearName	academicPlan/academicYears/federalAwardYearName	analysisContext.ActivePlan.AllAwards.LoanPeriod.federalAwardYearName
	Fund Name	fundName	Returns students based on Fund Name for any Award on the Academic Plan, per query parameters.	String	Dropdown	Fund Name from Fund Setup listed alpha-numerically	Uses Fund Name from Fund Setup Format Example: "Academic Achievement Grant" Note: If fund name includes spaces, the RQL Name will also include spaces.	fundName	academicPlan/academicYears/awards/fundName	analysisContext.ActivePlan.AllAwards.Fund.Name
	Gross Amount	grossAmount	Returns students based on Gross Amount for any Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 4500	amount	academicPlan/academicYears/awards/amount	analysisContext.ActivePlan.AllAwards.amount
	Loan Period End Date	loanPeriodEnd	Returns students based on any Loan Period End Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/awards/loanPeriod/endDate	analysisContext.ActivePlan.AllAwards.LoanPeriod.EndDate
	Loan Period Start Date	loanPeriodStart	Returns students based on any Loan Period Start Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/awards/loanPeriod/startDate	analysisContext.ActivePlan.AllAwards.LoanPeriod.StartDate
	Net Amount	netAmount	Returns students based on Net Amount for any Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3434	netAmount	academicPlan/academicYears/awards/netAmount	analysisContext.ActivePlan.AllAwards.netAmount
	Paid Amount	paidAmount	Returns students based on Paid Amount for any Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3434	paidAmount	academicPlan/academicYears/awards/paidAmount	analysisContext.ActivePlan.AllAwards.paidAmount
	Status	status	Returns students based on Status for any Award on the Academic Plan, per query parameters.	String	Dropdown	Accepted Cancelled Declined Estimated Offered Unfunded	Accepted Cancelled Declined Estimated Offered Unfunded Format Example: “Accepted”	awardStatus	academicPlan/academicYears/awards/awardStatus	analysisContext.ActivePlan.AllAwards.awardStatus
Document	-	Document[]	-	-	-	-	-	-	-	-	6.0
	Academic Year End Date	academicYearEndDate	Returns student records based on the Academic Year End Date for any Academic Year Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	academicYearEndDate	student/documents/academicYearEndDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.academicYearEndDate
	Academic Year Start Date	academicYearStartDate	Returns student records based on the Academic Year Start Date for any Academic Year Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	academicYearStartDate	student/documents/academicYearStartDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.academicYearStartDate
	Expiration Date	expirationDate	Returns student records based on the Expiration Date for any Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	expirationDate	student/documents/expirationDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.ExpirationDate
	FAY	federalAwardYearName	Returns students based on any FAY on the Academic Plan, per query parameters.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: 2023-2024	federalAwardYearName	student/documents/federalAwardYearName	analysisContext.ActivePlan.GeneratedDocumentRequirements.federalAwardYearName
	Name	name	Returns student records based on the Document Name on Document Setup for any Document Requirement, per query parameters.	String	Dropdown	Document Name listed in Document Setup alpha-numerically	Document Name in Document Setup Format Example: 2023-07-10	name	student/documents/name	analysisContext.ActivePlan.GeneratedDocumentRequirements.name
	Payment Period End Date	paymentPeriodEndDate	Returns student records based on the Payment Period End Date for any Payment Period Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	paymentPeriodEndDate	documents/paymentPeriodEndDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.paymentPeriodEndDate
	Payment Period Start Date	paymentPeriodStartDate	Returns student records based on the Payment Period Start Date for any Payment Period Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	paymentPeriodStartDate	student/documents/paymentPeriodStartDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.paymentPeriodStartDate
	Received Date	receivedDate	Returns student records based on the Received Date for any Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	receivedDate	student/documents/receivedDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.ReceivedDate
	Scope	documentScope	Returns student records based on the Document Scope for any Document Requirement, per query parameters.	String	Dropdown	Academic Year Federal Award Year Payment Period Student	ACADEMICYEAR FEDERALAWARDYEAR PAYMENTPERIOD STUDENT Format Example: FEDERALAWARDYEAR	documentScope	student/documents/documentScope	analysisContext.ActivePlan.GeneratedDocumentRequirements.documentScope
	Status	documentRequirementStatus	Returns student records based on the Document Status for any Document Requirement, per query parameters.	String	Dropdown	Incomplete Needed Received Satisfied Unsatisfactory	INCOMPLETE NEEDED RECEIVED SATISFIED UNSATISFACTORY Format Example: "SATISFIED"	documentRequirementStatus	student/documents/documentRequirementStatus	analysisContext.ActivePlan.GeneratedDocumentRequirements.documentRequirementStatus
ISIR	-	ISIR[]	-	-	-	-	-	-	-	-	6.0
	1st Bachelor's Degree By	firstBachelorsDegreeBy	Returns student records based on 1st Bachelor's Degree By on any active ISIRs, per query parameters.	String	Dropdown	No Yes	No Yes Format Example: "Yes"	firstBachelorsDegreeBy	academicPlan/student/isirs/isFirstBachelorDegreeReceived	analysisContext.StudentContext.ISIRs.isFirstBachelorDegreeReceived
	1st Bachelor's Degree	isFirstBachelorDegreeReceived	Returns student records based on 1st Bachelor's Degree on any active ISIRs, per query parameters.	String	Dropdown	No Yes	No Yes Format Example: "Yes"	isFirstBachelorDegreeReceived	academicPlan/student/isirs/isFirstBachelorDegreeReceived	analysisContext.StudentContext.ISIRs.isFirstBachelorDegreeReceived
	Application Receipt Date	applicationReceiptDate	Returns student records based on Application Receipt Date on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	applicationReceiptDate	academicPlan/student/isirs/applicationReceiptDate	analysisContext.Student.ISIRs.ApplicationReceiptDate
	Citizenship Status	citizenshipStatus	Returns student records based on Citizenship Status on any active ISIRs, per query parameters.	String	Dropdown	Blank Eligible Non Citizen Non Citizen or Eligible Non Citizen US Citizen	Blank EligibleNonCitizen NonCitizenOrEligibleNonCitizen USCitizen Format Example: "USCitizen"	citizenshipStatus	academicPlan/student/isirs/citizenshipStatus	analysisContext.Student.ISIRs.citizenshipStatus
	Comment Codes	commentCodes	Returns student records based on Comment Codes on any active ISIRs, per query parameters.	String Array	Dropdown	01 through 408 901 902 999	001 through 408 901 902 999 Format Example: "001, 072"	commentCodes	academicPlan/student/isirs/commentCodes	analysisContext.Student.ISIRs.CommentCodes
	Date Application Completed	dateApplicationCompleted	Returns student records based on Date Application Completed on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	dateApplicationCompleted	academicPlan/student/isirs/dateApplicationCompleted	analysisContext.Student.ISIRs.DateApplicationCompleted
	Degree or Certificate Working On	degreeCertificate	Returns student records based on Degree or Certificate Working On on any active ISIRs, per query parameters.	String	Dropdown	1st Bachelor's Degree 2nd Bachelor's Degree Associate Degree (general education or transfer program) Associate Degree (occupational or technical program) Certificate or diploma for completing an occupational, technical, or educational program of at least two years Certificate or diploma for completing an occupational, technical, or educational program of less than two years Graduate or professional degree Other/undecided Teaching Credential Program (non-degree program)	FirstBachelorsDegree SecondBachelorsDegree AssociateDegreeGeneralOrTransfer AssociateDegreeOccupationOrTechnical CertificateOrDiplomaAtLeast2 GraduateOrProfessionalDegree CertificateOrDiplomaLessThan2 OtherUndecided TeachingCredentialProgram Format Example: "FirstBachelorsDegree"	degreeCertificate	academicPlan/student/isirs/degreeCertificate	analysisContext.Student.ISIRs.degreeCertificate
	Dependency Status	dependencyStatus	Returns student records based on Dependency Status on any active ISIRs, per query parameters.	String	Dropdown	D - Dependent I - Independent X - Dependent (Rejected) Y - Independent (Rejected)	D I X Y Format Example: "D"	dependencyStatus	acade+J23micPlan/student/isirs/dependencyStatus	analysisContext.Student.ISIRs.dependencyStatus
	FAY	federalAwardYearName	Returns student records based on FAY on any active ISIRs, per query parameters. Note: FAY can be used as part of an array in conjunction with other ISIR parameters to narrow query results within a rule or a group.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: "2023-2024"	federalAwardYearName	academicPlan/student/isirs/federalAwardYearName	analysisContext.Student.ISIRs.FAY
	FTI: FISAP Total Income	FISAPTotalIncome	Returns student records based on FISAP Total Income on any active ISIRs, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 20072	fisapTotalIncome	academicPlan/student/isirs/fisapTotalIncome	analysisContext.Student.ISIRs.FISAPTotalIncome
	Grade Level in college	gradeLevelInCollege	Returns student records based on Grade Level in college on any active ISIRs, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 2	gradeLevelInCollege	academicPlan/student/isirs/gradeLevelInCollege	analysisContext.Student.ISIRs.GradeLevelInCollege
	Graduate Level ISIR	isGradLevelIsir	Returns student records based on any active ISIR Grade Level, per query parameters.	Boolean	Radio Button	Yes No	true false Format Example: true	isGradLevelIsir	academicPlan/student/isirs/isGradLevelIsir	analysisContext.Student.ISIRs.IsGradLevelIsir
	High School City	highSchoolCity	Returns student records based on High School City on any active ISIRs, per query parameters.	String	Text Box	Any text value	Any text value Format Example: "Number 1 City in the World"	highSchoolCity	academicPlan/student/isirs/highSchoolCity	analysisContext.Student.ISIRs.HighSchoolCity
	High School Name	highSchoolName	Returns student records based on High School Name Status on any active ISIRs, per query parameters.	String	Text Box	Any text value	Any text value Format Example: "Jefferson High School Number 2"	highSchool	academicPlan/student/isirs/highSchoolName	analysisContext.Student.ISIRs.HighSchoolName
	High School State	highSchoolState	Returns student records based on High School State on any active ISIRs, per query parameters.	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	highSchoolState	academicPlan/student/isirs/highSchoolState	analysisContext.Student.ISIRs.HighSchoolState
	Housing Plan	housingPlan	Returns student records based on Housing Plan on any active ISIRs, per query parameters.	String	Dropdown	Off-Campus On-Campus With Parent	OffCampus OnCampus WithParent Format Example: "OffCampus"	housingPlan	academicPlan/student/isirs/housingPlan	analysisContext.Student.ISIRs.housingPlan
	HS Diploma or Equivalent	HSDiplomaOrEquivalent	Returns student records based on HS Diploma or Equivalent on any active ISIRs, per query parameters.	String	Dropdown	GED/State Certificate High school diploma Home schooled None of the above	GEDStateCertificate HighSchoolDiploma HomeSchooled None Format Example: "HighSchoolDiploma"	hsDiplomaOrEquivalent	academicPlan/student/isirs/hsDiplomaOrEquivalent	analysisContext.Student.ISIRs.hsDiplomaOrEquivalent
	NSLDS Aggregate Combined OPB	nsldsAggregateCombinedOutstandingPrincipalBalance	Returns student records based on NSLDS Aggregate Combined OPB on any active ISIRs, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 52000	nsldsAggregateCombinedOutstandingPrincipalBalance	academicPlan/student/isirs/nsldsAggregateCombinedOutstandingPrincipalBalance	analysisContext.Student.ISIRs.NSLDSAggregateCombinedOutstandingPrincipalBalance
	NSLDS Aggregate Subsidized OPB	nsldsAggregateSubsidizedOutstandingPrincipalBalance	Returns student records based on NSLDS Aggregate Subsidized OPB on any active ISIRs, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 26000	nsldsAggregateSubsidizedOutstandingPrincipalBalance	academicPlan/student/isirs/nsldsAggregateSubsidizedOutstandingPrincipalBalance	analysisContext.Student.ISIRs.NSLDSAggregateSubsidizedOutstandingPrincipalBalance
	Parent Residency Date	parentsLegalResidenceDate	Returns student records based on Parent Residency Date on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	parentsLegalResidenceDate	academicPlan/student/isirs/parentsLegalResidenceDate	analysisContext.Student.ISIRs.ParentsLegalResidenceDate
	Parent State of Legal Residence	parentsStateOfLegalResidence	Returns student records based on Parent State of Legal Residence on any active ISIRs, per query parameters.	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	parentsStateOfLegalResidence	academicPlan/student/isirs/parentsStateOfLegalResidence	analysisContext.Student.ISIRs.ParentsStateOfLegalResidence
	Parent Tax Filer Status	parentsTaxReturnFilingStatus	Returns student records based on Parent Tax Filer Status on any active ISIRs, per query parameters.	String	Dropdown	Don't Know Head of Household Married - Filed Joint Return Married - Filed Separate Return Qualifying Widow(er) Single	DontKnow HeadOfHousehold MarriedFiledJointReturn MarriedFiledSeparateReturn QualifyingWidow Single Format Example: "QualifyingWidow"	parentsTaxReturnFilingStatus	academicPlan/student/isirs/parentsTaxReturnFilingStatus	analysisContext.Student.ISIRs.parentsTaxReturnFilingStatus
	Pell Eligibility	isPellEligible	Returns student records based on Pell Eligibility on any active ISIRs, per query parameters.	String	Dropdown	No Yes	No Yes Format Example: "Yes"	isPellEligible	academicPlan/student/isirs/isPellEligible	analysisContext.Student.ISIRs.isPellEligible
	Primary EFC	primaryEFC	Returns student records based on Primary EFC on any active ISIRs, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 0	primaryEFC	academicPlan/student/isirs/primaryEFC	analysisContext.Student.ISIRs.PrimaryEFC
	Selected for Verification	isSelectedForVerification	Returns student records based on Selected for Verification on any active ISIRs, per query parameters.	String	Dropdown	No Yes	No Yes Format Example: "Yes"	isSelectedForVerification	academicPlan/student/isirs/isSelectedForVerification	analysisContext.Student.ISIRs.isSelectedForVerification
	Student Residency Date	studentsLegalResidenceDate	Returns student records based on Student Residency Date on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	studentsLegalResidenceDate	academicPlan/student/isirs/studentsLegalResidenceDate	analysisContext.Student.ISIRs.LegalResidenceDate
	Student State of Legal Residence	studentsStateOfLegalResidence	Returns student records based on Student State of Legal Residence on any active ISIRs, per query parameters.	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	studentsStateOfLegalResidence	isirs/studentsStateOfLegalResidence	analysisContext.Student.ISIRs.StudentsStateOfLegalResidence
	Student Tax Filer Status	taxReturnFilingStatus	Returns student records based on Student Tax Filer Status on any active ISIRs, per query parameters.	String	Dropdown	Don't Know Head of Household Married - Filed Joint Return Married - Filed Separate Return Qualifying Widow(er) Single	DontKnow HeadOfHousehold MarriedFiledJointReturn MarriedFiledSeparateReturn QualifyingWidow Single Format Example: "QualifyingWidow"	studentsTaxReturnFilingStatus	academicPlan/student/isirs/studentsTaxReturnFilingStatus	analysisContext.Student.ISIRs.studentsTaxReturnFilingStatus
	Transaction Processed Date	transactionProcessedDate	Returns student records based on Transaction Processed Date on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	transactionProcessedDate	academicPlan/student/isirs/transactionProcessedDate	analysisContext.Student.ISIRs.TransactionProcessedDate
	Transaction Receipt Date	transactionReceiptDate	Returns student records based on Transaction Date on any active ISIRs, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	transactionReceiptDate	academicPlan/student/isirs/transactionReceiptDate	analysisContext.Student.ISIRs.TransactionReceiptDate
	Verification Status	verificationStatus	Returns student records based on Verification Status associated with any active ISIRs, per query parameters.	String	Dropdown	Blank Not Verified Payment Without Verification Selected, but not Verified Verified	Blank NotVerified Payment Without Verification SelectedNotVerified Verified Format Example: "Verified"	verificationStatus	academicPlan/student/isirs/verificationStatus	analysisContext.Student.ISIRs.verificationStatus
	Working on Masters Or Doctorate Program	workingOnMastersOrDoctorateProgram	Returns student records based on Working on Masters Or Doctorate Program on any active ISIRs, per query parameters.	String	Dropdown	No Yes	No Yes Format Example: "Yes"	workingOnMastersOrDoctorateProgram	academicPlan/student/isirs/workingOnMastersOrDoctorateProgram	analysisContext.Student.ISIRs.workingOnMastersOrDoctorateProgram
Payment Period	-	PaymentPeriod[]	-	N/A	N/A	N/A	N/A	N/A	N/A	N/A	6.0
	Anticipated Units	anticipatedUnits	Returns students based on Anticipated Units for any Payment Period on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 12	anticipatedUnits	academicPlan/academicYears/paymentPeriods/anticipatedUnits	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.anticipatedUnits
	End Date	endDate	Returns students based on any Payment Period End Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/paymentPeriods/endDate	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.EndDate
	Enrolled Units	progAppRegisteredUnits	Returns students based on Anticipated Units for any Payment Period on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 12	progAppRegisteredUnits	academicPlan/academicYears/paymentPeriods/progAppRegisteredUnits	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.progAppRegisteredUnits
	Enrollment Status	enrollmentStatus	Returns students based on Enrollment Status for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Closed None Open	CLOSED NONE OPEN Format Example: "OPEN"	enrollmentStatus	academicPlan/academicYears/paymentPeriods/enrollmentStatus	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Enrollment.EnrollmentStatus
	Grade Level	gradeLevel	Returns students based on Grade Level for any Payment Period on the Academic Plan, per query parameters.	Number	Dropdown	Any numeric value	Any numeric value Format Example: 12	gradeLevel	academicPlan/academicYears/paymentPeriods/gradeLevel	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Enrollment.GradelLevel
	Program Credential	programCredential	Returns students based on Program Credential on Program Setup using the Program associated with any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Associate's degree Bachelor's degree Doctoral degree First Professional Graduate/Professional certificate Master's degree Non-credential programs Post Baccalaureate certificate Undergraduate certificate or diploma	AssociatesDegree BachelorsDegree DoctoralDegree FirstProfessionalDegree GraduaterofessionalDegree MastersDegree NonCredentialPrograms PostBaccalaureateCertificate UndergraduateCertificateOrDiploma Format Example: "NonCredentialPrograms"	programCredential	academicPlan/academicYears/paymentPeriods/programCredential	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Program.programCredential
	Program External ID	programExternalID	Returns students based on Program External ID on Program Setup using the Program associated with any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Program External ID from Program Setup listed alpha-numerically	Uses Program External ID from Program Setup Format Example: "1025-BBS" Note: If program external ID includes spaces, the RQL Name will also include spaces.	programExternalId	academicPlan/academicYears/paymentPeriods/programExternalId	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Program.ExternalId
	Program Name	programName	Returns students based on Program Name using the Program associated with any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Program Name from Program Setup listed alphanumerically	Uses Program Name from Program Setup Format Example: "Bachelor in Business Studies" Note: If program name includes spaces, the RQL Name will also include spaces.	programName	academicPlan/academicYears/paymentPeriods/programName	http://analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Program.Name
	Program Type	programType	Returns students based on Program Type on Program Setup using the Program associated with any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	CTP Programs Ed-Licensure Graduate Post-Bach Licensure Post-Graduate Prep-Graduate Prep-Undergraduate Undergraduate	CPTPROGRAMS EDLICENSURE GRADUATE POSTBACHLICENSURE POSTGRADUATE PREPGRADUATE PREPUNDERGRADUATE UNDERGRADUATE Format Example: "UNDERGRADUATE"	programType	academicPlan/academicYears/paymentPeriods/programType	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Program.programType
	SAP Status	sapStatus	Returns students based on SAP Status for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	FA Probation FA Suspended FA Warning MTF Suspended Not Calculated Satisfactory	Probation Suspended Warning MTFSuspended NotCalculated Satisfactory Format Example: "Warning"	sapStatus	academicPlan/academicYears/paymentPeriods/sapStatus	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.sapStatus
	Start Date	startDate	Returns students based on any Payment Period Start Date on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/paymentPeriods/startDate	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.StartDate
	Term External ID	termExternalID	Returns students based on Term External ID on Term Setup for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Term External ID from Term Setup listed alpha-numerically	Uses Term Name from Term Setup Format Example: "2023Spring" Note: If term external ID includes spaces, the RQL Name will also include spaces.	termExternalId	academicPlan/academicYears/paymentPeriods/termExternalId	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.termExternalid
	Term Name	termName	Returns students based on Term Name for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Term Name from Term Setup listed alpha-numerically	Uses Term Name from Term Setup Format Example: "Spring 2023" Note: If term name includes spaces, the RQL Name will also include spaces.	termName	academicPlan/academicYears/paymentPeriods/termName	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.termName
	Track	track	Returns students based on Track on Term Setup for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Track Name from Term Setup listed alpha-numerically	Uses Track Name from Term Setup Format Example: "Spring Track A" Note: If term name includes spaces, the RQL Name will also include spaces.	track	academicPlan/academicYears/paymentPeriods/track	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.track
Payment Period Award	-	PaymentPeriodAward[]	-	-	-	-	-	-	-	-	6.0
	Award Status	awardStatus	Returns students based on Award Status for any Payment Period Award on the Academic Plan, per query parameters.	String	Dropdown	Accepted Cancelled Declined Estimated Offered Unfunded	Accepted Cancelled Declined Estimated Offered Unfunded Format Example: Accepted	awardStatus	academicPlan/academicYears/awards/awardStatus	analysisContext.ActivePlan.AllAwards.AwardDisbursements.Award.awardStatus
	End Date	endDate	Returns students based on Payment Period End Date for any Payment Period on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/awards/awardDisbursements/paymentPeriodEndDate	analysisContext.ActivePlan.AllAwards.AwardDisbursements.paymentPeriodEndDate
	FAY	federalAwardYearName	Returns students based on FAY for any Payment Period Award on the Academic Plan, per query parameters.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: "2023-2024"	federalAwardYearName	academicPlan/academicYears/awards/loanPeriod/federalAwardYearName	analysisContext.ActivePlan.AllAwards.AwardDisbursements.Award.LoanPeriod.federalAwardYearName
	Fund Budget Name	fundBudgetName	Returns students based on Fund Budget Name on Fund Setup for any Payment Period Award on the Academic Plan, per query parameters.	String	Dropdown	Fund Budget Name from Fund Setup listed alphabetically	Fund Budget Name from Fund Setup listed alphabetically Format Example: "Academic Achievement Grant Budget" Note: If fund budget name includes spaces, the RQL Name will also include spaces.	fundBudgetName	academicPlan/academicYears/awards/awardDisbursements/fundBudgetName	analysisContext.ActivePlan.AllAwards.AwardDisbursements.FundBudgetName
	Fund Name	fundName	Returns students based on Fund Name for any Payment Period Award on the Academic Plan, per query parameters.	String	Dropdown	Fund Name from Fund Setup listed alphabetically	Fund Name from Fund Setup listed alphabetically Note: If fund name includes spaces, the RQL Name will also include spaces.	fundName	academicPlan/academicYears/awards/fundName	analysisContext.ActivePlan.AllAwards.AwardDisbursements.fundName
	Gross Amount	grossAmount	Returns students based on Gross Amount for any Payment Period Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 1750	amount	academicPlan/academicYears/awards/awardDisbursements/amount	analysisContext.ActivePlan.AllAwards.AwardDisbursements.Amount
	Net Amount	netAmount	Returns students based on Net Amount for any Payment Period Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 1732	netAmount	academicPlan/academicYears/awards/awardDisbursements/netAmount	analysisContext.ActivePlan.AllAwards.AwardDisbursements.netAmount
	Paid Amount	paidAmount	Returns students based on Paid Amount for any Payment Period Award on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 1732	paidAmount	academicPlan/academicYears/awards/awardDisbursements/paidAmount	analysisContext.ActivePlan.AllAwards.AwardDisbursements.paidAmount
	Start Date	startDate	Returns students based on Payment Period Start Date for any Payment Period on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/awards/awardDisbursements/paymentPeriodStartDate	analysisContext.ActivePlan.AllAwards.AwardDisbursements.paymentPeriodStartDate
	Term External ID	termExternalID	Returns students based on Term External ID on Term Setup for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Term External ID from Term Setup listed alpha-numerically	Uses Term Name from Term Setup Format Example: "2023Spring" Note: If term external ID includes spaces, the RQL Name will also include spaces.	termExternalId	academicPlan/academicYears/awards/awardDisbursements/termExternalId	analysisContext.ActivePlan.AllAwards.AwardDisbursements.ternExternalid
	Term Name	termName	Returns students based on Term Name on Term Setup for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Term Name from Term Setup listed alpha-numerically	Uses Term Name from Term Setup Format Example: "Spring 2023" Note: If term name includes spaces, the RQL Name will also include spaces.	termName	academicPlan/academicYears/awards/awardDisbursements/termName	analysisContext.ActivePlan.AllAwards.AwardDisbursements.termName
Resource	-	Resource[]	-	-	-	-	-	-	-	-	6.0
	Payment Period Start Date	startDate	Returns students based on the Payment Period Start Date for any Payment Period on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	startDate	academicPlan/academicYears/paymentPeriods/startDate	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.StartDate
	Payment Period End Date	endDate	Returns students based on the Payment Period End Date for any Payment Period on the Academic Plan, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	endDate	academicPlan/academicYears/paymentPeriods/endDate	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.EndDate
	Resource Name for Payment Period	Uses [name=="Resource Name for Payment Period"] as part of the Resource array. Note: If the Resource Name has spaces, the Resource Name for Payment Period in the RQL will include the spaces.	Returns students based on the Resource Name for any Payment Period on the Academic Plan, per query parameters.	String	Dropdown	Resource Name from Add/Edit Resource Wizard on Awards tab listed alpha-numerically	Uses Resource Name from Add/Edit Resource Wizard on Awards tab Format Example: "Spring 2023" Note: If term name includes spaces, the RQL Name will also include spaces.	name	academicPlan/academicYears/paymentPeriods/resouces/name	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Resouces.name
	Resource Payment Period Amount	amount	Returns students based on the Resource amount for any Payment Period on the Academic Plan, per query parameters.	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 2000	amount	academicPlan/academicYears/paymentPeriods/resouces/amount	analysisContext.ActivePlan.AcademicYears.Enrollments.PaymentPeriods.Resouces.amount
Smart Form Question	-	SmartFormQuestion[]	-	-	-	-	-	-	-	-	6.0
	Academic Year End Date	academicYearEndDate	Returns student records based on the Academic Year End Date for any Academic Year Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	academicYearEndDate	student/documents/academicYearEndDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.academicYearEndDate
	Academic Year Start Date	academicYearStartDate	Returns student records based on the Academic Year Start Date for any Academic Year Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	academicYearStartDate	student/documents/academicYearStartDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.academicYearStartDate
	Document Expiration Date	expirationDate	Returns student records based on the Expiration Date for any Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	expirationDate	student/documents/expirationDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.ExpirationDate
	Document FAY	federalAwardYearName	Returns students based on FAY for any Document Requirement, per query parameters.	String	Dropdown	1949-1950 through 2049-2050	1949-1950 through 2049-2050 Format Example: 2023-2024	federalAwardYearName	student/documents/federalAwardYearName	analysisContext.ActivePlan.GeneratedDocumentRequirements.federalAwardYearName
	Document Name	documentName	Returns student records based on the Document Name on Document Setup for any Document Requirement, per query parameters.	String	Dropdown	Document Name listed in Document Setup alpha-numerically	Document Name in Document Setup Format Example: Scholarship Application	name	academicPlan/student/documents/name	analysisContext.ActivePlan.GeneratedDocumentRequirements.name
	Document Received Date	receivedDate	Returns student records based on the Received Date for any Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	receivedDate	student/documents/receivedDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.ReceivedDate
	Document Scope	documentScope	Returns student records based on the Document Scope for any Document Requirement, per query parameters.	String	Dropdown	Academic Year Federal Award Year Payment Period Student	ACADEMICYEAR FEDERALAWARDYEAR PAYMENTPERIOD STUDENT Format Example: FEDERALAWARDYEAR	documentScope	student/documents/documentScope	analysisContext.ActivePlan.GeneratedDocumentRequirements.documentScope
	Document Status	documentRequirementStatus	Returns student records based on the Document Status for any Document Requirement, per query parameters.	String	Dropdown	Incomplete Needed Received Satisfied Unsatisfactory	INCOMPLETE NEEDED RECEIVED SATISFIED UNSATISFACTORY Format Example: "SATISFIED"	documentRequirementStatus	student/documents/documentRequirementStatus	analysisContext.ActivePlan.GeneratedDocumentRequirements.documentRequirementStatus
	Payment Period End Date	paymentPeriodEndDate	Returns student records based on the Payment Period End Date for any Payment Period Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	paymentPeriodEndDate	documents/paymentPeriodEndDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.paymentPeriodEndDate
	Payment Period Start Date	paymentPeriodStartDate	Returns student records based on the Payment Period Start Date for any Payment Period Scope Document Requirement, per query parameters.	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	paymentPeriodStartDate	student/documents/paymentPeriodStartDate	analysisContext.ActivePlan.GeneratedDocumentRequirements.paymentPeriodStartDate
	Lists each Smart Form Code alpha-numerically	smartFormCode Example: smartFormCode=="scholarshipApplication"	Returns student records based on any Smart Form Code, per query parameters.	String	Dropdown	Smart Form Codes listed alpha-numerically	Uses smartFormCode from Smart Form Manager Format Example: "scholarshipApplication" Note: If the Smart Form Code has spaces, the RQL will include the spaces.	name	academicPlan/student/documents/smartFormType	analysisContext.ActivePlan.GeneratedDocumentRequirements.smartFormType
	Lists each Smart Form Question alpha-numerically, based on Smart Form Code selected.	questionCode Example: questionCode=="Gender"	Returns student records based on any Smart Form Question Code, per query parameters.	String	Dropdown	Smart Form Question Codes for the selected Smart Form Code listed alpha-numerically	Uses Smart Form questionCode from Smart Form Manager Format Example: "gender" Note: If the Smart Form Question Code has spaces, the RQL will include the spaces.	name	academicPlan/student/documents/smartFormFields/name	analysisContext.ActivePlan.GeneratedDocumentRequirements.SmartFormFields.questionCode
	Lists available Smart Form Question Response(s) alpha-numerically for pre-defined question options. Questions without pre-defined options require the response value to be defined.	value Example: value=="female"	Returns student records based on any Smart Form Response value, per query parameters.	Defined in Smart Form	Defined by Operator Type used in Smart Form	Smart Form values for the selected Smart Form Question listed alpha-numerically for pre-defined question options. Smart Form values for questions without pre-defined options require the response value to be defined.	Uses Smart Form Question value from Smart Form Manager Format Example: "female" Note: If the Smart Form Question value has spaces, the RQL will include the spaces.	value	academicPlan/student/documents/smartFormFields/value	analysisContext.ActivePlan.GeneratedDocumentRequirements.SmartFormFields.value
Student Address	-	StudentAddress[]	-	-	-	-	-	-	-	-	6.0
	Address Type	addressType	Returns student records based on Address Type for any address listed in the Student Details --> Contact Information Section, per query parameters.	String	Dropdown	Billing Local Original Other Permanent	Billing Local Original Other Permanent Format Example: "Permanent"	addressType	studentAddresses/addressType	analysisContext.Student.StudentAddresses.addressType
	County	county	Returns student records based on County for any address listed in the Student Details --> Contact Information Section, per query parameters.	String	Text Box	Any text value	Any text value Format Example: "Jefferson High School Number 2"	county	studentAddresses/county	analysisContext.Student.StudentAddresses.county
	Source Type	sourceType	Returns student records based on Source Type for any address listed in the Student Details --> Contact Information Section, per query parameters.	String	Dropdown	COD ISIR PortalRegistration SIS SNAP UI	COD ISIR PORTALREGISTRATION SIS SNAP UI Format Example: "SIS"	sourceType	studentAddresses/sourceType	analysisContext.Student.StudentAddresses.sourceType
	State	state	Returns student records based on State for any address listed in the Student Details --> Contact Information Section, per query parameters.	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	state	studentAddresses/state	analysisContext.Student.StudentAddresses.state
Student Data	-	Student	-	-	-	-	-	-	-	-	6.0
	Active	active	Returns only active, non-deleted students in the query results and file output, per query parameters. Inactive student records can be returned and only the total count viewed on the Query Preview tab under the Count of unique students field. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Boolean	Radio Button	Yes No	true false Format Example: true	active	student/active	analysisContext.Student.IsActive
	Campus External ID	locationId	Returns student records based on Campus External ID, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Location ID from Campus Setup listed alpha-numerically	Uses Campus ID from Campus Setup Format Example: "1 Campus Location" Note: If campus external ID includes spaces, the RQL Name will also include spaces.	locationId	student/siteId & student/siteName	analysisContext.Student.locationExternalId
	Campus Name	locationName	Returns student records based on Campus Name, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Location Name from Campus Setup listed alpha-numerically	Uses Campus Name from Campus Setup Format Example: "Campus Location A" Note: If campus name includes spaces, the RQL Name will also include spaces.	locationName	student/locationId & student/locationName	analysisContext.Student.locationName
	Citizenship Status	citizenshipStatus	Returns student records based on Citizenship Status listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Blank Eligible Non Citizen Non Citizen or Eligible Non Citizen US Citizen	Blank EligibleNonCitizen NonCitizenOrEligibleNonCitizen USCitizen Format Example: "USCitizen"	citizenshipStatus	student/citizenshipStatus	analysisContext.Student.citizenshipStatus
	Class Rank	classRank	Returns student records based on Class Rank listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 95	classRank	student/classRank	analysisContext.Student.classRank
	Disability Status	disabilityStatus	Returns student records based on Disability Status listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Text Box	Blank No Other Yes	Blank No Other Yes Format Example: "Other"	disabilityStatus	student/disabilityStatus	analysisContext.Student.disabilityStatus
	Ethnicity	ethnicity	Returns student records based on Ethnicity listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Blank Hispanic or Latino Not Hispanic or Latino Other	Blank HispanicOrLatino NotHispanicOrLatino Other Format Example: "HispanicOrLatino"	ethnicity	student/ethnicity	analysisContext.Student.ethnicity
	Gender	gender	Returns student records based on gender listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Blank Female Male Not Reported	BLANK FEMALE MALE NOTREPORTED Format Example: "MALE"	gender	student/gender	analysisContext.Student.gender
	Grad Cumulative GPA	gradCumulativeGPA	Returns student records based on Grad Cumulative GPA listed at the top of the Academic Plan under the Current Academic Plan Information, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3.957	gradCumulativeGPA	student/gradCumulativeGPA	analysisContext.Student.gradCumulativeGPA
	Grade Level	gradeLevel	Returns student records based on Grade Level listed on the Summary --> Student Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 2	gradeLevel	student/gradeLevel	analysisContext.Student.gradeLevel
	High School	HighSchool	Returns student records based on SIS High School listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Text Box	Any text value	Any text value Format Example: "Number 1 City in the World"	highSchool	student/highSchool	analysisContext.Student.highSchool
	High School City	highSchoolCity	Returns student records based on SIS High School City listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Text Box	Any text value	Any text value Format Example: "Jefferson High School Number 2"	highSchoolCity	student/highSchoolCity	analysisContext.Student.highSchoolCity
	High School Diploma Type	highSchoolDiplomaType	Returns student records based on SIS High School Diploma Type listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Ability to Benefit GED High school diploma Home schooled Other	AbilityToBenefit GED HighSchoolDiploma HomeSchooled Other Format Example: "HighSchoolDiploma"	highSchoolDiplomaType	student/highSchoolDiplomaType	analysisContext.Student.highSchoolDiplomaType
	High School GPA	highSchoolGPA	Returns student records based on High School GPA listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3.957	highSchoolGPA	student/highSchoolGPA	analysisContext.Student.highSchoolGPA
	High School Graduation Date	highSchoolGraduationDate	Returns student records based on High School Graduation Date listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	highSchoolGraduationDate	student/highSchoolGraduationDate	analysisContext.Student.highSchoolGraduationDate
	High School State	highSchoolState	Returns student records based on SIS High School State listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	highSchoolState	student/highSchoolState	analysisContext.Student.highSchoolState
	NCES High School Code	ncesHighSchoolCode	Returns student records based on SIS High School State listed in the Student Details --> High School Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Text Box	Any text value	Any text value Format Example: "NCES Code 1"	ncesHighSchoolCode	student/ncesHighSchoolCode	ncesHighSchoolCode
	Program Credential	ProgramCredential	Returns student records based on Program Credential on Program Setup using the Program listed on the Summary --> Student Information Section, per query parameters. The Program information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Associate's degree Bachelor's degree Doctoral degree First Professional Graduate/Professional certificate Master's degree Non-credential programs Post Baccalaureate certificate Undergraduate certificate or diploma	AssociatesDegree BachelorsDegree DoctoralDegree FirstProfessionalDegree GraduaterofessionalDegree MastersDegree NonCredentialPrograms PostBaccalaureateCertificate UndergraduateCertificateOrDiploma Format Example: "NonCredentialPrograms"	programCredential	student/programCredential	analysisContext.Student.programCredential
	Program External ID	programExternalID	Returns student records based on Program External ID on Program Setup using the Program listed on the Summary --> Student Information Section, per query parameters. The Program information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Program External ID from Program Setup listed alpha-numerically	Uses Program External ID from Program Setup Format Example: "1025-BBS" Note: If program external ID includes spaces, the RQL Name will also include spaces.	programExternalID	student/programExternalId	analysisContext.Student.programExternalId
	Program Name	programName	Returns student records based on Program Name listed on the Summary --> Student Information Section, per query parameters. The information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Program Name from Program Setup listed alphanumerically	Uses Program Name from Program Setup Format Example: "Bachelor in Business Studies" Note: If program name includes spaces, the RQL Name will also include spaces.	programName	student/programName	analysisContext.Student.programName
	Program Type	programType	Returns student records based on Program Type listed on the Summary --> Student Information Section, per query parameters. The information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	CTP Programs Ed-Licensure Graduate Post-Bach Licensure Post-Graduate Prep-Graduate Prep-Undergraduate Undergraduate	CPTPROGRAMS EDLICENSURE GRADUATE POSTBACHLICENSURE POSTGRADUATE PREPGRADUATE PREPUNDERGRADUATE UNDERGRADUATE Format Example: "UNDERGRADUATE"	programType	student/programType	analysisContext.Student.programType
	Race	race	Returns student records based on Race listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	American Indian or Alaska Native Asian Black or African American Blank Native Hawaiian or Other Pacific Islander Nonresident Alien Other Race Or Ethnicity Unknown Two Or More Races White	AmericanIndianOrAlaskaNative Asian BlackOrAfricanAmerican Blank NativeHawaiianOrOtherPacificIslander Other RaceOrEthnicityUnknown NonresidentAlien TwoOrMoreRaces White Format Example: "Asian"	race	student/race	analysisContext.Student.race
	Residency Date	residencyDate	Returns student records based on residencyDate listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Date	Calendar Date Picker	Calendar date selection	Date in YYYY-MM-DD format Format Example: 2023-07-10	residencyDate	student/residencyDate	analysisContext.Student.residencyDate
	Residency Status	residencyStatus	Returns student records based on residencyStatus listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	In District In State Out of District Out of State Unknown	InDistrict InState OutOfDistrict OutOfState Unknown	residencyStatus	student/residencyStatus	analysisContext.Student.residencyStatus
	School Of	schoolOf	Returns student records based on School Of on Program Setup using the Program listed on the Summary --> Student Information Section, per query parameters. The Program information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Program School Of from Program Setup listed alpha-numerically	Uses Program School Of from Program Setup Format Example: "Medicine" Note: If program school of includes spaces, the RQL Name will also include spaces.	schoolOf	student/schoolOf	analysisContext.Student.schoolOf
	Site External ID	siteId	Returns student records based on Site External ID, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Site ID from Site Setup listed alpha-numerically	Uses Site ID from Site Setup Format Example: "Online Campus A" Note: If Site ID includes spaces, the RQL Name will also include spaces.	siteId / siteName	student/siteId & student/siteName	analysisContext.Student.siteExternalId
	Site Name	siteName	Returns student records based on Site Name listed on the Summary --> Student Information Section, per query parameters. The information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Site Name from Site Setup listed alpha-numerically	Uses Site Name from Site Setup Format Example: "Campus A - Online" Note: If Site Name includes spaces, the RQL Name will also include spaces.	siteId / siteName	student/siteId & student/siteName	analysisContext.Student.siteName
	Specialization	specialization	Returns student records based on Specialization on Program Setup using the Program listed on the Summary --> Student Information Section, per query parameters. The Program information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	Program Specialization from Program Setup listed alpha-numerically	Uses Program Specialization from Program Setup Format Example: "Technology" Note: If program specialization includes spaces, the RQL Name will also include spaces.	specialization	student/specialization	analysisContext.Student.specialization
	State of Legal Residence	StateOfLegalResidence	Returns student records based on Residency State listed in the Student Details --> Demographic Information Section, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	String	Dropdown	List of State Abbreviations	State Abbreviation Format Example: "KS"	stateOfLegalResidence	student/stateOfLegalResidence	analysisContext.Student.stateOfLegalResidence
	Undergrad Cumulative GPA	UndergradCumulativeGPA	Returns student records based on Undergrad Cumulative GPA listed at the top of the Academic Plan under the Current Academic Plan Information, per query parameters. This information is provided to Regent via the SBL (see SBL Data Dictionary for additional details).	Number	Numeric Text Box	Any numeric value	Any numeric value Format Example: 3.957	undergradCumulativeGPA	student/undergradCumulativeGPA	analysisContext.Student.undergradCumulativeGPA
User Defined Field	-	UserDefinedField[]	-	-	-	-	-	-	-	-	6.0
	Lists each User Defined Field Name alpha-numerically	User Defined Field Name Example: name=="financialAidApplication"	Returns student records based on any User Defined Field listed in the Student Details --> Institutionally Defined Data Section, per query parameters.	String	Dropdown	User Defined Field Names listed alpha-numerically	Uses User Defined Field Name from Institution Setup Format Example: "financialAidApplication" Note: If the User Defined Field Name has spaces, the User Defined Name in the RQL will include the spaces.	name	academicPlan/student/udfs/name	analysisContext.Student.UDFs.name
	Lists each User Defined Field value alpha-numerically	User Defined Field Value Example: =="Yes"	Returns student records based on any User Defined Field value provided listed in the Student Details --> Institutionally Defined Data Section, per query parameters.	Defined in UDF Setup	Defined by Operator Type defined in UDF Setup	Value required to be entered	Uses value provided via SBL and/or manually entered on the Institutionally Defined Data section Format Example: "Yes" Note: If the User Defined Field Value has spaces, the User Defined Field Value in the RQL will include the spaces.	value	academicPlan/student/udfs/value	analysisContext.Student.UDFs.value

Customer Zone Knowledge Base

Query Data Dictionary

Introduction

Overview

Objects

Data Value Operators

Properties and Data Values