Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

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 (question) 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

  1. Any numeric value node.

Returns the absolute value of the given parameter.

YES

YES

iAbs

  1. 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 → returnsIFRS,

  • module label contains GAAP → returns GAAP,

  • in all other cases → returns empty string.

NO

YES

CheckFilingIndicator

  1. 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

Count

  1. Variable node.

Returns number of not-null facts in given variable node.

YES

YES

CreateDate

  1. Numeric value node representing year.

  2. Numeric value node representing month.

  3. Numeric value node representing day.

Creates date value.

YES

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

  1. Variable node.

  2. QName node.

Returns given explicit dimension (param 2) value from a given variable (param 1).

Partially - only in Join

YES

Exp

  1. Any numeric value node - the base of the power.

  2. Any numeric value node - the nominator of the exponent of the power.

  3. 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

  1. Variable node pointing to enumeration metric.

  2. 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

if-then-else

  1. Logical Expression 1

  2. Logical Expression 2

  3. 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:

  1. Is logical expression 1 = TRUE?

    1. YES.

      1. Is logical expression 2 = TRUE?

        1. YES → return TRUE.

        2. NO → return FALSE.

    2. NO.

      1. Is logical expression 3 present?

        1. YES.

          1. Is logical expression 3 = TRUE?

            1. YES → return TRUE.

            2. NO → return FALSE.

        2. NO → return TRUE.

YES

YES

IsInClosedRange

  1. Variable node.

  2. Numeric value node.

  3. 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

  1. Variable node.

  2. Numeric value node.

  3. 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

  1. Any value node.

Returns TRUE if value node is null, otherwise FALSE.

YES

YES

IsFallback

  1. Variable node.

Returns TRUE if variable value is equal to the default variable value, otherwise FALSE.

YES

YES

IsinChecksum

  1. String value node.

Returns TRUE if a given value is a valid ISIN code, otherwise FALSE.

NO

YES

LeiChecksum

  1. String value node.

Returns TRUE if a given value is a valid LEI code, otherwise FALSE.

NO

YES

Matches

  1. Value node.

  2. 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

  1. 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

  1. String value node.

Returns number of characters in the given string.

YES

YES

Substring

  1. String value node.

  2. Numeric value node.

  3. 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

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

CustomMarginEqual

  1. Numeric value node.

  2. Numeric value node.

  3. Numeric value node.

Returns true when param 1 is equal to param 2, with a margin of param 3.

YES

YES

CustomMarginGreaterThan

  1. Numeric value node.

  2. Numeric value node.

  3. Numeric value node.

Returns true when param 1 is greater than param 2, with a margin of param 3.

YES

YES

CustomMarginGreaterThanOrEqual

  1. Numeric value node.

  2. Numeric value node.

  3. 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

  1. Numeric value node.

  2. Numeric value node.

  3. Numeric value node.

Returns true when param 1 is less than param 2, with a margin of param 3.

YES

YES

CustomMarginLessThanOrEqual

  1. Numeric value node.

  2. Numeric value node.

  3. Numeric value node.

Returns true when param 1 is less than or equal to param 2, with a margin of param 3.

YES

YES

  • No labels