How do I write custom reports to search based on users status?

\

Registrars Module
Knowledge Base 2.0 article 380

How do I write custom reports to search based on users status?

Navigation Path
Custom Reports → <select report> → <edit report> → Status Fields

There are a number of searchable fields in the OASIS database that are classified as “status fields”  The status field is a database field that can hold multiple pieces of information at the exact same time.  To help us facilitate this process, the data storage mechanism that we use is called a BITWISE operation.

For example, a status variable can be either TRUE or FALSE.    The system has multiple options for each status field in the database.  Each  of those options will have a corresponding value.

In our system - a timestamp is saved that corresponds to the date and time that the status was set on the users account.

1 = Inquiry   - 2022-01-01  08:00:12
2 = Applicant - 2022 - 03 -01 10:12:35
4 .. another status option
8 .. another status option

In the above example the datafield can hold the value of 1, 2 or 3.  If  the datafield holds the value of “3” then both of the status identifiers (Inquiry and Applicant) have been checked.

When building a search query the following would result:


> userStatus = 1    →  will give you every user with  INQUIRY ONLY (with no other status fields checked)

> userStatus HAS BIT 1    → will give you every user where APPLICANT has been checked (there may be fields as well)

Other Options
> userStatus = 2    →  will give you every user with  APPLICANT ONLY (with no other status fields checked)
> userStatus HAS BIT 2    → will give you every user where INQUIRY has been checked (there may be fields as well)
> userStatus = 3    →  will give you every user with  INQUIRY and APPLICANT ONLY (with no other status fields checked)
> userStatus HAS BIT 3    → will give you every user where INQUIRY and APPLICANT are BOTH checked (there may be fields as well)

Adding search by Date:

This will give you a list of all users who have the applicant checkbox checked, where they were checked between the dates 2022-01–01 and 2022-12-31.  Line 4 specifically looks at the studentBit_applicant date that is stored in the system.

User Status - how to add / remove student status
Navigation Path
Search User → Profile → Status

Custom Status
Navigation Path
Registrar Module → Student Status → Custom Status List  ( to build your own status list)
Search User → Profile → Custom Status