/
Query Data Dictionary

Query Data Dictionary

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”