Preface
RulePoint
RulePoint Concepts
- RulePoint Concepts Overview
- Understanding RulePoint Entities
Using RulePoint
RulePoint Objects
- RulePoint Objects Overview
- State of RulePoint Objects
Working with Topics
Working with Connections
Working with Sources
Working with Responders
Working with Responses
Working with Watchlists
Working with Analytics
- Analytics Overview
- Analytic Types
- Creating an Analytic
- Copying an Analytic
- Editing an Analytic
- Deleting an Analytic
- Viewing Related Objects
- Predefined Analytics
  - abs
  - average
  - ceil
  - charat
  - clean
  - compareto
  - concat
  - confidence
  - correlation
  - count
  - current
  - date
  - datedifference
  - endswith
  - even
  - floor
  - getcurrentdate
  - getdatefrommillis
  - getdateinmillis
  - geodistance
  - geoinbound
  - geoinsidearea
  - geointersect
  - geooutbound
  - geooutsidearea
  - geopassthru
  - indexof
  - integer
  - isblank
  - isholiday
  - isnum
  - istext
  - isweekday
  - isweekend
  - large
  - list2vars
  - lower
  - max
  - min
  - mod
  - mode
  - mround
  - odd
  - parse
  - past
  - percentile
  - power
  - proper
  - range
  - regex
  - replace
  - round
  - rounddown
  - roundup
  - sign
  - small
  - startswith
  - stdev
  - stringequals
  - stringindexof
  - stringlastindexof
  - stringlength
  - substring
  - sum
  - trim
  - truncate
  - upper
  - xpath
- Predefined Operators
  - contains
  - equalsSet
  - has
  - in
  - match
  - notMatch
  - search
  - unique
  - group by
  - distinct
  - unmatched
- Using the distinct, group by, and ummatched Filters
DRQL
Working with Rules
Working with Alerts
Setting Access Controls
Troubleshooting RulePoint Issues
Connecting to an Ultra Messaging Application
Creating an Ultra Messaging JMS Source

User Guide

6.1
- 6.2
- 6.1.2

Back Next

Predefined Analytics

RulePoint provides a predefined set of analytics that you can use when writing rules. You cannot create instances of the predefined analytics.

The following table describes the predefined analytics, arranged in alphabetical order:

Analytics	Type and Description	Return Type
abs	Math: Returns the absolute value of a number.	List of real numbers
average	Statistical: Returns the average of its arguments.	Real number
ceil	Math: Rounds a number to the nearest integer or to the nearest multiple of significance.	List of real numbers
charat	String: Returns the character from a string at the specified index.	Character
clean	String: Removes all nonprintable characters from text.	List of string
compareto	String: Compares two given strings.	Integer
concat	String: Joins several items into one text item.	String
confidence	Statistical: Returns the confidence interval for a population mean.	Real number
correlation	Statistical: Returns the correlation coefficient between two data sets.	Real number
count	Statistical: Counts the number of occurrences of event properties.	Integer
current	Lookup: Selects the current event out of an event set.	Any type
date	Date and Time: Converts a date-time string into a format that RulePoint can use to compare with other date-time values.	Date
datedifference	Date: Returns the difference between two dates or time in years, months, days, hours, months, or seconds.	Real number
endswith	String: Checks if all the text inputs end with the given string.	Boolean value
even	Math: Rounds a number to the nearest even integer.	List of real numbers
floor	Math: Rounds a number down, toward zero, to the nearest multiple of significance.	List of real numbers
getcurrentdate	Date: Returns the current system date and time.	Date
getdatefrommillis	Date: Coverts milliseconds into date.	Date
getdateinmillis	Date: Coverts the date and time into milliseconds.	Long
geodistance	Geo spatial: Returns minimum distance between two geo points.	Real number
geoinbound	Geo spatial: Checks if a line has its points starting outside a geo polygon and ending inside the geo polygon.	Boolean value
geoinsidearea	Geo spatial: Determines whether a geo reference point is inside a defined polygon.	Boolean value
geointersect	Geo spatial: Validates whether two geo polygons intersect.	Boolean value
geooutbound	Geo spatial: Determines whether points of a line start inside a polygon and end outside the polygon.	Boolean value
geooutsidearea	Geo spatial: Determines whether a geo referenced point is outside a defined polygon.	Boolean value
geopassthru	Geo spatial: Verifies if a geo line passes through a specified geo point.	Boolean value
indexof	Lookup and reference: Accesses events with a specific index. An event set lists events from the newest event to the oldest event.	Any type
integer	Math: Rounds a number down to the nearest integer.	List of integers
isblank	Informational: Verifies whether all the data are blank.	List of Boolean values
isholiday	Informational: Verifies whether a date is in the holiday list.	Boolean value
isnum	Informational: Verifies whether all data contains only numbers.	List of Boolean values
istext	Informational: Verifies whether all data contains only text.	List of Boolean values
isweekday	Informational: Checks if the given date is a weekday.	Boolean value
isweekend	Informational: Verifies if the given date is a weekend.	Boolean value
large	Statistical: Returns the k-th largest value in a data set.	Real number
list2vars	Transform: Transforms result list in to multiple values and assigns them to temporary variables.	Any type
lower	String: Converts the text to lower case.	List of strings
max	Statistical: Evaluates a list of numbers and returns the number with the largest value.	Real number
min	Math: Evaluates a list of numbers and returns the number with the lowest value.	Real number
mod	Math: Returns the remainder after division.	Real number
mode	Statistical: Returns the most common value in a data set.	Real number
mround	Math: Returns a number rounded to the desired multiple	List of real numbers
odd	Math: Rounds a number up to the nearest odd integer.	List of real numbers
parse	String: Splits the text at the specified delimiter and returns a list of the text.	List of strings
past	Lookup: Selects the past event from an event set.	Any type
percentile	Statistical: Returns the k-th percentile of values in a range.	Real number
power	Math: Returns the result of a number raised to a power.	Real number
proper	String: Capitalizes the first letter in each word of a text value.	List of strings
range	Statistical: Calculates and returns the difference between the minimum and maximum numeric values provided.	Real number
regex	Regular expression: Applies a regular expression to a string and returns all matching substrings.	String
replace	String: Replaces characters within text.	List of strings
round	Math: Rounds a number to a specified number of digits.	List of real numbers
rounddown	Math: The rounddown analytic rounds a number down, towards zero.	List of real numbers
roundup	Math: Rounds a number up, away from zero.	List of real numbers
sign	Math: Returns the sign of a number.	List of real numbers
small	Statistical: Returns the k-th smallest value in a data set.	Real number
startswith	String: Validates if all the text that starts with the given string.	Boolean value
stdev	Statistical: Estimates standard deviation based on a sample.	Real number
stringequals	String: Validates if two strings are equal.	Boolean value
stringindexof	String: Returns the index within the string of the first occurrence of the specified substring.	Integer
stringlastindexof	String: Returns the index within the string of the rightmost occurrence of the specified substring.	Integer
substring	String: Returns the substring of the string based on the index provided.	String
sum	Math: Adds a list of numbers.	Real number
trim	String: Removes spaces from the text.	List of strings
truncate	Math: Truncates a number to an integer.	List of integers
upper	String: Converts the text to upper case.	List of strings
xpath	XML lookup: Navigates to a specific element and attribute in xml using xpath expression and returns the list of objects that match.	Any type

Rename Saved Search

Table of Contents

User Guide

User Guide

Predefined Analytics

Predefined Analytics