Operators and functions

Operators and functions could be found in ATOME: Matter during the process of creating a business rule. To find the list of most used examples and easily implement them to the business rule open a business rule and hover the cursor over the sign next to expression.

Clicking on it will open a small modal window with the list of functions and operators. By clicking on the “plus” sign it is possible to instantly add the chosen element to the expression.

Binary operators

Operator	Left parameter (param 1)	Right parameter (param 2)	Description	Can be used in XBRL	Can be used in Particles
`+`	Any numeric value node.	Any numeric value node.	Returns a sum of both parameters.	YES	YES
`-`	Any numeric value node.	Any numeric value node.	Returns a difference of both parameters.	YES	YES
`*`	Any numeric value node.	Any numeric value node.	Returns a product of both parameters.	YES	YES
`/`	Any numeric value node.	Any numeric value node different than zero.	Returns a quotient of both parameters.	YES	YES
`=`	Any value node.	Any value node.	Returns `TRUE` if param 1 is equal to param 2, otherwise `FALSE`.	YES	YES
`!=`	Any value node.	Any value node.	Returns `TRUE` if param 1 is not equal to param 2, otherwise `FALSE`.	YES	YES
`>=`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is greater than or equal to param 2, otherwise `FALSE`.	YES	YES
`>`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is greater than param 2, otherwise `FALSE`.	YES	YES
`<=`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is smaller than or equal to param 2, otherwise `FALSE`.	YES	YES
`<`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is smaller than param 2, otherwise `FALSE`.	YES	YES
`i+`	Any numeric value node.	Any numeric value node.	Returns an interval sum of both parameters.	YES	YES
`i-`	Any numeric value node.	Any numeric value node.	Returns a interval difference of both parameters.	YES	YES
`i*`	Any numeric value node.	Any numeric value node.	Returns a interval product of both parameters.	YES	YES
`i/`	Any numeric value node.	Any numeric value node different than zero.	Returns a interval quotient of both parameters.	YES	YES
`i=`	Any value node.	Any value node.	Returns `TRUE` if param 1 is interval equal to param 2, otherwise `FALSE`.	YES	YES
`i>=`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is interval greater than or equal to param 2, otherwise `FALSE`.	YES	YES
`i>`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is interval greater than param 2, otherwise `FALSE`.	YES	YES
`i<=`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is interval smaller than or equal to param 2, otherwise `FALSE`.	YES	YES
`i<`	Any numeric value node.	Any numeric value node.	Returns `TRUE` when param 1 is interval smaller than param 2, otherwise `FALSE`.	YES	YES
`and`	Any logical value node.	Any logical value node.	Returns `TRUE` when both parameters are `TRUE`, otherwise `FALSE`.	YES	YES
`or`	Any logical value node.	Any logical value node.	Returns `TRUE` when one of the parameters is `TRUE`, otherwise `FALSE`.	YES	YES

Functions

Function name	Parameters	Description	Can be used in XBRL	Can be used in Particles
`Abs`	Any numeric value node	Returns the absolute value of the given parameter.	YES	YES
`iAbs`	Any numeric value node	Returns the absolute interval value of the given parameter.	YES	YES
`AccountingStandard`		Returns accounting standard for currently validated report based on module label: module label contains IFRS → returns`IFRS`, module label contains GAAP → returns `GAAP`, in all other cases → returns empty string.	NO	YES
`AddPeriods`	Period node Period node	Returns the summed period.	YES
`AddPeriodToDate`	Date node Period node	Returns the date node delayed by the period value.	YES
`CheckFilingIndicator`	Variable node with table specified	Returns `TRUE` if filing indicator for a given table (param 1) has been reported as `filed`, otherwise `FALSE`.	NO	YES
`ContextPeriod`	Variable node	Returns context date from the variable.	YES
`Count`	Variable node	Returns number of not-null facts in given variable node.	YES	YES
`CreateDate`	Numeric value node representing year Numeric value node representing month Numeric value node representing day	Creates date value.	YES	YES
`CreatePeriod`	String value node matching ISO Duration schema	Returns new period node representing the given duration	YES
`CurrentDate`		Returns the current date.	NO	YES
`EndOfYearBeforeReport`		Returns year number previous to period year of the report currently being validated.	NO	YES
`Dim`	Variable node. QName node.	Returns given explicit dimension (param 2) value from a given variable (param 1).	Partially - only in Join	YES
`Exp`	Any numeric value node - the base of the power Any numeric value node - the nominator of the exponent of the power Any numeric value node - the denominator of the exponent of the power	Return calculated value of param 1 ^ (param 2 / param 3).	YES	YES
`False`		Returns `false` boolean value.	NO	NO
`GetLabel`	Variable node pointing to enumeration metric String node representing the language	Returns label of enumeration metric value for a specified variable.	YES	YES
`GroupConcatDistinct`	String value nodes	Returns all distinct given values, concatenated into a single value, using `,` as a separator.	NO	YES
`GroupConcat`	String value nodes	Returns all values, concatenated into a single value, using `,` as a separator.	NO	YES
`Identifier`	Variable node	Returns the value of XBRL identifier element associated with the given variable.	YES
`if-then-else`	Logical Expression 1 Logical Expression 2 Logical Expression 3 (optional)	Allowing to create the logical expression with the following syntax: `If [logical expression 1] then [logical expression 2] else (TRUE or [logical expression 3] if present)` Evaluation algorithm: Is `logical expression 1` = `TRUE`? YES. Is `logical expression 2` = `TRUE`? YES → `return TRUE`. NO → `return FALSE`. NO. Is `logical expression 3` present? YES. Is `logical expression 3` = `TRUE`? YES → `return TRUE`. NO → `return FALSE`. NO → `return TRUE`.	YES	YES
`IsInClosedRange`	Variable node Numeric value node Numeric value node, greater or equal to param 2	Returns `TRUE` if fact specified by a variable node (param 1) belongs to range <param 2, param 3>, otherwise `FALSE`.	YES	NO - can be added when needed.
`IsInOpenRange`	Variable node Numeric value node Numeric value node, greater or equal to param 2	Returns `TRUE` if fact specified by a variable node (param 1) belongs to range (param 2, param 3), otherwise `FALSE`.	YES	NO - can be added when needed.
`IsNull`	Any value node	Returns `TRUE` if value node is null, otherwise `FALSE`.	YES	YES
`IsFallback`	Variable node	Returns `TRUE` if variable value is equal to the default variable value, otherwise `FALSE`.	YES	YES
`IsinChecksum`	String value node	Returns `TRUE` if a given value is a valid ISIN code, otherwise `FALSE`.	NO	YES
`LeiChecksum`	String value node	Returns `TRUE` if a given value is a valid LEI code, otherwise `FALSE`.	NO	YES
`Matches`	Value node String value node	Returns `TRUE` if a value provided in param 1 is matching the regular expression provided in param 2, otherwise `FALSE`.	YES	YES
`Max`	Numeric value nodes	Returns maximum value of the values provided.	YES	YES
`iMax`	Numeric value nodes	Returns maximum interval value of the values provided.	YES	YES
`Min`	Numeric value nodes	Returns minimum value of the values provided.	YES	YES
`iMin`	Numeric value nodes	Returns minimum interval value of the values provided.	YES	YES
`Not`	Logical expression	Returns `TRUE` when given logical expression is `FALSE`, otherwise `FALSE`.	YES	YES
`ReportCurrency`		Returns the currency of the report currently being validated.	NO	YES
`ReportDate`		Returns period date of the report currently being validated.	NO	YES
`ReportYear`		Returns period year number of the report currently being validated.	YES	YES
`ReportingLevel`		Returns reporting level for the report currently being validated: module label contains Consolidated → returns `CON`, module label contains Individual → returns `IND`, in all other cases → returns empty string.	NO	YES
`StringLength`	String value node	Returns number of characters in the given string.	YES	YES
`Substring`	String value node Numeric value node Numeric value node (optional)	Returns new string value defined as a part of param 1, starting from character defined by an index (param 2), up to the end, or a number of characters specified by optional param 3.	YES	YES
`SubtractDates`	Date node Date node	Returns a period node with the difference between the 2 dates.	YES
`SubtractPeriods`	Period node Period node	Returns the difference of the 2 periods.	YES
`SubtractPeriodFromDate`	Period node Period node	Returns the difference of the 2 periods.	YES
`Sum`	Numeric value nodes	Returns sum of the values provided.	YES	YES
`iSum`	Numeric value nodes	Returns interval sum of the values provided.	YES	YES
`True`		Returns `true` boolean value.	NO	NO
`Unit`	Variable node	Returns QName node with variable unit.
`CustomMarginEqual`	Numeric value node Numeric value node Numeric value node	Returns `true` when param 1 is equal to param 2, with a margin of param 3.	YES	YES
`CustomMarginGreaterThan`	Numeric value node Numeric value node Numeric value node	Returns `true` when param 1 is greater than param 2, with a margin of param 3.	YES	YES
`CustomMarginGreaterThanOrEqual`	Numeric value node Numeric value node Numeric value node	Returns `true` when param 1 is greater than or equal to param 2, with a margin of param 3.	YES	YES
`CustomMarginLessThan`	Numeric value node Numeric value node Numeric value node	Returns `true` when param 1 is less than param 2, with a margin of param 3.	YES	YES
`CustomMarginLessThanOrEqual`	Numeric value node Numeric value node Numeric value node	Returns `true` when param 1 is less than or equal to param 2, with a margin of param 3.	YES	YES