Skip to main content

Appendix A. System function reference: validation functions

Function	Signature	Description	Parameters	Returns
isValidDate	isValidDate(value, exp)	Determines whether a date value is in a valid date format.	value — string, required: date value to validate exp — RegExp, optional: custom regular expression for date format	boolean: true if date is valid or empty false if format is invalid
isUNKDate	isUNKDate(value)	Determines whether a date value containing "UNK" (Unknown) is in a valid date format.	value — string, required: date value to validate	boolean: true if format is valid or empty false if format is invalid
isValidTime	isValidTime(value, exp)	Determines whether a time value is in a valid 24-hour time format.	value — string, required: time value to validate exp — RegExp, optional: custom regular expression for time format	boolean: true if time is valid or empty false if format is invalid
isUNKTime	isUNKTime(value)	Determines whether a time value containing "UNK" (Unknown) is in a valid time format.	value — string, required: time value to validate	boolean: true if format is valid or empty false if format is invalid
isTime	isTime(value)	Determines whether a time value is in a standard 24-hour format.	value — string, required: time value to validate	boolean: true if time format is valid or empty false if format is invalid
isTime12	isTime12(value)	Determines whether a time value is in a standard 12-hour format.	value — string, required: time value to validate	boolean: true if format is valid false if format is invalid

Function	Signature	Description	Parameters	Returns
isLater	isLater(dateValue, historyDateValue)	Determines whether the first date value is after (or equal to) the second date value.	dateValue — string, required: first date value to compare (expected to be the later date) historyDateValue — string, required: second date value to compare (expected to be the earlier date)	boolean: true if dateValue >= historyDateValue or dates cannot be parsed false if dateValue < historyDateValue
isDateAfter	isDateAfter(date1, date2)	Determines whether the first date is after the second date (supports dates containing UNK).	date1 — string, required: first date value to compare (expected to be the later date) date2 — string, required: second date value to compare (expected to be the earlier date)	boolean: true if date1 is after date2 or comparison is not possible false if date1 is not after date2
hasValidEqualDate	hasValidEqualDate()	Determines whether a base date has an equal match among a set of comparison dates (special rule).	arguments — string[], variable: first value is the base date subsequent values are comparison dates (auto-filled by system)	boolean: true if match is found or no valid comparison targets exist false if no match is found
isTimeRange	isTimeRange(date2, time2, date1, time1, timepoint, condition)	Determines whether two date and time pairs satisfy a time point range condition.	date2— string, required: second date value (minuend date) time2 — string, required: second time value (minuend time) date1 — string, required: first date value (subtrahend date) time1 — string, required: first time value (subtrahend time) timepoint — string, required: timepoint label used to match the corresponding range configuration in condition condition — string, required: stringified 2D array defining the allowed ranges for each timepoint	boolean: true if within allowed range or parameters are incomplete false if outside allowed range
dateComparison	dateComparison(curDate, exp, unit, compareDate)	Determines whether the current and previous item group entries in a log form satisfy a specified date condition (applies to log forms only).	curDate — string, required: date value of current record exp — string, required: comparison expression string, e.g. ">5", "<10", ">=3", "<=7" unit — string, required: unit for date difference calculation: 'D'=days 'H'=hours 'm'=minutes 'S'=seconds 'W'=weeks 'M'=months 'Y'=years 'YA'=exact age compareDate — string, autofilled by system: date value of previous record	boolean: true if condition is met or parameters are empty false if condition is not met

Function	Signature	Description	Parameters	Returns
mustAnswer	mustAnswer(value)	Determines whether an item's value has been filled in (non-empty validation).	value — any, required: item value to validate	boolean: true if filled in false if not filled in
isRange	isRange(value, minValue, maxValue)	Determines whether an input value is within a specified closed interval (inclusive of boundary values).	value — string/number, required: value to validate minValue — number, required: minimum value of range (inclusive) maxValue — number, required: maximum value of range (inclusive)	boolean: true if within range or parameters are empty false if out of range
mustCheck	isChecked(value)	Determines whether a radio button or dropdown item is selected (non-empty is considered selected).	value — string, required: radio button/dropdown item value to validate	boolean: true if selected (value is non-empty) false if not selected (value is null/undefined/empty string)
isValidFloat	isValidFloat(value, decimal)	Determines whether a floating-point number meets the specified precision (decimal places validation).	value — string, required: float value to validate (in string form) decimal — number, optional: required number of decimal places (exact match)	boolean: true if precision is met or value is empty/precision not specified false if precision is not met or not a number
isRepeatValue	isRepeatValue()	Determines whether a specified item's value is duplicated in other item groups (primarily used in log forms).	value — any[], variables: first value is current item value subsequent values are same item's values from other records (autofilled by system)	boolean: true if not duplicated or current value is empty false if a duplicate exists
isNotNullAndEmpty	isNotNullAndEmpty(value)	Determines whether a value is non-empty (not null, not empty string, or not undefined).	value — any, required: value to validate	boolean: true if value is non-empty false if value is null/undefined/empty string

Function	Signature	Description	Parameters	Returns
condition	condition(condition, validate, elseValue)	Determines whether a condition is met and returns a specified value based on the result (a conditional branching function).	condition — boolean, required: condition expression to evaluate (result is true/false) validate — any, required: return value when condition is true (typically result of another validation function) elseValue — any, optional, default = true: value returned when condition is false (default prevents query generation)	any: returns validate if condition is true otherwise returns elseValue
isItemEnable	isItemEnable(itemId)	Determines whether the specified item is in an enabled state.	itemId — any, required: item identifier (item's enabled state value is automatically passed in by system)	boolean: true if item is enabled false if item is disabled
isPrevCycleItemEnable	isPrevCycleItemEnable(itemId)	Determines whether the specified item in the previous cycle is in an enabled state.	itemId — any, required: item identifier (automatically replaced by system with enabled state value from previous Cycle)	boolean true if item is enabled in previous Cycle false if disabled or Cycle does not exist
NotEmptyIgnoreRule	NotEmptyIgnoreRule(condition)	Ignores rule validation when a non-empty value is already stored in the database; otherwise returns based on a condition (a conditional ignore function).	condition — boolean, required: condition expression to use when database value is empty val — string, autofilled by system: stored value of current rule's item in database	boolean: returns true when database value is non-empty otherwise returns value of condition
validateRelatedFormDates	validateRelatedFormDates(relatedFormDateItem, comparisonOperator, thisFormDateItem)	Validates whether dates in a related form satisfy the specified comparison condition.	relatedFormDateItem — string, required: date item identifier in Related Form (e.g. '$AE.AESTDAT') comparisonOperator — string, required: comparison operator, supports '==', '!=', '>', '<', '>=', '<=' thisFormDateItem — string, optional: date item in current form to compare against; if omitted, uses rule's own item relatedDates — string[], variable, auto-filled by system: expanded list of date values from Related Form	boolean: true if all comparisons satisfy condition or parameters are empty false if any comparison does not satisfy condition
isRelatedByForm	isRelatedByForm(relatedFormItem)	Determines whether the current form is referenced by the specified related item (a special rule).	relatedFormItem — any, required: item identifier in Related Form (replaced by system with actual association status value)	boolean: true if current form is referenced false if not referenced

In this section:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.