Page History
...
| Category | Function | Description |
|---|---|---|
| Logic | AND | Returns TRUE if all of its arguments are TRUE |
| OR | Returns TRUE if any argument is TRUE | |
| TRUE | Returns the boolean value TRUE | |
| FALSE | Returns the boolean value FALSE | |
| NOT | Reverses the boolean value of its argument | |
| UNKNOWN | Returns the logical value unknown | |
| Text | CONCATENATE | Joins several text items into one text item |
| JOIN | Joins several text items into one text item, while placing a separator character between them | |
| MATCH | Checks if a string completely matches a regular expression | |
| FIND | Returns found characters if a pattern is found within text value | |
| FIRST | Returns the first position where one text value is found within another | |
| LAST | Returns the last position where one text value is found within another | |
| Statistics | AVERAGE | Returns the average of its arguments |
| MIN | Returns the minimum of a specified value in a list or collection | |
| MAX | Returns the maximum of a specified value in a list or collection | |
| COUNT | Counts the number of instances in a specified collection | |
| Date and Time | DATETIME | Converts a date in the form of text or a date object to a dateTime object |
| DATE | Converts a date in the form of text or a dateTime object to a date object | |
| ADD PERIOD TO DATE | Adds a specified period (day, month etc.) to a date | |
| ADD PERIOD TO DATETIME | Adds a specified period (day, month etc.) to a date | |
| SUBTRACT PERIOD FROM DATE | Subtracts a specified period (day, month etc.) from a date and time | |
| SUBTRACT PERIOD FROM DATETIME | Subtracts a specified period (day, month etc.) from a date and time | |
| PERIOD BETWEEN | Returns the period (days, months etc.) between two dates, two dateTimes or a date-dateTime combination | |
| YEAR | Returns the number of the year | |
| MONTH | Returns the number of the month | |
| DAY | Returns the number of the day in the month | |
| HOUR | Returns the number of hours in a dateTime object | |
| MINUTE | Returns the number of minutes in a dateTime object | |
| SECOND | Returns the number of seconds in a dateTime object | |
| TODAY | Returns today’s date | |
| NOW | Returns the current date and time | |
| Collection | SIZE collection | Returns the size of a collection |
| UNIQUE collection | Filters duplicate instances in a collection | |
| SUBSET OF | Returns a subset of a collection | |
| UNION | Combines two collections into one new collection | |
| INTERSECTION | Returns the intersection of two collections | |
| Math | ADD | Adds two numbers |
| SUM | Sums the specified values in a collection | |
| SUBTRACT | Subtracts two numbers | |
| DIVIDE | Divides two numbers | |
| DIV | Returns the integer portion of a division | |
| MOD | Returns the remainder from division | |
| ROUND | Rounds a number to a specified number of digits | |
| ROUND TO MULTIPLE | Rounds a number to the nearest integer or to the nearest multiple of significance | |
| MULTIPLY | Multiplies two numbers | |
| PRODUCT | Multiplies the specified values in a collection | |
| POWER | Returns the result of a number raised to a power | |
| LESS | Compares two number values and returns TRUE when one is smaller than the other | |
| LESS OR EQUAL | Compares two number values and returns TRUE when one is equal or smaller than the other | |
| GREATER | Compares two number values and returns TRUE when one is greater than the other | |
| GREATER OR EQUAL | Compares two number values and returns TRUE when one is equal to or greater than the other | |
| EQUAL | Compares two values and returns TRUE when they are equal | |
| NOT EQUAL | Compares two number values and returns TRUE when they are not equal | |
| List | EXISTS | Returns TRUE if there is an instance that matches the specifications |
| ALL | Returns a collection of all instances of a specified entity | |
| COLLECT FROM | Returns a collection for a specified entity | |
| COLLECT FROM WHERE | Returns a collection for a specified entity that matches the specified conditions | |
| COLLECT FROM NAMED | Returns a collection for a specified entity | |
| COLLECT FROM NAMED WHERE | Returns a collection for a specified entity that matches the specified conditions | |
| UNPACK | Returns the content of a single-valued list | |
| Conversion | TEXT | Converts a value type to string |
| INTEGER | Converts a value type to integer | |
| NUMBER | Converts a value type to number | |
| CURRENCY | Converts a value type to currency | |
| PERCENTAGE | Converts a value type to percentage | |
| DATE | Converts a value type to date | |
| DATETIME | Converts a value type to datetime | |
| BOOLEAN | Converts a value type to boolean | |
| More functions | ISUNKNOWN | Replaces an unknown value with a specified value |
| IS A | ||
| TYPE OF | ||
| AUTHORIZATIONROLES | ||
| CHANNEL | ||
| LANGUAGE | ||
| PAGE | ||
| PRIVILEGES | ||
| EVENT |
Statistics
AVERAGE
Use this function to determine the average (arithmetic mean) of a list or collection.
The AVG function has two syntax forms: the collection form and the list form. You can use the collection form to determine the average value of all occurances of an attribute. The list form is used to determine the average value of a set of different attributes.
Collection form syntax
AVG(attribute)- attribute - An attribute of any type of number or date of which multiple instances can occur at runtime.
List form syntax
AVG([value1, value2, ...])- [value1, value2, …] - A list of attributes, expressions or fixed values of any type of number or date. Use the square brackets to indicate that the arguments form a list of values.
Return types
- number
- integer
- currency
- percentage
- date
The function returns UNKNOWN if one or more values are UNKNOWN.
Examples
Suppose the following domain model.
...
If you want to determine the average bidding on the current residence:
- AVG(Residence.hasBiddings.amount)
If you want to determine the average amount of the appraisal value, the asking price and the mortgage of the current residence:
- AVG([Residence.appraisalValue, Residence.askingPrice, Residence.mortgage])
MIN
Use this function to determine the minimum value of a list or collection.
The MIN function has two syntax forms: the collection form and the list form. You can use the collection form to determine the minimum value of all occurrences of an attribute. The list form is used to determine the minimum value of a set of different attributes.
Collection form syntax
MIN(attribute)- attribute - An attribute of any type of number or date of which multiple instances can occur at runtime.
List form syntax
MIN([value1, value2, ...])- [value 1, value 2, …] - A list of attributes, expressions or fixed values of any type of number or date. Use the square brackets to indicate that the arguments form a list of values.
Examples
Suppose the following domain model.
...
If you want to determine the lowest bidding on the current residence:
- MIN(Residence.hasBiddings.amount)
If you want to determine the smallest amount within the appraisal value, the asking price and the mortgage:
- MIN([Residence.appraisalValue, Residence.askingPrice, Residence.mortgage])
MAX
Use this function to determine the maximum value of a list or collection.
The MAX function has two syntax forms: the collection form and the list form. You can use the collection form to determine the maximum value of all occurrences of an attribute. The list form is used to determine the maximum value of a set of different attributes.
Collection form syntax
MAX(attribute)- attribute - An attribute of any type of number or date of which multiple instances can occur at runtime.
List form syntax
MAX([value1, value2, ...])- [value 1, value 2, …] - A list of attributes, expressions or fixed values of any type of number or date. Use the square brackets to indicate that the arguments form a list of values.
Examples
Suppose the following domain model.
...
If you want to determine the highest bidding on the current residence:
- MAX(Residence.hasBiddings.amount)
If you want to determine the highest amount within the appraisal value, the asking price and the mortgage:
- MAX([Residence.appraisalValue, Residence.askingPrice, Residence.mortgage])
COUNT
Use this function to retrieve the number of instances for the specified entities or attributes.
Syntax
COUNT(collection)- collection - A collection of attribute or entity instances.
Return type
- integer
Examples
Suppose the following data model.
...
...
- COUNT(ALL Person) results in 4
- COUNT(House.rooms) results in 3
- COUNT(ALL Person + ALL House) results in 5
- COUNT(COLLECT Person FROM ALL Person WHERE(Person.name = “Lisa”)) results in 1
- COUNT(? (= UNKNOWN)) results in UNKNOWN 1)
Date and Time
DATETIME
You can use this function to create2) a dateTime value out of integers or numbers 3).
Syntax
DATETIME(year, month, day, hour, minute, second)
- year - An integer value between and including 1 and 9999 that represents the year in the constructed date.
- month - An integer value between and including 1 and 12 that represents the month in the constructed date.
- day - An integer value between and including 1 and 31 that represents the day in the constructed date.
- hour - An integer value between and including 0 and 23 that represents the hours in the constructed time.
- minute - An integer value between and including 0 and 59 that represents the minutes in the constructed time.
- second - An integer value between and including 0 and 59 that represents the seconds in the constructed time.
Return type
- dateTime
Examples
- DATETIME(2010, 5, 25, 23, 00, 00) returns 25-5-2010 23:00:00
- DATETIME(-2010, 5, 25, 23, 00, 00) results in UNKNOWN
- DATETIME(2010, 5, 25, 45, 00, 00) results in UNKNOWN
...
Overview
Content Tools