You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Reference guide: functions and expressions
| 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 |
More functions
ISUNKNOWN
This function replaces a value if that value is unkown.
Syntax
ISUNKNOWN(attribute, value)
- attribute - Attribute of which the value has to be returned if that value is known.
- value - Value to return if the attribute value is unknown.
Return type
- any type, equals the attribute type
Examples
Suppose the following data model.
| Person.name | Person.SequenceNumber |
|---|---|
| “Bob” | 654 |
| “Jane” | ? |
| “Mary” | 667 |
| “Rick” | ? |
| “Ron” | ? |
| “Jenny” | 765 |
- for Jane, ISUNKNOWN(Person.SequenceNumber, 999) returns 999
- for Mary, ISUNKNOWN(Person.SequenceNumber, 999) returns 667
IS A
Use this function to check the type of an instance. The function returns TRUE if the selected instance is of the specified entity.
Syntax
instance IS A entity_name
- instance - Instance to check.
- entity_name - Name of the entity as string.
Return type
- boolean
Examples
Suppose a domain model in which there is a singleton entity Residence that has a multivalued relation hasRooms with Room. Room is the base entity for singleton Kitchen and not singletons Bedroom and Bathroom.
If you want to determine the number of bedrooms is the residence:
- COUNT(COLLECT Room FROM Residence.hasRooms WHERE (Room IS A “Bedroom”))
If you want to determine the number of bathrooms is the residence:
- COUNT(COLLECT Room FROM Residence.hasRooms WHERE (Room IS A “Bathroom”))
TYPE OF
Use this function to determine the type of an instance. The function returns the name of the entity.
Syntax
TYPE OF base_entity
- base_entity - Name of the instance's base entity.
Return type
- string
Examples
Suppose a domain model in which there is a singleton entity Residence that has a multivalued relation hasRooms with Room. Room is the base entity for singleton Kitchen and not singletons Bedroom and Bathroom.
- for the Kitchen instance the expression TYPE OF Room results in “Kitchen”
- for the Bedroom instances the expression TYPE OF Room = “Bedroom” results in TRUE
AUTHORIZATIONROLES
This system attribute is obsolete since studio version 7.0. With the introduction of processes a new concept 'privilege' was introduced to replace the authorization concept. Therefor the system attribute was also replaced. For backwards compatibility reasons, after logging on to the runtime, the system.authorizationroles attribute will be filled with the user's privileges.
See also: Privileges
CHANNEL
You can get the name of the current channel by using the system attribute system.channel. This is a predefined system attribute, so you don’t have to create it yourself.
At run-time the system returns a string value with the channel you choose while logging on. This value is assigned to the attribute system.channel.
LANGUAGE
You can get the name of the current language by using the system attribute system.language. This is a predefined system attribute, so you don’t have to create it yourself.
At run-time the system returns a string value with the language that you choose while logging on. This value is assigned to the attribute system.language.
PAGE
You can get the name of the current page by using the system attribute system.currentpage. This is a predefined system attribute, so you don’t have to create it yourself.
At run-time the system returns a string value with the page name of the page you are on, this value is assigned to the attribute system.currentpage.
PRIVILEGES
You can get the name of the current privileges by using the system attribute system.privileges. This is a predefined system attribute, so you don’t have to create it yourself.
At run-time the system returns a list of string values of the privileges that you choose while logging on. These values are assigned to the attribute system.privileges.
EVENT
You can capture the parameters associated with an event by using the system attribute system.event. This is a predefined system attribute, so you don’t have to create it yourself.
At run-time the system returns the string values with the parameters associated with the event on the current page. This value is assigned to the attribute system.event.
Beside these user defined event parameters, there are some container types that come with their own built-in buttons. Some older1) containertypes can throw a 'default event' with associated event parameters. Standard container types with this behaviour are:
| Container type | Button | Action |
|---|---|---|
| AQ_InstanceSelector | Edit | _edit_instance, _edit_instance <entityName>, _edit_instance <relation_attr> |
| Delete | _delete_instance | |
| Add | _edit_instance, _add_instance, _edit_instance <entityName>, _edit_instance <relation_attr> | |
| Not applicable | Cancel | _clear_instance, _void |
| Save | _save_instance | |
| AQ_DecisionTreeSelector | matchButton | _matchTree |
| selectButton | _selectTree | |
| AQ_DecisionTreeEvaluator | continueButton | _continueTree |
| stopButton | _stopTree | |
| retryButton | _retryTree |
Even though some action labels are the same, the system handles them in a different way, this depends on the context. For instance ‘Edit’ will open an existing instance, ‘Add’ will create a new instance, however the action ‘_edit_instance’ is the same.
Special behaviour of the AQ_InstanceSelector
The AQ_InstanceSelector adds the following actions to system.event, depending on the action that was taken in the instance selector:
- _add_instance: this action is added when a new instance is created
- _edit_instance: this action is added when an existing instance has been edited
- _delete_instance: this action is added when an instance has been deleted
- _update_instance: this action is added when an instance has been updated
instanceType<entity name>: this action describes the entity of the instance that has been edited. For example, adding an instance of type Person puts the following actions in system.event: “_add_instance, instanceType_Person”
1) New container types (from release 7.0 and up) should not throw a default event with parameters but separate events for each generated button
Overview
Content Tools