Appendix B. System function reference: calculation functions

RoundN

RoundN(value, _decimal)

Returns a floating-point number rounded to the specified number of decimal places (standard rounding).

value — string, required: float value to round (string or number)

_decimal — string/number, required: decimal precision expressed as a decimal, e.g. 0.1 means 1 decimal place, 0.01 means 2 decimal places

string:

FloorN

FloorN(value, _decimal)

Returns a floating-point number truncated down to the specified number of decimal places (floor).

value — string, required: float value to floor (string or number)

_decimal — string/number, required: decimal precision expressed as a decimal, e.g. 0.1 means 1 decimal place

string:

CeilN

CeilN(value, _decimal)

Returns a floating-point number rounded up to the specified number of decimal places (ceiling).

value — string, required: float value to ceil (string or number)

_decimal — string/number, required: decimal precision expressed as a decimal, e.g. 0.1 means 1 decimal place

string:

getMax

getMax()

Returns the maximum value of the specified type from one or more inputs.

type — string, required: data type, supports 'char' (string comparison), 'number' (integer comparison), 'float' (float comparison), 'arrayNumber' (expand arrays then compare as number)

num — any[], required >=1: values to compare; when type='arrayNumber' each value must be array

string: maximum value found

getMin

getMin()

Returns the minimum value of the specified type from one or more inputs.

type — string, required: data type, supports 'char' (string comparison), 'number' (integer comparison), 'float' (float comparison), 'arrayNumber' (expand arrays then compare as number)

num — any[], required >=1: values to compare; when type='arrayNumber' each value must be array

string: minimum value found

notEmptyValue

notEmptyValue()

Returns the first non-empty value from one or more inputs.

value — any[], required >=1: values to check

any:

sum

sum()

Returns the sum of all numeric inputs.

value — any[], required >=1: values to sum

number/string: calculated sum of all provided values

average

average()

Returns the average of all numeric input values (rounded).

digit — number, required: number of decimal places to retain (precision), e.g. 2 means two decimal places

values — any[], required >=1: numeric values to average

string:

multiply

multiply()

Multi-argument multiplication function

value — any[], required >=2: values to multiply

number/string/undefined:

division

division()

Multi-argument division function

dividend — any, required: dividend (first argument)

divisors — any[], required >=1: divisors

number/string:

toNum

toNum(value)

Converts an input value to a numeric type.

value — string/number, required: value to convert

number/string:

date

date(value)

Converts a date string to milliseconds (timestamp).

value — string, required; date string to convert

number/string: millisecond timestamp corresponding to the date

toDate

toDate(value)

Converts a date string to a JavaScript Date object.

value — string, required: date string to convert

Date/string:

toTime

toTime(value)

Converts and validates a time string as a valid time value.

value — string, required: time string to convert

string:

toStr

toStr(value)

Converts an input value to a string

value — any, required: value to convert (any type)

string

uppercase

uppercase(str)

Converts the input string to uppercase

str — any, required: value to convert

string: uppercase string

lowercase

lowercase(str)

Converts the input string to lowercase

str — any, required: value to convert

string: lowercase string

dateAdd

dateAdd(value, offvalue, unit)

Returns a date value offset by the specified amount.

value — string, required: date value to calculate (supports DD-MMM-YYYY, YYYY-MM-DD, YYYY-MM-DD HH:mm:SS and other formats)

offvalue — number, required: offset value, positive for forward offset, negative for backward offset

unit — string, required: offset value unit:

string:

dateDiff

dateDiff(date1, date2, unit)

Returns the difference between two dates converted to the specified unit (date1 - date2).

date1 — string, required: minuend date (supports multiple date formats, may include time portion)

date2 — string, required: subtrahend date

unit — string, required: difference unit

number/string:

dateFormat

dateFormat(date, format)

Formats a date string into the specified format.

date — string, required: date string (supports multiple formats)

format — string, required: target date format, supports YYYY (4-digit year), MM (2-digit month), MMM (abbreviated English month), DD (2-digit day) and other placeholders

string:

timeDiff

timeDiff(time1, time2, unit)

Returns the difference between two time values converted to the specified unit (time1 - time2).

time1 — string, required: minuend time value (e.g. '14:30:00')

time2 — string, required: subtrahend time value (e.g. '10:00:00')

unit — string, required: difference unit:

number/string:

getDays

getDays(value)

Returns the number of days corresponding to a millisecond value.

value — number, required: millisecond value to convert

number

getNow

getNow()

Returns the current date in "yyyy-MM-dd" format.

No parameters

string: current date, e.g. '2026-04-03'

getCharBySeparator

getCharBySeparator(value, separator, length, index)

Splits a string by a separator and returns the substring at the specified position.

value — string, required: string to split

separator — string, required: separator

length — number, required: expected number of substrings after splitting

index — number, required: which substring to return (starting from 1)

string:

getContainStr

getContainStr()

Searches for specified substrings within a target string and returns the first match found.

target — string, required: target string

searchStrings — string[], required >=1: substrings to match

string:

getContainStrNum

getContainStrNum()

Returns the count of matched substrings found within a target string.

target — string, required: target string

searchStrings — string[], required >=1: substrings to match

number: count of matched substrings

autoValue

autoValue(value, bcondition, enableWrite)

Assigns an input value to a control without triggering the edit check rules.

value — any, required: the value to assign

bcondition — boolean, optional, default = true: whether to execute assignment

enableWrite — boolean, optional, default = false: whether control is editable after assignment

object:

{
value: string,
bcondition: boolean,
enableWrite: boolean
}

autoIncrease

autoIncrease(seed, step, subpagestep, digit, prefix)

Assigns an initial value to an item; when the Item Group is copied, the copied item is assigned an auto-incremented value (primarily used in log forms).

seed — number, required: starting value, typically starting from 1

step — number, required: increment per step

subpagestep — number, optional:

digit — number, optional: number of digits, padded with leading zeros if insufficient (e.g. 3 → '001')

prefix — string, optional: prefix for result, supports {value} placeholder

object:

{
value: string,
bcondition: boolean,
enableWrite: boolean
} 

triggerVisit

triggerVisit(condition)

Triggers visit display based on a condition (applicable to unscheduled, common, and scheduled visits).

condition — boolean, required: trigger condition expression

boolean: whether condition is met

triggerNextVisit

triggerNextVisit(condition)

Triggers the display of the next unscheduled visit based on a condition.

condition — boolean, required: trigger condition expression

-

initVisit

initVisit(condition)

Initializes a visit based on a condition.

condition — boolean, required: initialization condition expression

-

initNextVisit

initNextVisit(condition)

Initializes the next visit based on a condition.

condition — boolean, required: initialization condition expression

-

triggerCycle

triggerCycle(condition, cycleName, index)

Triggers the creation of a specified cycle visit based on a condition.

condition — boolean, required: trigger condition expression

cycleName — string, required: name of Cycle

index — number, required: index number of Cycle

boolean: whether condition is met

triggerNextCycle

triggerNextCycle(condition, cycleName)

Triggers the creation of the next cycle visit based on a condition.

condition — boolean, required: trigger condition expression

cycleName — string, required: name of Cycle

boolean: whether condition is met

showGridIg

showGridIg(condition, igSn)

Controls if a specified item group (IG) row is shown or hidden in a grid form.

condition — boolean, required: display condition, true to show, false to hide

igSn — number, required: IG serial number (starting from 1)

object:

{
sn: number,
isShow: boolean|null
}

ignoreInit

ignoreInit(val)

Wrapper function to ignore rules for uninitialized data.

value — any, required: the value to pass through

-

getMaxByLog

getMaxByLog(item)

Returns the maximum value of a specified item across all active records in a log form.

type — string, required: data type

values — any[], variable, autofilled by system: item values from each record in Log Form

string: maximum value

getMaxConditionByLog

getMaxConditionByLog(item, condition)

Returns the maximum value of a specified item from records that meet a condition in a log form.

type — string, required: data type

pairs — any[], variable: sequence of (value, condition) pairs

-

getMinByLog

getMinByLog(item)

Returns the minimum value of a specified item across all active records in a log form.

type — string, required: data type

values — any[], variable, autofilled by system: item values from each record in Log Form

string: minimum value

getFirstByLog

getFirstByLog(item)

Returns the value of the first record for a specified item in a log form.

item — any, required: item identifier in Log Form (replaced by system with first record's value)

-

getLastByLog

getLastByLog(item)

Returns the value of the last record for a specified item in a log form.

item — any, required: item identifier in Log Form (replaced by system with last record's value)

-

getFirstSnByItemValue

getFirstSnByItemValue(item, itemValue)

Returns the SN (serial number) of the first occurrence of a specified item value in a log form.

item — string, required: item identifier in Log Form

itemValue — any, required: value to match

-

getLastSnByItemValue

getLastSnByItemValue(item, itemValue)

Returns the SN (serial number) of the last occurrence of a specified item value in a log form.

item — string, required: item identifier in Log Form

itemValue — any, required: value to match

-

getCountByItemValue

getCountByItemValue(item, itemValue)

Returns the total count of occurrences of a specified item value in a log form.

item — string, required: item identifier in Log Form

itemValue — any, required: value to match

-

getSnInLog

getSnInLog()

Returns the SN (serial number) of the current record in a log form.

No parameters

-

getItemValueByLogSn

getItemValueByLogSn(sn, itemId)

Returns the value of a specified item at a given SN (serial number) in a log form.

sn — number, required: record serial number

itemId — string, required: item identifier

-

getSumOfItemInLog

getSumOfItemInLog(itemId, condition)

Calculates the sum of item values across all active IGs that meet a condition in a log form.

itemId — any, required: first item value

condition — boolean, required: first condition

pairs — any[], variable: sequence of (item, condition) pairs

getItemInLogByCurrentSn

getItemInLogByCurrentSn(itemId)

Returns the value of a specified item under the current IG SN in a log form.

itemId — string, required: item identifier to retrieve value for

-

getItemValueByFirstValueInLogForm

getItemValueByFirstValueInLogForm(recordItem, judgementItem, judgementItemValue)

Returns the value of a specified item from the first matching record in a log form based on a condition value.

recordItem — string, required: item identifier to retrieve value for

judgementItem — string, required: judgement item identifier for matching

judgementItemValue — any, required: value to match

value of recordItem in first matching record

getItemValueByLastValueInLogForm

getItemValueByLastValueInLogForm(recordItem, judgementItem, judgementItemValue)

Returns the value of a specified item from the last matching record in a log form based on a condition value.

recordItem — string, required: item identifier to retrieve value for

judgementItem — string, required: judgement item identifier for matching

judgementItemValue — any, required: value to match

value of recordItem in last matching record

getCountByItemVal

getCountByItemVal(recordItem, judgementItem, judgementItemValue)

Counts the number of matching records in a log form based on a condition value.

recordItem — string, required: record item identifier

judgementItem — string, required: judgement item identifier for matching

judgementItemValue — any, required: value to match

number: count of matching records

getCycleSnItemValue

getCycleSnItemValue(groupName, cyleNum, crfItemId)

Returns the CRF Item value at a specified serial number within a specified Cycle

groupName — string, required: Cycle group name

cyleNum — number, required: Cycle serial number

crfItemId — string, required: CRF Item identifier

-

getPrevCycleItemVal

getPrevCycleItemVal(itemId)

Returns the value of a specified item in the previous Cycle

itemId — string, required: item identifier to retrieve the value for

-

getCycleSnOfItem

getCycleSnOfItem(itemId)

Returns the Cycle serial number (SN) of the Cycle containing the specified item

itemId — string, required: item identifier to query Cycle SN for

-

getPreviousCyclesItemValues

getPreviousCyclesItemValues(itemId)

Returns a collection of the specified item's values from all Cycle Visits prior to the current Cycle

itemId — string, required: item ID under Cycle Visit

-

getCountByItemValAllVisitsInCycle

getCountByItemValAllVisitsInCycle(judgementItem, judgementItemValue)

Counts the number of records matching a condition across all Visits within a Cycle

judgementItem — string, required: judgement item identifier for matching

judgementItemValue — any, required: judgement value to match

number: count of matching records

getSubjectArmCode

getSubjectArmCode()

Returns the arm code (treatment group code) of the current subject.

No parameters

-

cycleVisitName

cycleVisitName(name)

Determines whether the cycle visit name equals the provided parameter; the visit is displayed only if they match.

name — string, required: Cycle Visit name to match

-

getICFVersion

getICFVersion(SVDAT, ICFDate, ICFVersion)

Returns the ICF (Informed Consent Form) version number.

SVDAT — string, required: visit date (Date of Visit)

ICFDate — string, required: ICF signing date (first pair)

ICFVersion — string, required: ICF version number (second pair)

pairs — string[], variable: additional (ICFDate, ICFVersion) pairs

string:

getSubjectPhase

getSubjectPhase()

Returns the current study phase of the subject.

No parameters

-

getSubjectCountryValue

getSubjectCountryValue()

Returns the country or region value of the site where the current subject is enrolled.

No parameters

-

getItemValAnyway

getItemValAnyway(itemId)

Always returns the value of the specified item, regardless of whether the visit or form is disabled.

itemId — string, required: item identifier to retrieve value for

-

getOnlyValidEqualDtTime

getOnlyValidEqualDtTime()

Returns the time value corresponding to the only matching date.

baseDt — string, required: base date to match

pairs — string[], variable: sequence of (date, time) pairs

string:

getIGSerialNumber

getIGSerialNumber()

Returns the serial number of the current IG (applicable to eDiary or Log Form).

No parameters

-

getCurrentFormName

getCurrentFormName()

Returns the current form name.

No parameters

-

getCurrentVisitName

getCurrentVisitName()

Returns the current visit name.

No parameters

-

getItemValueInPreUnscheduledVisit

getItemValueInPreUnscheduledVisit(itemId)

Returns the value of a specified item from the visit preceding the current unscheduled visit.

itemId — string, required: item identifier to retrieve value for

value of item in previous Unscheduled Visit

getEdiaryDateValue

getEdiaryDateValue()

Placeholder function for auto-filling data in the eDiary app after dosing.

No parameters

-

getEdiaryWindowDate

getEdiaryWindowDate()

Placeholder function for edit check on date format data entry in eDiary.

No parameters

-

getComplianceValue

getComplianceValue(itemId)

Returns the medication compliance value.

itemId — string, required: item identifier to retrieve compliance value for

-

getMinCompareBaseline

getMinCompareBaseline(compareItem, baseline)

Returns the result of comparing a specified item with the baseline value in an unscheduled visit (minimum comparison).

compareItem — any, required: item identifier to compare (manually specified)

baseline — any, required: baseline item identifier

getValueFromRelatedForm

getValueFromRelatedForm(var1, var2, deDuplicate, alphabetSort, separator)

Retrieves and concatenates the values of a specified item from a related form.

var1 — string, required: from_Item identifier in Related Form

var2 — string, required: item identifier in to_form of Related Form

deDuplicate — boolean, required: whether to deduplicate

alphabetSort — boolean, required: whether to sort alphabetically

separator — string, required: separator, cannot be empty

string: concatenated text value

cubeRoot

cubeRoot(num, digit)

Calculates the cube root of a number.

num — string/number, required: number to calculate cube root of

digit — number, optional: number of decimal places to retain, e.g. 2, 3, 4

string:

squareRoot

squareRoot(num, digit)

Calculates the square root of a number.

num — string/number, required: number to calculate square root of (non-negative)

digit — number, optional: number of decimal places to retain

string

labRangeCheck

labRangeCheck(lowcheck, uppercheck)

Checks whether a lab result is within the standard normal range (simplified version, auto-generated by design).

lowcheck — boolean, required: whether to perform lower limit check

uppercheck — boolean, required: whether to perform upper limit check

standardJson — string, autofilled by system: JSON string of standard data (LabConversionRangeDto structure)

object

{
type: string,
isValid: boolean,
tip: string
}

check result

labRangeCheck1

labRangeCheck1(lowcheck, uppercheck, lowFactor, upperFactor)

Checks whether a lab result is within a custom extreme value range (full version).

lowcheck — boolean, required: whether to perform lower limit check

uppercheck — boolean, required: whether to perform upper limit check

lowFactor — number, conditional: lower limit conversion factor

upperFactor — number, conditional: upper limit conversion factor

standardJson — string, autofilled by system: JSON string of standard data

fromLabRangeCheck — boolean, internal: indicates call from labRangeCheck (skips factor validation)

object

{
type: string,
isValid: boolean,
tip: string
} 

check result

getSiteNameOfReporter

getSiteNameOfReporter()

Returns the site name of the reporter.

No parameters

string: site name of reporter

getCountryOrRegionOfReporter

getCountryOrRegionOfReporter()

Returns the country or region of the reporter.

No parameters

string: country or region of reporter

getProvinceOrStateOfReporter

getProvinceOrStateOfReporter()

Returns the province or state of the reporter.

No parameters

string: province or state of reporter

getCityOfReporter

getCityOfReporter()

Returns the city of the reporter.

No parameters

string: city of reporter

getAddressOfReporter

getAddressOfReporter()

Returns the address of the reporter.

No parameters

string: address of reporter

getPostalOrZoneCodeOfReporter

getPostalOrZoneCodeOfReporter()

Returns the postal or zone code of the reporter.

No parameters

string: postal or zone code of reporter

getFirstNameOfReporter

getFirstNameOfReporter()

Returns the first name of the reporter.

No parameters

string: first name of reporter

getLastNameOfReporter

getLastNameOfReporter()

Returns the last name of the reporter.

No parameters

string: last name of reporter

getPhoneOfReporter

getPhoneOfReporter()

Returns the phone number of the reporter.

No parameters

string: phone number of reporter

getEmailOfReporter

getEmailOfReporter()

Returns the email address of the reporter.

No parameters

string: email address of reporter