These function families complete the expression language. Each group below lists its functions with their parameters, return type and examples.
1. Text and Pattern Functions
Regular Expression Functions
Functions for matching and replacing patterns with regular expressions.
regexMatch
(text, pattern) Checks whether a string matches a regular expression pattern.
| Parameters | | text | string | String to test | | pattern | string | Regular expression pattern | |
| Returns | boolean |
| Examples | regexMatch("abc123", "[0-9]+") → true regexMatch("hello", "^[0-9]+$") → false |
| See Also | |
regexReplace
(text, pattern, replacement) Replaces every match of a regular expression pattern in a string.
| Parameters | | text | string | Input string | | pattern | string | Regular expression pattern to match | | replacement | string | Replacement string | |
| Returns | string |
| Examples | regexReplace("abc123def456", "[0-9]+", "#") → abc#def# regexReplace("hello world", "\s+", " ") → hello world |
| See Also | |
(text, pattern, group?) Extracts the first match of a regular expression pattern from a string. You can also extract a specific capture group.
| Parameters | | text | string | Input string | | pattern | string | Regular expression pattern | | group (optional) | number | Capture group index; 0 returns the full match (default: 0) | |
| Returns | string |
| Examples | regexExtract("abc123def", "[0-9]+") → 123 regexExtract("2025-01-15", "(\d{4})-(\d{2})", 1) → 2025 |
| See Also | |
String Utilities
Additional string manipulation functions.
repeat
(text, count) Repeats text the specified number of times.
| Parameters | | text | string | Text to repeat | | count | number | Number of repetitions | |
| Returns | string |
| Examples | repeat("ab", 3) → "ababab" |
countOccurrences
(text, search) Counts non-overlapping occurrences of a substring.
| Parameters | | text | string | Text to search | | search | string | Substring to find | |
| Returns | number |
| Examples | countOccurrences("abcabc", "abc") → 2 |
split
(text, delimiter, index) Splits text at a delimiter and returns the nth part, starting at 1.
| Parameters | | text | string | Text to split | | delimiter | string | Delimiter | | index | number | 1-based index of the part to return | |
| Returns | string |
| Examples | split("a-b-c", "-", 2) → "b" |
exact
(a, b) Case-sensitive string comparison. Returns true if the strings are identical.
| Parameters | | a | string | First string | | b | string | Second string | |
| Returns | boolean |
| Examples | exact("Hello", "hello") → false |
2. Date and Duration Helpers
Duration Helpers
Converts durations in milliseconds to common time units.
durationInDays
(ms) Converts milliseconds to days.
| Parameters | | ms | number | Duration in milliseconds | |
| Returns | number |
| Examples | durationInDays(86400000) → 1 durationInDays(caseThroughputTime) → Throughput time in days |
durationInHours
(ms) Converts milliseconds to hours.
| Parameters | | ms | number | Duration in milliseconds | |
| Returns | number |
| Examples | durationInHours(3600000) → 1 durationInHours(stepDuration) → Step duration in hours |
durationInMinutes
(ms) Converts milliseconds to minutes.
| Parameters | | ms | number | Duration in milliseconds | |
| Returns | number |
| Examples | durationInMinutes(60000) → 1 durationInMinutes(waitingTime) → Waiting time in minutes |
durationInSeconds
(ms) Converts milliseconds to seconds.
| Parameters | | ms | number | Duration in milliseconds | |
| Returns | number |
| Examples | durationInSeconds(1500) → 1.5 |
Date Construction
Creates dates from components or parses strings as dates.
date
(year, month, day) Creates a UTC date from a year, month, and day.
| Parameters | | year | number | Year | | month | number | Month (1-12) | | day | number | Day of the month | |
| Returns | date |
| Examples | date(2024, 1, 1) → 1704067200000 date(2024, 6, 15) → June 15, 2024 |
toDate
(value, format?) Parses a value as a date. Accepts numbers, such as epoch milliseconds, or strings.
| Parameters | | value | any | Value to convert to a date | | format (optional) | string | Date format pattern (optional) | |
| Returns | date |
| Examples | toDate(1704067200000) → 1704067200000 toDate("2024-01-15") → January 15, 2024 toDate("31/12/2024 23:45:59", "dd/MM/yyyy HH:mm:ss") → 1735688759000 |
| Notes | When a format is provided, use the same supported tokens as formatDate. Parsing is UTC-based. |
today
() Returns the current date at midnight UTC.
| Returns | date |
| Examples | today() → Current date at midnight |
Date Period Boundaries
Truncates or rounds dates to period boundaries.
startOfDay
(date) Truncates a date to the start of the day (midnight).
| Parameters | | date | date | Date to truncate | |
| Returns | date |
| Examples | startOfDay(StartTime) → Midnight of the same day |
startOfWeek
(date) Returns the start of the week (Monday).
| Parameters | |
| Returns | date |
| Examples | startOfWeek(StartTime) → Monday of the same week |
startOfMonth
(date) Returns the first day of the month.
| Parameters | |
| Returns | date |
| Examples | startOfMonth(StartTime) → First of the month |
startOfYear
(date) Returns January 1 of the year.
| Parameters | |
| Returns | date |
| Examples | startOfYear(StartTime) → January 1st |
endOfWeek
(date) Returns the end of the week (Sunday at 23:59:59).
| Parameters | |
| Returns | date |
| Examples | endOfWeek(StartTime) → Sunday end of day |
endOfMonth
(date) Returns the end of the month at 23:59:59.
| Parameters | |
| Returns | date |
| Examples | endOfMonth(StartTime) → Last day of the month, end of day |
endOfYear
(date) Returns December 31 at 23:59:59.
| Parameters | |
| Returns | date |
| Examples | endOfYear(StartTime) → December 31st, end of day |
Date Shortcuts
Convenience functions for common date difference and addition calculations.
daysBetween
(date1, date2) Returns the difference between two dates in days.
| Parameters | | date1 | date | Start date | | date2 | date | End date | |
| Returns | number |
| Examples | daysBetween(StartTime, EndTime) → Duration in days between two dates |
hoursBetween
(date1, date2) Returns the difference between two dates in hours.
| Parameters | | date1 | date | Start date | | date2 | date | End date | |
| Returns | number |
| Examples | hoursBetween(StartTime, EndTime) → Duration in hours between two dates |
minutesBetween
(date1, date2) Returns the difference between two dates in minutes.
| Parameters | | date1 | date | Start date | | date2 | date | End date | |
| Returns | number |
| Examples | minutesBetween(StartTime, EndTime) → Duration in minutes between two dates |
secondsBetween
(date1, date2) Returns the difference between two dates in seconds.
| Parameters | | date1 | date | Start date | | date2 | date | End date | |
| Returns | number |
| Examples | secondsBetween(StartTime, EndTime) → Duration in seconds between two dates |
addDays
(date, days) Adds days to a date.
| Parameters | | date | date | Base date | | days | number | Number of days to add | |
| Returns | date |
| Examples | addDays(StartTime, 5) → Date 5 days later |
addHours
(date, hours) Adds hours to a date.
| Parameters | | date | date | Base date | | hours | number | Number of hours to add | |
| Returns | date |
| Examples | addHours(StartTime, 3) → Date 3 hours later |
addMinutes
(date, minutes) Adds minutes to a date.
| Parameters | | date | date | Base date | | minutes | number | Number of minutes to add | |
| Returns | date |
| Examples | addMinutes(StartTime, 30) → Date 30 minutes later |
addSeconds
(date, seconds) Adds seconds to a date.
| Parameters | | date | date | Base date | | seconds | number | Number of seconds to add | |
| Returns | date |
| Examples | addSeconds(StartTime, 45) → Date 45 seconds later |
endOfDay
(date) Returns the end of the day (23:59:59.999) for a given date.
| Parameters | |
| Returns | date |
| Examples | endOfDay(StartTime) → 23:59:59 on the same day |
startOfQuarter
(date) Returns the first day of the quarter for a given date.
| Parameters | |
| Returns | date |
| Examples | startOfQuarter(StartTime) → 2024-04-01 for a June date |
endOfQuarter
(date) Returns the last moment of the quarter for a given date.
| Parameters | |
| Returns | date |
| Examples | endOfQuarter(StartTime) → 2024-06-30T23:59:59Z for a June date |
3. Logic Helpers
Multi-Way Conditional
Matches a value against multiple cases.
switch
(value, match1, result1, ..., default?) Matches a value against a list of cases and returns the corresponding result. Similar to a multi-way if.
| Parameters | | value | any | Value to match | | match1, result1, ... | any | Pairs of match values and results | | default (optional) | any | Default result if no match (optional) | |
| Returns | any |
| Examples | switch("a", "a", 1, "b", 2, 0) → 1 switch(Status, "Open", 1, "Closed", 2, 0) → 1 if Open, 2 if Closed, else 0 |
| Notes | Takes variadic arguments: switch(value, match1, result1, match2, result2, ..., default) |
Range Check
Checks whether values fall within ranges or clamps them to a range.
between
(value, low, high) Returns true if a value is between the lower and upper bounds, inclusive.
| Parameters | | value | number | Value to check | | low | number | Lower bound | | high | number | Upper bound | |
| Returns | boolean |
| Examples | between(Amount, 100, 1000) → true if Amount is between 100 and 1000 |
clamp
(value, min, max) Restricts a value to the [min, max] range.
| Parameters | | value | number | Value to clamp | | min | number | Minimum value | | max | number | Maximum value | |
| Returns | number |
| Examples | clamp(Score, 0, 100) → Score restricted to 0-100 |
Let Binding
Assigns names to intermediate values for use in complex expressions.
let
(name, value, body) Assigns a value to a name, then evaluates the body expression with that name available.
| Parameters | | name | string | Variable name (string literal) | | value | any | Expression to assign | | body | any | Expression that uses the assigned variable | |
| Returns | any |
| Examples | let("avg", caseAvg(Amount), Amount - avg) → Deviation from case average let("x", Amount * 2, let("y", x + 3, x * y)) → Nested let bindings |
4. Flow, Activity and SLA Functions
Preceded-By Predicates
Checks whether an activity is preceded by another activity in a case.
directlyPrecededBy
(activity, predecessor) Returns true if the second activity directly precedes the first activity in the case.
| Parameters | | activity | string | Activity to check | | predecessor | string | Expected predecessor activity | |
| Returns | boolean |
| Examples | directlyPrecededBy("Approve", "Review") → true if Review directly precedes Approve |
| See Also | |
eventuallyPrecededBy
(activity, predecessor) Returns true if the second activity eventually precedes the first activity in the case.
| Parameters | | activity | string | Activity to check | | predecessor | string | Expected predecessor activity | |
| Returns | boolean |
| Examples | eventuallyPrecededBy("Ship", "Order") → true if Order appears before Ship in the case |
| See Also | |
Rework Detection
Identifies rework patterns where activities repeat within a case.
isRework
Property True if the current activity occurred earlier in the case.
reworkCount
Property Total number of repeated activity executions in the case.
activityOccurrence
Property Occurrence number of this activity in the case: 1 for the first time, 2 for the second, and so on.
Activity Queries
Checks whether activities appear in a case and counts their occurrences.
hasActivity
(activityName) Returns true if the named activity appears anywhere in the case.
| Parameters | | activityName | string | Name of the activity to check | |
| Returns | boolean |
| Examples | hasActivity("Approve") → true if the case contains an Approve activity |
activityCount
(activityName) Returns the number of times the named activity appears in the case.
| Parameters | | activityName | string | Name of the activity to count | |
| Returns | number |
| Examples | activityCount("Review") → Number of Review activities in the case |
Inter-Activity Timing
Measures the time between specific activities in a case.
timeBetween
(activityA, activityB) Returns the time between the first occurrence of activity A and the first occurrence of activity B.
| Parameters | | activityA | string | First activity | | activityB | string | Second activity | |
| Returns | number |
| Examples | timeBetween("Submit", "Approve") → Time in ms from Submit to Approve |
timeSinceActivity
(activityName) Time elapsed since the last occurrence of the named activity before the current event.
| Parameters | | activityName | string | Activity name | |
| Returns | number |
| Examples | timeSinceActivity("Start") → Time since the last Start activity |
timeToActivity
(activityName) Time until the next occurrence of the named activity after the current event.
| Parameters | | activityName | string | Activity name | |
| Returns | number |
| Examples | timeToActivity("Complete") → Time until the next Complete activity |
SLA Functions
Monitors Service Level Agreements and detects breaches.
slaBreached
(duration, threshold) Returns true if a duration exceeds the SLA threshold.
| Parameters | | duration | number | Actual duration | | threshold | number | SLA threshold | |
| Returns | boolean |
| Examples | slaBreached(100000, 86400000) → false slaBreached(caseThroughputTime, 86400000) → true if case exceeds 24-hour SLA |
slaRemaining
(startDate, slaDuration) Returns the time remaining before an SLA breach, or a negative value after the breach.
| Parameters | | startDate | date | Start timestamp | | slaDuration | number | SLA duration in milliseconds | |
| Returns | number |
| Examples | slaRemaining(caseStartTime, 172800000) → Time remaining for 48-hour SLA |
caseAge
Property Time elapsed since the case started, in milliseconds from the first event to now.
Self-Loop Detection
Detects and counts self-loop patterns where the same activity occurs consecutively.
isSelfLoop
Property True if the current activity is the same as the previous activity in the case.
selfLoopCount
Property Number of consecutive repetitions of the same activity in the current case.
Resource Analytics
Detects resource handoffs and changes within a case.
isResourceChange
(expr) Returns true if the expression value changed from the previous event.
| Parameters | | expr | any | Column expression to check for changes | |
| Returns | boolean |
| Examples | isResourceChange(Resource) → true when resource differs from previous event |
resourceHandoffCount
(expr) Counts value changes across the case.
| Parameters | | expr | any | Column expression whose changes to count | |
| Returns | number |
| Examples | resourceHandoffCount(Resource) → 2 for Alice→Alice→Bob→Bob→Alice |
| Notes | Not available in Athena-backed expressions yet. For backend queries, use isResourceChange(expr) together with caseCountIf(...) in a derived attribute. |
5. Statistics, Ranking and Value Changes
Ranking Functions
Ranks events by expression values within a case or across all events.
caseRank
(expr) Rank of the current event in the case, ordered by expression value, with gaps for ties.
| Parameters | | expr | number | Expression to rank by | |
| Returns | number |
| Examples | caseRank(Amount) → Rank by Amount within the case |
caseDenseRank
(expr) Dense rank within the case, with no gaps for ties.
| Parameters | | expr | number | Expression to rank by | |
| Returns | number |
| Examples | caseDenseRank(Amount) → Dense rank by Amount within the case |
allRank
(expr) Rank across all events.
| Parameters | | expr | number | Expression to rank by | |
| Returns | number |
| Examples | allRank(Duration) → Global rank by Duration |
allPercentRank
(expr) Percent rank across all events, from 0 to 1.
| Parameters | | expr | number | Expression to rank by | |
| Returns | number |
| Examples | allPercentRank(Duration) → Percentile rank (0-1) |
Value Change Detection
Detects when values change between events.
changed
(expr) Returns true if the expression value differs from the previous event.
| Parameters | | expr | any | Expression to check for changes | |
| Returns | boolean |
| Examples | changed(Resource) → true if the resource changed from the previous event |
caseChanges
(expr) Counts value changes across all events in the case.
| Parameters | | expr | any | Expression to check for changes | |
| Returns | number |
| Examples | caseChanges(Resource) → Number of resource handoffs in the case |
| Notes | Not available in Athena-backed expressions yet. For backend queries, use changed(expr) together with caseCountIf(...) in a derived attribute. |
Conditional Running Aggregates
Running aggregates with conditions, calculated through the current event.
caseRunningSumIf
(expr, condition) Running conditional sum through the current event.
| Parameters | | expr | number | Expression to sum | | condition | boolean | Condition to filter events | |
| Returns | number |
| Examples | caseRunningSumIf(Amount, Status == "Paid") → Running sum of Amount where Status is Paid |
caseRunningCountIf
(condition) Running conditional count through the current event.
| Parameters | | condition | boolean | Condition to count | |
| Returns | number |
| Examples | caseRunningCountIf(Activity == "Error") → Running count of Error activities |
caseRunningAvgIf
(expr, condition) Running conditional average through the current event.
| Parameters | | expr | number | Expression to average | | condition | boolean | Condition to filter events | |
| Returns | number |
| Examples | caseRunningAvgIf(Duration, Priority == "High") → Running average duration of high-priority events |
Elapsed Time Properties
Properties for measuring progress and elapsed time within a case.
elapsedSinceStart
Property Time elapsed since the case started, in milliseconds.
remainingInCase
Property Time remaining until the case ends, in milliseconds.
percentComplete
Property Progress through the case as a fraction from 0 to 1.
Extended Conditional Aggregates
Additional conditional aggregate functions for median, standard deviation, and distinct counts.
caseMedianIf
(expr, condition) Calculates the conditional median across case events where the condition is true.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | caseMedianIf(Amount, Activity == "Review") → Median amount for Review activities |
allMedianIf
(expr, condition) Calculates the conditional median across all events where the condition is true.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | allMedianIf(Amount, Status == "Complete") → Global median for complete events |
caseStdDevIf
(expr, condition) Calculates the conditional standard deviation across case events.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | caseStdDevIf(Duration, Activity == "Review") → StdDev of Review durations in case |
allStdDevIf
(expr, condition) Calculates the conditional standard deviation across all events.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | allStdDevIf(Amount, Priority == "High") → Global stddev for high priority |
caseCountDistinctIf
(expr, condition) Counts distinct values conditionally across case events.
| Parameters | | expr | any | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | caseCountDistinctIf(Category, Amount > 100) → Distinct categories with large amounts |
allCountDistinctIf
(expr, condition) Counts distinct values conditionally across all events.
| Parameters | | expr | any | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | allCountDistinctIf(User, Department == "Sales") → Distinct users in Sales department |
Extended Running Aggregates
Additional running aggregate functions for median, standard deviation, and conditional minimum and maximum.
caseRunningMedian
(expr) Running median of values through the current event.
| Parameters | | expr | number | Value expression | |
| Returns | number |
| Examples | caseRunningMedian(Amount) → Running median amount |
caseRunningStdDev
(expr) Running standard deviation through the current event.
| Parameters | | expr | number | Value expression | |
| Returns | number |
| Examples | caseRunningStdDev(Amount) → Running standard deviation |
caseRunningMinIf
(expr, condition) Running conditional minimum through the current event.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | caseRunningMinIf(Amount, Activity == "Review") → Running min of Review amounts |
caseRunningMaxIf
(expr, condition) Running conditional maximum through the current event.
| Parameters | | expr | number | Value expression | | condition | boolean | Filter condition | |
| Returns | number |
| Examples | caseRunningMaxIf(Amount, Priority == "High") → Running max for high priority |
6. JSON Functions