Function Fields

Overview

Function fields provide a way for Axiom users to display customizable aggregate data. Conceptually, they are similar to calculated fields, though with the added ability to change the input of the calculation directly in the field's parameters. For example, a calculated field exists called "All Profile Codes" that simply lists all Profile Codes associated with a person. There are several function fields that allow the user to select directly from the query design which Profile Codes to display and how to display them.

A number of function fields exist, each with their own parameters. This article provides an overview of their functionality and links to further articles on each function field category.

Functionality

Function fields exist within certain query templates and are visually set apart from regular fields with the orange "Fn" prefix. When a function field is highlighted, parameters are displayed in the Properties tab on the right. Parameters change depending on the function field and determine the input for that field. For example, in the screen pictured here, the Related Children function field can be updated to display children, grandchildren, students, and more.

Show and Hide Parameters

A parameter can have three display states:

  • Required: The parameter is required. Use the default setting or select a new one. Required parameters display at the top of the Parameters area and have the word "required" displayed next to them. If required criteria in required parameters are not supplied, the query cannot be run. In such a case, an error icon displays next to the name of the function field and the word "required" turns red.
  • Promoted: The parameter is available but is not required and so may be removed. Promoted parameters are situated below the required ones. Hovering over them reveals a "remove" link. Click "remove" to remove it from the promoted list to the drop-down menu below.
  • Optional: Any non-required parameters that are not currently promoted are hidden (removed), and may be accessed from the drop-down menu at the bottom of the Parameters area. To promote a parameter and thus make it accessible in the function field, select it from the drop-down and click Add.

Edit Parameters

To edit the parameters of a function field, click on the parameter category (e.g., Display Children in the above screenshot), revealing the options. The options will vary based on the type of parameter: radio buttons denote that only one option may be selected, and checkboxes denote that more than one may be selected.

In some select parameter categories, there may be an Advanced search for when the number of possible inputs is higher than may be typical. To select multiple options from the advanced search, use the command "Shift + Click" for contiguous selections; use "Ctrl + Click" for non-contiguous selections.

"Shift + Click" for Contiguous Selections"Ctrl + Click" for Non-contiguous Selections.

This functionality is currently available on the following functions fields:

  • Classification List (by Date)
  • Classification List (by School Year)
  • Classification Exists (by Date)
  • Classification Exists (by School Year)
  • Group Membership Lists

Using Function Fields in Queries

Function fields are similar to other fields in that they retain all the regular properties of query fields: They can be shown and hidden, reordered with respect to other fields, have different styles applied, etc. To use a function field in a query, simply add the field to the field list (if not already present), modify the criteria for the desired parameters, and run the query. Function field parameters can be changed every time the query is run, and they always reflect current data.

Technical Limitations of Processing-Intensive Tasks

Function fields are processing-intensive and as such, using them in a query will tend to slow the speed at which the results appear. The lag time can range from unnoticeable to many seconds, and can potentially cause the query to time out. How long a query using a function field takes to run depends on several factors:

  • Complexity of the query (e.g., a Find Person query is simpler than some of the complex admissions and development queries), including criteria applied non-function fields and additional tables being referenced
  • Number of records being returned
  • Number of function fields in the query (more function fields is more processing-intensive)
  • Type of function fields used (some are more inherently processing-intensive than others)
  • Type of criteria applied to the function field(s)

Specific Function Fields

Academic Function Fields

  • Attendance Category Count
  • Attendance Count
  • Attendance Status Count
  • Class Avg by grading period
  • Course Grades
  • GPA
  • Grade Comparison (GP)
  • Grade Comparison (GP) (abs)
  • Honor Roll Status
  • Other Grade - Abbreviation
  • Overall Comment
  • Overall Grade - Description
  • Posted Numeric Grade
  • Posted Numeric Grade in Range
  • Posted Letter Grade
  • Posted Letter Grade Equals Value
  • Qualitative Grade
  • Rubric Criteria List

Admissions and Enrollment Checklist Item Function Fields

Click here to read more about checklist item function fields.

  • Adm Checklist Item Date
  • Adm Checklist Item Notes
  • Adm Checklist Item Status
  • Admissions Checklist Item Completion Status
  • Admission Checklist Item
  • Enr Checklist Item Date
  • Enr Checklist Item Notes
  • Enr Checklist Item Status
  • Enrollment Checklist Item
  • Visits by Grade Level

Admission Application Review Function Fields

Click here to read more about admission application review function fields.

  • Adm Reviewer
  • Adm Review Notes
  • Adm Review Criteria List
  • Adm Review Criteria Score
  • Adm Review Total Score
  • Important Relationship Count

Schedule Function Fields

Click here to read more about schedule function fields.

  • Class End Time
  • Class Start Time
  • Class Schedule Information
  • Room Schedule
  • Student Schedule
  • Teacher Schedule

Demographic Function Fields

Click here to read more about demographics function fields.

  • Contact Info History by Type
  • Related Children
  • Profile Code(s)
  • Profile Code Category
  • Profile Code List
  • Profile Code Count
  • Profile Code Exists

Development Function Fields

Click here to read more about Development function fields.

  • # Gifts by Type
  • Active Rating Value
  • Amounts by Fiscal Year
  • Amounts by Calendar Year
  • Calendar Year Amount
  • Constituent Tag List
  • Development Rating Exists
  • Filtered Giving (BETA)
  • Fiscal Year Amount
  • Gift Date
  • Next Action in Range
  • Number of Gifts
  • Opportunity Amount
  • Opportunity Objective Amount
  • Opportunity Target
  • Previous Action Range
  • Rating Value Count
  • Rating Value in Date Range
  • Screening Value (Most Recent)
  • Total Giving

Employment Function Fields

  • Time Off Amount Allowed
  • Time Off Amount Remaining
  • Time Off Amount Used

Enrollment Policy Function Fields

Click here to read more about class enrollment function fields.

  • Class Enrollments
  • Enr Policy Category
  • Enr Policy Notes
  • Enr Policy Response
  • Enrollment Policy Reponse Date
  • Financial Aid Amount
  • Household Enr Policy Category
  • Household Enr Policy Notes
  • Household Enr Policy Response
  • Household Enr Policy Response Date
  • No. of Program Registrations

Individual Event (on person records) Function Fields

Click here to read more about individual event function fields.

  • Ind Event Most Recent Date
  • Individual Event Count
  • Individual Event Detail
  • Individual Event Exists

Person Classification Function Fields

Click here to read more about person classification function fields.

  • Classification Count
  • Classification List
  • Classification List (by Date)
  • Classification List (by School Year)
  • Classification Exists
  • Classification Exists (by Date)
  • Classification Exists (by School Year)
  • Classifications by Type

Standardized Test Function Fields

Click here to read more about standardized test function fields.

  • Test Summary by Year
  • Test Summary by Grade Level
  • Test Score by Year (Text)
  • Test Score by Year (Numeric)
  • Test Score by Grade (Text)
  • Test Score by Grade (Numeric)

CRM and Data Integrity Function Fields

  • Consent Policy
  • Dupe Group Contains Role
  • External Username
  • Group Membership List
  • Legacy ID by Data Source
  • Pronoun Part of Speech

Other Function Fields (unsorted)

  • Reference Values
  • Person Name
  • Nth Year % of Days Present
  • Period Budget #1 (Fn)
  • Period Actual (Fn)
  • Query Field Parameter Test
  • # of Sections nth Year
  • Immunization Date